Big Bang Documentation¶
Big Bang is an umbrella Helm chart that uses Flux to deploy and reconcile a configurable collection of Kubernetes packages.
Start Here¶
New to Big Bang? Follow the Getting Started path:
- Understand what Big Bang manages and what remains outside its boundary.
- Review the prerequisites for your selected release and configuration.
- Choose an installation path:
- Evaluation quickstart for a disposable development or demonstration cluster.
- First production-oriented deployment for a customer-managed GitOps environment.
- Disconnected deployment when dependencies must be mirrored inside the environment.
- Continue with configuration and operations before promoting a deployment to production.
The evaluation quickstart is not a production baseline. Big Bang also does not provision or harden the Kubernetes cluster on which it runs.
Find Documentation by Task¶
| Goal | Documentation |
|---|---|
| Understand the architecture and GitOps model | Concepts |
| Configure global and package values | Configuration |
| Choose an environment-specific deployment pattern | Installation |
| Operate, upgrade, and troubleshoot a deployment | Operations |
| Review integrated and optional packages | Packages |
| Follow a focused procedure | Tutorials |
| Contribute to Big Bang or package development | Community and Development |
Sources of Truth¶
Documentation is versioned with the repository. When instructions disagree with generated or executable content for the selected release, use these sources in order:
chart/Chart.yamlfor the chart and Kubernetes version constraints.chart/values.yamland the generated configuration reference for values and defaults.base/and rendered manifests for Flux resources and Kubernetes objects.- The selected release notes for required migrations and known changes.
Get Help¶
- Search troubleshooting for the failing layer or symptom.
- Review Repo1 work items before reporting a defect.
- Follow the repository contributing guide when proposing a change.