SONAR-23665 change ingress class name default logic

SonarSource · Nov 20, 2024 · e6e40ff · e6e40ff
1 parent e510db5
commit e6e40ff
Show file tree

Hide file tree

Showing 16 changed files with 3,187 additions and 2 deletions.
diff --git a/charts/sonarqube-dce/CHANGELOG.md b/charts/sonarqube-dce/CHANGELOG.md
@@ -8,6 +8,7 @@ All changes to this chart will be documented in this file.
 * Update the Chart's icon with the SonarQube Server logo
 * Fix ENV variables not fetched when using extraConfig.configmaps
 * Support Gateway on different namespace in HTTPRoute
+* Change `ingress.ingressClassName` default, set it to `nginx` if `nginx.enabled` or `ingress-nginx.enabled`
 
 ## [10.7.0]
 * Update Chart's version to 10.7.0

diff --git a/charts/sonarqube-dce/Chart.yaml b/charts/sonarqube-dce/Chart.yaml
@@ -39,6 +39,8 @@ annotations:
       description: "Fix ENV variables not fetched when using extraConfig.configmaps"
     - kind: added
       description: "Support Gateway on different namespace in HTTPRoute"
+    - kind: changed
+      description: "Change `ingress.ingressClassName` default, set it to `nginx` if `nginx.enabled` or `ingress-nginx.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
@@ -484,7 +484,7 @@ The following table lists the configurable parameters of the SonarQube chart and
 | `ingress.hosts[0].serviceName` | Optional field to override the default serviceName of a path | `None`                                                                                                       |
 | `ingress.hosts[0].servicePort` | Optional field to override the default servicePort of a path | `None`                                                                                                       |
 | `ingress.tls`                  | Ingress secrets for TLS certificates                         | `[]`                                                                                                         |
-| `ingress.ingressClassName`     | Optional field to configure ingress class name               | `None`                                                                                                       |
+| `ingress.ingressClassName`     | Optional field to configure ingress class name               | `None` OR `nginx` if `nginx.enabled` or `ingress-nginx.enabled`                                              |
 | `ingress.annotations`          | Field to add extra annotations to the ingress                | {`nginx.ingress.kubernetes.io/proxy-body-size: "64m"`} if `ingress-nginx.enabled=true or nginx.enabled=true` |
 
 ### InitContainers

diff --git a/charts/sonarqube-dce/templates/ingress.yaml b/charts/sonarqube-dce/templates/ingress.yaml
@@ -25,6 +25,8 @@ metadata:
 spec:
   {{- if .Values.ingress.ingressClassName }}
   ingressClassName: {{ .Values.ingress.ingressClassName }}
+  {{- else if or (.Values.nginx).enabled (index .Values "ingress-nginx" "enabled") }}
+  ingressClassName: "nginx"
   {{- end }}
   rules:
   {{- range .Values.ingress.hosts }}

diff --git a/charts/sonarqube/CHANGELOG.md b/charts/sonarqube/CHANGELOG.md
@@ -11,6 +11,7 @@ All changes to this chart will be documented in this file.
 * Update the Chart's icon with the SonarQube Server logo
 * Set `app.kubernetes.io/name` and `app.kubernetes.io/version` as selector labels
 * Support Gateway on different namespace in HTTPRoute
+* Change `ingress.ingressClassName` default, set it to `nginx` if `nginx.enabled` or `ingress-nginx.enabled`
 
 ## [10.7.0]
 * Update Chart's version to 10.7.0

diff --git a/charts/sonarqube/Chart.yaml b/charts/sonarqube/Chart.yaml
@@ -50,6 +50,8 @@ annotations:
       description: "Set 'app.kubernetes.io/name' and 'app.kubernetes.io/version' as selector labels"
     - kind: added
       description: "Support Gateway on different namespace in HTTPRoute"
+    - kind: changed
+      description: "Change `ingress.ingressClassName` default, set it to `nginx` if `nginx.enabled` or `ingress-nginx.enabled`"
   artifacthub.io/containsSecurityUpdates: "false"
   artifacthub.io/images: |
     - name: sonarqube

diff --git a/charts/sonarqube/README.md b/charts/sonarqube/README.md
@@ -328,7 +328,7 @@ The following table lists the configurable parameters of the SonarQube chart and
 | `ingress.hosts[0].serviceName` | Optional field to override the default serviceName of a path | `None`                                                                                                       |
 | `ingress.hosts[0].servicePort` | Optional field to override the default servicePort of a path | `None`                                                                                                       |
 | `ingress.tls`                  | Ingress secrets for TLS certificates                         | `[]`                                                                                                         |
-| `ingress.ingressClassName`     | Optional field to configure ingress class name               | `None`                                                                                                       |
+| `ingress.ingressClassName`     | Optional field to configure ingress class name               | `None` OR `nginx` if `nginx.enabled` or `ingress-nginx.enabled`                                              |
 | `ingress.annotations`          | Field to add extra annotations to the ingress                | {`nginx.ingress.kubernetes.io/proxy-body-size: "64m"`} if `ingress-nginx.enabled=true or nginx.enabled=true` |
 
 ### HttpRoute

diff --git a/charts/sonarqube/templates/ingress.yaml b/charts/sonarqube/templates/ingress.yaml
@@ -22,6 +22,8 @@ metadata:
 spec:
   {{- if .Values.ingress.ingressClassName }}
   ingressClassName: {{ .Values.ingress.ingressClassName }}
+  {{- else if or (.Values.nginx).enabled (index .Values "ingress-nginx" "enabled") }}
+  ingressClassName: "nginx"
   {{- end }}
   rules:
   {{- range .Values.ingress.hosts }}

diff --git a/tests/unit-compatibility-test/fixtures/sonarqube-dce/ingress-values.yaml b/tests/unit-compatibility-test/fixtures/sonarqube-dce/ingress-values.yaml
@@ -958,6 +958,7 @@ metadata:
     kubernetes.io/tls-acme: "true"
     nginx.ingress.kubernetes.io/proxy-body-size: "8m"
 spec:
+  ingressClassName: user-based
   rules:
   - host: sonarqube.your-org.com
     http: