Skip to content

docs: fix command of the Keycloak OIDC tutorial#6097

Open
yuki681 wants to merge 1 commit into
kubernetes-sigs:mainfrom
yuki681:issue/6035
Open

docs: fix command of the Keycloak OIDC tutorial#6097
yuki681 wants to merge 1 commit into
kubernetes-sigs:mainfrom
yuki681:issue/6035

Conversation

@yuki681

@yuki681 yuki681 commented Jun 19, 2026

Copy link
Copy Markdown

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 causes kubectl get ns to fail.

Related Issue

Fixes #6035

Changes

  • Updated docs/installation/in-cluster/keycloak/index.md
    • Replaced --exec-arg=--oidc-extra-scope=email,profile with separate --exec-arg entries for email and profile so the example works with pflag's StringSlice parsing used by --exec-arg.

Steps to Test

Follow the updated Keycloak OIDC tutorial in docs/installation/in-cluster/keycloak/index.md and confirm that the setup completes successfully and kubectl get ns does not fail.

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.
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: yuki681
Once this PR has been reviewed and has the lgtm label, please assign illume for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jun 19, 2026
@illume illume requested a review from Copilot June 19, 2026 14:09

@illume illume left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 — Missing area: description prefix — e.g. frontend: HomeButton: Fix so it navigates to home or backend: 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 #NN in commit messages.

Good examples:

  • frontend: HomeButton: Fix so it navigates to home
  • backend: config: Add enable-dynamic-clusters flag

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 passing email and profile as separate --oidc-extra-scope exec args.
  • Keeps the tutorial flow intact while ensuring kubectl get ns works after following the steps.

@yuki681

yuki681 commented Jun 20, 2026

Copy link
Copy Markdown
Author

@illume

Thanks for the feedback 🙏
I received the same commit message comment on a previous PR (#5762) for:

docs: development: Add dependency installation steps

and now for:

docs: fix Keycloak OIDC scope args for pflag parsing

Could you clarify what format you would prefer for documentation-related commits?

Is docs: considered too broad as an area, or is there another issue with the format?

Would something like:

docs: Tutorial: OIDC with Keycloak: Fix command args for pflag spec

be acceptable, or is there a different convention you'd like us to follow for docs commits?

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: OIDC with Keycloak: Fix oidc-extra-scope argument handling

4 participants