Skip to content

Commit

Permalink
docs: fix readme typos (#151)
Browse files Browse the repository at this point in the history
* docs: fix readme typos

* docs: add nl
  • Loading branch information
raffis authored Dec 6, 2023
1 parent 8fefe1c commit 48fa91f
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,14 +180,14 @@ spec:
### Secret substitution

All fields support secret subsitution from kubernetes secrets.
A pattern like `${secret:secretName:secretField}` can be used anywhere in the `KeycloakRealm`` `.spec.realm` as
A pattern like `${secret:secretName:secretField}` can be used anywhere in the `KeycloakRealm` `.spec.realm` as
well as in `KeycloakUser` and `KeycloakClient` resources.

**Note**: The secret must be in the same namespace as the KeycloakRealm.

## How does this work?
For each `KeycloakRealm` the controller attempts to create reconciler pod which invokes upstream images from [keycloak-config-cli](https://github.com/adorsys/keycloak-config-cli). For each realm beeing reconciled a pod is spinned up in the same namespace the realm lives. If a current reconciliation is in progress one can get the reconciler pod from `.status.reconciler`.
The controller tries to automatically elect the keycloak version however it is possible to overrule this by defining the keycloak version manually on the `KeycloakRealm`` in `.spec.version`.
The controller tries to automatically elect the keycloak version however it is possible to overrule this by defining the keycloak version manually on the `KeycloakRealm` in `.spec.version`.

Previous versions of this controller bundled [keycloak-config-cli](https://github.com/adorsys/keycloak-config-cli) artifacts in the controller itself. However this introduced various implications. For instances it was not possible to tweak arguments for [keycloak-config-cli](https://github.com/adorsys/keycloak-config-cli) itself by realm. Also shelling out to `java` was a bit of a security concern since the controller image itself also needs to bundle an OpenJDK runtime.
From version 2.x the controller is refactored into a cloud native approach as described above.
Expand Down Expand Up @@ -241,6 +241,7 @@ as long as a reconciliation is in progress.

`.status.reconciler` references the reconciler pod while a realm has a `Reconciling` condition
and `.status.lastFailedRequests` includes all failed requests from the current reconciliation.

**Note**: `.status.lastFailedRequests` will only be included if the sidecar proxy is deployed. See the following chapter.

```yaml
Expand Down Expand Up @@ -419,4 +420,4 @@ The controller can be configured using cmd args:
--min-retry-delay duration The minimum amount of time for which an object being reconciled will have to wait before a retry. (default 750ms)
--watch-all-namespaces Watch for resources in all namespaces, if set to false it will only watch the runtime namespace. (default true)
--watch-label-selector string Watch for resources with matching labels e.g. 'sharding.fluxcd.io/shard=shard1'.
```
```

0 comments on commit 48fa91f

Please sign in to comment.