How to upgrade to Prometheus-Operator-CRDs chart📜
The prometheus-operator-crds chart is a Big Bang managed version of the prometheus-operatator-crds upstream chart. The below details the steps required to update to a new version of the prometheus-operator-crds package.
NOTE: This package is slightly different than others as there are no pods or images associated with the chart, it is for CRDs only.
-
Navigate to the upstream chart repo and folder and find the tag that corresponds with the new chart version for this update
-
git clonethe [prometheus-operator-crds] repository](https://repo1.dso.mil/big-bang/product/packages/prometheus-operator-crds) from Repo1 and checkout therenovate/ironbankbranch. -
Update the chart version in
./chart/Chart.yamland append or bump the-bb.0suffix (if missing or incorrect) to the chart version from upstream. -
Ensure the Big Bang
./chart/Chart.yamland the target upstream versionChart.yamlalign correctly with the following:- Check
appVersionandbigbang.dev/applicationVersionsin./chart/Chart.yamlto make sure they match and have updated to the correct version - Check the upstream chart dependencies and compare the dependency versions against the corresponding image tags in
./chart/values.yamlto make sure they match
- Check
-
Update dependencies and binaries using
helm dependency update ./chart. -
Update
CHANGELOG.mdadding an entry for the new version and noting all changes (at minimum should includeUpdated prometheus-operatator-crds from x.x.x to x.x.x). -
Generate the
README.mdupdates by following the guide in gluon. -
Push up your changes, add upgrade notices if applicable, validate that CI passes.
- If there are any failures, follow the information in the pipeline to make the necessary updates.
- Add the
debuglabel to the MR for more detailed information. - Reach out to the CODEOWNERS if needed.
-
(Optional, only required if package changes are expected to have cascading effects on bigbang umbrella chart) As part of your MR that modifies bigbang packages, you should modify the bigbang bigbang/tests/test-values.yaml to target your branch for CI/CD MR testing.
- To do this, at a minimum, you will need to follow the instructions at bigbang/docs/developer/test-package-against-bb.md with changes for prometheus-operatator-crds enabled (Refer to
docs/dev-overrides.yamlfor example)
- To do this, at a minimum, you will need to follow the instructions at bigbang/docs/developer/test-package-against-bb.md with changes for prometheus-operatator-crds enabled (Refer to
-
Complete the manual testing steps in the following section.
-
Once all manual testing is complete, take your MR out of “Draft” status, assign reviewers, and add the review label.
Testing new Prometheus-Operator-CRDs Version📜
Refer to docs/dev-overrides.yaml for YAML values to deploy against Big Bang.
- Ensure all Monitoring Pods are alive and healthy
- Login to Prometheus, validate under
Status->Targetsthat all targets are showing as up as healthy - Login to Alert Manager and validate that alerts are firing (if the main page shows no alert groups check the Prometheus logs and see if there are errors with that connection)