Repository navigation
use official NebariApp CR template - #32
Conversation
* docs: document nebari-app library chart usage * docs: address review feedback on nebari-app docs
|
📄 Docs preview for |
dcmcand
left a comment
There was a problem hiding this comment.
Replacing three hand-written NebariApp templates with the upstream nebari-app library is a good change. The rendered output matches base for all three charts. It also fixes auth-fastapi ignoring auth.enabled=false, and spec fields like forwardAccessToken now pass through from values. Two suggestions inline, neither blocking.
| version: 0.1.0 | ||
| version: 0.1.1 | ||
| appVersion: "1.0.0" | ||
| dependencies: |
There was a problem hiding this comment.
Adding this dependency breaks make up-basic and make up-fastapi on a fresh clone. dev/Makefile runs helm upgrade --install on these charts without fetching dependencies first, and *.tgz is gitignored, so helm fails with found in Chart.yaml, but missing in charts/ directory: nebari-app. CI doesn't catch it because the workflows build the dependencies themselves.
We should do what up-podinfo already does:
up-basic: cluster
helm dependency build $(CHART_BASIC)
helm upgrade --install my-pack $(CHART_BASIC) \up-fastapi: cluster
helm dependency build $(CHART_FASTAPI)
helm upgrade --install my-pack $(CHART_FASTAPI) \| With plain YAML or Kustomize, the NebariApp manifest is always present. When | ||
| deploying standalone, simply skip that file or exclude it from your apply command. | ||
|
|
||
| ### NebariApp in Helm charts |
There was a problem hiding this comment.
The "Helm" section of docs/nebariapp-crd-reference.md (and its copy in docs/site/src/content/docs/nebariapp-crd-reference.md) still shows the hand-written template, plus a values block with service.name: "" # Defaults to release fullname. That default is gone now: an empty name fails with spec.service.name is required. The README links to that page as the complete field reference, so readers get two contradicting recipes. We should replace both copies of that section with the nebari-app.nebariApp include shown here, or link to this section.
Reference Issues or PRs
What does this implement/fix?
Put a
xin the boxes that applyTesting
Documentation
Access-centered content checklist
Text styling
H1or#in markdown).Non-text content
Any other comments?