8d314a69a0
* fix: adding doc note about admin ingress closes: #33203 Signed-off-by: Steve Hawkins <shawkins@redhat.com> * Update docs/guides/operator/basic-deployment.adoc Co-authored-by: Martin Bartoš <mabartos@redhat.com> Signed-off-by: Steven Hawkins <shawkins@redhat.com> --------- Signed-off-by: Steve Hawkins <shawkins@redhat.com> Signed-off-by: Steven Hawkins <shawkins@redhat.com> Co-authored-by: Martin Bartoš <mabartos@redhat.com> |
||
---|---|---|
.. | ||
overlays/default-namespace | ||
scripts | ||
src | ||
.gitignore | ||
assembly.xml | ||
Dockerfile | ||
olm-assembly.xml | ||
pom.xml | ||
README.md |
Keycloak on Quarkus
The module holds the codebase to build the Keycloak Operator on top of Quarkus. Using the Quarkus Operator SDK.
Also see Operator guides
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 17 (or newer) installed.
Build the Docker image with:
mvn clean package -Dquarkus.container-image.build=true
This will build a container image from Dockerfile
, using docker
by default. podman
is also supported if you do these steps beforehand:
- Follow this guide 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:
kc.operator.keycloak.image
And the imagePullPolicy with:
kc.operator.keycloak.image-pull-policy
Contributing
Quick start on Minikube
Enable the Minikube Docker daemon:
eval $(minikube -p minikube docker-env)
Compile the project and generate the Docker image with JIB:
mvn clean package -Dquarkus.kubernetes.image-pull-policy=IfNotPresent -Dquarkus.container-image.build=true
Install the CRD definition and the operator in the cluster in the keycloak
namespace:
kubectl create namespace keycloak
kubectl apply -k target
to install in the default
namespace:
kubectl apply -k overlays/default-namespace
Remove the created resources with:
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
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:
-Dtest.operator.kubernetes.ip=localhost
On Linux or on Mac using minikube
on a VM, instead you should enable ingress:
minikube addons enable ingress
To avoid skipping tests that are depending on custom Keycloak images, you need to build those first:
./build-testing-docker-images.sh [SOURCE KEYCLOAK IMAGE TAG] [SOURCE KEYCLOAK IMAGE]
And run the tests passing an extra Java property:
-Dtest.kc.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:
mvn clean verify \
-Dquarkus.container-image.build=false \
-Dquarkus.container-image.image=quay.io/keycloak/keycloak-operator:nightly \
-Dtest.operator.deployment=remote