Documentation for using AWS JDBC Wrapper (#721)

Signed-off-by: Michal Hajas <mhajas@redhat.com>
keycloak · Feb 26, 2024 · 3304cc3 · 3304cc3
1 parent 721a9bd
commit 3304cc3
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 11 deletions.
diff --git a/doc/kubernetes/collector/build.sh b/doc/kubernetes/collector/build.sh
@@ -12,6 +12,9 @@ mkdir -p ${BUILDDIR}/helm
 # Those value match the Keycloak on ROSA Benchmark Key Results example
 helm template --debug ${STARTDIR}/../../../provision/minikube/keycloak \
   --set hostname=minikube.nip.io \
+  --set keycloakHostname=\<KEYCLOAK_URL_HERE\> \
+  --set dbUrl=\<AWS_AURORA_URL_HERE\> \
+  --set keycloakImage=\<KEYCLOAK_IMAGE_HERE\> \
   --set jvmDebug=false \
   --set cryostat=false \
   --set instances=3 \
@@ -31,6 +34,9 @@ helm template --debug ${STARTDIR}/../../../provision/minikube/keycloak \
 # Those value match the Keycloak on ROSA Benchmark Key Results example
 helm template --debug ${STARTDIR}/../../../provision/minikube/keycloak \
   --set hostname=minikube.nip.io \
+  --set keycloakHostname=\<KEYCLOAK_URL_HERE\> \
+  --set dbUrl=\<AWS_AURORA_URL_HERE\> \
+  --set keycloakImage=\<KEYCLOAK_IMAGE_HERE\> \
   --set jvmDebug=false \
   --set cryostat=false \
   --set heapInitMB=64 \

diff --git a/provision/keycloak-tasks/Utils.yaml b/provision/keycloak-tasks/Utils.yaml
@@ -212,6 +212,7 @@ tasks:
         --set dbPoolMaxSize={{.KC_DB_POOL_MAX_SIZE}}
         --set dbUrl={{ .KC_DATABASE_URL }}
         --set database={{.KC_DATABASE}}
+        --set useAWSJDBCWrapper={{.KC_USE_AWS_JDBC_WRAPPER}}
         --set keycloakImage={{.CURRENT_KC_CONTAINER_IMAGE}}
         --set instances={{ .KC_INSTANCES }}
         --set cpuRequests={{ .KC_CPU_REQUESTS }}

diff --git a/provision/minikube/keycloak/templates/keycloak.yaml b/provision/minikube/keycloak/templates/keycloak.yaml
@@ -51,12 +51,12 @@ spec:
       haproxy.router.openshift.io/disable_cookies: 'true'
 {{end}}
 {{ if .Values.keycloakImage }}
-  image: {{ .Values.keycloakImage }}
-  startOptimized: {{ .Values.startOptimized }}
+  image: {{ .Values.keycloakImage }} # <2>
+  startOptimized: {{ .Values.startOptimized }} # <2>
 {{ end }}
   features:
     enabled:
-      - multi-site # <2>
+      - multi-site # <3>
 {{- if .Values.infinispan.customConfig }}
   # tag::keycloak-ispn[]
   cache:
@@ -65,14 +65,14 @@ spec:
         key: {{ base .Values.infinispan.configFile }} # <1>
   # end::keycloak-ispn[]
 {{- end }}
-{{ if .Values.useAWSJDBCWrapper }}
+{{- if .Values.useAWSJDBCWrapper }}
   transaction:
-    xaEnabled: false
+    xaEnabled: false # <4>
 {{ end }}
   # tag::keycloak-ispn[]
   additionalOptions:
   # end::keycloak-ispn[]
-{{ if or (eq .Values.database "infinispan") (eq .Values.database "postgres+infinispan") }}
+{{- if or (eq .Values.database "infinispan") (eq .Values.database "postgres+infinispan") }}
     - name: storage-hotrod-host
       value: infinispan
     - name: storage-hotrod-port
@@ -98,9 +98,9 @@ spec:
     # end::keycloak-queue-size[]
     - name: log-console-output
       value: json
-    - name: metrics-enabled # <3>
+    - name: metrics-enabled # <5>
       value: 'true'
-    - name: http-pool-max-threads # <4>
+    - name: http-pool-max-threads # <6>
       value: {{ div 200 .Values.instances | quote }}
 {{- if .Values.infinispan.remoteStore.enabled }}
     # tag::keycloak-ispn[]
@@ -116,10 +116,10 @@ spec:
       secret:
         name: remote-store-secret
         key: password
-{{- if .Values.infinispan.site }}
+    {{- if .Values.infinispan.site }}
     - name: spi-connections-infinispan-quarkus-site-name # <4>
       value: {{ .Values.infinispan.site }}
-{{- end }}
+    {{ end }}
     # end::keycloak-ispn[]
 {{- end }}
 {{- if .Values.infinispan.jgroupsTls }}

diff --git a/provision/minikube/keycloak/values.yaml b/provision/minikube/keycloak/values.yaml
@@ -18,7 +18,7 @@ dbPoolInitialSize: 15
 dbPoolMaxSize: 15
 dbPoolMinSize: 15
 dbUrl: ''
-useAWSJDBCWrapper: true
+useAWSJDBCWrapper: false
 storage: ''
 database: postgres
 disableCaches: false