- Our goal is to have near 100% of publicly sharable docs in this centralized location to act as a single source of truth where all documentation can be found and help move docs out of IL2 Confluence and Private Repos to better support the open source community.
# 2. Big Bang Quick Start, Local Dev Env Setup, and Docs:
## What types of documentation can be found in the docs folder?
- Developer Contribution Docs
- Docs to help understand BigBang (At a concrete level, what the value add is, and Architecture Diagrams)
- Deployment Prerequisites
- Deployment Docs for Internet Connected and Disconnected deployments
## Purpose:
- Guides new users with zero prior knowledge on how they can spin up Big Bang from scratch within 2 hours, will cover:
- Any Prerequesites and suggestions for meeting them
- Explanation of how k3d and BigBang automation works, so that new new users can understand whats happening as they follow quick start guide.
- Multiple Methods of provisioning and interfacing with a k3d node
- 2 Methods of installing BigBang to cover the following 2 use cases:
1. Quick Start Demo:
- Leverages preset config values in a public git repo
2. Local Development Environment Setup:
- Cover how to inject values using 100% local overrides (minimal GitOps / SOPS encryption) so new developers are aware of how to achieve fast feedback loop
- In Depth Documentation on how to configure a production grade internet connected deployment of Big Bang Covering:
- Overview of the deployment process that includes explanations of how the automation works and why certain design decisions were made so that new users can understand what is happening and why things are done how they're done as they work through the deployment guide.
- Suggested Repo organization conventions, standards, and reasoning
- Any Prerequesites and suggestions for meeting them
- How to prepare a new repo (this repo can double as a template repo)
- How to Configure GitOps Encryption using SOPS
- AWS KMS and IAM
- (Future Additions)
- A Checklist of secret config files to prepare
- How to prepare secret config files, store them encrypted in git, and leverage them using GitOps
- Flux Configuration for:
- A Public Git Repo using HTTPS signed by Public CA
- A Private Git Repo using HTTPS signed by Public CA
# 5. Internet Disconnected GitOps Deployment Docs:
- In Depth Documentation on how to configure a production grade internet disconnected deployment of Big Bang Covering:
- Overview of the deployment process that includes explanations of how the automation works and why certain design decisions were made so that new users can understand what is happening and why things are done how they're done as they work through the deployment guide.
- Suggested Repo organization conventions, standards, and reasoning
- Any Prerequesites and suggestions for meeting them
- How to prepare a new repo (this repo can double as a template repo)
- How to setup a Private SSH based Git Repo
- How to setup and maintain a Internet Disconnected Registry
- How to Configure GitOps Encryption using SOPS
- Generic GPG Key Pairs
- Flux Configuration for:
- A Private Git Repo using HTTPS signed by a Private CA
- A Private SSH based Git Repo
# 6. Post Installation Package Configuration Docs:
## Location:
- Should exist in the repo of each individual package, and a documentation server hosted on BigBang as outlined [here](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/master/charter/PackageDocumentation.md)
- These docs should be available on a webpage hosted on the Big Bang Cluster using Hugo
(https://docs.bigbang.dev by default)
## Purpose:
# BigBang Package Docs
## Where is the best place to look for documentation on BigBang Packages?
- Our goal is to have these docs available on a webpage hosted on the Big Bang Cluster using Hugo
(https://docs.bigbang.dev by default) (look [here](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/master/charter/PackageDocumentation.md) for more info)
- This allows us to support a centralized location for package configuration documentation, while allowing support for dynamically added versions of distributed packages in a maintainable way.
