Image Overview: keycloak

Overview: keycloak Chainguard Image

Minimalist Wolfi-based Keycloak image for identity and access management.

Download this Image

The image is available on cgr.dev:

docker pull cgr.dev/chainguard/keycloak:latest

Usage

Docker

Launch a development instance of Keycloak:

docker run --name local-keycloak -p 8080:8080 \
	-e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=change_me \
	cgr.dev/chainguard/keycloak:latest \
	start-dev

The Keycloak UI can be accessed via:

http://localhost:8080/

To launch a production instance of Keycloak, refer to the examples in the following documentation, as this is dependent on environment-specific settings and customizations.

Helm

To launch a development instance of keycloak in k8s using the following helm chart:

helm install keycloak oci://registry-1.docker.io/bitnamicharts/keycloak \
  --set image.registry=cgr.dev \
  --set image.repository=chainguard/keycloak \
  --set image.tag=latest \
  --set "args={start-dev}"

Refer to the keycloak and helm chart documentation for more detail.

Customizing the image

Keycloak provides a mechanism to configure and customize the image. This process is outlined in the Keycloak image documentation.

There are subtle differences in the executable paths used in the Chainguard image. Below is the example copied from the documentation, updated with the correct paths:

FROM cgr.dev/chainguard/keycloak:latest as builder

# Enable health and metrics support
ENV KC_HEALTH_ENABLED=true
ENV KC_METRICS_ENABLED=true

# Configure a database vendor
ENV KC_DB=postgres

WORKDIR /usr/share/java/keycloak
# for demonstration purposes only, please make sure to use proper certificates in production instead
RUN keytool -genkeypair -storepass password -storetype PKCS12 -keyalg RSA -keysize 2048 -dname "CN=server" -alias server -ext "SAN:c=DNS:localhost,IP:127.0.0.1" -keystore conf/server.keystore
RUN /usr/share/java/keycloak/bin/kc.sh build

FROM cgr.dev/chainguard/keycloak:latest
COPY --from=builder /usr/share/java/keycloak/ /usr/share/java/keycloak/

# change these values to point to a running postgres instance
ENV KC_DB=postgres
ENV KC_DB_URL=<DBURL>
ENV KC_DB_USERNAME=<DBUSERNAME>
ENV KC_DB_PASSWORD=<DBPASSWORD>
ENV KC_HOSTNAME=localhost
ENTRYPOINT ["/usr/share/java/keycloak/bin/kc.sh"]

Last updated: 2024-04-22 00:45