Improvements to Keycloak cache handling

Rename environment variables according to the Keycloak documentation and
adjust some values to this.

Signed-off-by: Dominic Hopf <[email protected]>

Author: dmaphy

bitnami/keycloak/Chart.yaml

@@ -34,4 +34,4 @@ maintainers:
 name: keycloak
 sources:
 - https://github.com/bitnami/charts/tree/main/bitnami/keycloak
-version: 24.5.1
+version: 24.5.2

bitnami/keycloak/README.md

@@ -686,12 +686,12 @@ As an alternative, you can use of the preset configurations for pod affinity, po
 
 ### Keycloak Cache parameters
 
-| Name                                     | Description                                                                         | Value        |
-| ---------------------------------------- | ----------------------------------------------------------------------------------- | ------------ |
-| `cache.enabled`                          | Switch to enable or disable the keycloak distributed cache for kubernetes.          | `true`       |
-| `cache.stackName`                        | Set infinispan cache stack to use                                                   | `kubernetes` |
-| `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`      |
+| Name                                     | Description                                                                                                                                             | Value             |
+| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
+| `cache.enabled`                          | Switch to enable or disable the keycloak distributed cache for kubernetes.                                                                              | `true`            |
+| `cache.stack`   `                        | Set infinispan cache stack to use, sets KC_CACHE_STACK (<https://www.keycloak.org/server/all-config?q=cache-stack>)                                     | `kubernetes`      |
+| `cache.configFile`                       | cache.configFile Set infinispan cache stack config filename sets KC_CACHE_CONFIG_FILE (<https://www.keycloak.org/server/all-config?q=cache-config-file>)| `"cache-ispn.xml"`|
+| `cache.useHeadlessServiceWithAppVersion` | Set to true to create the headless service used for ispn containing the app version                                                                     | `false`           |
 
 ### Keycloak Logging parameters
 
@@ -867,4 +867,4 @@ Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.
+limitations under the License.

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

@@ -86,20 +86,20 @@ data:
   KEYCLOAK_SPI_TRUSTSTORE_FILE: {{ printf "/opt/bitnami/keycloak/spi-certs/%s" .Values.spi.truststoreFilename }}
   {{- end }}
   {{- if .Values.cache.enabled }}
-  KEYCLOAK_CACHE_TYPE: "ispn"
-  {{- if .Values.cache.stackName }}
-  KEYCLOAK_CACHE_STACK: {{ .Values.cache.stackName | quote }}
+  KC_CACHE_TYPE: "ispn"
+  {{- if .Values.cache.stack }}
+  KC_CACHE_STACK: {{ .Values.cache.stack | quote }}
   {{- end }}
-  {{- if .Values.cache.stackFile }}
-  KEYCLOAK_CACHE_CONFIG_FILE: {{ .Values.cache.stackFile | quote }}
+  {{- if .Values.cache.configFile }}
+  KC_CACHE_CONFIG_FILE: {{ .Values.cache.configFile | 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"
+  KC_CACHE_TYPE: "local"
   {{- end }}
   {{- if .Values.logging }}
   KEYCLOAK_LOG_OUTPUT: {{ .Values.logging.output | quote }}

bitnami/keycloak/values.yaml

@@ -1372,14 +1372,14 @@ externalDatabase:
 ## ref: https://www.keycloak.org/server/caching
 ## @param cache.enabled Switch to enable or disable the keycloak distributed cache for kubernetes.
 ## 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.stack Set infinispan cache stack to use, sets KC_CACHE_STACK (https://www.keycloak.org/server/all-config?q=cache-stack)
+## @param cache.configFile Set infinispan cache stack config filename sets KC_CACHE_CONFIG_FILE (https://www.keycloak.org/server/all-config?q=cache-config-file)
 ## @param cache.useHeadlessServiceWithAppVersion Set to true to create the headless service used for ispn containing the app version
 ##
 cache:
   enabled: true
-  stackName: kubernetes
-  stackFile: ""
+  stack: kubernetes
+  configFile: "cache-ispn.xml"
   useHeadlessServiceWithAppVersion: false
 ## @section Keycloak Logging parameters