Skip to content

Commit

Permalink
SONAR-18974 address reviewer comments
Browse files Browse the repository at this point in the history
  • Loading branch information
jCOTINEAU committed Nov 21, 2024
1 parent 44bab2c commit 989f04a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
10 changes: 10 additions & 0 deletions charts/sonarqube-dce/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,16 @@ Nonetheless, if you intend to run a production-grade SonarQube please follow the
* Set `initSysctl.enabled` to **false**. This parameter would run **root** `sysctl` commands, while those sysctl-related values should be set by the Kubernetes administrator at the node level (see [here](#elasticsearch-prerequisites))
* Set `initFs.enabled` to **false**. This parameter would run **root** `chown` commands. The parameter exists to fix non-posix, CSI, or deprecated drivers.

### Renaming major values

Before SonarQube Server Datacenter 10.8, we had a difference in naming convention between `.Values.searchNodes` and `.Values.ApplicationNodes`, one is pure camelCase, the other has a starting Capital. While a minor difference, we promote cleanCode at Sonar and this is a clear maintanability inconsistency issue.

For user starting from 10.8 we advise everyone to rename your `ApplicationNodes` to `applicationNodes`.

While this is a straightforward change for users, the internal logic for being cross-compatible without rewriting all files is pretty difficult. Hence please report any bug to https://community.sonarsource.com/

PS: if you are interested in the technical details please take a look at this [PR](https://github.com/SonarSource/helm-chart-sonarqube/pull/586)

#### Cpu and memory settings

Monitoring cpu and memory is an important part of software reliability. The SonarQube helm chart comes with default values for cpu and memory requests and limits. Those memory values are matching the default SonarQube JVM Xmx and Xms values.
Expand Down
7 changes: 4 additions & 3 deletions charts/sonarqube-dce/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@ WARNING:
Please visit https://docs.openshift.com/container-platform/4.14/openshift_images/create-images.html#use-uid_create-images for more information.
{{ if .Values.postgresql.enabled }}
WARNING: The embedded PostgreSQL is intended for evaluation only, it is DEPRECATED, and it will be REMOVED in a future release.
Please visit https://artifacthub.io/packages/helm/sonarqube/sonarqube#production-use-case for more information.
Please visit https://artifacthub.io/packages/helm/sonarqube/sonarqube-dce#production-use-case for more information.
{{- end }}
{{ if or (.Values.nginx).enabled (index .Values "ingress-nginx" "enabled") }}
WARNING: The ingress nginx controller dependency has been upgraded to a major version (4.x), please carefully read the changelogs at https://github.com/kubernetes/ingress-nginx/releases and refer to the documentation at https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/.
Please also visit https://artifacthub.io/packages/helm/sonarqube/sonarqube#production-use-case for more information.
{{- end }}
Please also visit https://artifacthub.io/packages/helm/sonarqube/sonarqube-dce#production-use-case for more information.
{{- end }}
WARNING: If your value file contains values under .Values.ApplicationNodes, this key is DEPRECATED. Please make sure to read the renaming guide https://artifacthub.io/packages/helm/sonarqube/sonarqube#renaming-major-values

0 comments on commit 989f04a

Please sign in to comment.