UNCLASSIFIED - NO CUI

Skip to content
Snippets Groups Projects
Commit 517988c7 authored by Caitlin Bowman-Clare's avatar Caitlin Bowman-Clare
Browse files

Update docs/understanding-bigbang/README.md, docs/FAQ.md, README.md

parent 28c8a86e
No related branches found
No related tags found
1 merge request!4474Update docs/understanding-bigbang/README.md, docs/FAQ.md, README.md
# Big Bang
Big Bang is a declarative, continuous delivery tool for deploying DoD hardened and approved packages into a Kubernetes cluster.
Big Bang is a declarative, continuous delivery tool for deploying Department of Defense (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/big-bang/bigbang](https://repo1.dso.mil/big-bang/bigbang)
......@@ -8,17 +8,17 @@ Big Bang is a declarative, continuous delivery tool for deploying DoD hardened a
Big Bang's scope is to provide publicly available installation manifests for packages required to adhere to the DoD DevSecOps Reference Architecture and additional useful utilities. Big Bang packages are broken into three categories:
- Core: [Core packages](./docs/understanding-bigbang/package-architecture/README.md##Core) are a group of capabilities required by the DoD DevSecOps Reference Architecture, that are supported directly by the Big Bang development team. The specific capabilities that are considered core currently are Service Mesh, Policy Enforcement, Logging, Monitoring, and Runtime Security.
- **Core:** [Core packages](./docs/understanding-bigbang/package-architecture/README.md##Core) are a group of capabilities required by the DoD DevSecOps Reference Architecture, that are supported directly by the Big Bang development team. The specific capabilities that are considered core currently are Service Mesh, Policy Enforcement, Logging, Monitoring, and Runtime Security.
- Addons: [Addon packages](./docs/understanding-bigbang/package-architecture/README.md##Addons) are any packages/capabilities that the Big Bang development team directly supports that do not fall under the above core definition. These serve to extend the functionality/features of Big Bang.
- **Add-ons:** [Addon packages](./docs/understanding-bigbang/package-architecture/README.md##Addons) are any packages/capabilities that the Big Bang development team directly supports that do not fall under the above core definition. These serve to extend the functionality/features of Big Bang.
- Community: [Community packages](https://repo1.dso.mil/big-bang/product/community) are any packages that are maintained by the broader Big Bang community (users, vendors, etc). These packages could be alternatives to core or addon packages, or even entirely new packages to help extend usage/functionality of Big Bang.
- **Community:** [Community packages](https://repo1.dso.mil/big-bang/product/community) are any packages that are maintained by the broader Big Bang community (e.g., users and/or vendors). These packages could be alternatives to core or add-on packages, or even entirely new packages to help extend usage/functionality of Big Bang.
In order for an installation of Big Bang to be a valid installation/configuration you must install/deploy a core package of each category (for additional details on categories and options see [here](./docs/understanding-bigbang/package-architecture/README.md##Core)).
In order for an installation of Big Bang to be a valid installation/configuration, you must install/deploy a core package of each category. For additional details on categories and options, see [here](./docs/understanding-bigbang/package-architecture/README.md##Core).
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 Kubernetes cluster can be used 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, and/or monitoring are handled via Big Bang. Additional packages (e.g. ArgoCD and 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 in the [Big Bang Docs](./docs/README.md).
......@@ -29,7 +29,7 @@ Additional information can be found in the [Big Bang Docs](./docs/README.md).
## Contributing to Big Bang
There are 3 main ways to contribute to Big Bang:
There are three primary ways to contribute to Big Bang:
- [Contribute to the Big Bang Team's Backlog](https://repo1.dso.mil/big-bang/bigbang/-/issues)
- [Contribute to open-source projects under the Big Bang Technical Oversight Committee (BBTOC)](https://repo1.dso.mil/big-bang/product/bbtoc/-/blob/master/CONTRIBUTING.md)
......@@ -41,7 +41,7 @@ Additional information can be found in the [contributing guide](./CONTRIBUTING.m
## Release Schedule
- Big Bang releases adopt a standardized versioning based on and loosely following the [Semantic Versioning 2.0.0 guidelines](https://semver.org/spec/v2.0.0.html) (major.minor.patch). These releases are not based on a fixed schedule and instead the specifics in the following scheme.
- Big Bang releases adopt a standardized versioning based on and loosely following the [Semantic Versioning 2.0.0 guidelines](https://semver.org/spec/v2.0.0.html) (major.minor.patch). These releases are not based on a fixed schedule and instead, follow the specifics in the following scheme:
### Patch Version
......@@ -62,10 +62,10 @@ Minor version changes should be backwards compatible.
A major version increment indicates a release that has significant changes, which could potentially break compatibility with previous versions. A major change is required when there are changes to the architecture of Big Bang or critical values file keys. For example removing a core package or changing significant values that propagate to all core and add-on packages are considered major version changes. As examples of major version changes:
- Removal or renaming of Big Bang values.yaml top level keys (e.g., istio, git repository values, etc.)
- Removal or renaming of Big Bang values.yaml top level keys (e.g., istio and/or git repository values).
- Change to the structure of chart/templates files or key values.
- Additional integration between core/add-on packages that require change to the charts of all packages.
- Modification of Big Bang GitOps engine (i.e. switching from FluxCD -> ArgoCD)
- Modification of Big Bang GitOps engine (i.e., switching from FluxCD -> ArgoCD).
To see what is on the roadmap or included in a given release you can still review our [project milestones](https://repo1.dso.mil/groups/big-bang/-/milestones)
......@@ -77,7 +77,7 @@ The Big Bang Universe Community Slack workspace is a great place to go to get in
> All Big Bang documentation is also provided at [https://docs-bigbang.dso.mil](https://docs-bigbang.dso.mil) offering a better experience and improved searchability.
The following list are useful starting points in the Big Bang documentation.
Several useful starting points in the Big Bang documentation are listed in the following:
- [Developer Contribution Documentation](./docs/developer/README.md)
- [Key Big Bang Concept Overviews](./docs/understanding-bigbang/README.md)
......
# Frequently Asked Questions
## Costs and licensing fees
## Costs and licensing Fees
> Will a user, government program, or support contract incur any costs, other
than their own labor, for installing and using Big Bang?
......@@ -11,7 +11,7 @@ to use it in your environment.
Our baseline includes multiple software components, with a variety
of open-source and commercial licenses. Details of these components and
their licensing models can be found in
[Big Bang Licensing Model Overview](./understanding-bigbang/licensing-model.md)
[Big Bang Licensing Model Overview.](./understanding-bigbang/licensing-model.md)
In Big Bang 2.0, our default core components will be open source, though paid
alternatives will remain available.
......@@ -35,7 +35,7 @@ Platform One does offer optional hosting and support contracts:
instance of Big Bang, which an application can be hosted on. Party Bus removes the
need for you to operate a cluster entirely.
For more information on services, [contact us](https://p1.dso.mil/contact-us) or email platformone@dso.mil
For more information on services, [contact us](https://p1.dso.mil/contact-us) or email platformone@dso.mil.
> Do we need a government PM to send a formal request to Platform One in order
to get started?
......@@ -54,8 +54,7 @@ TODO: reach out link
> Is Big Bang secure? What about its plugins?
Big Bang is compliant with the
[DevSecOps Reference Architecture](https://dodcio.defense.gov/Portals/0/Documents/Library/DoD%20Enterprise%20DevSecOps%20Reference%20Design%20-%20CNCF%20Kubernetes%20w-DD1910_cleared_20211022.pdf),
and is used at all impact levels and classifications.
[DevSecOps Reference Architecture](https://dodcio.defense.gov/Portals/0/Documents/Library/DoD%20Enterprise%20DevSecOps%20Reference%20Design%20-%20CNCF%20Kubernetes%20w-DD1910_cleared_20211022.pdf), and is used at all impact levels and classifications.
[Iron Bank](https://p1.dso.mil/products/iron-bank) performs automated scans of all image
components used in Big Bang, and patches vulnerabilities as they are found. Big Bang
......@@ -84,7 +83,7 @@ managed Big Bang Platform as a Service (PaaS) solution, or one of the [Big Bang
## Change Control
> How do you manage change control on BB? How can we be notified of changed?
> How do you manage change control on Big Bang? How can we be notified of changed?
Big Bang has a two-week release cadence. You can view our
[release schedule](https://docs-bigbang.dso.mil/latest/#Navigating-our-documentation),
......@@ -96,11 +95,11 @@ for more information.
> Can you provide the latest documentation and briefings?
The most up-to-date information on BigBang can be found on
[Big Bang Docs](https://docs-bigbang.dso.mil/latest/docs)
The most up-to-date information on BigBang can be found on
[Big Bang Docs.](https://docs-bigbang.dso.mil/latest/docs)
An overview of BigBang's architecture, and the packages available, can be found
on the [Big Bang Universe](https://universe.bigbang.dso.mil/)
on the [Big Bang Universe.](https://universe.bigbang.dso.mil/)
It would also be useful to review
[Understanding Big Bang](https://docs-bigbang.dso.mil/latest/docs/understanding-bigbang/?h=understanding+bigbang%2F)
[Understanding Big Bang.](https://docs-bigbang.dso.mil/latest/docs/understanding-bigbang/?h=understanding+bigbang%2F)
......@@ -2,15 +2,15 @@
Start with the [Documentation README](../README.md), which includes the following sections:
* [What is Big Bang](../README.md#what-is-big-bang)
* [What Big Bang is not](../README.md#what-big-bang-isnt)
* [What is Big Bang?](../README.md#what-is-big-bang)
* [What *isn't* Big Bang?](../README.md#what-big-bang-isnt)
* [Benefits of Big Bang](../README.md#benefits-of-using-big-bang)
## Acronyms
* **CSP**: Cloud Service Provider
* **L4 LB**: Layer 4 Load Balancer
* **KMS**: Key Management System / Encryption as a Service (AWS/GCP KMS, Azure Key Vault, HashiCorp Transient Secret Engine)
* **KMS**: Key Management System/Encryption as a Service (AWS/GCP KMS, Azure Key Vault, HashiCorp Transient Secret Engine)
* **PGP**: Pretty Good Privacy (Asymmetric Encryption Key Pair, where public key is used to encrypt, private key used to decrypt)
* **SOPS**: "Secret Operations" CLI tool by Mozilla, leverages KMS or PGP to encrypt secrets in a Git Repo. (Flux and P1's modified ArgoCD can use SOPS to decrypt secrets stored in a Git Repo.)
* **ATO**: Authority to Operate
......
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