Getting Started

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

Prerequisites

Bitbucket Server

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

See the official Bitbucket Server installation guide.

Docker Host

To run your pipeline jobs, you also need Docker to create and manage containers.

While you can use the same host where you have 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 GNU/Linux, Windows or macOS, check the official guide: How to install Docker Engine.

Installation

Snake CI Add-on

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

Snake Runner

Snake Runner can be installed on GNU/Linux, Windows or macOS: read the comprehensive guide on how to setup Snake Runner in Docker

Ensure runner is connected

Navigate to Bitbucket admin panel → Find the CI/CD section and click Runners. There, you will see a list of all runners with their statuses.

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


Is everything up and running? Follow the basic workflow and setup your first pipeline.


Workflow

Basic workflow with Snake CI from the developer perspective

Setup Add-on

Installation and configuration of Snake CI Add-on

Setup Runner

Install and run Snake Runner with Docker


Last modified July 27, 2020