UNCLASSIFIED - NO CUI

Skip to content
Snippets Groups Projects
Commit 1d54f548 authored by Chris Schaefer's avatar Chris Schaefer Committed by Nigel Bazzeghin
Browse files

add integration docs

parent e76684a6
No related branches found
No related tags found
1 merge request!190add integration docs
......@@ -4,7 +4,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
## [0.66.0-bb.0] - 2024-07-17
## Changed
### Changed
- Upgrade gitlab runner from 17.0.0 to 17.1.0:
- Make lifecycle options configurable in the deployment [upstream !473](https://gitlab.com/gitlab-org/charts/gitlab-runner/-/merge_requests/473)
......@@ -12,7 +12,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
- Updated registry1.dso.mil/ironbank/gitlab/gitlab-runner/gitlab-runner 17.0.0 -> 17.1.0
- Updated registry1.dso.mil/ironbank/gitlab/gitlab-runner/gitlab-runner-helper 17.0.0 -> 17.1.0
## [0.65.0-bb.3] - 2024-07-01
### Fixed
......@@ -23,10 +22,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
## [0.65.0-bb.2] - 2024-06-21
### Fixed
- Removed duplicate istio.hardened entry in chart/values.yaml
## [0.65.0-bb.1] - 2024-06-20
### Fixed
- Updated authorizationPolicy to properly reflect matchLabel selector and port for metrics
## [0.65.0-bb.0] - 2024-05-24
......
# 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-runner (see: [istio templates](./chart/templates/bigbang/istio/), [network policy templates](./chart/templates/bigbang/networkpolicies/), [service entry templates](./chart/templates/bigbang/serviceentries/)), and kyverno (see: [kyverno custom entries](./chart/templates/bigbang/kyverno/).
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
# How to upgrade the Gitlab Runner Package chart
BigBang makes modifications to the upstream helm chart. The full list of changes is at the end of this document.
1. Renovate may have already made changes in the development branch. If that is the case then just verify that the changes are correct as you go through these steps.
......
# 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 gitlab-runner 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
gitlabRunner:
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.
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