Merge pull request #166 from projectsyn/update-keycloakx-doc

Update the documentation for the name change from keycloak to keycloakx
projectsyn · Oct 6, 2022 · 25a1e47 · 25a1e47
2 parents 14afa51 + 4de3687
commit 25a1e47
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/docs/modules/ROOT/pages/how-tos/pin-versions.adoc b/docs/modules/ROOT/pages/how-tos/pin-versions.adoc
@@ -4,7 +4,7 @@ This tutorial explains how to pin Keycloak to specific version.
 
 == Pin Helm chart version
 
-The Keycloak deployment is mainly generated through https://github.com/codecentric/helm-charts/tree/master/charts/keycloak[codecentric's Keycloak Helm chart].
+The Keycloak deployment is mainly generated through https://github.com/codecentric/helm-charts/tree/master/charts/keycloakx[codecentric's Keycloak Helm chart].
 New versions are released in the https://github.com/codecentric/helm-charts/releases[Releases page].
 
 Normally the component tries to stay up-to-date with the latest Helm chart version.
@@ -15,7 +15,7 @@ If you need to override the chart version, you can pin it in the parameters:
 parameters:
   keycloak:
     charts:
-      keycloak: '<version>'
+      keycloakx: '<version>'
 ----
 
 == Pin container image tag

diff --git a/docs/modules/ROOT/pages/how-tos/restore.adoc b/docs/modules/ROOT/pages/how-tos/restore.adoc
@@ -97,11 +97,11 @@ kubectl -n syn patch apps ${ARGO_APP} --type=json \
 +
 [source,bash]
 ----
-kubectl -n $NAMESPACE patch statefulset keycloak --type=json \
+kubectl -n $NAMESPACE patch statefulset keycloakx --type=json \
   -p '[{"op":"replace", "path":"/spec/replicas", "value": 0}]'
 
 # Wait until statefulset has been scaled down
-kubectl -n $NAMESPACE get statefulset keycloak -w
+kubectl -n $NAMESPACE get statefulset keycloakx -w
 ----
 
 . Load the backup and restore it
@@ -127,7 +127,7 @@ kubectl -n syn patch apps root --type=json \
   }]'
 
 # Wait until Keycloak has started sucessfully
-kubectl -n $NAMESPACE get statefulset keycloak -w
+kubectl -n $NAMESPACE get statefulset keycloakx -w
 ----
 
 [NOTE]

diff --git a/docs/modules/ROOT/pages/references/parameters.adoc b/docs/modules/ROOT/pages/references/parameters.adoc
@@ -723,6 +723,6 @@ type:: dict
 default:: see `defaults.yml`
 
 All helm_values are passed to the helm chart.
-This allows to configure all https://github.com/codecentric/helm-charts/tree/keycloak-18.1.1/charts/keycloak#configuration[keycloak helm chart values].
+This allows to configure all https://github.com/codecentric/helm-charts/tree/keycloakx-1.6.0/charts/keycloak#configuration[keycloak helm chart values].
 
 Note that it's your own liability to make sure you don't break stuff by overwriting values here!