Skip to content

docs: add warning about API server OIDC configuration #4641

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zyzzmohit wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −1
Open

docs: add warning about API server OIDC configuration #4641

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/installation/in-cluster/oidc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: OIDC

Headlamp supports OIDC for cluster users to effortlessly log in using a "Sign in" button.

> **⚠️ Important:** For Headlamp's OIDC authentication to work, your Kubernetes cluster's API server **must** also be configured to accept OIDC tokens. Headlamp handles the user login flow, but the cluster validates the resulting token. See the [Kubernetes documentation on OIDC tokens](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#openid-connect-tokens) for details.

![screenshot the login dialog for a cluster](./oidc_button.png)

To use OIDC, Headlamp needs to know how to configure it, so you have to provide the following OIDC-related arguments to Headlamp from your OIDC provider:
Expand Down Expand Up @@ -101,7 +103,6 @@ For quick reference if you are already familiar with setting up Entra ID,
- Set `-oidc-validator-client-id` to `6dae42f8-4368-4678-94ff-3960e28e3630`
- Set `-oidc-use-access-token=true`


### Example: OIDC with Dex

If you are using Dex and want to configure Headlamp to use it for OIDC,
Expand Down