SONAR-23712 deprecate sonarqubeFolder

SonarSource · Nov 22, 2024 · b6a5299 · b6a5299
1 parent a24ce5f
commit b6a5299
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 9 deletions.
diff --git a/charts/sonarqube-dce/README.md b/charts/sonarqube-dce/README.md
@@ -528,13 +528,13 @@ The following table lists the configurable parameters of the SonarQube chart and
 
 ### SonarQube Specific
 
-| Parameter                      | Description                                                                             | Default          |
-| ------------------------------ | --------------------------------------------------------------------------------------- | ---------------- |
-| `sonarqubeFolder`              | Directory name of SonarQube                                                             | `/opt/sonarqube` |
-| `monitoringPasscode`           | Value for sonar.web.systemPasscode needed for LivenessProbes (encoded to Base64 format) | `define_it`      |
-| `monitoringPasscodeSecretName` | Name of the secret where to load `monitoringPasscode`                                   | `None`           |
-| `monitoringPasscodeSecretKey`  | Key of an existing secret containing `monitoringPasscode`                               | `None`           |
-| `extraContainers`              | Array of extra containers to run alongside the `sonarqube` container (aka. Sidecars)    | `[]`             |
+| Parameter                      | Description                                                                                                                               | Default          |
+| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
+| `sonarqubeFolder`              | (DEPRECATED) Directory name of SonarQube, Due to 1-1 mapping between helm version and docker version, there is no need for configuration  | `/opt/sonarqube` |
+| `monitoringPasscode`           | Value for sonar.web.systemPasscode needed for LivenessProbes (encoded to Base64 format)                                                   | `define_it`      |
+| `monitoringPasscodeSecretName` | Name of the secret where to load `monitoringPasscode`                                                                                     | `None`           |
+| `monitoringPasscodeSecretKey`  | Key of an existing secret containing `monitoringPasscode`                                                                                 | `None`           |
+| `extraContainers`              | Array of extra containers to run alongside the `sonarqube` container (aka. Sidecars)                                                      | `[]`             |
 
 ### JDBC Overwrite
 

diff --git a/charts/sonarqube-dce/values.schema.json b/charts/sonarqube-dce/values.schema.json
@@ -150,6 +150,12 @@
                 }
             }
         },
+        "sonarqubeFolder":
+        {
+            "type": "string",
+            "deprecated": true,
+            "$comment": "(DEPRECATED) This value will is no longer required and will be droped in future releases"
+        },
         "terminationGracePeriodSeconds": {
             "type": "integer",
             "deprecated": true,

diff --git a/charts/sonarqube-dce/values.yaml b/charts/sonarqube-dce/values.yaml
@@ -769,8 +769,7 @@ postgresql:
 # podLabels:
 #   key: value
 podLabels: {}
-# For compatibility with 8.0 replace by "/opt/sq"
-# For compatibility with 8.2, leave the default.
+# (DEPRECATED) this field will be removed, as it needs to match the SonarQube image folder structure, considering we have one chart version per docker image version this field is not needed anymore.
 sonarqubeFolder: /opt/sonarqube
 
 # Enable/Disable logging in JSON format