Repository navigation
docs(alb): correct and expand ALB authentication and identity docs - #174
Open
dlotterman wants to merge 2 commits into
Open
dlotterman wants to merge 2 commits into
dlotterman wants to merge 2 commits into
Conversation
Fix wrong or incomplete auth information, verified live against the ALB on 2026-11-18: - Google OIDC can be limited to a Workspace domain or listed people with a jwt block on the ID token cookie plus authorization rules; it is not "anyone with a Google account" only. - oidc + jwt in one policy works; drop the Auth0 warning that it causes a 500, and the advice to remove the WAF. - datumctl alb auth set attaches to the Gateway; a route-level policy silently replaces it while alb describe still reports it enabled. - alb describe doesn't show hand-written policies or added routes. - One SecurityPolicy per route; a second is rejected as Conflicted. - Basic Auth forwards the Authorization header (with password) to the origin; forwardUsernameHeader and per-user passwords are supported. Add pages for API keys, JWT, generic OIDC (any provider), authorization rules, CORS, and per-path authentication, and list what isn't available (mTLS, extAuth, provider retries, GeoIP, auth metrics).
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Corrects the ALB authentication pages and documents what the ALB's
SecurityPolicyalready supports beyond Basic Auth, Google, and Auth0. Examples were validated with server-side dry-runs, and most were tested live on throwaway load balancers.Corrections
jwtblock that reads the ID-token cookie (cookieNames.idToken+extractFrom.cookies) and anauthorizationrule on thehdclaim to allow only your Workspace domain, or onemailfor named people. Others can still sign in with Google but get403at the edge. See "Restrict who can sign in" inoidc-google.mdx.jwt+oidcin one policy causes a 500 (it works, including with Google as the issuer), and the advice to remove the WAF when OIDC fails.datumctl alb auth setattaches to the Gateway. A route-level policy (even CORS-only) replaces it for that route, andalb describestill reports Basic Auth as enabled.alb describedoesn't show hand-written policies or added routes.SecurityPolicy; a second is rejected asConflicted.Authorizationheader, password included, to the origin. Per-user passwords andforwardUsernameHeaderare now documented.New pages
API keys, JWT, OIDC with any provider, authorization rules, CORS, and per-path authentication. The overview now lists what isn't available: client certificates (mTLS),
extAuth, retries to the identity provider, location rules, and auth metrics.OIDC
logoutPath,passThroughAuthHeader(a valid bearer token skips sign-in), anddenyRedirect(401instead of a redirect for JSON requests) were tested live.refreshTokenis described from Envoy Gateway's reference.Needs a check before merge
oidc.mdxtells readers to host their identity provider outside Datum, because an issuer behind a Datum ALB failed about half of token exchanges in testing. Engineering may want to confirm before this is public.Platform bugs found (documented as known issues)
alb auth unset/alb deleteleave theALB_NAME-basic-authSecret behind without itsgateway-synclabel but with thegateway-resource-replicatorfinalizer, so deleting it hangs inTerminating.alb deleteleaves hand-addedHTTPRoutes orphaned.Should merge cleanly with #173, which touches
docs.jsonand the ALB overview pages.