Merge branch '839-doc-pipeline-integration' into 'master'

Resolve "Document product integration for using package pipeline"

Closes #839

See merge request platform-one/big-bang/bigbang!977

docs/developer/package-integration/package-integration-pipeline.md

@@ -2,11 +2,80 @@
 
 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
+- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+- [Docker CLI](https://docs.docker.com/get-docker/)
+- [Big Bang package project containing your Helm chart](./package-integration-upstream.md)
+   > You will need to have the Container Registry enabled.This can be requested from the Big Bang team.
+
+> Throughout this document, we will be setting up an application called `podinfo` as a demonstration.
+
+## Package Pipeline
+
+Pipelines provide rapid feedback to changes in our Helm chart as we develop and should be put in place as early as possible.  Big Bang has a [generic pipeline](https://repo1.dso.mil/platform-one/big-bang/pipeline-templates/pipeline-templates/-/blob/master/templates/package-tests.yml) that we can reuse for packages.
+
+1. The pipeline **requires** that all images are stored in either Iron Bank (`registry1.dso.mil`) or Repo1 (`registry.dso.mil`).  In some cases, you may be able to substitute images already in Iron Bank for the ones in the Helm chart.  For example, images for `curl`, `kubectl` or `jq` can use `registry1.dso.mil/ironbank/big-bang/base`.  If you have not already submitted your containers to Iron Bank, [start the process](https://repo1.dso.mil/dsop/dccscr/-/blob/master/README.md).  While you are working your way to Iron Bank approval, you can temporarily put the images in `registry.dso.mil` for development by doing the following:
+
+   > Check if the Container Registry is on by navigating to `https://repo1.dso.mil/platform-one/big-bang/apps/sandbox/<your project>/container_registry`.  If you get a 404 error, you need to request a Maintainer turn this feature on in your project via Settings > General > Visibility > Container Registry.
+
+   ```shell
+   # Image Info
+   export IMGSRC_REPO=docker.io
+   export IMGSRC_PROJ=stefanprodan
+   export IMGDST_REPO=registry.dso.mil
+   export IMGDST_PROJ=platform-one/big-bang/apps/sandbox/podinfo
+   export IMGNAME=podinfo
+   export IMGTAG=6.0.0
+
+   # Pull image locally
+   docker pull $IMGSRC_REPO/$IMGSRC_PROJ/$IMGNAME:$IMGTAG
+
+   # Retag image
+   docker tag $IMGSRC_REPO/$IMGSRC_PROJ/$IMGNAME:$IMGTAG $IMGDST_REPO/$IMGDST_PROJ/$IMGNAME:$IMGTAG
+
+   # Login in docker registry
+   docker login $IMGDST_REPO
+
+   # Push to registry
+   docker push $IMGDST_REPO/$IMGDST_PROJ/$IMGNAME:$IMGTAG
+   ```
 
-## Integration
+1. Update `chart/values.yaml` with either the `registry1.dso.mil` or `registry.dso.mil` for images.  For example:
 
-## Validation
+   ```yaml
+   image:
+     repository: registry.dso.mil/platform-one/big-bang/apps/sandbox/podinfo/podinfo
+     tag: 6.0.0
+   ```
+
+1. Add the following to `.gitlab-ci.yml` to call the pipeline.
+
+   ```yaml
+   include:
+     - project: 'platform-one/big-bang/pipeline-templates/pipeline-templates'
+       ref: master
+       file: '/templates/package-tests.yml'
+   ```
+
+1. Add overlay values for testing into `tests/test-values.yaml`.  This will be where you add values needed for running in the pipeline.  For now it can be a blank, placeholder.
+
+1. Commit the changes
+
+   ```shell
+   git add -A
+   git commit -m "feat: package pipeline"
+   git push
+   ```
+
+1. Big Bang requires a Merge Request to run the pipeline.  Open a MR to merge your branch into the main branch.
+
+   > You will need to add `SKIP UPDATE CHECK` and `SKIP UPGRADE` into the title of the first MR or it will fail.  Until you have a baseline Helm chart and CHANGELOG in place, these stages need to be skipped.
+
+1. The pipeline will install the package, run any Helm tests (`chart/tests`), and run any custom tests (`tests`).
+
+1. Troubleshoot and fix any failures from the pipeline.
+
+## Big Bang Pipeline
+
+TBD