Chainguard Container for keycloak-config-cli-iamguarded-fips

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-fips: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 FIPS is a FIPS-compliant 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, with full FIPS compliance.

Helm Chart Integration

The Keycloak Config CLI IAMGuarded FIPS image is automatically deployed as part of the Keycloak IAMGuarded Helm chart installation when using FIPS-compliant images:

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 FIPS
keycloakConfigCli:
  enabled: true
  image:
    registry: myregistry.example.com
    repository: mirrored/keycloak-config-cli-iamguarded-fips
    digest: sha256:... # Use specific digest instead of tag
  configuration:
    # Your Keycloak configuration files
    "realm-config.json": |
      {
        "realm": "my-realm",
        "enabled": true
      }

Authentication

Ensure proper pull credentials are configured through one of the following methods:

Option 1: Using Helm values with global.imagePullSecrets

# values.yaml
global:
  imagePullSecrets:
    - name: chainguard-pull-secret

Option 2: Create a Kubernetes pull secret

# Step 1: Authenticate with chainctl and generate a pull token
chainctl auth login
chainctl auth configure-docker --pull-token --save --ttl=24h

# Step 2: Create the Kubernetes secret
kubectl create secret docker-registry chainguard-pull-secret \
  --docker-server=cgr.dev \
  --docker-username=$(echo cgr.dev | docker-credential-cgr get | jq -r '.Username') \
  --docker-password=$(echo cgr.dev | docker-credential-cgr get | jq -r '.Secret') \
  -n <your-namespace>

# Step 3: Reference the secret in your Helm installation
helm install keycloak oci://cgr.dev/$ORGANIZATION/iamguarded-charts/keycloak \
  --set "global.org=$ORGANIZATION" \
  --set "global.imagePullSecrets[0].name=chainguard-pull-secret" \
  --set "keycloakConfigCli.enabled=true"

Option 3: Cluster node-scoped registry permissions (cluster-dependent)

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 with FIPS compliance. 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 FIPS image provides security-minded defaults while ensuring secure configuration management with FIPS 140-2 compliance. This FIPS variant ensures all cryptographic operations meet federal standards. 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 Containers are minimal container images that are secure by default.

In many cases, the Chainguard Containers tagged as :latest contain only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager. Chainguard Containers are built with Wolfi, our Linux undistro 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 -dev variant.

Although the -dev container image variants have similar security features as their more minimal versions, they feature additional software that is typically not necessary in production environments. We recommend using multi-stage builds to leverage the -dev variants, copying application artifacts into a final minimal container that offers a reduced attack surface that won’t allow package installations or logins.

Learn More

To better understand how to work with Chainguard Containers, please visit Chainguard Academy and Chainguard Courses.

In addition to Containers, Chainguard offers VMs and Libraries. Contact Chainguard to access additional products.

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.