[bitnami/keycloak] add option to use dedicated version bound headless service for jgroups discovery (#31271)

* [bitnami/keycloak] add option to include app version in headless service and update JAVA_OPTS_APPEND

fixes #31072

Signed-off-by: Oliver Cremerius <antikalk@users.noreply.github.com>

* Update CHANGELOG.md

Signed-off-by: Bitnami Containers <bitnami-bot@vmware.com>

* Update README.md with readme-generator-for-helm

Signed-off-by: Bitnami Containers <bitnami-bot@vmware.com>

---------

Signed-off-by: Oliver Cremerius <antikalk@users.noreply.github.com>
Signed-off-by: Bitnami Containers <bitnami-bot@vmware.com>
Co-authored-by: Bitnami Containers <bitnami-bot@vmware.com>

bitnami/keycloak/CHANGELOG.md

@@ -1,8 +1,13 @@
 # Changelog
 
-## 24.3.2 (2024-12-20)
+## 24.4.0 (2025-01-09)
 
-* [bitnami/keycloak] Update KEYCLOAK_ADMIN env variables deprecation ([#30636](https://github.com/bitnami/charts/pull/30636))
+* [bitnami/keycloak] add option to use dedicated version bound headless service for jgroups discovery ([#31271](https://github.com/bitnami/charts/pull/31271))
+
+## <small>24.3.2 (2024-12-30)</small>
+
+* [bitnami/*] Fix typo in README (#31052) ([b41a51d](https://github.com/bitnami/charts/commit/b41a51d1bd04841fc108b78d3b8357a5292771c8)), closes [#31052](https://github.com/bitnami/charts/issues/31052)
+* [bitnami/keycloak] Update KEYCLOAK_ADMIN env variables deprecation (#30636) ([668bd27](https://github.com/bitnami/charts/commit/668bd2772c5ea45af7b1b57141c1776ccf4169f4)), closes [#30636](https://github.com/bitnami/charts/issues/30636)
 
 ## <small>24.3.1 (2024-12-16)</small>
 

bitnami/keycloak/Chart.yaml

@@ -33,4 +33,4 @@ maintainers:
 name: keycloak
 sources:
 - https://github.com/bitnami/charts/tree/main/bitnami/keycloak
-version: 24.3.2
+version: 24.4.0

bitnami/keycloak/README.md

@@ -685,11 +685,12 @@ As an alternative, you can use of the preset configurations for pod affinity, po
 
 ### Keycloak Cache parameters
 
-| Name              | Description                                                                | Value        |
+| Name                                     | Description                                                                         | Value        |
-| ----------------- | -------------------------------------------------------------------------- | ------------ |
+| ---------------------------------------- | ----------------------------------------------------------------------------------- | ------------ |
-| `cache.enabled`   | Switch to enable or disable the keycloak distributed cache for kubernetes. | `true`       |
+| `cache.enabled`                          | Switch to enable or disable the keycloak distributed cache for kubernetes.          | `true`       |
-| `cache.stackName` | Set infinispan cache stack to use                                          | `kubernetes` |
+| `cache.stackName`                        | Set infinispan cache stack to use                                                   | `kubernetes` |
-| `cache.stackFile` | Set infinispan cache stack filename to use                                 | `""`         |
+| `cache.stackFile`                        | Set infinispan cache stack filename to use                                          | `""`         |
+| `cache.useHeadlessServiceWithAppVersion` | Set to true to create the headless service used for ispn containing the app version | `false`      |
 
 ### Keycloak Logging parameters
 

bitnami/keycloak/templates/configmap-env-vars.yaml

@@ -95,7 +95,11 @@ data:
   {{- if .Values.cache.stackFile }}
   KEYCLOAK_CACHE_CONFIG_FILE: {{ .Values.cache.stackFile | quote }}
   {{- end }}
+  {{- if .Values.cache.useHeadlessServiceWithAppVersion }}
+  JAVA_OPTS_APPEND: {{ printf "-Djgroups.dns.query=%s-headless-ispn-%s.%s.svc.%s" (include "common.names.fullname" .) (replace "." "-" .Chart.AppVersion) (include "common.names.namespace" .) .Values.clusterDomain | quote }}
+  {{- else }}
   JAVA_OPTS_APPEND: {{ printf "-Djgroups.dns.query=%s-headless.%s.svc.%s" (include "common.names.fullname" .) (include "common.names.namespace" .) .Values.clusterDomain | quote }}
+  {{- end }}
   {{- else }}
   KEYCLOAK_CACHE_TYPE: "local"
   {{- end }}

bitnami/keycloak/templates/headless-service-ispn.yaml

@@ -0,0 +1,43 @@
+{{- /*
+Copyright Broadcom, Inc. All Rights Reserved.
+SPDX-License-Identifier: APACHE-2.0
+*/}}
+
+{{- if and .Values.cache.enabled .Values.cache.useHeadlessServiceWithAppVersion }}
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ printf "%s-headless-ispn-%s" (include "common.names.fullname" .) (replace "." "-" .Chart.AppVersion) | trunc 63 | trimSuffix "-" }}
+  namespace: {{ include "common.names.namespace" . | quote }}
+  labels: {{- include "common.labels.standard" ( dict "customLabels" .Values.commonLabels "context" $ ) | nindent 4 }}
+    app.kubernetes.io/component: keycloak
+  {{- if or .Values.commonAnnotations .Values.service.headless.annotations }}
+  {{- $annotations := include "common.tplvalues.merge" ( dict "values" ( list .Values.service.headless.annotations .Values.commonAnnotations ) "context" . ) }}
+  annotations: {{- include "common.tplvalues.render" ( dict "value" $annotations "context" $) | nindent 4 }}
+  {{- end }}
+spec:
+  type: ClusterIP
+  clusterIP: None
+  ports:
+    - name: http
+      port: {{ .Values.containerPorts.http }}
+      protocol: TCP
+      targetPort: http
+    {{- if .Values.tls.enabled }}
+    - name: https
+      port: {{ .Values.containerPorts.https }}
+      protocol: TCP
+      targetPort: https
+    {{- end }}
+    {{- if .Values.service.extraHeadlessPorts }}
+    {{- include "common.tplvalues.render" (dict "value" .Values.service.extraHeadlessPorts "context" $) | nindent 4 }}
+    {{- end }}
+    {{- if .Values.service.headless.extraPorts }}
+    {{- include "common.tplvalues.render" (dict "value" .Values.service.headless.extraPorts "context" $) | nindent 4 }}
+    {{- end }}
+  publishNotReadyAddresses: true
+  {{- $podLabels := include "common.tplvalues.merge" ( dict "values" ( list .Values.podLabels .Values.commonLabels ) "context" . ) }}
+  selector: {{- include "common.labels.matchLabels" ( dict "customLabels" $podLabels "context" $ ) | nindent 4 }}
+    app.kubernetes.io/component: keycloak
+    app.kubernetes.io/app-version: {{ .Chart.AppVersion }}
+{{- end }}

bitnami/keycloak/templates/statefulset.yaml

@@ -44,6 +44,7 @@ spec:
         {{- end }}
       labels: {{- include "common.labels.standard" ( dict "customLabels" $podLabels "context" $ ) | nindent 8 }}
         app.kubernetes.io/component: keycloak
+        app.kubernetes.io/app-version: {{ .Chart.AppVersion }}
     spec:
       serviceAccountName: {{ template "keycloak.serviceAccountName" . }}
       {{- include "keycloak.imagePullSecrets" . | nindent 6 }}

bitnami/keycloak/values.yaml

@@ -1371,11 +1371,13 @@ externalDatabase:
 ## NOTE: Set to false to use 'local' cache (only supported when replicaCount=1).
 ## @param cache.stackName Set infinispan cache stack to use
 ## @param cache.stackFile Set infinispan cache stack filename to use
+## @param cache.useHeadlessServiceWithAppVersion Set to true to create the headless service used for ispn containing the app version
 ##
 cache:
   enabled: true
   stackName: kubernetes
   stackFile: ""
+  useHeadlessServiceWithAppVersion: false
 ## @section Keycloak Logging parameters
 
 ## Keycloak logging configuration