UNCLASSIFIED - NO CUI

Skip to content
Snippets Groups Projects
Commit f2b5f0ec authored by Micah Nagel's avatar Micah Nagel
Browse files

Merge branch '1272-draft-follow-on-follow-on-docs-design-update' into 'master'

Resolve "Follow-on Follow-on Docs Design update"

Closes #1272

See merge request platform-one/big-bang/bigbang!1960
parents dee6b915 4aa69c7b
No related branches found
No related tags found
1 merge request!1960Resolve "Follow-on Follow-on Docs Design update"
Pipeline #933707 passed with warnings
Showing
with 53 additions and 17 deletions
nav:
- Home: README.md
- Packages: packages.md
- Developer: developer
- Guides: guides
- Prerequisites: prerequisites
- Understanding Big Bang: understanding-bigbang
......@@ -8,7 +8,7 @@
1. Defines which DevSecOps Platform packages/helm charts will be deployed
1. Defines what input parameters will be passed through to the chosen helm charts.
* You can see what applications are part of the platform by checking the following resources:
* [../Packages.md](../Packages.md) lists the packages and organizes them in categories.
* [packages.md](./packages.md) lists the packages and organizes them in categories.
* [Release Notes](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/releases) lists the packages and their versions.
* For a code based source of truth, you can check [BigBang's default values.yaml](../chart/values.yaml), and `[CTRL] + [F]` "repo:", to quickly iterate through the list of applications supported by the BigBang team.
......
nav:
- Home: README.md
- AWS Dev Script: aws-k3d-script.md
- CI Workflow: ci-workflow.md
- Package Development: develop-package.md
- Development Environment: development-environment.md
- K8s Storage Options: k8s-storage.md
- Partybus Pipelines: mdo-partybus-pipelines.md
- Release Process: release-process.md
- Testing: testing.md
- Testing Vendor Distros: vendor-distro-integration.md
- Package Integration: package-integration
......@@ -29,7 +29,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/package-integration-ownership.md)
[Package Owner Requirements & Overview](./package-integration/ownership.md)
## Big Bang Code Through Party Bus Pipeline
......
......@@ -83,7 +83,7 @@ This stage is ran on every merge request event, and is a requirement for merging
Ultimately, BigBang is designed to deploy production ready workloads on real infrastructure. While local and ephemeral clusters are excellent for fast feedback during development, changes must ultimately be tested on real clusters on real infrastructure.
As part of BigBang's [charter](https://repo1.dso.mil/platform-one/big-bang/charter), it is expected work on any CNCF conformant kubernetes cluster, on multiple clouds, and on premise environments. By very definition, this means infrastructure testing is _slow_. To strive for a pipeline with a happy medium of providing fast feedback while still exhaustively testing against environments that closely mirror production, __infrastructure testing only occurs on manual actions on merge request commits.__
As part of BigBang's architecture, it is expected work on any CNCF conformant kubernetes cluster, on multiple clouds, and on premise environments. By very definition, this means infrastructure testing is _slow_. To strive for a pipeline with a happy medium of providing fast feedback while still exhaustively testing against environments that closely mirror production, __infrastructure testing only occurs on manual actions on merge request commits.__
This requires adding `test-ci::infra` label to your MR. In addition, infrastructure testing pipeline is run nightly on a schedule.
Note: Due to the amount of resources and time required for this pipeline, the `test-ci::infra` label should be used sparingly. The scheduled nightly run will ideally catch issues if they are already in master. The `test-ci::infra` label should mainly be used when:
......
nav:
- Home: README.md
- Database: database.md
- Documentation: documentation.md
- Flux: flux.md
- Helm Standards: helm-standards.md
- Monitoring: monitoring.md
- Network Policies: network-policies.md
- Ownership: ownership.md
- Pipeline: pipeline.md
- Policy Enforcement: policy-enforcement.md
- Service Mesh: service-mesh.md
- SSO: sso.md
- Object Storage: storage.md
- Supported: supported.md
- Testing: testing.md
- Upstream: upstream.md
# Big Bang Integration: Overview
# Integration: Overview
The following documents should be followed, in order, to fully integrate a new package into Big Bang:
......
# Big Bang Package: Database Integration
# Database Integration
If the package you are integrating connects to a database, you will need to follow the instructions below to integrate this feature into Big Bang.
......
# Big Bang Package: Documentation
# Documentation
Big Bang requires some additional documentation for supported packages to help user's understand how it interacts with other components. The following are documents that should be created or updated for integration into Big Bang:
- Package Architecture: See [Big Bang's Architecture instructions](../../understanding-bigbang/package-architecture/ref-package/Architecture.md). Examples are included in [understanding-bigbang/package-architecture](../../understanding-bigbang/package-architecture).
- [Big Bang Packages](../../../Packages.md)
- Package Architecture: See [Big Bang's Architecture instructions](../../understanding-bigbang/package-architecture/ref-package.md). Examples are included in [understanding-bigbang/package-architecture](../../understanding-bigbang/package-architecture).
- [Big Bang Packages](../../packages.md)
- [Default Credentials](../../guides/using-bigbang/default-credentials.md)
- [Licensing](../../understanding-bigbang/licensing-model.md)
- [Minimum Hardware Requirements](../../prerequisites/minimum-hardware-requirements.md)
# Big Bang Package: Flux Integration
# Flux Integration
Following the steps in this guide will result in the `integration` job being run for Third Party and Sandbox pipelines.
......
# Big Bang Package: Monitoring
# Monitoring
Monitoring packages requires a way to scrape metrics, provide those to data storage, and analyzing the results. Big Bang uses Prometheus and Grafana as the service for monitoring. Most packages offer built-in Prometheus metrics scraping or an add-on that will scrape the metrics. This document will show you how to integrate metrics scraping with Big Bang.
......
# Big Bang Package: Network Policies
# Network Policies
To increase the overall security posture of Big Bang, network policies are put in place to only allow ingress and egress from package namespaces to other needed services. A deny by default policy is put in place to deny all traffic that is not explicitly allowed. The following is how to implement the network policies per Big Bang standards.
......
# Big Bang Package: Pipeline Integration
# Pipeline Integration
Big Bang contains and uses a continuous deployment tool to deploy packages using Helm charts sourced from Git. This document will cover how to integrate a Helm chart from a mission application or other package into the pattern Big Bang requires. Once complete, you will be able to deploy your package with Big Bang.
......
# Big Bang Package: Policy Enforcement
# Policy Enforcement
Big Bang has several policies for Kubernetes resources to ensure best practices and security. For example, images must be pulled from Iron Bank, or containers must be run as non-root. These policies are currently enforced by [OPA Gatekeeper](https://repo1.dso.mil/platform-one/big-bang/apps/core/policy), which gets deployed as the first package in Big Bang.
......
# Big Bang Package: Service Mesh Integration
# Service Mesh Integration
[Istio](https://istio.io/) provides the [service mesh](https://istio.io/latest/about/service-mesh/) for Big Bang. The service mesh assists with secure traffic routing in the cluster. This document will show you how to update your package to support Big Bang's configuration of Istio.
......
# Big Bang Package: Single Sign On (SSO)
# Single Sign On (SSO)
Big Bang has configuration for Single Sign-On (SSO) authentication using an identity provider, like Keycloak. If the package supports SSO, you will need to integrate Big Bang's configuration with the package. If the package does not support SSO, an [authentication service](https://repo1.dso.mil/platform-one/big-bang/apps/core/authservice) can be used to intercept traffic and provide SSO. This document details how to setup your package for either scenario.
......
# Big Bang Package: Object Storage
# Object Storage
If the package you are integrating connects to object storage (e.g. S3 buckets), you will need to follow the instructions below to integrate this feature into Big Bang.
......
# Big Bang Package: Supported Package Integration
# Supported Package Integration
After [graduating your package](https://repo1.dso.mil/platform-one/bbtoc/-/tree/master/process) and getting approval to add it to Big Bang, the following instructions must be completed.
......
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