SONAR-24842 Add the possibility to save data with hostpath in the Helm Charts

Co-authored-by: jbaz <[email protected]>

Author: davividal

charts/sonarqube-dce/README.md

@@ -43,7 +43,7 @@ helm upgrade --install -n sonarqube-dce sonarqube sonarqube/sonarqube-dce --set
 The above command deploys SonarQube on the Kubernetes cluster in the default configuration in the sonarqube namespace.
 If you are interested in deploying SonarQube on Openshift, please check the [dedicated section](#openshift).
 
-The [configuration](#configuration) section lists the parameters that can be configured during installation. 
+The [configuration](#configuration) section lists the parameters that can be configured during installation.
 
 The default login is admin/admin.
 
@@ -150,7 +150,7 @@ Nonetheless, if you intend to run a production-grade SonarQube please follow the
 
 Prior to SonarQube Server Datacenter 10.8, we used a different naming conventions for `searchNodes` and `ApplicationNodes`. Specifically, we used the [Camel Case](https://en.wikipedia.org/wiki/Camel_case) notation in the former and not in the latter. While this can be viewed as a minor difference, we promote [Clean Code](https://www.sonarsource.com/solutions/clean-code/) at Sonar and this is a clear maintanability (and inconsistency) issue.
 
-Starting from 10.8, we advise users to rename your `ApplicationNodes` to `applicationNodes`. While this is a straightforward change for users, ensuring cross-compability between both usage is challenging (if you are interested in the technical implementation, please take a look at this [PR](https://github.com/SonarSource/helm-chart-sonarqube/pull/586)). 
+Starting from 10.8, we advise users to rename your `ApplicationNodes` to `applicationNodes`. While this is a straightforward change for users, ensuring cross-compability between both usage is challenging (if you are interested in the technical implementation, please take a look at this [PR](https://github.com/SonarSource/helm-chart-sonarqube/pull/586)).
 
 Please report any encountered bugs to https://community.sonarsource.com/.
 
@@ -244,7 +244,7 @@ If you want to make your application publicly visible with Routes, you can set `
 
 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: 
+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:
 
 ```
 kubectl apply -f https://github.com/kubernetes-sigs/metrics-server/releases/latest/download/components.yaml

charts/sonarqube/CHANGELOG.md

@@ -6,6 +6,7 @@ All changes to this chart will be documented in this file.
 * Upgrade SonarQube Community Build to 25.6.0.109173
 * Upgrade nginx subchart to 4.12.2
 * Support Kubernetes v1.32
+* Add the possibility of to save the data with hostpath
 
 ## [2025.3.0]
 * Update Chart's version to 2025.3.0

charts/sonarqube/Chart.yaml

@@ -38,6 +38,8 @@ annotations:
       description: "Upgrade nginx subchart to 4.12.2"
     - kind: changed
       description: "Support Kubernetes v1.33"
+    - kind: changed
+      description: "Add the possibility of to save the data with hostpath"
   artifacthub.io/containsSecurityUpdates: "false"
   artifacthub.io/images: |
     - name: sonarqube-community

charts/sonarqube/README.md

@@ -488,19 +488,32 @@ The following table lists the configurable parameters of the SonarQube chart and
 
 ### Persistence
 
-| Parameter                   | Description                                       | Default         |
-| --------------------------- | ------------------------------------------------- | --------------- |
-| `persistence.enabled`       | Flag for enabling persistent storage              | `false`         |
-| `persistence.annotations`   | Kubernetes pvc annotations                        | `{}`            |
-| `persistence.existingClaim` | Do not create a new PVC but use this one          | `None`          |
-| `persistence.storageClass`  | Storage class to be used                          | `""`            |
-| `persistence.accessMode`    | Volumes access mode to be set                     | `ReadWriteOnce` |
-| `persistence.size`          | Size of the volume                                | `5Gi`           |
-| `persistence.volumes`       | (DEPRECATED) Please use extraVolumes instead      | `[]`            |
-| `persistence.mounts`        | (DEPRECATED) Please use extraVolumeMounts instead | `[]`            |
-| `persistence.uid`           | UID used for init-fs container                    | `1000`          |
-| `persistence.guid`          | GUID used for init-fs container                   | `0`             |
-| `emptyDir`                  | Configuration of resources for `emptyDir`         | `{}`            |
+| Parameter                   | Description                                        | Default         |
+| --------------------------- | -------------------------------------------------- | --------------- |
+| `persistence.enabled`       | Flag for enabling persistent storage               | `false`         |
+| `persistence.annotations`   | Kubernetes pvc annotations                         | `{}`            |
+| `persistence.existingClaim` | Do not create a new PVC but use this one           | `None`          |
+| `persistence.storageClass`  | Storage class to be used                           | `""`            |
+| `persistence.accessMode`    | Volumes access mode to be set                      | `ReadWriteOnce` |
+| `persistence.size`          | Size of the volume                                 | `5Gi`           |
+| `persistence.volumes`       | (DEPRECATED) Please use extraVolumes instead       | `[]`            |
+| `persistence.mounts`        | (DEPRECATED) Please use extraVolumeMounts instead  | `[]`            |
+| `persistence.uid`           | UID used for init-fs container                     | `1000`          |
+| `persistence.guid`          | GUID used for init-fs container                    | `0`             |
+| `emptyDir`                  | Configuration of resources for `emptyDir`          | `{}`            |
+| `persistence.hostPath.path` | Path where the data will be stored with `hostPath` | `""`            |
+| `persistence.hostPath.type` | `hostPath` volume types                            | `""`            |
+
+When using hostPath persistence, ensure that you are aware of the implications
+of using hostPath volumes in Kubernetes, as they can lead to data loss if the
+node is deleted or if the pod is rescheduled to a different node, as well as
+potential security risks if not properly managed. It is generally recommended
+to use a more robust storage solution for production deployments. Please refer
+to the [Kubernetes documentation](https://kubernetes.io/docs/concepts/storage/volumes/#hostpath)
+for more information on hostPath volumes.
+
+In order to use hostPath persistence, you need to enable `persistence.enabled`
+and set `persistence.hostPath.path` and `persistence.hostPath.type`.
 
 ### JDBC Overwrite
 

charts/sonarqube/templates/_pod.tpl

@@ -234,14 +234,14 @@ spec:
       volumeMounts:
         - mountPath: {{ .Values.sonarqubeFolder }}/extensions/jdbc-driver/oracle
           name: sonarqube
-          subPath: extensions/jdbc-driver/oracle 
+          subPath: extensions/jdbc-driver/oracle
         - name: install-oracle-jdbc-driver
           mountPath: /tmp/scripts/
         {{- if .Values.jdbcOverwrite.oracleJdbcDriver.netrcCreds }}
         - name: oracle-jdbc-driver-netrc-file
           mountPath: /root
         {{- end }}
-      {{- if .Values.caCerts.enabled }} 
+      {{- if .Values.caCerts.enabled }}
         - mountPath: /tmp/secrets/ca-certs
           name: ca-certs
       {{- end }}
@@ -471,12 +471,16 @@ spec:
             path: prometheus-ce-config.yaml
     {{- end }}
     - name: sonarqube
-      {{- if .Values.persistence.enabled }}
+      {{- if and .Values.persistence.enabled (not .Values.persistence.hostPath) }}
       persistentVolumeClaim:
         claimName: {{ if .Values.persistence.existingClaim }}{{ .Values.persistence.existingClaim }}{{- else }}{{ include "sonarqube.fullname" . }}{{- end }}
+      {{- else if and .Values.persistence.enabled .Values.persistence.hostPath }}
+      hostPath:
+         path: {{ .Values.persistence.hostPath.path }}
+         type: {{ .Values.persistence.hostPath.type }}
       {{- else }}
       emptyDir: {{- toYaml .Values.emptyDir | nindent 8 }}
-      {{- end  }}
+      {{- end }}
     - name : tmp-dir
       emptyDir: {{- toYaml .Values.emptyDir | nindent 8 }}
       {{- if or .Values.sonarProperties .Values.sonarSecretProperties .Values.sonarSecretKey ( not .Values.elasticsearch.bootstrapChecks) }}

charts/sonarqube/values.yaml

@@ -489,6 +489,13 @@ persistence:
   ## Specify extra mounts. Refer to ".spec.containers.volumeMounts" specification : https://kubernetes.io/fr/docs/concepts/storage/volumes/
   mounts: []
 
+  # In case you want to specify hostPath for to storage into the host.
+  # hostPath:
+  #   # Path where the data will be stored.
+  #   path: /data/sonarqube/
+  #   # Type of volume. Must be one of: DirectoryOrCreate, Directory, FileOrCreate, File, Socket, CharDevice, BlockDevice.
+  #   type: DirectoryOrCreate
+
 # In case you want to specify different resources for emptyDir than {}
 emptyDir: {}
   # Example of resouces that might be used:
@@ -672,7 +679,6 @@ extraConfig:
 #  image:
 #  annotations: {}
 
-
 # (DEPRECATED) please use setAdminPassword instead
 # account:
 # The values can be set to define the current and the (new) custom admin passwords at the startup (the username will remain "admin")