Skip to content

Latest commit

 

History

History
118 lines (83 loc) · 5.65 KB

README.md

File metadata and controls

118 lines (83 loc) · 5.65 KB
Raw

Camunda Keycloak Container Image

build-images build-images Docker image Licence

This Docker image provides a generic Keycloak setup based on bitnami/keycloak. It also includes:

  • an optional AWS wrapper, allowing for the use of AWS Identity and Access Management (IAM) Roles for Service Accounts (IRSA) for database authentication.
  • an optional Camunda Identity login theme

Getting Started

Prerequisites

Make sure you have Docker installed on your machine.

⚙️ Starting the Container

To start the image, run:

docker run --name mykeycloak -p 8443:8443 \
        -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=change_me \
        docker.io/camunda/keycloak:26

Keycloak will start in production mode, using secured HTTPS communication and will be available at https://localhost:8443.

🏷️ Available Tags on Docker Hub

Explore the available tags for the Camunda Keycloak Docker image on Docker Hub: Since we derive this image from the base image of Bitnami Keycloak, you can find the base image tags at hub.docker.com/bitnami/keycloak.

  • :<base image version>-<yyyy-mm-dd>-<iteration>: This tag is associated with a specific date and incremental number (e.g., 24-2024-03-04-004). It is recommended for production use due to its immutable nature. 🏷️
  • :<base image version>: Refers to the latest build of a particular Keycloak version (e.g., 24.0.1-0).
  • :<major keycloak version>: Indicates the latest build of the specified major Keycloak version (e.g., 24).
  • :latest: Corresponds to the latest stable build of the most recent Keycloak version.

Configuration

Bitnami Keycloak container image configuration is available at hub.docker.com/bitnami/keycloak.

IAM Roles for Service Accounts (IRSA) Support

Since Keycloak version 21 and onwards, you can utilize the AWS Advanced JDBC Wrapper included in this image to enable IRSA (IAM Role for Service Accounts). Refer to the Keycloak documentation for more information.

Kubernetes Configuration

For Kubernetes with IRSA, configure the following environment variables:

- name: KEYCLOAK_EXTRA_ARGS
  value: "--db-driver=software.amazon.jdbc.Driver --transaction-xa-enabled=false --log-level=INFO,software.amazon.jdbc:INFO"
- name: KEYCLOAK_JDBC_PARAMS
  value: "wrapperPlugins=iam"
- name: KEYCLOAK_JDBC_DRIVER
  value: "aws-wrapper:postgresql"

- name: KEYCLOAK_DATABASE_USER
  value: db-user-name
- name: KEYCLOAK_DATABASE_NAME
  value: db-name
- name: KEYCLOAK_DATABASE_HOST
  value: db-host
- name: KEYCLOAK_DATABASE_PORT
  value: 5432

- name: KEYCLOAK_ENABLE_STATISTICS
  value: "true"
- name: KEYCLOAK_ENABLE_HEALTH_ENDPOINTS
  value: "true"

Don't forget to set the serviceAccountName of the deployment/statefulset to point to the created service account with the IRSA annotation.

Usage with Helm Chart

To use this image in the Helm chart bitnami/keycloak, update the image used and add the necessary extra environment variables:

image: docker.io/camunda/keycloak:26
extraEnvVars:
  - name: KEYCLOAK_EXTRA_ARGS
    value: "--db-driver=software.amazon.jdbc.Driver --transaction-xa-enabled=false --log-level=INFO,software.amazon.jdbc:INFO"
  - name: KEYCLOAK_JDBC_PARAMS
    value: "wrapperPlugins=iam"
  - name: KEYCLOAK_JDBC_DRIVER
    value: "aws-wrapper:postgresql"
externalDatabase:
  host: "aurora.rds.your.domain"
  port: 5432
  user: keycloak
  database: keycloak

Feel free to adjust the values according to your actual configuration.

Reference

Contributions

We welcome contributions and enhancements to this Docker image. Feel free to join the GitHub Discussion around enhancements of the admin bootstrapping process.

Keycloak is a Cloud Native Computing Foundation incubation project.

© Keycloak Authors 2023. © 2023 The Linux Foundation. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page.