nebari-dev / nebari-dev/data-science-pack
README: document auth setup, troubleshooting, and the declared maturity level
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 7
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 13
Description
Checklist items [B]:
Authentication setup is documented (if applicable)
Troubleshooting section covers common failure modes
Upstream chart values that users need to customize are documented
Plus a promotion requirement: the README must state the pack's declared maturity level, and it currently doesn't mention one anywhere.
Auth setup today lives in values.yaml comments and a commented-out GenericOAuthenticator block; the README only mentions dummy auth. Needs a section covering the Keycloak path: operator-provisioned OIDC client, the *-oidc-client secret convention, enforceAtGateway: false rationale, and the rbac bootstrap job.
The values.yaml comments already contain most of a troubleshooting section, it just needs to be surfaced:
extraVolumes/extraVolumeMountsoverride silently dropping custom config (falls back to dummy auth)- "400 OAuth state mismatch" from KC-initiated SSO without
hubExternalUrl - NFSv4 export broken on overlayfs nodes (kind/k3d), fixed with
mountOptions: ["nfsvers=3"] - jhub-app-proxy must be >= v0.2.3 for pixi/nebi env activation
- jhub-apps CrashLoopBackOff when
service_workers> 1
Part of #120. Related: #87 (end user workflow docs).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with README and the authentication and troubleshooting comments in values.yaml, including the commented-out GenericAuthenticator block. Document the Keycloak path, required chart values, listed failure modes, and the pack's declared maturity level. Done means the README covers every checklist item and matches the existing values.yaml guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100