Skip to content

Write the NKP architecture explainer pageΒ #666

@khuyentran1401

Description

@khuyentran1401

Goal

Write a conceptual explainer page that gives readers a clear mental model of how NKP is structured, so they can reason about deployments, upgrades, and extension points without diving into code.

Scope

Page lives under docs/docs/explanations/ covering:

  • Layered architecture: cloud/bare-metal provider β†’ Kubernetes cluster β†’ foundational software (ingress, cert-manager, Keycloak, ArgoCD, storage) β†’ Nebari Operator β†’ Software Packs β†’ dynamic landing page.
  • The nic CLI: what it does (provisions Kubernetes + foundational layer), what it doesn't do (it is not an application manager).
  • GitOps via ArgoCD: how applications and packs are reconciled from Git, not imperatively installed.
  • State management: NIC tracks provisioned infrastructure (S3 / Azure Blob / GCS backends) with locking.
  • Separation of concerns: platform team vs. pack developer vs. end user; why infrastructure and applications evolve on independent lifecycles.

Out of scope

Acceptance criteria

  • Layered architecture is explained in prose (diagram comes from separate sub-issue).
  • Readers can articulate what the nic CLI does vs. doesn't do after reading.
  • GitOps role is explained at a conceptual level (not a how-to).

Resources

Most authoritative (code-audited): AGENTS.md in nebari-infrastructure-core (PR #297).

Repos:

Design docs in nebari-infrastructure-core (some claims may be aspirational and not yet shipped; cross-check against AGENTS.md):

Metadata

Metadata

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

Status

Todo πŸ“¬

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions