github crossplane-contrib/provider-keycloak v3.3.0

one hour ago

provider-keycloak v3.3.0

Compared against v3.2.4.

Highlights

  • Singleton blocks are now plain objects instead of one-item lists (new API versions, old versions still served).
  • Four new managed resources: ClientScopeAssignments, organization AdminPermissions, KeystoreCustom, KeystoreEcdhGenerated.
  • terraform-provider-keycloak bumped to v5.11.0.
  • Stale-reference recovery and Realm flow-binding fixes.

New API versions: singleton lists become objects (#795)

Terraform blocks with max_items = 1 used to be exposed as lists with a single entry.
They are now embedded objects in a new API version. The old version stays served and
converts in both directions through the conversion webhook, so no action is needed at upgrade.

Kind Old version (served) New version (storage)
realm.keycloak.crossplane.io/Realm v1alpha1 v1alpha2
realm.keycloak.crossplane.io/UserProfile v1alpha1 v1alpha2
openidclient.keycloak.crossplane.io/Client v1alpha1, v1alpha2 v1alpha3
openidclient.keycloak.crossplane.io/ClientPermissions v1alpha1 v1alpha2
samlclient.keycloak.crossplane.io/Client v1alpha1 v1alpha2
group.keycloak.crossplane.io/Permissions v1alpha1 v1alpha2
user.keycloak.crossplane.io/Permissions v1alpha1 v1alpha2
user.keycloak.crossplane.io/User v1alpha1 v1alpha2
ldap.keycloak.crossplane.io/UserFederation v1alpha1 v1alpha2
workflow.keycloak.crossplane.io/Workflow v1alpha1 v1alpha2

The namespaced variants (*.keycloak.m.crossplane.io) are changed the same way.

Migrate at your own pace:

-apiVersion: realm.keycloak.crossplane.io/v1alpha1
+apiVersion: realm.keycloak.crossplane.io/v1alpha2
 kind: Realm
 spec:
   forProvider:
     securityDefenses:
-      - headers:
-          - xFrameOptions: DENY
-        bruteForceDetection:
-          - maxLoginFailures: 5
+      headers:
+        xFrameOptions: DENY
+      bruteForceDetection:
+        maxLoginFailures: 5
-apiVersion: openidclient.keycloak.crossplane.io/v1alpha2
+apiVersion: openidclient.keycloak.crossplane.io/v1alpha3
 kind: Client
 spec:
   forProvider:
     authorization:
-      - policyEnforcementMode: ENFORCING
+      policyEnforcementMode: ENFORCING

If you write the old version with more than one entry in a singleton list, the webhook rejects it
instead of silently dropping data.

New managed resources

ClientScopeAssignments (#811)

Manages the full set of default and optional client scopes of an OpenID or SAML client in a single resource.

apiVersion: realm.keycloak.crossplane.io/v1alpha1
kind: ClientScopeAssignments
metadata:
  name: my-client-scopes
spec:
  forProvider:
    realmIdRef:
      name: my-realm
    clientIdRef:          # or samlClientIdRef for SAML clients
      name: my-client
    defaultScopes: [profile, roles, basic]
    optionalScopes: [email, phone]

Organization AdminPermissions (#812)

Fine-grained admin permissions for organizations. Requires Keycloak 26.7+ with admin-fine-grained-authz:v2.

apiVersion: organization.keycloak.crossplane.io/v1alpha1
kind: AdminPermissions
metadata:
  name: manage-organizations
spec:
  forProvider:
    realmIdRef:
      name: my-realm
    name: manage-organizations
    organizationIdsRefs:
      - name: my-organization
    scopes: [view, manage]

KeystoreCustom (#813)

Configures any realm key provider by its provider ID. The config comes from a Secret, and each key is one config property.

apiVersion: v1
kind: Secret
metadata:
  name: keystore-custom-config
  namespace: crossplane-system
stringData:
  priority: "100"
---
apiVersion: realm.keycloak.crossplane.io/v1alpha1
kind: KeystoreCustom
metadata:
  name: eddsa-generated
spec:
  forProvider:
    realmIdRef:
      name: my-realm
    name: eddsa-generated
    providerId: eddsa-generated
    configSecretRef:
      name: keystore-custom-config
      namespace: crossplane-system

KeystoreEcdhGenerated (#814)

Generated ECDH keys for encryption.

apiVersion: realm.keycloak.crossplane.io/v1alpha1
kind: KeystoreEcdhGenerated
metadata:
  name: ecdh-generated
spec:
  forProvider:
    realmIdRef:
      name: my-realm
    name: ecdh-generated
    ellipticCurveKey: P-256
    algorithm: ECDH-ES
    priority: 100

Fixes

  • Stale-reference recovery no longer treats UUIDs containing 404 as "not found", re-resolves references only in memory, backs off exponentially and no longer blocks deletes.
  • Realm vs. Bindings (#755): Realm no longer late-initializes flow bindings that a Bindings resource manages, which ends the tug-of-war between them.
  • OpenID client authorization changes (e.g. policyEnforcementMode) are now applied on update, through the terraform-provider-keycloak v5.11.0 bump (keycloak/terraform-provider-keycloak#1793).
  • Localization teardown failures prevented (#790).
  • Dev env/docs: kc-admin-api client scope for Keycloak 26.8.2 (#788).

Dependencies

  • terraform-provider-keycloak → v5.11.0
  • go.opentelemetry.io/otel/trace → v1.47.0 (security, #783)
  • GitHub Actions, Makefile tools and golangci-lint updates (Renovate)

Don't miss a new provider-keycloak release

NewReleases is sending notifications on new releases.