Skip to content

Software Packs: hands-on NebariApp walkthrough #675

Description

@khuyentran1401

Goal

A hands-on tutorial that walks pack authors and curious platform engineers through deploying a NebariApp on a local Kind cluster end-to-end. Readers should be able to see the operator wire up routing, TLS, and auth in practice, on their own laptop, in under 10 minutes.

Scope

New tutorial page under docs/docs/software-packs/ (exact path per IA decision):

  • Prerequisites: Docker, kubectl, Kind, make
  • Steps to set up the dev cluster, install the operator, and deploy a sample NebariApp against a hello-world Service
  • A second pass that enables auth and shows the Keycloak login flow
  • Cleanup instructions

The page can be authored as a thin wrapper that points readers at the operator's existing quickstart, or as a self-contained walkthrough on nebari.dev. The decision is part of this issue.

Out of scope

  • Documenting every NebariApp field (handled by reference docs sub-issue)
  • Building a pack from the template (handled by "Build your own pack" sub-issue)
  • Operator install on a production cluster (separate operational how-to)

Acceptance criteria

  • A reader can go from zero to a working NebariApp on Kind by following the page alone
  • The page shows what the operator creates (HTTPRoute, Certificate, Keycloak OAuth client) and how to verify each is wired up
  • Decision is recorded about whether to mirror the quickstart on nebari.dev or wrap it as a pointer page

Resources

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Fields

Priority

None yet

Start date

None yet

Target date

None yet

Size

None yet

Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions