brigade

README

Brigade: Acme Continuous Integration and Deployment

Brigade is a tool for running scriptable automated tasks in the cloud. It is ideally suited for CI/CD workloads. Brigade runs as part of a Kubernetes cluster.

For example, Brigade can be used to run CI tasks on a GitHub repository:

• Install Brigade into your Kubernetes cluster (if you haven't already)
• Define an brigade.js file in the root of your GitHub repository.
• Add a GitHub hook pointing to your Brigade server
• On each push event (including tagging), Brigade runs your brigade.js file.

The Brigade Technology Stack

• Brigade ❤ JavaScript: Writing Brigade pipelines is as easy as writing a few lines of JavaScript.
• Brigade ❤ Kubernetes: Brigade is Kubernetes-native. Your builds are translated into pods, secrets, and services
• Brigade ❤ Docker: No need for special plugins or elaborate extensions. Brigade uses off-the-shelf Docker images to run your jobs. And Brigade also supports DockerHub webhooks.
• Brigade ❤ GitHub: Brigade comes with built-in support for GitHub, DockerHub, and other popular web services. And it can be easily extended to support your own services.

Quickstart

The easiest way to get started with Brigade is to install it using Helm:

$ git clone https://github.com/deis/brigade.git
$ cd brigade
$ helm install --name brigade ./chart/brigade

You will now have Brigade installed.

To create new projects, use the brigade-project Helm chart. While inside the Git repository cloned above, run these commands:

$ helm inspect values ./brigade-project > myvalues.yaml
$ # edit myvalues.yaml
$ helm install --name my-project ./brigade-project -f myvalues.yaml

When editing myvalues.yaml, follow the instructions in that file for configuring your new project. Once you have customized that file, you can install the project based on your new configuration by passing it with -f myvalues.yaml.

Now creating your first brigade.js is as easy as this:

const { events } = require('brigadier')

events.on("push", (brigadeEvent, project) => {
  console.log("Hello world!")
})

But don't be fooled by its simplicty. Brigade can be used to create complex distributed pipelines. Check out the tutorial for more.

Brigade ❤ Developers

These directions assume you are using minikube for development. For other environments, you must make sure you push the Docker images to the right registry or cluster Docker daemon.

To get started:

• Clone this repo and change directories into it
• Point to MiniKube's Docker environment with eval $(minikube docker-env)
• Run make bootstrap build docker-build to build the source
• Install the Helm chart: helm install -n brigade chart/brigade