Skip to content

use official NebariApp CR template - #32

Merged
dcmcand merged 2 commits into
mainfrom
nebari-app-template
Oct 1, 2026
Merged

dcmcand merged 2 commits into
mainfrom
nebari-app-template

Conversation

@pmeier

@pmeier pmeier commented Sep 30, 2026 •

Copy link
Copy Markdown
Member

Reference Issues or PRs

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Any other comments?

@pmeier
pmeier marked this pull request as ready for review September 30, 2026 15:23
@pmeier
pmeier requested a review from dcmcand September 30, 2026 15:23
@pmeier

pmeier commented Sep 30, 2026

Copy link
Copy Markdown
Member Author

@dcmcand Does this PR somewhat replace your #30?

* docs: document nebari-app library chart usage

* docs: address review feedback on nebari-app docs
@github-actions

github-actions Bot commented Oct 1, 2026

Copy link
Copy Markdown

📄 Docs preview for nebari-app-template:
https://nebari-app-template.nebari-software-pack-template.pages.dev

@dcmcand dcmcand left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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) \

Comment thread README.md
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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@dcmcand
dcmcand merged commit 427e89e into main Oct 1, 2026
4 checks passed
@dcmcand
dcmcand deleted the nebari-app-template branch October 1, 2026 10:36
@pmeier pmeier mentioned this pull request Oct 1, 2026
3 of 18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants