OCPBUGS-114346: Document OIDC IdP naming restriction for group sync

[agawai]

Fixes OCPBUGS-114346

When openID.claims.groups is configured, oauth-server annotates synchronized Group objects with oauth.openshift.io/idp.<IdP name>. Kubernetes annotation keys cannot contain spaces, so identity provider names such as AIF - Keycloak or Microsoft Entra ID fail login with An authentication error occurred.

This change documents that restriction on the OpenID Connect identity provider page, recommends a name such as AIF-Keycloak, and notes that the OIDC client redirect URL must be updated if the IdP is renamed.

The product defect is tracked in OCPBUGS-56908 (oauth-server PR 252). This docs PR covers current shipped behavior (including 4.20/4.21) until that fix is available.

Test plan

• Confirm the IMPORTANT note appears in modules/identity-provider-oidc-about.adoc (included by Configuring an OpenID Connect identity provider)
• Confirm the name and groups callouts in the sample CRs mention the restriction
• Docs preview / peer review of AsciiDoc rendering

Made with Cursor

[openshift-ci-robot]

@agawai: This pull request references Jira Issue OCPBUGS-114346, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug

• bug is open, matching expected state (open)
• bug target version (5.1.0) matches configured target version for branch (5.1.0)
• bug is in the state New, which is one of the valid states (NEW, ASSIGNED, POST)

The bug has been updated to refer to the pull request using the external bug tracker.

Details

In response to this:

Fixes OCPBUGS-114346

When openID.claims.groups is configured, oauth-server annotates synchronized Group objects with oauth.openshift.io/idp.<IdP name>. Kubernetes annotation keys cannot contain spaces, so identity provider names such as AIF - Keycloak or Microsoft Entra ID fail login with An authentication error occurred.

This change documents that restriction on the OpenID Connect identity provider page, recommends a name such as AIF-Keycloak, and notes that the OIDC client redirect URL must be updated if the IdP is renamed.

The product defect is tracked in OCPBUGS-56908 (oauth-server PR 252). This docs PR covers current shipped behavior (including 4.20/4.21) until that fix is available.

Test plan

• Confirm the IMPORTANT note appears in modules/identity-provider-oidc-about.adoc (included by Configuring an OpenID Connect identity provider)
• Confirm the name and groups callouts in the sample CRs mention the restriction
• Docs preview / peer review of AsciiDoc rendering

Made with Cursor

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[openshift-ci]

Hi @agawai. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.