Chainguard Container for keycloak-config-cli-iamguarded

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-iamguarded:latest

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

Overview

Keycloak Config CLI IAMGuarded is a security-enhanced configuration management tool designed to work as a companion image with the Keycloak IAMGuarded Helm chart. This image enables configuration-as-code for Keycloak deployments by importing YAML/JSON-formatted configuration files.

Helm Chart Integration

The Keycloak Config CLI IAMGuarded image is automatically deployed as part of the Keycloak IAMGuarded Helm chart installation:

cgr.dev/$ORGANIZATION/iamguarded-charts/keycloak

Basic Installation

The Keycloak Config CLI is included when you install the Keycloak chart with configuration enabled:

helm install keycloak oci://cgr.dev/$ORGANIZATION/iamguarded-charts/keycloak \
  --set "global.org=$ORGANIZATION" \
  --set "keycloakConfigCli.enabled=true"

Important: Replace $ORGANIZATION with your Chainguard organization name. The default organization in the chart values is chainguard-private, which must be changed to match your organization.

Configuration Requirements

Organization Setting

The global.org value is required and can be set either:

• Via --set flag during installation
• In your existing values.yaml file

Registry Configuration

For users who mirror images to custom repositories:

• Use global.imageRegistry to override the default cgr.dev
• For complex mirroring strategies, consult the chart's values.yaml for individual image configuration options including registry, repository, tag, and digest

Example values.yaml for individual image configuration:

# Keycloak Config CLI
keycloakConfigCli:
  enabled: true
  image:
    registry: myregistry.example.com
    repository: mirrored/keycloak-config-cli-iamguarded
    digest: sha256:... # Use specific digest instead of tag
  configuration:
    # Your Keycloak configuration files
    "realm-config.json": |
      {
        "realm": "my-realm",
        "enabled": true
      }

Authentication

For detailed instructions on configuring authentication and pull credentials for iamguarded images, please refer to our comprehensive guide:

How to Use Chainguard Helm Charts

Best Practices

1. Pin to Digest: While charts follow the same tagging scheme as Chainguard images, always pin to a specific chart digest to prevent unexpected updates:

   helm install keycloak oci://cgr.dev/$ORGANIZATION/iamguarded-charts/keycloak@sha256:DIGEST \
     --set "global.org=$ORGANIZATION" \
     --set "keycloakConfigCli.enabled=true"

   The digest can be found in the output of helm pull e.g:

   helm pull oci://cgr.dev/$ORGANIZATION/iamguarded-charts/keycloak
   Pulled: cgr.dev/chainguard-private/iamguarded-charts/keycloak:$tag
   Digest: sha256:...

2. Review Default Values: The chart provides security-minded defaults that are sensible but may not be production-ready for all use cases. Review the chart's values.yaml (run helm show values) for the full range of configuration options.

3. Image Pinning: All IAMGuarded charts pin images to specific digests that have been tested for compatibility, ensuring reliable deployments.

Validation

After deployment, the Keycloak Config CLI will automatically apply your configuration files to the Keycloak instance. You can verify successful configuration by checking the job logs and validating the configuration in the Keycloak admin console.

Prerequisites

Prerequisites are defined in the chart's Chart.yaml and individual templates. The Keycloak Config CLI requires a running Keycloak instance and will automatically wait for it to be ready before applying configurations.

Security Considerations

The Keycloak Config CLI IAMGuarded image provides security-minded defaults while ensuring secure configuration management. Store sensitive configuration data using Kubernetes secrets and reference them in your Helm values for enhanced security.

For detailed configuration options and advanced usage, refer to the chart's values.yaml file.

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.