docs: fix command of the Keycloak OIDC tutorial#6097
Conversation
Update docs/installation/in-cluster/keycloak/index.md to pass each extra OIDC scope as a separate exec arg because pflag's StringSlice parses comma-separated values as separate arguments.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: yuki681 The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
illume
left a comment
There was a problem hiding this comment.
Thanks for the contribution.
Could you take a look at the commit messages in this PR? We follow a Linux kernel style for git commits — see the contributing guide and git log for examples.
Commits that need attention
docs: fix Keycloak OIDC scope args for pflag parsing— Missingarea: descriptionprefix — e.g.frontend: HomeButton: Fix so it navigates to homeorbackend: config: Add enable-dynamic-clusters flag.
Commit guidelines
- Use atomic commits focused on a single change.
- Use the title format
<area>: <Description of changes>— description must start with a capital letter. - Keep the title under 72 characters (soft requirement).
- Explain the intention and why the change is needed.
- Make commit titles meaningful and describe what changed.
- Do not add code that a later commit rewrites; squash or reorder commits instead.
- Do not include
Fixes #NNin commit messages.
Good examples:
frontend: HomeButton: Fix so it navigates to homebackend: config: Add enable-dynamic-clusters flag
There was a problem hiding this comment.
Pull request overview
This PR corrects the Keycloak OIDC tutorial command used to configure kubectl exec-credential auth, preventing --exec-arg comma-splitting from producing an invalid kubeconfig exec argument list.
Changes:
- Fixes the
kubectl config set-credentials ... --exec-arg=--oidc-extra-scope=...example by passingemailandprofileas separate--oidc-extra-scopeexec args. - Keeps the tutorial flow intact while ensuring
kubectl get nsworks after following the steps.
|
Thanks for the feedback 🙏 and now for: Could you clarify what format you would prefer for documentation-related commits? Is Would something like: be acceptable, or is there a different convention you'd like us to follow for docs commits? Thanks! |
Summary
This PR fixes the command in the "Configuring kubectl for OIDC User Authentication" section of the Keycloak OIDC tutorial (
docs/installation/in-cluster/keycloak/index.md) because running it as currently documented creates an invalid kubeconfig entry and causeskubectl get nsto fail.Related Issue
Fixes #6035
Changes
docs/installation/in-cluster/keycloak/index.md--exec-arg=--oidc-extra-scope=email,profilewith separate--exec-argentries foremailandprofileso the example works with pflag'sStringSliceparsing used by--exec-arg.Steps to Test
Follow the updated Keycloak OIDC tutorial in
docs/installation/in-cluster/keycloak/index.mdand confirm that the setup completes successfully andkubectl get nsdoes not fail.