nebari-dev / nebari-dev/data-science-pack
[DOCS] - Add docs page for enterprise CA bundle
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 7
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 13
Description
The enterprise CA bundle / TLS-inspecting egress feature (shipped in https://github.com/nebari-dev/data-science-pack/pull/102, closed https://github.com/nebari-dev/data-science-pack/issues/85) has no user-facing docs. Right now it only lives as inline comments in values.yaml:
https://github.com/nebari-dev/nebari-data-science-pack/blob/main/values.yaml
It's gated behind custom.trust-bundle-enabled and defaults to false, so it's easy to miss that it exists at all. That's actually what led to https://github.com/nebari-dev/data-science-pack/issues/154 getting filed as a fresh request when the feature was already there. A short page covering when to turn it on, the config keys, and how the init-container merge lines up with NIC core's trust-manager would close that gap.
Originally noted in https://github.com/nebari-dev/data-science-pack/issues/145#issuecomment-4916762829
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 values.yaml and the shipped pull request 102 to trace the existing enterprise CA bundle configuration. Document when to enable custom.trust-bundle-enabled, the relevant config keys, and how the init-container merge relates to NIC core's trust-manager; the issue is done when users can discover and configure the feature without relying on inline comments.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 76/100