Getting Started

This page describes how to get started with Snake CI, including installation and basic configuration.

Snake CI consists of two parts — the add-on and the runner. The add-on is what provides the UI for users in your Bitbucket Server / Data Center. The runner is what is going to handle your workload and execute the pipelines you give.

There is a little bit of requirements for the add-on to be up and running.

Bitbucket Server

You need a recent version of Bitbucket Server (we recommend version 6.0 or later) to get up and running.

See the official Bitbucket Server installation guide.

Docker

To run your pipeline jobs, you also need a Docker host or Kubernetes cluster to create and manage containers.

While you can use the same system where you host Bitbucket, we encourage you to use a different host because it is much easier to scale and manage.

You need a recent version of Docker daemon up and running on any supported OS such as Linux, Windows or macOS. Check the official guide for details.

Installation

Snake CI

There are two ways to ship the add-on for your Bitbucket Server / Data Center:

  • Navigate to Bitbucket admin panelFind new apps → Search for Snake CI → and click Install.
  • Download JAR file from the Atlassian Marketplace page: Snake CI Add-on.

Snake Runner

Snake Runner can be installed on Linux, Windows or macOS. Read the comprehensive guide on how to set up Snake Runner in Docker.

Ensure runner is connected

Navigate to Bitbucket admin panelCI/CD section → Runners. There, you will see a list of every runner and its status.

The runner must have the online status to receive jobs and execute them.


Is everything up and running? Follow this basic workflow to set up your first pipeline.


Workflow

Basic workflow with Snake CI from the developer perspective

Install the Snake CI add-on in Bitbucket

Installation and configuration of the Snake CI add-on for Bitbucket Server & Data Center

Install Snake Runner

Setup and run Snake Runner to handle your workload.

Last modified October 21, 2020