keycloak-config-cli

keycloak-config-cli is a Keycloak utility to ensure the desired configuration state for a realm based on a JSON/YAML file. The format of the JSON/YAML file based on the export realm format. Store and handle the configuration files inside git just like normal code. A Keycloak restart isn't required to apply the configuration.

Config files

The config files are based on the keycloak export files. You can use them to re-import your settings. But keep your files as small as possible. Remove all UUIDs and all stuff which is default set by keycloak.

moped.json is a full working example file you can consider. Other examples are located in the test resources.

Variable Substitution

keycloak-config-cli supports variable substitution of config files. This could be enabled by import.var-substitution=true (disabled by default). Use substitutions like

Base64 Decoder:        $(base64Decoder:SGVsbG9Xb3JsZCE=)
Base64 Encoder:        $(base64Encoder:HelloWorld!)
Java Constant:         $(const:java.awt.event.KeyEvent.VK_ESCAPE)
Date:                  $(date:yyyy-MM-dd)
DNS:                   $(dns:address|apache.org)
Environment Variable:  $(env:USERNAME)
File Content:          $(file:UTF-8:src/test/resources/document.properties)
Java:                  $(java:version)
Localhost:             $(localhost:canonical-name)
Properties File:       $(properties:src/test/resources/document.properties::mykey)
Resource Bundle:       $(resourceBundle:org.example.testResourceBundleLookup:mykey)
Script:                $(script:javascript:3 + 4)
System Property:       $(sys:user.dir)
URL Decoder:           $(urlDecoder:Hello%20World%21)
URL Encoder:           $(urlEncoder:Hello World!)
URL Content (HTTP):    $(url:UTF-8:http://www.apache.org)
URL Content (HTTPS):   $(url:UTF-8:https://www.apache.org)
URL Content (File):    $(url:UTF-8:file:///$(sys:user.dir)/src/test/resources/document.properties)
XML XPath:             $(xml:src/test/resources/document.xml:/root/path/to/node)

to replace the values with java system properties or environment variables. Recursive variable replacement like $(file:UTF-8:$(env:KEYCLOAK_PASSWORD_FILE)) is enabled by default if import.var-substitution is set to true.

The variable substitution is running before the json parser gets executed. This allows json structures or complex values.

See Apache Common StringSubstitutor documentation for more information and advanced usage.

Note: Since variable substitution is a part of the keycloak-config-cli, it's done locally. This means, the environment variables need to be available where keycloak-config-cli is executed.

If import.var-substitution-prefix=${ and import.var-substitution-suffix=} (default in keycloak-config-cli 3.x) is set, then keycloak builtin variables like ${role_uma_authorization} needs to be escaped by $${role_uma_authorization}.

Logging

JSON logging support

keycloak-config-cli supports logging in JSON format. To enable, set SPRING_PROFILES_ACTIVE=json-log.

Log level

CLI Option	ENV Variable	Description	Default
--logging.level.root	LOGGING_LEVEL_ROOT	define the root log level	info
--logging.level.keycloak-config-cli	LOGGING_LEVEL_KEYCLOAKCONFIGCLI	log level of keycloak-config-cli components	value of loging.level.root
--logging.level.http	LOGGING_LEVEL_HTTP	log level http requests between keycloak-config-cli and Keycloak	value of loging.level.root

Supported features

See: docs/FEATURES.md

Compatibility with keycloak

Since keycloak-config-cli 4.0 will support the latest 4 releases of keycloak, if possible.

There are some exceptions, for example if keycloak introduce some backward compatible changes, keycloak-config-cli will cut the support, too.

Compatibility matrix for old versions

keycloak-config-cli	Keycloak 4 - 7	Keycloak 8	Keycloak 9 - 11	Keycloak 12 - 13
v0.8.x	✓	✗	✗	✗
v1.0.x - v2.6.x	✗	✓	✓	✗
v3.0.x - v3.x.x	✗	✗	✓	✓

• ✓ Supported
• ✗ Not supported

Build this project

keycloak-config-cli using maven to build and test keycloak-config-cli. A Java Development Kit (JDK) needs to be installed on the local machine.

In case maven is not installed in you system, the mvnw command will download maven for you.

./mvnw package

# Windows only
mvnw.cmd package

Run integration tests against real keycloak

We are using TestContainers in our integration tests. To run the integration tests a configured docker environment is required.

./mvnw verify

# Windows only
mvnw.cmd verify

Run this project

Start a local keycloak on port 8080:

docker-compose down --remove-orphans && docker-compose up keycloak

before performing following command:

java -jar ./target/keycloak-config-cli.jar \
    --keycloak.url=http://localhost:8080/auth \
    --keycloak.ssl-verify=true \
    --keycloak.user=admin \
    --keycloak.password=admin123 \
    # default usage: local files
    --import.path=./contrib/example-config/moped.json

    # alternative usage: local directory
    # --import.path=./contrib/example-config-directory/
    # alternative usage: remote file
    # --import.path=http://hostname/moped.json
    # alternative usage: remote resource and basic auth
    # --import.path=http://user:pass@hostname/moped.json

Docker

A docker images is available at DockerHub (docker.io/adorsys/keycloak-config-cli) and quay.io (quay.io/adorsys/keycloak-config-cli)

Available docker tags

Tag	Description
latest	latest available release of keycloak-config-cli which is built against the latest supported Keycloak release.
latest-x.y.z	latest available release of keycloak-config-cli which is built against the Keycloak version x.y.z.
edge	latest commit on the main branch and which is built against the latest supported Keycloak release.
a.b.c	keycloak-config-cli version a.b.c which is built against the latest supported Keycloak release.
a.b.c-x.y.z	keycloak-config-cli version a.b.c which is built against the Keycloak version x.y.z.
maven	See below

Additionally, the tag maven contains the source code and compile keycloak-config-cli at runtime. This has the advantage to keycloak-config-cli with Keycloak versions, that not official supported., e.g.:

docker run --rm -ti -v $PWD:/config/ -eKEYCLOAK_VERSION=13.0.1 -eMAVEN_CLI_OPTS="-B -ntp -q" adorsys/keycloak-config-cli:edge-build

Docker run

For docker -e you have to replace dots with underscores.

docker run \
    -e KEYCLOAK_URL=http://<your keycloak host>:8080/auth \
    -e KEYCLOAK_USER=<keycloak admin username> \
    -e KEYCLOAK_PASSWORD=<keycloak admin password> \
    -e KEYCLOAK_AVAILABILITYCHECK_ENABLED=true \
    -e KEYCLOAK_AVAILABILITYCHECK_TIMEOUT=120s \
    -e IMPORT_PATH=/config \
    -e IMPORT_FORCE=false \
    -v <your config path>:/config \
    adorsys/keycloak-config-cli:latest

Docker build

To build the docker image locally, you have to build the keycloak-config-cli first. By default, the dockerfile expects the jar file at ./target/keycloak-config-cli.jar.

The location of ./target/keycloak-config-cli.jar can be modified by using --build-arg JAR= parameter on the docker build command. Inside the docker build the ADD command is used. Multiple source like zip files OR remote locations are supported, too.

Here is an example to build the docker image using the jar form a Github release .

docker build \
    --build-arg JAR=https://github.com/adorsys/keycloak-config-cli/releases/download/v4.2.0/keycloak-config-cli-15.0.1.jar \
    -t keycloak-config-cli:latest .

Helm

We provide a helm chart here.

Since it make no sense to deploy keycloak-config-cli as standalone application, you could add it as dependency to your chart deployment.

Checkout helm docs about chart dependencies!

Configuration

CLI option / Environment Variables

CLI Option	ENV Variable	Description	Default	Docs
--keycloak.url	KEYCLOAK_URL	Keycloak URL including web context. Format: scheme://hostname:port/web-context.	-
--keycloak.user	KEYCLOAK_USER	login user name	admin
--keycloak.password	KEYCLOAK_PASSWORD	login user password	-
--keycloak.client-id	KEYCLOAK_CLIENTID	login clientId	admin-cli
--keycloak.client-secret	KEYCLOAK_CLIENTSECRET	login client secret	-
--keycloak.grant-type	KEYCLOAK_GRANTTYPE	login grant_type	password
--keycloak.login-realm	KEYCLOAK_LOGINREALM	login realm	master
--keycloak.ssl-verify	KEYCLOAK_SSLVERIFY	Verify ssl connection to keycloak	true
--keycloak.http-proxy	KEYCLOAK_HTTPPROXY	Connect to Keycloak via HTTP Proxy. Format: scheme://hostname:port	-
--keycloak.availability-check.enabled	KEYCLOAK_AVAILABILITYCHECK_ENABLED	Wait until Keycloak is available	false
--keycloak.availability-check.timeout	KEYCLOAK_AVAILABILITYCHECK_TIMEOUT	Wait timeout for keycloak availability check	120s
--import.path	IMPORT_PATH	Location of config files (if location is a directory, all files will be imported)	/config	Spring ResourceLoader
--import.force	IMPORT_FORCE	Import realm even if config from --import.path is unchanged	false
--import.cache-key	IMPORT_CACHEKEY	Cache key for importing config.	default
--import.state	IMPORT_STATE	Enable state management. Purge only resources managed by kecloak-config-cli. S.	true	MANAGED.md
--import.state-encryption-key	IMPORT_STATEENCRYPTIONKEY	Enables state in encrypted format. If unset, state will be stored in plain	-
--import.file-type	IMPORT_FILETYPE	Format of the configuration import file. Allowed values: AUTO,JSON,YAML	auto
--import.parallel	IMPORT_PARALLEL	Enable parallel import of certain resources	false
--import.var-substitution	IMPORT_VARSUBSTITUTION	Enable variable substitution config files	false
--import.var-substitution-in-variable	IMPORT_VARSUBSTITUTION_IN_VARIABLES	Expand variables in variables.	true
--import.var-substitution-undefined-throws-exceptions	IMPORT_VARSUBSTITUTION_UNDEFINED_THROWS_EXCEPTIONS	Raise exceptions, if variables are not defined.	true
--import.var-substitution-prefix	IMPORT_VARSUBSTITUTION_PREFIX	Configure the variable prefix, if import.var-substitution is enabled.	$(
--import.var-substitution-suffix	IMPORT_VARSUBSTITUTION_SUFFIX	Configure the variable suffix, if import.var-substitution is enabled.	)
--import.sync-user-federation	IMPORT_SYNC_USER_FEDERATION	Enable the synchronization of user federation.	false
--import.remove-default-role-from-user	IMPORT_REMOVEDEFAULTROLEFROMUSER	See below.	false
--import.skip-attributes-for-federated-user	IMPORT_SKIP_ATTRIBUTESFORFEDERATEDUSER	Set attributes to null for federated users to avoid read only conflicts	false

See application.properties for all available settings.

For docker -e you have to remove hyphens and replace dots with underscores.

Take a look at spring relax binding or binding from Environment Variables if you need alternative spellings.

import.remove-default-role-from-user

Keycloak 13 attach a default role named default-role-$REALM that contains some defaults from any user. Previously keycloak-config-cli remove that default role, if the role not defined inside the import json. The flag prevents keycloak-config-cli from exclude default-roles-$REALM from removal logic. This results that it's not longer possible to explicit remove the role from a user, if import.remove-default-role-from-user set to true.

Spring boot options

CLI Option	ENV Variable	Description	Default	Docs
--spring.profiles.active	SPRING_PROFILES_ACTIVE	enable spring profiles. comma separated	-	Set the Active Spring Profiles
--loging.level.root	LOGGING_LEVEL_ROOT	define the root log level	info	Logging
--debug	DEBUG	enables debug mode of spring boot	false

Configure properties values through files

Available since keycloak-config-cli 2.6.3.

By define an environment variable SPRING_CONFIG_IMPORT=configtree:/run/secrets/, the values of properties can be provided via files instead of plain environment variable values.

Example: To configure the property keycloak.password in this case, the file should be in /run/secrets/keycloak.password.

The configuration and secret support in Docker Swarm is a perfect match for this use case.

Checkout the spring docs to get more information about the configuration trees feature in spring boot.

Perform release

Create release via maven release plugin:

./mvnw -Dresume=false release:prepare release:clean
git push --follow-tags

Commercial support

Checkout https://adorsys.com/en/products/keycloak-config-cli/ for commercial support.