UNCLASSIFIED - NO CUI

Skip to content
Snippets Groups Projects
Commit 3735ce14 authored by Josh Wolf's avatar Josh Wolf
Browse files

docs: update README with auto generated docs for values

parent 5fb2bc83
No related branches found
No related tags found
2 merge requests!258Release 1.1,!253docs: add autodocs generation for helm values
Pipeline #169172 passed with warnings
{{ template "chart.header" . }}
{{ template "chart.deprecationWarning" . }}
{{ template "chart.badgesSection" . }}
{{ template "chart.description" . }}
{{ template "chart.homepageLine" . }}
Big Bang follows a [GitOps](#gitops) approach to configuration management, using [Flux v2](#flux-v2) to reconcile Git with the cluster. Environments (e.g. dev, prod) and packages (e.g. istio) can be fully configured to suit the deployment needs.
## Usage
Big Bang is intended to be used for deploying and maintaining a DoD hardened and approved set of packages into a Kubernetes cluster. Deployment and configuration of ingress/egress, load balancing, policy auditing, logging, monitoring, etc. are handled via Big Bang. Additional packages (e.g. ArgoCD, GitLab) can also be enabled and customized to extend Big Bang's baseline. Once deployed, the customer can use the Kubernetes cluster to add mission specific applications.
Additional information can be found in [Big Bang Overview](./docs/1_overview.md).
## Getting Started
To start using Big Bang, you will need to create your own Big Bang environment tailored to your needs. The [Big Bang customer template](https://repo1.dso.mil/platform-one/big-bang/customers/template/) is provided for you to copy into your own Git repository and begin modifications. Follow the instructions in [Big Bang Getting Started](./docs/2_getting_started.md) to customize and deploy Big Bang.
{{ template "chart.maintainersSection" . }}
{{ template "chart.sourcesSection" . }}
{{ template "chart.requirementsSection" . }}
{{ template "chart.valuesSection" . }}
## Contributing
Please see the [contributing guide](./CONTRIBUTING.md) if you are interested in contributing to Big Bang.
This diff is collapsed.
apiVersion: v2
name: bigbang
version: 1.1.0
description: Big Bang is a declarative, continuous delivery tool for core DoD hardened and approved [packages](#packages) into a Kubernetes cluster.
type: application
keywords:
- platform1
- bigbang
home: https://p1.dso.mil/#/products/big-bang
sources:
- https://repo1.dso.mil/platform-one/big-bang/bigbang
maintainers:
- name: Tom Runyon
email: tom@runyon.dev
- name: Josh Wolf
email: josh@rancherfederal.com
icon: https://p1.dso.mil/img/Big_Bang_Color_Logo_White_text.b04263b1.png
This diff is collapsed.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment