keycloak/terraform-provider-keycloak

terraform-provider-keycloak

Terraform provider for Keycloak.

Migration to the new provider

To migrate from mrparkers/keycloak to the keycloak/keycloak Terraform provider, you can use the terraform state replace-provider command:

terraform state replace-provider mrparkers/keycloak keycloak/keycloak

You can find the documentation for this command here.

Docs

All documentation for this provider can now be found on the Terraform Registry: https://registry.terraform.io/providers/keycloak/keycloak/latest/docs

Installation

This provider can be installed automatically using Terraform >=0.13 by using the terraform configuration block:

terraform {
  required_providers {
    keycloak = {
      source = "keycloak/keycloak"
      version = ">= 5.9.0"
    }
  }
}

If you are using Terraform 0.12, you can use this provider by downloading it and placing it within one of the implied local mirror directories. Or, follow the old instructions for installing third-party plugins.

If you are using any provider version below v2.0.0, you can also follow the old instructions for installing third-party plugins.

A note for users of the legacy Wildfly distribution

Recently, Keycloak has been updated to use Quarkus over the legacy Wildfly distribution. The only significant change here that affects this Terraform provider is the removal of /auth from the default context path for the Keycloak API.

If you are using the legacy Wildfly distribution of Keycloak, you will need to set the base_path provider argument to /auth. This can also be done by using the KEYCLOAK_BASE_PATH environment variable.

Supported Versions

This provider will officially support the latest three minor versions of Keycloak, although older versions may still work.

The following versions are used when running acceptance tests in CI:

• 26.7.0 (latest)
• 26.6.4
• 26.5.7
• 26.4.7
• 26.3.5
• 26.2.5
• 26.1.4
• 26.0.8

Releases

This provider uses GoReleaser to build and publish releases. Each release published to GitHub contains binary files for Linux, macOS (darwin), and Windows, as configured within the .goreleaser.yml file.

Each release also contains a terraform-provider-keycloak_${RELEASE_VERSION}_SHA256SUMS file that can be used to check integrity.

You can find the list of releases here. You can find the changelog for each version here.

Note: Prior to v2.0.0, a statically linked build for use within Alpine linux was included with each release. This is no longer done due to GoReleaser not supporting CGO. Instead of using a statically linked, build you can use the linux_amd64 build as long as libc6-compat is installed.

Development

This project requires Go 1.25 and Terraform 1.15.0. This project uses Go Modules for dependency management, which allows this project to exist outside an existing GOPATH.

After cloning the repository, you can build the project by running make build.

Debugging

We support remote debugging via delve via the make target build-debug and run-debug.

To debug the plugin, proceed as follows:

1. Run make build-debug
2. Run make run-debug
3. Attach a remote debugger to the printed local address, e.g. 127.0.0.1:58772 from your IDE.
4. Copy the TF_REATTACH_PROVIDERS='{...}' env variable, that is printed by the delve debugger after attachment.
5. In a separate terminal prepend the TF_REATTACH_PROVIDERS='{...}' env variable to your terraform ... command

Note that we use the delve options to wait for a debugger. This allows us to debug the complete plugin lifecycle.

Note for Goland users, there is a preconfigured remote debugger configuration called local debug.

Debugging Example

The easiest way to play with the remote debugger setup is the bundled example project. To use that run make build-example-debug and follow the steps above.

Local Environment

You can spin up a local developer environment via Docker Compose by running make local. This will spin up a few containers for Keycloak, PostgreSQL, and OpenLDAP, which can be used for testing the provider. This environment and its setup via make local is not intended for production use.

You can also use make local-mtls to start Keycloak with required client authentication via mTLS certificate.

To stop the environment you can use the make local-stop. To remove the local environment use make local-down.

Note: The setup scripts require the jq command line utility.

Tests

Every resource supported by this provider will have a reasonable amount of acceptance test coverage.

You can run acceptance tests against a Keycloak instance by running make testacc. You will need to supply some environment variables in order to set up the provider during tests. Here is an example for running tests against a local environment that was created via make local:

KEYCLOAK_CLIENT_ID=terraform \
KEYCLOAK_CLIENT_SECRET=884e0f95-0f42-4a63-9b1f-94274655669e \
KEYCLOAK_CLIENT_TIMEOUT=5 \
KEYCLOAK_REALM=master \
KEYCLOAK_TEST_PASSWORD_GRANT=true \
KEYCLOAK_URL="http://localhost:8080" \
make testacc

Test with HTTPS

You can also run the same tests on Keycloak's https port. For this start the env with make local. After that run the following command:

KEYCLOAK_CLIENT_ID=terraform \
KEYCLOAK_CLIENT_SECRET=884e0f95-0f42-4a63-9b1f-94274655669e \
KEYCLOAK_CLIENT_TIMEOUT=5 \
KEYCLOAK_REALM=master \
KEYCLOAK_TEST_PASSWORD_GRANT=true \
KEYCLOAK_URL="https://localhost:8443" \
KEYCLOAK_TLS_CA_CERT="$(cat provider/testdata/tls/server-cert.pem)" \
make testacc

Test Authenticating with HTTPS + mTLS

You can also run the same tests on Keycloak's https port with the Keycloak Terraform provider authenticating to the server with a mTLS client certificate. For this start the env with make local-mtls. After that run the following command:

KEYCLOAK_CLIENT_ID=terraform \
KEYCLOAK_CLIENT_SECRET=884e0f95-0f42-4a63-9b1f-94274655669e \
KEYCLOAK_CLIENT_TIMEOUT=5 \
KEYCLOAK_REALM=master \
KEYCLOAK_TEST_PASSWORD_GRANT=true \
KEYCLOAK_URL_HTTP="http://localhost:8080" \
KEYCLOAK_URL="https://localhost:8443" \
KEYCLOAK_TLS_CLIENT_CERT="$(cat provider/testdata/tls/client-cert.pem)" \
KEYCLOAK_TLS_CLIENT_KEY="$(cat provider/testdata/tls/client-key.pem)" \
KEYCLOAK_TLS_CA_CERT="$(cat provider/testdata/tls/server-cert.pem)" \
make testauth

Test Authenticating with provided Access Token

You can also run the same test with a provided access token. For this start the env with make local. To obtain an access token for the admin user via the admin-cli client, run make access-token to store an acess token in the ./keycloak_access_token file.

After that run the following command:

make access-token
KEYCLOAK_CLIENT_ID=terraform \
KEYCLOAK_CLIENT_TIMEOUT=5 \
KEYCLOAK_ACCESS_TOKEN="$(cat keycloak_access_token)" \
KEYCLOAK_REALM=master \
KEYCLOAK_URL="http://localhost:8080" \
make testauth

Run examples

You can run examples against a Keycloak instance. Follow the commands for running examples against a local environment that was created via make local:

make build-example
cd example
terraform init
terraform plan -out tfplan
terraform apply tfplan
rm tfplan

Acknowledgments

The Keycloak Terraform Provider was originally created by Michael Parker. Many thanks for the hard work and dedication in building the foundation for this project. Also, many thanks to all the contributors extending it and approving the license change to maintain it as part of the Keycloak project.

License

This software is licensed under Apache License, Version 2.0, (LICENSE-APACHE-2.0 or https://www.apache.org/licenses/LICENSE-2.0)

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this software by you shall be licensed under the Apache License, Version 2.0, without any additional terms or conditions.