brigade

README

Brigade: Event-based Scripting for Kubernetes

Script simple and complex workflows using JavaScript. Chain together containers, running them in parallel or serially. Fire scripts based on times, GitHub events, Docker pushes, or any other trigger. Brigade is the tool for creating pipelines for Kubernetes.

• JavaScript scripting
• Project-based management
• Configurable event hooks
• Easy construction of pipelines
• Check out the docs to get started.

---

NOTE

Brigade 2.0 is currently under active development in the v2 branch of this repository.

We're excited to announce the first beta release for Brigade 2, v2.0.0-beta.1! See the README on the v2 branch to learn how to get started with Brigade 2.0.

---

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.

The design introduction introduces Brigade concepts and architecture.

Quickstart

Check out the quickstart on the docs here.

Related Projects

• Kashti - a dashboard for your Brigade pipelines.
• Brigadeterm - a simple terminal ui for brigade pipelining system.
• Brigade exporter - a Prometheus exporter to gather metrics from Brigade.
• Gateways
  • GitHub App: A GitHub gateway utilizing the GitHub Checks API
  • BitBucket events: Gateway Support for BitBucket repositories
  • GitLab events: Gateway Support for GitLab repositories
  • Kubernetes events: Gateway that listens to Kubernetes event stream
  • Event Grid gateway: Gateway for Azure Event Grid events
  • Cron Gateway: Schedule events to run at a particular time
  • Trello and Generic Webhooks: Experimental gateway for Trello and for generic webhooks
  • Draft Pack for Building Custom Gateways: Build your own gateway in 5 minutes
  • Azure DevOps / VSTS gateway: Gateway for Azure DevOps / VSTS events

Brigade ❤ Developers

To get started head to the developer's guide

Brigade is well-tested on Minikube and Azure Kubernetes Service.

Contributing

The Brigade project accepts contributions via GitHub pull requests. The Contributing document outlines the process to help get your contribution accepted.

Support & Feedback

We have a slack channel! Kubernetes/#brigade Feel free to join for any support questions or feedback, we are happy to help. To report an issue or to request a feature open an issue here

License