SONAR-22911 Document the upgrade process when autoscaling is enabled

SonarSource · Sep 5, 2024 · f024fb0 · f024fb0
1 parent 6cb02f7
commit f024fb0
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/charts/sonarqube-dce/CHANGELOG.md b/charts/sonarqube-dce/CHANGELOG.md
@@ -17,6 +17,7 @@ All changes to this chart will be documented in this file.
 * Support the TLS communication between App and Search nodes
 * Support additional CA Certificate as ConfigMap instead of Secret only
 * Changed default value for caCerts.image
+* Document the upgrade process when autoscaling is enabled
 
 ## [10.6.0]
 * Upgrade SonarQube to 10.6.0

diff --git a/charts/sonarqube-dce/Chart.yaml b/charts/sonarqube-dce/Chart.yaml
@@ -59,6 +59,8 @@ annotations:
       description: "Support additional CA Certificate as ConfigMap instead of Secret only"
     - kind: changed
       description: "Changed default value for caCerts.image"
+    - kind: changed
+      description: "Document the upgrade process when autoscaling is enabled"
   artifacthub.io/links: |
     - name: support
       url: https://community.sonarsource.com/

diff --git a/charts/sonarqube-dce/README.md b/charts/sonarqube-dce/README.md
@@ -222,7 +222,7 @@ If you want to make your application publicly visible with Routes, you can set `
 
 ## Autoscaling
 
-The SonarQube applications nodes can be set to automally scale up and down based on their average CPU utilization. This is particularly useful when scanning new projects or evaluating Pull Requests with SonarQube. In order to enable the autoscaling, you can rely on the `ApplicationNodes.hpa` parameters.
+The SonarQube applications nodes can be set to automatically scale up and down based on their average CPU utilization. This is particularly useful when scanning new projects or evaluating Pull Requests with SonarQube. In order to enable the autoscaling, you can rely on the `ApplicationNodes.hpa` parameters.
 
 Please ensure the [Metrics Server](https://github.com/kubernetes-sigs/metrics-server) is installed in your cluster to provide resource usage metrics. You can deploy it using: 
 
@@ -231,6 +231,12 @@ kubectl apply -f https://github.com/kubernetes-sigs/metrics-server/releases/late
 
 ```
 
+### Upgrading the Helm chart
+
+When upgrading your SonarQube instance, due to high CPU usage, it is recommended to disable the autoscaling before the upgrade process, re-enabling it afterwards.
+
+You can achieve that by either setting `ApplicationNodes.hpa.enabled` to `false` or by setting `ApplicationNodes.hpa.maxReplicas` to be the same value as `ApplicationNodes.hpa.minReplicas`.
+
 ## Secure the communication within the cluster
 
 In order to secure the communication between Application and Search nodes, you need to set both `nodeEncryption.enabled` and `searchNodes.searchAuthentication.enabled` to `true`.
@@ -373,7 +379,7 @@ The following table lists the configurable parameters of the SonarQube chart and
 | `ApplicationNodes.plugins.image`                                 | Image for plugins container                                                                                                                                                                                    | `""`                                                                   |
 | `ApplicationNodes.plugins.resources`                             | Resources for plugins container                                                                                                                                                                                | `""`                                                                   |
 | `ApplicationNodes.plugins.netrcCreds`                            | Name of the secret containing .netrc file to use creds when downloading plugins                                                                                                                                | `""`                                                                   |
-| `ApplicationNodes.plugins.noCheckCertificate`                    | Flag to not check server's certificate when downloading plugins                                                                                                                                                | `false                                                                 |
+| `ApplicationNodes.plugins.noCheckCertificate`                    | Flag to not check server's certificate when downloading plugins                                                                                                                                                | `false`                                                                |
 | `ApplicationNodes.plugins.securityContext`                       | Security context for the container to download plugins                                                                                                                                                         | [Restricted podSecurityStandard](#kubernetes---pod-security-standards) |
 | `ApplicationNodes.jvmOpts`                                       | (DEPRECATED) Values to add to `SONAR_WEB_JAVAOPTS`. Please set directly `SONAR_WEB_JAVAOPTS` or `sonar.web.javaOpts`                                                                                           | `""`                                                                   |
 | `ApplicationNodes.jvmCeOpts`                                     | (DEPRECATED) Values to add to `SONAR_CE_JAVAOPTS`. Please set directly `SONAR_CE_JAVAOPTS` or `sonar.ce.javaOpts`                                                                                              | `""`                                                                   |