127 lines
3.6 KiB
Markdown
127 lines
3.6 KiB
Markdown
# Keycloak on Quarkus
|
|
|
|
The module holds the codebase to build the Keycloak Operator on top of [Quarkus](https://quarkus.io/).
|
|
Using the [Quarkus Operator SDK](https://github.com/quarkiverse/quarkus-operator-sdk).
|
|
|
|
Also see [Operator guides](https://www.keycloak.org/guides#operator)
|
|
|
|
## Activating the Module
|
|
|
|
When build from the project root directory, this module is only enabled if the installed JDK is 11 or newer.
|
|
|
|
## Building
|
|
|
|
Ensure you have JDK 11 (or newer) installed.
|
|
|
|
Build the Docker image with:
|
|
|
|
```bash
|
|
mvn clean package -Doperator -Dquarkus.container-image.build=true
|
|
```
|
|
|
|
This will build a container image from `src/main/docker/Dockerfile.jvm`, using `docker` by default. `podman` is also supported if you do these steps beforehand:
|
|
|
|
- Follow [this guide](https://quarkus.io/guides/podman#setting-docker_host-on-linux) to enable the podman user socket
|
|
- Set the `DOCKER_HOST` environment variable to point at this user socket. For example: `DOCKER_HOST=unix:///run/user/1000/podman/podman.sock`.
|
|
- You may also have to set `QUARKUS_DOCKER_EXECUTABLE_NAME=podman`
|
|
|
|
## Configuration
|
|
|
|
The Keycloak image can be configured, when starting the operator, using the Java property:
|
|
|
|
```
|
|
operator.keycloak.image
|
|
```
|
|
|
|
And the imagePullPolicy with:
|
|
|
|
```
|
|
operator.keycloak.image-pull-policy
|
|
```
|
|
|
|
## Contributing
|
|
|
|
### Quick start on Minikube
|
|
|
|
Enable the Minikube Docker daemon:
|
|
|
|
```bash
|
|
eval $(minikube -p minikube docker-env)
|
|
```
|
|
|
|
Compile the project and generate the Docker image with JIB:
|
|
|
|
```bash
|
|
mvn clean package -Doperator -Dquarkus.container-image.build=true -Dquarkus.kubernetes.deployment-target=minikube
|
|
```
|
|
|
|
Install the CRD definition and the operator in the cluster in the `keycloak` namespace:
|
|
|
|
```bash
|
|
kubectl apply -k target
|
|
```
|
|
|
|
to install in the `default` namespace:
|
|
|
|
```bash
|
|
kubectl apply -k overlays/default-namespace
|
|
```
|
|
|
|
Remove the created resources with:
|
|
|
|
```bash
|
|
kubectl delete -k <previously-used-folder>
|
|
```
|
|
|
|
### Testing
|
|
|
|
Testing allows 2 methods specified in the property `test.operator.deployment` : `local` & `remote`.
|
|
|
|
`local` : resources will be deployed to the local cluster and the operator will run out of the cluster
|
|
|
|
`remote` : same as local test but an image for the operator will be generated and deployed run inside the cluster
|
|
|
|
```bash
|
|
mvn clean verify \
|
|
-Dquarkus.container-image.build=true \
|
|
-Dquarkus.container-image.tag=test \
|
|
-Dquarkus.kubernetes.image-pull-policy=IfNotPresent \
|
|
-Dtest.operator.deployment=remote
|
|
```
|
|
|
|
To run tests on Mac with `minikube` and the `docker` driver you should run `minikube tunnel` in a separate shell and configure the Java properties as follows:
|
|
```bash
|
|
-Dtest.operator.kubernetes.ip=localhost
|
|
```
|
|
|
|
On Linux or on Mac using `minikube` on a VM, instead you should pass this additional property:
|
|
```bash
|
|
-Dtest.operator.kubernetes.ip=$(minikube ip)
|
|
```
|
|
|
|
To avoid skipping tests that are depending on custom Keycloak images, you need to build those first:
|
|
|
|
```bash
|
|
./build-testing-docker-images.sh [SOURCE KEYCLOAK IMAGE TAG] [SOURCE KEYCLOAK IMAGE]
|
|
```
|
|
|
|
And run the tests passing an extra Java property:
|
|
|
|
```bash
|
|
-Dtest.operator.custom.image=custom-keycloak:latest
|
|
```
|
|
|
|
### Testing using a pre-built operator image from a remote registry
|
|
You can run the testsuite using an already built operator image from a remote image registry.
|
|
|
|
To do this, you need to set `quarkus.container-image.build=false` and specify the desired image
|
|
you want to use by setting `quarkus.container-image.image=<your-image>:<your-tag>`
|
|
|
|
#### Example:
|
|
|
|
```bash
|
|
mvn clean verify \
|
|
-Dquarkus.container-image.build=false \
|
|
-Dquarkus.container-image.image=quay.io/keycloak/keycloak-operator:nightly \
|
|
-Dtest.operator.deployment=remote
|
|
```
|