Upgrading to a new version📜
The below details the steps required to update to a new version of the Sonarqube package.
- Do diff of upstream chart between old and new release tags to become aware of any significant chart changes. A graphical diff tool such as Meld is useful. You can see where the current helm chart came from by inspecting
- Create a development branch and merge request from the Gitlab issue.
- Merge/Sync the new helm chart with the existing package code. A graphical diff tool like Meld is useful. Reference the “Modifications made to upstream chart” section below. Be careful not to overwrite Big Bang Package changes that need to be kept. Note that some files will have combinations of changes that you will overwrite and changes that you keep. Stay alert. The hardest file to update is the
chart/Chart.yamlupdate gluon to the latest version and run
helm dependency update chartfrom the top level of the repo to package it up.
- Modify the
chart/values.yamlto point to the newest version.
chart/Chart.yamlto the appropriate versions. The annotation version should match the
version: X.X.X-bb.X appVersion: X.X.X annotations: bigbang.dev/applicationVersions: | - Sonarqube: X.X.X
CHANGELOG.mdadding an entry for the new version and noting all changes.
- Generate the
README.mdupdates by following the guide in gluon.
- Open an MR in “Draft” status and validate that CI passes. This will perform a number of smoke tests against the package, but it is good to manually deploy to test some things that CI doesn’t.
- Once all manual testing is complete take your MR out of “Draft” status and add the review label.
How to test Sonarqube📜
Deploy and login with both admin user and sso.
Test Basic Functionality and Monitoring📜
Deploy with the following Big Bang override values to test the repo job and monitoring interaction:
clusterAuditor: enabled: false gatekeeper: enabled: false istiooperator: enabled: true istio: enabled: true jaeger: enabled: false kiali: enabled: false logging: enabled: false eckoperator: enabled: false fluentbit: enabled: false monitoring: enabled: true twistlock: enabled: false addons: sonarqube: enabled: true git: tag: null branch: "name-of-your-development-branch"
- Navigate to the Prometheus target page (https://prometheus.bigbang.dev/targets) and validate that the Sonarqube target shows as up.
Modifications made to upstream chart📜
This is a high-level list of modifications that Big Bang has made to the upstream helm chart. You can use this as as cross-check to make sure that no modifications were lost during an upgrade process.
add the gluon library archive from
helm dependency update ./chart
commit the tar archives that were downloaded from the helm dependency update command. And also commit the requirements.lock that was generated.
- Bitnami postgres chart for development
- add istio VirtualService
- add ServiceMonitor
- add PeerAuthentication
- add NetworkPolicies
- add templates for helm tests sonarqube-cypress-test.yaml
chart/templates/deployment.yaml & sonarqube-sts.yaml📜
- remove default images
- change waitForDb from using
- modify caCert init container to conditionally use command/args from values
- switched upstream cat/wget plugin install to curl
- re-write job with istio termination
- Added istio.enabled wraper
- Added define “deployment.waitForDb.compatible”
- Added define “sonarqube.chart”
- add cypress tests
- changes for Big Bang version, gluon dependency, and annotations
- add this file during helm dependency update
- add Kptfile
- Big Bang additions at the bottom of the values file
- Replace image with Iron Bank image
- add PullSecret.name = private-registry
- add fips options
- added bbtests values to support cypress/script tests
- drop all’s
- enable serviceaccount creation
- set automountToken to false to maintain security posture