Chainguard Container for keycloak-config-cli

Import YAML/JSON-formatted configuration files into Keycloak - Configuration as Code for Keycloak.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/keycloak-config-cli:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

This image is comparable to the adorsys/keycloak-config-cli image available from Docker Hub. Switching to the Chainguard image should not require any changes to your existing setup.

Getting Started

These instructions assume you have a running instance of Keycloak with which keycloak-config-cli can interact.

Docker

You can run the following command to test Chainguard's keycloak-config-cli image:

docker run --rm \
-e KEYCLOAK_URL=<keycloak url> \
-e KEYCLOAK_USER=<keycloak username> \
-e KEYCLOAK_PASSWORD=<keycloak password> \
-v <hostpath to config files>:/config \
cgr.dev/ORGANIZATION/keycloak-config-cli:latest

Helm

You can use the official Helm chart and replace the image in values.yaml with the Chainguard image.

For example, you could use the following values.yaml file to configure the Helm chart:

env:
  IMPORT_FILES_LOCATIONS: file:/config/*
  KEYCLOAK_URL: "<URL to Keycloak running in your cluster>"

image:
  repository: cgr.dev/ORGANIZATION/keycloak-config-cli
  tag: latest

secrets:
  KEYCLOAK_PASSWORD: <Keycloak password>

# Any config files you wish to use can be added to a Kubernetes secret
# This secret is mounted into the keycloak-config-cli container automatically to its /config directory
existingConfigSecret: "keycloak-config-cli-config"

Run the following commands to install and run Chainguard's keycloak-config-cli image using Helm:

helm repo add keycloak-config-cli https://jkroepke.github.io/helm-charts/

"keycloak-config-cli" has been added to your repositories

helm repo update

...Successfully got an update from the "keycloak-config-cli" chart repository
Update Complete. ⎈Happy Helming!⎈

helm install keycloak-config-cli keycloak-config-cli/keycloak-config-cli --values values.yaml

NAME: keycloak-config-cli
LAST DEPLOYED: <DATE>
NAMESPACE: default
STATUS: deployed
REVISION: 1
TEST SUITE: None

Documentation and Resources

• Official keycloak-config-cli repository

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.