Skip to content

Commit

Permalink
Update rhsso README
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuacanter committed Dec 6, 2024
1 parent 5c2cabf commit 683b370
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 13 deletions.
2 changes: 2 additions & 0 deletions .wordlist-txt
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@ auth
authorino
autocompletion
aws
backend
backticks
baseUrls
buildah
Expand Down Expand Up @@ -244,6 +245,7 @@ js
json
kafka
kataconfig
keycloak
kiali
knative
kubeadmin
Expand Down
31 changes: 18 additions & 13 deletions components/operators/rhsso/README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,39 @@
# keycloak

Installs the Red Hat SSO (keycloak) operator
Installs the Red Hat SSO (keycloak) operator and/or instance.

Do not use the `base` directory directly, as you will need to patch the `channel` based on the version of OpenShift you are using, or the version of the operator you want to use.
## Usage

### Install the operator

The current *overlays* available are for the following channels:

* [stable](operator/overlays/stable)

## Usage

### Install the operator

```
oc apply -k keycloak/operator/overlays/stable
oc apply -k rhsso/operator/overlays/stable
```


### Install an instance of Keycloak

```
oc apply -k keycloak/instance/overlays/<overlay-name>
oc apply -k rhsso/instance/overlays/<overlay-name>
```
Available Overlays:
`keycloak-standalone` - A base Keycloak instance
`ocp-oidc-client` - A Keycloak instance with a realm containing a backend client and configuration for an OpenShift IDP
The current overlays are available for the following cases:

* [keycloak-standalone](instance/overlays/keycloak-standalone) - A base Keycloak instance with no realm configuration
* [aws-ocp-oidc](instance/overlays/aws-ocp-oidc) - A Keycloak instance base with a component configuring a realm containing a backend client and configuration for an OpenShift IDP

### Install all components

```
oc apply -k rhsso/aggregate/overlays/<overlay-name>
```

#### Oidc Client Overlay
#### Oidc Client Component

This overlay installs the instance of Keycloak and the sets up the following items to use OpenShift as and IDP as well as setting up a client for the backend service to use.
This component installs the instance of Keycloak and the sets up the following items to use OpenShift as and IDP as well as setting up a client for the backend service to use.

The following items are created:
* `KeycloakRealm` `openshift-realm` - Defines the `openshift-ai` realm as well as the `backend-service` client and `openshift-v4` idp. Contains baseUrls and secrets that must be changed for the application to authenticate correctly. See patch-realm.yaml for example substitutions. NOTE: The KeycloakRealm will only create the initial realm. If the realm already exists, changes to the CR [will not update the realm in Keycloak](https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html/server_installation_and_configuration_guide/operator#realm-cr).
Expand Down

0 comments on commit 683b370

Please sign in to comment.