Topic Guides
Topic Guides
This section of the documentation dives deep into individual parts of Brigade. This is where complete guides to Brigade’s controller, sandbox engine, and much more live. This is probably where you’ll want to spend most of your time; if you work your way through these guides you should come out knowing pretty much everything there is to know about Brigade.
If you don’t see a topic guide here and have a reasonable level of knowledge on the subject, why not write one up?
Table of Contents
- Architecture
- Brigade Design: A high-level explanation of how Brigade is designed.
- Using Brigade (brigade.js, webhooks)
- Scripting Guide: How to write JavaScript for
brigade.jsfiles. - Using the Brigade CLI
- Brigade.js Reference: The API for brigade.js files.
- Scripting Guide - Advanced: Advanced examples for
brigade.jsfiles. - Adding dependencies to
brigade.js: How to add local dependencies and NPM packages to yourbrigade.jsfiles. - GitHub Integration: A guide for configuring GitHub integration.
- Container Registry Integration: A guide for configuring integration with DockerHub or Azure Container Registry.
- Generic Gateway: How to use Brigade’s Generic Gateway functionality.
- Using Secrets: How to pass sensitive data into builds.
- Brigade Gateways: Learn how to write your own Brigade gateway.
- Scripting Guide: How to write JavaScript for
- Configuring and Running Brigade
- Projects: Install, upgrade, and use Brigade Projects.
- Securing Brigade: Things to consider when configuring Brigade.
- Storage: How Brigade uses Kubernetes Persistent Storage.
- Workers: More information regarding Brigade Worker.
- Testing Brigade: How to test Brigade.
- Contributing to Brigade Development
- Brigade Developers Guide: A guide for people who want to modify Brigade’s code.
- Examples
- Example Projects: Brigade-related projects.