diff --git a/docs/developer/package-integration-database.md b/docs/developer/package-integration-database.md new file mode 100644 index 0000000000000000000000000000000000000000..56ca87c9b0a688434864bc69b0193857e4c1ba3a --- /dev/null +++ b/docs/developer/package-integration-database.md @@ -0,0 +1,11 @@ +# Big Bang Package: Database Integration + +If the package you are integrating connects to a database or cache server, you will need to follow the instructions below to integrate this feature into Big Bang + +## Prerequisites + +TBD + +## Integration + +## Validation diff --git a/docs/developer/package-integration-documentation.md b/docs/developer/package-integration-documentation.md new file mode 100644 index 0000000000000000000000000000000000000000..4ddd0b99c712e480274eac437ca2f493c883d794 --- /dev/null +++ b/docs/developer/package-integration-documentation.md @@ -0,0 +1,5 @@ +# Big Bang Package: 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: + +- TBD diff --git a/docs/developer/package-integration-flux.md b/docs/developer/package-integration-flux.md new file mode 100644 index 0000000000000000000000000000000000000000..c472c63417833486b1cf419ae1f0ad9a2bab32e8 --- /dev/null +++ b/docs/developer/package-integration-flux.md @@ -0,0 +1,11 @@ +# Big Bang Package: Flux Integration + +Big Bang uses a continuous deployment tool, [Flux](https://fluxcd.io/) to deploy packages using Helm charts sourced from Git ([GitOps](https://www.weave.works/technologies/gitops/)). This document will cover how to integrate a Helm chart, from a mission application or other package, into the Flux pattern required by Big Bang. Once complete, you will be able to deploy your package with Big Bang. + +## Prerequisites + +TBD + +## Integration + +## Validation diff --git a/docs/developer/package-integration-monitoring.md b/docs/developer/package-integration-monitoring.md new file mode 100644 index 0000000000000000000000000000000000000000..efe0a7150ec6ad0d112c851712051cb01d65e048 --- /dev/null +++ b/docs/developer/package-integration-monitoring.md @@ -0,0 +1,11 @@ +# Big Bang Package: 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. + +## Prerequisites + +TBD + +## Integration + +## Validation diff --git a/docs/developer/package-integration-network-policies.md b/docs/developer/package-integration-network-policies.md new file mode 100644 index 0000000000000000000000000000000000000000..8a35875eb7c1e9c0e6676053e5e05077558adac1 --- /dev/null +++ b/docs/developer/package-integration-network-policies.md @@ -0,0 +1,11 @@ +# Big Bang Package: Network Policies + +To help harden the 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. + +## Prerequisites + +TBD + +## Integration + +## Validation diff --git a/docs/developer/package-integration-overview.md b/docs/developer/package-integration-overview.md new file mode 100644 index 0000000000000000000000000000000000000000..3d501b4fbbee1e95b4074b3da2aaa6b4347ddd8b --- /dev/null +++ b/docs/developer/package-integration-overview.md @@ -0,0 +1,17 @@ +# Big Bang Integration: Overview + +The following documents should be followed, in order, to fully integrate a new package into Big Bang: + +1. [Upstream Helm Chart](./package-integration-upstream.md): Initialize package workspace using an upstream Helm chart +1. [CICD Pipeline](./package-integration-pipeline.md): Establish a baseline package pipeline for testing changes +1. [Flux Helm Chart](./package-integration-flux.md): Create Flux compatible GitOps Helm chart required by Big Bang +1. [Service mesh](./package-integration-service-mesh.md): Integrate with service mesh for ingress/egress +1. [Monitoring](./package-integration-monitoring.md): Enable metrics scraping on product +1. [Database](./package-integration-database.md): If required, add internal and external database support using Big Bang values +1. [Object Storage](./package-integration-storage.md): If required, add internal or external object storage support using Big Bang values +1. [Single-sign On](./package-integration-sso.md): If available, add single-sign on (SSO) through internal or external identify provider. +1. [Additional Tests](./package-integration-testing.md): Add testing to validate basic functionality +1. [Network Policies](./package-integration-network-policies.md): Add ingress/egress policies to restrict network traffic for security +1. [Policy Enforcement](./package-integration-policy-enforcement.md): Update package to comply with default security and governance policies in Big Bang +1. [Supported Package](./package-integration-supported.md): Migrate package into the Big Bang repo as a supported package +1. [Final Documentation](./package-integration-documentation.md): Add additional Big Bang documentation for final release diff --git a/docs/developer/package-integration-pipeline.md b/docs/developer/package-integration-pipeline.md new file mode 100644 index 0000000000000000000000000000000000000000..dec758c43438edb48529ca1eefb134d810d1805f --- /dev/null +++ b/docs/developer/package-integration-pipeline.md @@ -0,0 +1,12 @@ +# Big Bang Package: Pipeline Integration + +Big Bang contains a 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. + + +## Prerequisites + +TBD + +## Integration + +## Validation diff --git a/docs/developer/package-integration-policy-enforcement.md b/docs/developer/package-integration-policy-enforcement.md new file mode 100644 index 0000000000000000000000000000000000000000..2ea0643ced9634a76cf3c70ec8cfe6ccf9b5bf59 --- /dev/null +++ b/docs/developer/package-integration-policy-enforcement.md @@ -0,0 +1,13 @@ +# Big Bang Package: 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. + +When integrating your package, you must adhere to the policies that are enforced or your resources will be denied by the Kubernetes admission controller. The following is how to identify and fix policy violations. + +## Prerequisites + +TBD + +## Integration + +## Validation diff --git a/docs/developer/package-integration-service-mesh.md b/docs/developer/package-integration-service-mesh.md new file mode 100644 index 0000000000000000000000000000000000000000..a70e8bf37ea0812bc25e0de79e7a6e99895803db --- /dev/null +++ b/docs/developer/package-integration-service-mesh.md @@ -0,0 +1,12 @@ + +# Big Bang Package: 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. + +## Prerequisites + +TBD + +## Integration + +## Validation diff --git a/docs/developer/package-integration-sso.md b/docs/developer/package-integration-sso.md new file mode 100644 index 0000000000000000000000000000000000000000..be5275f280a232c378f08b71bbad3ac580be9b26 --- /dev/null +++ b/docs/developer/package-integration-sso.md @@ -0,0 +1,11 @@ +# Big Bang Package: 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. + +## Prerequisites + +TBD + +## Integration + +## Validation diff --git a/docs/developer/package-integration-storage.md b/docs/developer/package-integration-storage.md new file mode 100644 index 0000000000000000000000000000000000000000..4c878a87ec21be6fc8ac576fa2a94839e760eace --- /dev/null +++ b/docs/developer/package-integration-storage.md @@ -0,0 +1,11 @@ +# Big Bang Package: Object Storage + +If your package supports using object storage (e.g. S3 buckets), it must be integrated with Big Bang's storage configuration. This document will detail how to do this. + +## Prerequisites + +TBD + +## Integration + +## Validation diff --git a/docs/developer/package-integration.md b/docs/developer/package-integration-supported.md similarity index 100% rename from docs/developer/package-integration.md rename to docs/developer/package-integration-supported.md diff --git a/docs/developer/package-integration-testing.md b/docs/developer/package-integration-testing.md new file mode 100644 index 0000000000000000000000000000000000000000..9dfc3b5c1d5e10f30e9f415768952c66cde55d80 --- /dev/null +++ b/docs/developer/package-integration-testing.md @@ -0,0 +1,18 @@ +# Big Bang Package: Testing + +Usually, Helm charts come with a set of Helm tests that can be run to test the deployment of the application. Big Bang requires some additional tests to verify integration is working as expected. By adding additional tests, the goal is to verify that the package is functioning. For example, we may want to validate that + +- The HTTPS endpoint can be reached +- The admin user can login using the configured (or randomized) password +- A non-admin user can be created and can login +- Data can be stored and retrieved from the database +- Artifacts can be stored and retrieved from the object storage +- Interactions with other services/packages works + +## Prerequisites + +TBD + +## Integration + +## Validation diff --git a/docs/developer/package-integration-upstream.md b/docs/developer/package-integration-upstream.md new file mode 100644 index 0000000000000000000000000000000000000000..7ece5d4560e31a2ffd6502cf9abb3f2031ff2fc7 --- /dev/null +++ b/docs/developer/package-integration-upstream.md @@ -0,0 +1,11 @@ +# Big Bang Package: Upstream Integration + +Before beginning the process of integrating a package into Big Bang, you will need to create a workspace and create or sync the package's Helm chart. This document shows you how to setup the workspace and sync the upstream Helm chart. + +## Prerequisites + +TBD + +## Integration + +## Validation