Skip to content

Commit d615418

Browse files
committed
docs: installation: Add oidc auto-login to guide
1 parent 0373094 commit d615418

File tree

1 file changed

+10
-0
lines changed
  • docs/installation/in-cluster

1 file changed

+10
-0
lines changed

docs/installation/in-cluster/oidc.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,15 @@ then add them all to the option:
6565
used by Dex and other services, but since it's not part of the default spec,
6666
it was removed in the mentioned version.
6767
68+
69+
### Auto-login
70+
71+
By default, Headlamp shows a "Sign in" button for OIDC clusters. To bypass this screen and redirect users to your Identity Provider (IDP) you can use the auto-login flag.
72+
73+
- `-oidc-auto-login=true` OR env var `HEADLAMP_CONFIG_OIDC_AUTO_LOGIN`
74+
75+
> **ℹ️ Note:** This will only cause a redirect if the user is not currently authenticated and the selected cluster is configured in OIDC.
76+
6877
### Token Validation Overrides
6978
7079
In the event your OIDC Provider issues `access_tokens` from a different Issuer URL or clientID audience than its `id_tokens` (i.e. Azure Entra ID) you may have need of the following parameters to configure what is used in validation of tokens.
@@ -100,6 +109,7 @@ For quick reference if you are already familiar with setting up Entra ID,
100109
- Set `--oidc-validator-idp-issuer-url` to `https://sts.windows.net/<Your Directory (tenant) ID>/`
101110
- Set `-oidc-validator-client-id` to `6dae42f8-4368-4678-94ff-3960e28e3630`
102111
- Set `-oidc-use-access-token=true`
112+
- Set `-oidc-auto-login=true` (optional to skip the "Sign in" screen)
103113
104114
105115
### Example: OIDC with Dex

0 commit comments

Comments
 (0)