UNCLASSIFIED - NO CUI

Skip to content
Snippets Groups Projects
Commit 30af9547 authored by Ryan Thompson's avatar Ryan Thompson
Browse files

Resolve "Broken Link in bb-docs site"

parent cc56c2a2
No related branches found
No related tags found
1 merge request!2200Resolve "Broken Link in bb-docs site"
[Project Maintainers]
* @brandencobb @micah.nagel @michaelmcleroy @ryan.thompson.44 @runyontr @ryan.j.garcia
* @brandencobb @micah.nagel @michaelmcleroy @ryan.thompson.44 @ryan.j.garcia
[Docs Owners]
# Allow any one of the listed codeowners to approve merges to the documentation
# Does not allow the creator of the merge request to be the approver.
/docs/ @brandencobb @echuang @evan.rush @kenna81 @kevin.wilder @LynnStill @micah.nagel @michaelmartin @michaelmcleroy @runyontr @ryan.j.garcia @toladipupo @ronwebb @ryan.thompson.44 @lucas.rodriguez
/docs/ @brandencobb @echuang @evan.rush @kenna81 @kevin.wilder @LynnStill @micah.nagel @michaelmcleroy @ryan.j.garcia @toladipupo @ronwebb @ryan.thompson.44 @lucas.rodriguez
......@@ -14,15 +14,15 @@ Table of Contents:
- [Secrets & Certificates](#secrets--certificates)
- [Merge requests process](#merge-requests-process)
## Developers Guide
## Developers Guide
Big Bang is designed in such a way as to be as easily deployed locally as it is in production. In fact, most contributions begin locally.
## Iron Bank Images
Per the [charter](https://repo1.dso.mil/platform-one/big-bang/charter), all Big Bang packages will leverage container images from [IronBank](https://ironbank.dso.mil/). In order to pull these images, ImagePullSecrets must be provided to BigBang. To obtain access to these images, follow the guides below. These steps should NOT be used for production since the API keys for a user are only valid when the user is logged into [Registry1](https://registry1.dso.mil)
Per the [charter](https://repo1.dso.mil/platform-one/big-bang/charter), all Big Bang packages will leverage container images from [IronBank](https://ironbank.dso.mil/). In order to pull these images, ImagePullSecrets must be provided to Big Bang. To obtain access to these images, follow the guides below. These steps should NOT be used for production since the API keys for a user are only valid when the user is logged into [Registry1](https://registry1.dso.mil)
1) Register for a free Ironbank account [Here](https://sso-info.il2.dso.mil/new_account.html)
1) Register for a free Iron Bank account [Here](https://sso-info.il2.dso.mil/new_account.html)
1) Log into the [Iron Bank Registry](https://registry1.dso.mil), in the top right click your *Username* and then *User Profile* to get access to your *CLI secret*/API keys.
1) When installing BigBang, set the Helm Values `registryCredentials.username` and `registryCredentials.password` to match your Registry1 username and API token
......@@ -39,7 +39,7 @@ k3d cluster create --k3s-arg "--no-deploy=metrics-server,traefik@server:*" -p 80
For development, it is quicker to test changes without having to push to Git. To do this, we can bypass Flux2 and deploy Big Bang directly with its Helm chart.
Start by creating `myvalues.yaml` to configure your local Big Bang. Big Bang's template repository contains a starter [development values.yaml](https://repo1.dso.mil/platform-one/big-bang/customers/template/-/blob/main/dev/configmap.yaml).
Start by creating `myvalues.yaml` to configure your local Big Bang. The Big Bang template repository contains a starter [development values.yaml](https://repo1.dso.mil/platform-one/big-bang/customers/template/-/blob/main/dev/configmap.yaml).
Configure `myvalues.yaml` to suit your needs.
......@@ -82,4 +82,3 @@ Follow instructions in the [Big Bang encryption guide](./docs/understanding-bigb
The merge request process is provided as an overview of the pipeline stages required to get a commit merged.
Follow instruction in [CI-Workflow](./docs/developer/ci-workflow.md) for specific details on the pipeline stages.
......@@ -2,46 +2,49 @@
Big Bang is a declarative, continuous delivery tool for deploying DoD hardened and approved packages into a Kubernetes cluster.
> _If viewing this from Github, note that this is a mirror of a government repo hosted on [Repo1](https://repo1.dso.mil/) by [DoD Platform One](http://p1.dso.mil/). Please direct all code changes, issues and comments to https://repo1.dso.mil/platform-one/big-bang/bigbang_
> _If viewing this from Github, note that this is a mirror of a government repo hosted on [Repo1](https://repo1.dso.mil/) by [DoD Platform One](http://p1.dso.mil/). Please direct all code changes, issues and comments to [https://repo1.dso.mil/platform-one/big-bang/bigbang](https://repo1.dso.mil/platform-one/big-bang/bigbang)_
## Usage & Scope
Big Bang's scope is to provide publicly available installation manifests for:
- A specific set of packages that adhere to the DevSecOps Reference Architecture. The core list of packages can be found [here](https://repo1.dso.mil/platform-one/big-bang/apps/core).
- A specific set of packages that adhere to the DevSecOps Reference Architecture. The core list of packages can be found [here](https://repo1.dso.mil/platform-one/big-bang/apps/core).
- Packages that facilitate development of applications that adhere to the DevSecOps Reference Architecture. The full list of packages can be found [here](https://repo1.dso.mil/platform-one/big-bang/apps).
- Packages that facilitate development of applications that adhere to the DevSecOps Reference Architecture. The full list of packages can be found [here](https://repo1.dso.mil/platform-one/big-bang/apps).
Big Bang also builds tooling around the testing and validation of Big Bang packages. These tools are provided as-is, without support.
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.
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 Kubernetes cluster can be used to add mission specific applications.
Additional information can be found at [Big Bang Docs](https://docs-bigbang.dso.mil) and [here](./docs/README.md).
## Getting Started
- You will need to instantiate a 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.
## Contributing to Big Bang
There are 3 main ways to contribute to Big Bang:
There are 3 main ways to contribute to Big Bang:
- [Contribute to the Big Bang Team's Backlog](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/issues)
- [Contribute to open-source projects under the Big Bang Technical Oversight Committee (BBTOC)](https://repo1.dso.mil/platform-one/bbtoc/-/blob/master/CONTRIBUTING.md)
- [Submit new package proposals](https://repo1.dso.mil/platform-one/bbtoc/-/issues/new?issue%5Bmilestone_id%5D=)
- Please review the [package integration guide](./docs/developer/package-integration/README.md) if you are interested in submitting a new package
- A shepherd will be assigned to the project to create a repo in the [BB sandbox](https://repo1.dso.mil/platform-one/big-bang/apps/sandbox)
- [Contribute to open-source projects under the Big Bang Technical Oversight Committee (bbtoc)](https://repo1.dso.mil/platform-one/bbtoc/-/blob/master/CONTRIBUTING.md)
- [Contribute to the Big Bang Team's Backlog](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/issues)
Additional information can be found in the [contributing guide](./CONTRIBUTING.md).
## Release Schedule
- Big Bang releases every 2 weeks. In order to stay current with all features and security updates ensure you are no more than `n-2` releases behind.
- Big Bang releases every 2 weeks with a minor release number. In order to stay current with all features and security updates ensure you are no more than `n-2` releases behind.
- To see what is on the roadmap please see our [project milestones](https://repo1.dso.mil/groups/platform-one/big-bang/-/milestones)
## Navigating our documentation
Big Bang Documentation is located in the following locations:
Big Bang Documentation is located in the following locations:
- [Developer Contribution Documentation](./docs/developer)
- [Key Big Bang Concept Overviews](./docs/understanding-bigbang)
- [User Guides for Big Bang](./docs/guides/)
- [Big Bang Prerequisites](./docs/prerequisites/)
- [Big Bang Example Configurations](./docs/assets/configs/example/)
- [Developer Contribution Documentation](./docs/developer/README.md)
- [Key Big Bang Concept Overviews](./docs/understanding-bigbang/README.md)
- [User Guides for Big Bang](./docs/guides/README.md)
- [Big Bang Prerequisites](./docs/prerequisites/README.md)
- [Big Bang Example Configurations](https://repo1.dso.mil/groups/platform-one/big-bang/bigbang/docs/assets/configs/example/)
......@@ -18,6 +18,7 @@ Join MatterMost channels to ask questions and communicate with the team. Here is
[Development Environment](./development-environment.md)
## Package Requirements
[Big Bang Package Integration Guide](./package-integration/README.md) and [BBTOC Graduated Requirements](https://repo1.dso.mil/platform-one/bbtoc/-/tree/master/process#graduated-project-requirements)
## Package Development
......@@ -29,6 +30,7 @@ Join MatterMost channels to ask questions and communicate with the team. Here is
[Integrate Package with Big Bang](./package-integration/README.md)
## Package Owner Overview
[Package Owner Requirements & Overview](./package-integration/ownership.md)
## Big Bang Code Through Party Bus Pipeline
......
nav:
- Home: README.md
- Using Big Bang: using-bigbang
- Deployment Scenarios: deployment-scenarios
- Backup and Restore: backup-and-restore
# - Airgap: airgap
# Hiding airgap docs until we stabilize
\ No newline at end of file
- Airgap: airgap
# Hiding airgap docs until we stabilize
# User Guides
[[_TOC_]]
## Preface
The guides included here are not all inclusive of every situation. Please open an issue or provide an MR for any guide improvements or additions.
## Using Big Bang
[Chart Values Guide](./using-bigbang/values-guide.md)
[Default Credentials](./using-bigbang/default-credentials.md)
[Image Pull Policy](./using-bigbang/image-pull-policy.md)
[Pod Usage in Graphana](./using-bigbang/pod-usage-in-grafana.md)
[Migrating Logging from ELK to PLG](./using-bigbang/efk-plg-logging-migration.md)
## Deployment Scenarios
[Quickstart](./deployment-scenarios/quickstart.md)
[Multiple Ingress](./deployment-scenarios/multiple-ingress.md)
[SSO Quickstart](./deployment-scenarios/sso-quickstart.md)
### Airgap Deployments
[Airgap Deployments](./airgap/README.md)
## Backup and Restore
[GitLab Backup and Restore](./backup-and-restore/gitlab-backup-restore.md)
[Nexus Migration with Velero](./backup-and-restore/nexus-migration-with-velero.md)
nav:
- Home: README.md
- Install Flux: install-flux.md
- OS Preconfiguration: os-preconfiguration.md
- Kubernetes Preconfiguration: kubernetes-preconfiguration.md
......
# Prerequisits
[[_TOC_]]
## Hardware Requirements
[Minimum Hardware](./minimum-hardware-requirements.md)
## Software Requirements
[Operating System Preconfiguration](./os-preconfiguration.md)
[Kubernetes Preconfiguration](./kubernetes-preconfiguration.md)
[Flux Installation](./install-flux.md)
[Default Storageclass](./default-storageclass.md)
## Licensing Requirements
[Licensing Model](../understanding-bigbang/licensing-model.md)
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