Skip to content

Commit

Permalink
Update the documentation for the name change from keycloak to keycloakx
Browse files Browse the repository at this point in the history
  • Loading branch information
Gabriel Mainberger committed Oct 5, 2022
1 parent f97fc05 commit 4de3687
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/how-tos/pin-versions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/ROOT/pages/how-tos/restore.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/references/parameters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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!

0 comments on commit 4de3687

Please sign in to comment.