Skip to content

NebariApp CRD Reference

Updated 1 min read

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.

ForGo to
What a pack must do to run on the platformNebari Pack Specification
Every field, type, and defaultNebariApp API reference, generated from the Go types
How the operator reconciles a NebariAppoperator reconciler docs
Step-by-step onboarding with the nebari-app chartOnboarding 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.

Worked examples, which is what a template is for. Each examples/ directory onboards the same app a different way:

ExampleShows
examples/vanilla-yamlThe plainest possible NebariApp, no templating
examples/basic-nginxA minimal Helm chart that renders one
examples/kustomize-nginxA Kustomize base with dev and production overlays
examples/wrap-existing-chartWrapping an upstream chart you do not control
examples/auth-fastapiAn 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.

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.