docs(architecture): add ARCHITECTURE.md with three-plane component overview#13
Open
saiyam1814 wants to merge 1 commit intoNVIDIA:mainfrom
Open
docs(architecture): add ARCHITECTURE.md with three-plane component overview#13saiyam1814 wants to merge 1 commit intoNVIDIA:mainfrom
saiyam1814 wants to merge 1 commit intoNVIDIA:mainfrom
Conversation
…erview Adds ARCHITECTURE.md at the repository root covering: - ASCII diagram of the control/invocation/compute plane topology with all five invocation-plane services including nats-auth-callout - Component responsibility table for all 13 services - Step-by-step single request lifecycle (12 steps, sync and async) - Scale-to-zero mechanism via NATS JetStream durable buffering - Multi-cluster routing using per-cluster NATS JetStream subjects (source: nvca/pkg/queue/nats/client.go) - Function workload types (container, Helm, task variants) - CRD hierarchy with verified API groups (nvcf/v1, nvca/v2beta1, nvca/v1alpha1) - Links to all 10 AGENTS.md files that exist in the repository New contributors currently reconstruct this picture by reading across multiple AGENTS.md files, the helmfile, proto definitions, and source code. A single canonical document at the repo root lowers the onboarding barrier and provides a shared reference for design discussions. JIRA: NO-REF NVBug: none Signed-off-by: Saiyam Pathak <saiyam911@gmail.com>
saiyam1814
force-pushed
the
saiyam/docs/architecture-overview
branch
from
53aa806 to
43900f3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TL;DR
Adds
ARCHITECTURE.mdat the repository root covering the three-plane topology, component responsibilities, single-request lifecycle, scale-to-zero mechanism, multi-cluster routing, workload types, and CRD hierarchy.Additional Details
New contributors currently reconstruct the full architecture picture by reading across multiple
AGENTS.mdfiles, the helmfile, proto definitions, and source code. A single canonical document at the repo root lowers the onboarding barrier and gives a shared reference for design discussions.Every claim in the document is directly derived from source:
src/compute-plane-services/nvca/pkg/queue/nats/client.gosrc/compute-plane-services/nvca/pkg/apis/nvca/internal/miniservice/andhttp-invocationcratesFor the Reviewer
The ASCII diagram is intentionally text-based (no external image dependency). If the team prefers Mermaid, happy to convert.
For QA
Documentation only - no behavior change.
Issues
NO-REF
Checklist