Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: bump supported keycloak versions, misc documentation updates, remove old docs #650

Merged
merged 9 commits into from
Feb 2, 2022
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ jobs:
strategy:
matrix:
keycloak-version:
- '15.0.2'
- '16.1.1'
- '15.1.1'
- '14.0.0'
- '13.0.1'
fail-fast: false
concurrency:
group: ${{ github.head_ref }}-${{ matrix.keycloak-version }}
Expand Down
27 changes: 7 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,40 @@
# terraform-provider-keycloak
Terraform provider for [Keycloak](https://www.keycloak.org/).

[![CircleCI](https://circleci.com/gh/mrparkers/terraform-provider-keycloak.svg?style=shield)](https://circleci.com/gh/mrparkers/terraform-provider-keycloak)

## Docs

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

## Installation

v2.0.0 and above can be installed automatically using Terraform >=0.13 by using the `terraform` configuration block:
This provider can be installed automatically using Terraform >=0.13 by using the `terraform` configuration block:

```hcl
terraform {
required_providers {
keycloak = {
source = "mrparkers/keycloak"
version = ">= 2.0.0"
version = ">= 3.0.0"
}
}
}
```

If you are using v2.0.0 and above with Terraform 0.12, you can use this provider by downloading it and placing it within
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](https://www.terraform.io/docs/commands/cli-config.html#implied-local-mirror-directories).
Or, follow the [old instructions for installing third-party plugins](https://www.terraform.io/docs/configuration-0-11/providers.html#third-party-plugins).

If you are using any version below v2.0.0, you can also follow the [old instructions for installing third-party plugins](https://www.terraform.io/docs/configuration-0-11/providers.html#third-party-plugins).

## Upgrade from terraform 0.12 and keycloak provider 1.x

Please read https://www.terraform.io/upgrade-guides/0-13.html first. For a keycloak project follow the following steps in order:

1. `terraform -v` should print 0.13 and list no keycloak provider
1. `terraform state replace-provider registry.terraform.io/-/keycloak mrparkers/keycloak`
1. find all `provider keycloak {...}` blocks in `*.tf` (also in all modules you are including) and delete the `version` line
1. add the `terraform { required_provides { keycloak = { ...` block mentioned in "Installation" to `terraform.tf` (also in all module directories you are including). Be sure to also always add "source" or else the Terraform looks for "hashicorp/keycloak"!
1. `terraform 0.13upgrade`
1. `terraform init`
If you are using any provider version below v2.0.0, you can also follow the [old instructions for installing third-party plugins](https://www.terraform.io/docs/configuration-0-11/providers.html#third-party-plugins).

## Supported Versions

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

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

- 15.0.2 (latest)
- 16.1.1 (latest)
- 15.1.1
- 14.0.0
- 13.0.1

## Releases

Expand All @@ -61,7 +48,7 @@ created by a PGP key with the fingerprint `C508 6791 5E11 6CD2`. This key can be
You can find the list of releases [here](https://github.com/mrparkers/terraform-provider-keycloak/releases).
You can find the changelog for each version [here](https://github.com/mrparkers/terraform-provider-keycloak/blob/master/CHANGELOG.md).

Note: Prior to 2.0.0, a statically linked build for use within Alpine linux was included with each release. This is no longer
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](https://goreleaser.com/limitations/cgo/). Instead of using a statically linked,
build you can use the `linux_amd64` build as long as `libc6-compat` is installed.

Expand Down
2 changes: 1 addition & 1 deletion custom-user-federation-example/build.gradle
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
buildscript {
ext.kotlinVersion = '1.3.31'
ext.keycloakVersion = '15.0.2'
ext.keycloakVersion = '16.1.1'
ext.shadowJarVersion = '4.0.2'

repositories {
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ services:
ports:
- 8389:389
keycloak:
image: jboss/keycloak:15.0.2
image: jboss/keycloak:16.1.1
command: -b 0.0.0.0 -Dkeycloak.profile.feature.upload_scripts=enabled -Dkeycloak.profile.feature.admin_fine_grained_authz=enabled -Dkeycloak.profile.feature.token_exchange=enabled
depends_on:
- postgres
Expand Down
47 changes: 0 additions & 47 deletions docs-old/data_sources/keycloak_group.md

This file was deleted.

30 changes: 0 additions & 30 deletions docs-old/data_sources/keycloak_openid_client.md

This file was deleted.

30 changes: 0 additions & 30 deletions docs-old/data_sources/keycloak_realm.md

This file was deleted.

38 changes: 0 additions & 38 deletions docs-old/data_sources/keycloak_realm_keys.md

This file was deleted.

51 changes: 0 additions & 51 deletions docs-old/data_sources/keycloak_role.md

This file was deleted.

This file was deleted.

30 changes: 0 additions & 30 deletions docs-old/index.css

This file was deleted.

Loading