Quick install guide

This part is a work-in-progress because Brigade is still developer-oriented

Brigade is deployed via Helm. Here are the steps:

  1. Make sure helm is installed, and helm version returns the correct server.
  2. Add the Brigade repo: helm repo add brigade https://azure.github.io/brigade
  3. Install Brigade: helm install brigade/brigade --name brigade-server

At this point, you have a running Brigade service. You can use helm get brigade-server and other Helm tools to examine your running Brigade server.

Cluster Ingress

By default, Brigade is configured to set up a service as a load balancer for your Brigade build system. To find out your IP address, run:

$ kubectl get svc brigade-server-brigade-github-gw
NAME                               TYPE           CLUSTER-IP    EXTERNAL-IP    PORT(S)          AGE
brigade-server-brigade-github-gw   LoadBalancer   7744:32394/TCP   45d

(Note that brigade-server-brigade-github-gw is just the name of the Helm release (brigade-server) with -brigade-github-gw appended)

The EXTERNAL-IP field is the IP address that external services, such as GitHub, will use to trigger actions.

Note that this is just one way of configuring Brigade to receive inbound connections. Brigade itself does not care how traffic is routed to it. Those with operational knowledge of Kubernetes may wish to use another method of ingress routing.


We recommend using Brig, a command line tool for interacting with Brigade. Read the Brig guide for installation and usage docs.

Notes for Minikube

You can run Brigade on Minikube for easy testing and development. Minikube provides built-in support for caching and sharing files during builds. However, there are a few things that are much harder to do when running locally:

Notes for Azure Container Services (AKS)

Brigade is well-tested on AKS Kubernetes. We recommend using at least Kubernetes 1.6.

Prev: Overview | Next: Writing your first CI pipeline, Part 1