Release v2.2.0

Keycloak Module Release 2.2.0

Welcome to the latest release of keycloak module of Kubernetes Fury Distribution maintained by team SIGHUP.

This is a patch release updating Keycloak Operator and Operated to v26.0.2 .

Component Images 🚢

Component	Supported Version	Previous Version
keycloak-operated	v26.0.2	v22.0.5
keycloak-operator	v26.0.2	v22.0.5

Bug Fixes and Changes 🐛

• Updating Keycloak to v26.0.2

• By default, the --optimized argument is now passed to the kc.sh command. To handle this behavior you can set the spec.startOptimized option in Keycloak Custom Resource.

Update Guide 🦮

Process

To upgrade this module from v2.1.1 to v2.2.0, execute the following:

KEYCLOAK_NS=<your_keycloak_namespace>

# Remove the old Keycloak Operator. This will not delete Keycloak instances.
kubectl delete deploy keycloak-operator -n $KEYCLOAK_NS

# Update Keycloak Operator and CRDs
kustomize build katalog/keycloak-operator | kubectl apply -n $KEYCLOAK_NS -f - 

N.B. It's not required to upgrade the keycloak-operated package, since the Operator will take care of updating the pods.

Preview v2.2.0-rc1

Keycloak Module Release 2.2.0

Welcome to the latest release of keycloak module of Kubernetes Fury Distribution maintained by team SIGHUP.

This is a patch release updating Keycloak Operator and Operated to v26.0.2 .

Component Images 🚢

Component	Supported Version	Previous Version
keycloak-operated	v26.0.2	v22.0.5
keycloak-operator	v26.0.2	v22.0.5

Bug Fixes and Changes 🐛

• Updating Keycloak to v26.0.2

• By default, the --optimized argument is now passed to the kc.sh command. To handle this behavior you can set the spec.startOptimized option in Keycloak Custom Resource.

Update Guide 🦮

Process

To upgrade this module from v2.1.1 to v2.2.0, execute the following:

KEYCLOAK_NS=<your_keycloak_namespace>

# Remove the old Keycloak Operator. This will not delete Keycloak instances.
kubectl delete deploy keycloak-operator -n $KEYCLOAK_NS

# Update Keycloak Operator and CRDs
kustomize build katalog/keycloak-operator | kubectl apply -n $KEYCLOAK_NS -f - 

N.B. It's not required to upgrade the keycloak-operated package, since the Operator will take care of updating the pods.

Preview v2.2.0-rc0

Keycloak Module Release 2.2.0

Welcome to the latest release of keycloak module of Kubernetes Fury Distribution maintained by team SIGHUP.

This is a patch release updating Keycloak Operator and Operated to v26.0.2 .

Component Images 🚢

Component	Supported Version	Previous Version
keycloak-operated	v26.0.2	v22.0.5
keycloak-operator	v26.0.2	v22.0.5

Bug Fixes and Changes 🐛

• Updating Keycloak to v26.0.2

• By default, the --optimized argument is now passed to the kc.sh command. To handle this behavior you can set the spec.startOptimized option in Keycloak Custom Resource.

Update Guide 🦮

Process

To upgrade this module from v2.1.1 to v2.2.0, execute the following:

KEYCLOAK_NS=<your_keycloak_namespace>

# Remove the old Keycloak Operator. This will not delete Keycloak instances.
kubectl delete deploy keycloak-operator -n $KEYCLOAK_NS

# Update Keycloak Operator and CRDs
kustomize build katalog/keycloak-operator | kubectl apply -n $KEYCLOAK_NS -f - 

N.B. It's not required to upgrade the keycloak-operated package, since the Operator will take care of updating the pods.

Release v2.1.0

Keycloak Module Release 2.1.0

Welcome to the latest release of keycloak module of Kubernetes Fury Distribution maintained by team SIGHUP.

This is a major release adding Keycloak Operator and updating Keycloak to v22.x .

Component Images 🚢

Component	Supported Version	Previous Version
keycloak-operated	v22.0.1	v21.1.1
keycloak-operator	v22.0.1	v21.1.1

Bug Fixes and Changes 🐛

• Updating Keycloak to v22.0.1

Update Guide 🦮

Process

To upgrade this module from v2.0.0 to v2.1.0, execute the following:

KEYCLOAK_NS=<your_keycloak_namespace>

# Remove the old Keycloak Operator. This will not delete Keycloak instances.
kubectl delete deploy keycloak-operator -n $KEYCLOAK_NS

# Update Keycloak Operator and CRDs
kustomize build katalog/keycloak-operator | kubectl apply -n $KEYCLOAK_NS -f - 

N.B. It's not required to upgrade the keycloak-operated package, since the Operator will take care of updating the pods.

Release v2.0.0

Keycloak Module Release 2.0.0

Welcome to the latest release of keycloak module of Kubernetes Fury Distribution maintained by team SIGHUP.

This is a major release adding Keycloak Operator and updating Keycloak to v21.x .

Component Images 🚢

Component	Supported Version	Previous Version
keycloak-operated	v21.1.1	No update
keycloak-operator	v21.1.1	No update

Bug Fixes and Changes 🐛

• Introducing a new deployment strategy based on Keycloak Operator
• Updating Keycloak to v21.1.1
• Adding additional metrics using the Keycloak Metrics SPI plugin
• Adding a Keycloak dashboard for Grafana

Breaking Changes 💔

• Keycloak cannot be deployed without the operator anymore
• All URLs in Keycloak do not start with /auth prefix, as in the previous versions
• The default service for keycloak has changed from keycloak to keycloak-service

Update Guide 🦮

Warnings

• Since the auth prefix was removed, you have to define the variable KC_HTTP_RELATIVE_PATH=/auth to maintain retro-compatibility. This also applies to ServiceMonitors, in which you have to patch the path adding the prefix /auth
• To migrate from the non-operator deployment to the operator pattern, you need to have an external database in order to preserve data.
• External database credentials must be configured using a secret and a patch. See the example in ../../examples/keycloak-operated-deployment

Process

To upgrade this module from v1.1.0 to v2.0.0, execute the following:

# Delete the old Keycloak instance
KEYCLOAK_NS=<your_keycloak_namespace>
kubectl delete -n $KEYCLOAK_NS serviceaccount/keycloak
kubectl delete -n $KEYCLOAK_NS role.rbac.authorization.k8s.io/keycloak-viewer
kubectl delete -n $KEYCLOAK_NS rolebinding.rbac.authorization.k8s.io/keycloak-view
kubectl delete -n $KEYCLOAK_NS configmap/cache-owners-7kg6b9bdfc
kubectl delete -n $KEYCLOAK_NS service/keycloak
kubectl delete -n $KEYCLOAK_NS service/keycloak-discovery
kubectl delete -n $KEYCLOAK_NS statefulset.apps/keycloak

# Install Keycloak Operator and CRDs
kustomize build katalog/keycloak-operator | kubectl apply -n $KEYCLOAK_NS -f - 

# Install Keycloak instance
kustomize build katalog/keycloak-operated | kubectl apply -n $KEYCLOAK_NS -f - 

Release v1.1.0

KeyCloak Module version 1.1.0

SIGHUP team maintains this module updated and tested.
That is the main reason why we worked on this new release. With the Kubernetes 1.21 release, it became the perfect time
to start testing this module against this Kubernetes release.

Continue reading the Changelog to discover them:

Changelog

• Update KeyCloak from version v7.0.1 to v13.0.1.
• Kubernetes support:
  • Deprecate Kubernetes 1.17 support.
  • Kubernetes 1.20 is considered stable.
  • Add tech-preview support to Kubernetes 1.21.

Upgrade path

To upgrade this module from v1.0.1 to v1.1.0, you need to download this new version, then apply the
kustomize project. No further action is required.

$ kustomize build katalog/keycloak | kubectl apply -f -
# Or
$ kustomize build examples/h2-tests | kubectl apply -f -

Preview v1.1.0-rc0

KeyCloak Module version 1.1.0

SIGHUP team maintains this module updated and tested.
That is the main reason why we worked on this new release. With the Kubernetes 1.21 release, it became the perfect time
to start testing this module against this Kubernetes release.

Continue reading the Changelog to discover them:

Changelog

• Update KeyCloak from version v7.0.1 to v13.0.1.
• Kubernetes support:
  • Deprecate Kubernetes 1.17 support.
  • Kubernetes 1.20 is considered stable.
  • Add tech-preview support to Kubernetes 1.21.

Upgrade path

To upgrade this module from v1.0.1 to v1.1.0, you need to download this new version, then apply the
kustomize project. No further action is required.

$ kustomize build katalog/keycloak | kubectl apply -f -
# Or
$ kustomize build examples/h2-tests | kubectl apply -f -

Release v1.0.1

KeyCloak Module version v1.0.1

This is a patch release that aligns the module to the standard fury module layout.

Changelog

• Add the latest Kubernetes Versions as E2E tests and support
  • Add missing e2e tests (basic ones)
• Modularize the documentation and the packages
  • Leave the basic KeyCloak as it is, then move other variants to the examples' directory.
    • h2-tests: Use only this option to test KeyCloak. It is used in the E2E tests.
    • external-cache: Use this setup to run KeyCloak in a cluster across multiple data
      centers.
    • keycloak-4.8.2: You should put your custom modifications to the official docker image
      here.

Upgrade path

To upgrade this module from v1.0.0 to v1.0.1, you need to download this new version, then apply the
kustomize project. No further action is required.

$ kustomize build katalog/keycloak | kubectl apply -f -
# Or
$ kustomize build examples/h2-tests | kubectl apply -f -

Preview v1.0.1-rc3

KeyCloak Module version v1.0.1

This is a patch release that aligns the module to the standard fury module layout.

Changelog

• Add the latest Kubernetes Versions as E2E tests and support
  • Add missing e2e tests (basic ones)
• Modularize the documentation and the packages
  • Leave the basic KeyCloak as it is, then move other variants to the examples' directory.
    • h2-tests: Use only this option to test KeyCloak. It is used in the E2E tests.
    • external-cache: Use this setup to run KeyCloak in a cluster across multiple data
      centers.
    • keycloak-4.8.2: You should put your custom modifications to the official docker image
      here.

Upgrade path

To upgrade this module from v1.0.0 to v1.0.1, you need to download this new version, then apply the
kustomize project. No further action is required.

$ kustomize build katalog/keycloak | kubectl apply -f -
# Or
$ kustomize build examples/h2-tests | kubectl apply -f -

Preview v1.0.1-rc2

KeyCloak v1.0.1

TBD