Skip to content

Commit

Permalink
doc: README
Browse files Browse the repository at this point in the history
  • Loading branch information
christianwoehrle committed Oct 3, 2022
1 parent 5dd085c commit 2551036
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,34 @@ the Operator handle the creation of the KeycloakClient in Keycloak.

*Note*: You will need a running Kubernetes cluster to use the Operator

1. Run `make cluster/prepare` # This will apply the necessary Custom Resource Definitions (CRDs) and RBAC rules to the clusters
2. Run `kubectl apply -f deploy/operator.yaml` # This will start the operator in the current namespace
1. Run `make cluster/prepare`

This will apply the necessary Custom Resource Definitions (CRDs) and RBAC rules to the clusters
2. Run `kubectl apply -f deploy/operator.yaml`

This will start the operator in the current namespace

### Install keycloak with a realm

This installs keycloak wih a realm test-realm via the codecentric helm chart

1. Run `make cluster/installKeycloak`

### Creating Keycloak Instance and realm
This installs Keycloak on your cluster.
To access Keycloak run the following command:

`export POD_NAME=$(kubectl get pods --namespace keycloak -l "app.kubernetes.io/name=keycloakx,app.kubernetes.io/instance=keycloak" -o name)

kubectl --namespace keycloak port-forward "$POD_NAME" 8080
`

And access the application via the URL
`http://localhost:8080/auth/`

The credentials are admin/admin


### Creating Keycloak CustomRessources, to let the Operator manage KeycloakClients on the KeycloakInstallation
Once the CRDs and RBAC rules are applied and the operator is running, install the keycloak-cr, the keycloakrealm-cr and the keycloakclient-cr.
The keycloak- and keycloakrealm-crs are only used to reference keycloak and the keycloakrealm.

Expand Down

0 comments on commit 2551036

Please sign in to comment.