docs: document OIDC secret structure, app-native OAuth, and wrap-chart gotchas#10
Merged
Merged
Conversation
…t gotchas - Document full OIDC secret structure including issuer-url key, client ID naming convention, and auto-created RBAC resources - Add comprehensive app-native OAuth section with dual-layer auth pattern, credential wiring examples, and Superset reference - Cross-reference auth-flow.md from CRD reference for provisionClient and enforceAtGateway fields - Add service name discovery guidance for wrap-existing-chart pattern - Add Bitnami paywall warning and alternatives (CloudNativePG, Valkey) - Document that Helm sub-chart values cannot use template expressions Closes #4, closes #5, closes #6, closes #7, closes #9
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.
Summary
Adds documentation based on real-world experience building the nebari-superset-pack. These are gaps and gotchas discovered during that process.
Changes
docs/auth-flow.md:
client-id,client-secret,issuer-url,spa-client-id,device-client-id<namespace>-<nebariapp-name>)extraEnvRaw/valueFrom.secretKeyRefwiring examplesissuer-urlextraEnvvsextraEnvRawguidancedocs/nebariapp-crd-reference.md:
provisionClientdescription with client ID naming convention and link to secret structure docsenforceAtGatewaydescription with link to app-native OAuth docsclientSecretRefdescription to mentionissuer-urlkeyexamples/wrap-existing-chart/README.md:
helm templateverificationTest plan
Closes #4, closes #5, closes #6, closes #7, closes #9