NebariApp CRD Reference
Where to find the NebariApp contract and its field reference.
API Version: reconcilers.nebari.dev/v1
Kind: NebariApp
This page used to hold a hand-maintained copy of the NebariApp field reference. It no longer
does, because the copy went stale: it tracked operator v0.1.0-alpha.19 while the operator
moved on, and nothing detected the drift. Two copies of it lived in this repository, and the
operator generates a third from the Go types.
The contract now has one home, next to the code that enforces it.
Where to look instead
Section titled “Where to look instead”| For | Go to |
|---|---|
| What a pack must do to run on the platform | Nebari Pack Specification |
| Every field, type, and default | NebariApp API reference, generated from the Go types |
| How the operator reconciles a NebariApp | operator reconciler docs |
Step-by-step onboarding with the nebari-app chart | Onboarding an app |
The API reference is generated by make docs in the operator repository, so it cannot fall
behind the types the way this page did.
What this repository still gives you
Section titled “What this repository still gives you”Worked examples, which is what a template is for. Each examples/ directory onboards the
same app a different way:
| Example | Shows |
|---|---|
examples/vanilla-yaml | The plainest possible NebariApp, no templating |
examples/basic-nginx | A minimal Helm chart that renders one |
examples/kustomize-nginx | A Kustomize base with dev and production overlays |
examples/wrap-existing-chart | Wrapping an upstream chart you do not control |
examples/auth-fastapi | An app reading the identity token the platform provides |
For the authentication sequence end to end, see Authentication flow. Requirements for promoting a pack are in the release readiness checklist.
Changing the contract
Section titled “Changing the contract”The requirements in the Pack Specification are governed by the Core team through a platform
RFD in nebari-dev/governance. Opening a pull
request against the specification without an accepting RFD is not the route.