add preliminary doc section for integration testing

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [8.1.2-bb.2] (2024-07-18)
+
+### Added
+
+- Added information about testing on bigbang for certain integration changes
+
 ## [8.1.2-bb.1] (2024-07-15)
 
 ### Changed

README.md

 # gitlab
 
-![Version: 8.1.2-bb.1](https://img.shields.io/badge/Version-8.1.2--bb.1-informational?style=flat-square) ![AppVersion: 17.1.2](https://img.shields.io/badge/AppVersion-17.1.2-informational?style=flat-square)
+![Version: 8.1.2-bb.2](https://img.shields.io/badge/Version-8.1.2--bb.2-informational?style=flat-square) ![AppVersion: 17.1.2](https://img.shields.io/badge/AppVersion-17.1.2-informational?style=flat-square)
 
 GitLab is the most comprehensive AI-powered DevSecOps Platform.
 

chart/Chart.yaml

 ---
 apiVersion: v1
 name: gitlab
-version: 8.1.2-bb.1
+version: 8.1.2-bb.2
 appVersion: 17.1.2
 description: GitLab is the most comprehensive AI-powered DevSecOps Platform.
 keywords:

docs/DEVELOPMENT_MAINTENANCE.md

+# Files that require bigbang integration testing
+
+### See [bb MR testing](./docs/test-package-against-bb.md) for details regarding testing changes against bigbang umbrella chart.
+
+There are certain integrations within the bigbang ecosystem and this package that require additional testing outside of the specific package tests ran during CI.  This is a requirement when files within those integrations are changed, as to avoid causing breaks up through the bigbang umbrella.  Currently, these include changes to the istio implementation within gitlab (see: [istio templates](./chart/templates/bigbang/istio/), [network policy templates](./chart/templates/bigbang/networkpolicies/), [service entry templates](./chart/templates/bigbang/serviceentries/)).
+
+Be sure to also test against monitoring locally as it is integrated by default with these high-impact service control packages, and needs to be validated using the necessary chart values beneath `istio.hardened` block with `monitoring.enabled` set to true as part of your [dev-overrides.yaml](./docs/dev-overrides.yaml).
+
 # Notice about updating postgres via renovate
-  Currently, we do not update postgresql via renovate bot unless the [upstream gitlab documentation](https://docs.gitlab.com/ee/install/requirements.html#postgresql-requirements) updates beyond our current supported version of postgres. Due to local in-place image upgrades not working because of limitations around the data directory being initialized by a previous major postgresql version, this requires a manual `pg_dump` from current & `pg_restore` to new updated postgres pod locally (RDS and other non docker DBs will do this automatically). We try to keep all local in-cluster/CI DBs on the same version and upgrade once all are recommended and tested to be on the next major version.
+Currently, we do not update postgresql via renovate bot unless the [upstream gitlab documentation](https://docs.gitlab.com/ee/install/requirements.html#postgresql-requirements) updates beyond our current supported version of postgres. Due to local in-place image upgrades not working because of limitations around the data directory being initialized by a previous major postgresql version, this requires a manual `pg_dump` from current & `pg_restore` to new updated postgres pod locally (RDS and other non docker DBs will do this automatically). We try to keep all local in-cluster/CI DBs on the same version and upgrade once all are recommended and tested to be on the next major version.
 
 # How to upgrade the Gitlab Package chart
 BigBang makes modifications to the upstream helm chart. The full list of changes is at the end of  this document.

docs/test-package-against-bb.md

+# Testing your Package Branch against Bigbang before Package Merge
+
+These instructions right now are written for istio changes, but the same is probably true for kyverno and possibly for others. CODEOWNERS reviewing Merge Requests (MRs) should enforce this.
+
+## Run Bigbang Tests Against your Branch
+
+As part of your MR that modifies istio you will need to run bigbang tests against your branch. To do this, at a minimum, you will need to complete the following:
+
+1. Create a new branch on bigbang off of master `git checkout master && git pull && git checkout -b my-bigbang-branch-for-testing.`
+1. Modify the [test values](https://repo1.dso.mil/big-bang/bigbang/-/blob/master/tests/test-values.yaml?ref_type=heads). Yours will be different for your package, you may need more than this.
+    ```yaml
+    gitlab:
+      git:
+        tag: null
+        branch: my-package-branch-that-needs-testing
+      values:
+        istio:
+          hardened:
+            enabled: true
+    ```
+1. Stage your changes `git add -A.`
+1. Commit your changes `git commit -m "prepping for test."`
+1. Push your changes `git push -u origin my-bigbang-branch-for-testing.`
+1. Create the bigbang MR as a draft with `TEST ONLY DO NOT MERGE` in the title, and add the label of the package to test (e.g., `monitoring`).
+1. Wait for tests to finish, and do fixes on your package branch as needed until they pass.
+1. Close the bigbang MR by deleting the bigbang branch `git push -d origin my-bigbang-branch-for-testing.`
+1. Link the bigbang MR on your package MR as evidence of your package working in bigbang.