Skip to content

docs(release): cut qualified three-stack documentation - #1941

Merged
sbaum1994 merged 1 commit into
mainfrom
docs/cut-cp-0-20-6-compute-0-4-4-obs-0-2-2
Sep 16, 2026
Merged

sbaum1994 merged 1 commit into
mainfrom
docs/cut-cp-0-20-6-compute-0-4-4-obs-0-2-2

Conversation

@sbaum1994

@sbaum1994 sbaum1994 commented Sep 16, 2026

Copy link
Copy Markdown
Collaborator

TL;DR

Publishes an immutable documentation version for the QA-qualified control-plane 0.20.6, compute-plane 0.4.4, and observability 0.2.2 stack set. All three stack resources are available from the public nvidia/nvcf registry.

Additional Details

Why

QA needs one stable documentation version that identifies the exact three-stack combination under qualification. The stack publications have completed, so the frozen manifest and download instructions can use their public locations.

What changed

  • Adds the cp-0.20.6-compute-0.4.4-obs-0.2.2 documentation snapshot, catalog snapshot, and Fern navigation file.
  • Makes the qualified stack set the default documentation version, adds it to the version dropdown, and uses the concise Latest (cp-0.20.6-compute-0.4.4-obs-0.2.2) label.
  • Records public download locations for the control-plane 0.20.6, compute-plane 0.4.4, and observability 0.2.2 stack resources in the frozen release.
  • Keeps development docs synchronized with control-plane 0.20.7, compute-plane 0.4.4, and observability 0.2.2 after cutting the qualified snapshot.
  • Keeps the new 0.20.7 control-plane bundle and state-metrics versions marked publication pending in development docs.
  • Uses version-local links in the frozen snapshot so both the default and explicitly versioned Fern routes validate.
  • Treats docs/cp-*/ as frozen versioned documentation in lint configuration and contributor guidance.
  • Adds placeholder release notes and an upgrade guide outline for moving from nvcf-self-managed-stack 0.6.1 to 0.20.6.
  • Moves gRPC Invocation Enablement from Deployment to Configuration in the qualified and development navigation.

Customer Release Notes

Adds versioned documentation for the qualified NVCF self-managed stack set.

Plan Summary

Not applicable.

Usage

Select cp-0.20.6-compute-0.4.4-obs-0.2.2 from the documentation version dropdown.

Notes

The three exact stack resources were verified anonymously in NGC. Each resource is signed, upload-complete, and malware-scan clean.

Related Pull Requests

Dependencies

None. This change adds no third-party dependencies and requires no license or NOTICE update.

For the Reviewer

Please focus on the frozen catalog, generated manifest and image-mirroring pages, and Fern version routing.

For QA

QA needed: No additional product QA. The documentation snapshot records the supplied QA-qualified release set.

Validation completed:

  • go test -C tools/docs-version-sync ./...
  • go vet -C tools/docs-version-sync ./...
  • ./tools/scripts/test/test-cut-docs-version
  • ./tools/ci/check-doc-version-sync
  • env -u GITHUB_TOKEN ./tools/ci/check-doc-version-current-release
  • ./tools/ci/check-docs
  • git diff --check

Issues

Relates to #1845

Checklist

  • I am familiar with the Contributing Guidelines.
  • I have signed off my commits for Developer Certificate of Origin (DCO) compliance.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

Summary by CodeRabbit

  • Documentation

    • Added comprehensive self-hosted NVCF documentation covering installation, configuration, cluster management, functions, tasks, gateways, autoscaling, observability, troubleshooting, and operational runbooks.
    • Added release documentation and navigation for the qualified NVCF stack version.
    • Updated user guides with current stack versions, artifact availability, and download behavior.
    • Improved documentation organization, including versioned navigation and clearer gRPC placement.
  • Chores

    • Updated documentation lint exclusions and version-generation behavior.
    • Refreshed publication metadata and state-metrics versions.

@sbaum1994
sbaum1994 requested review from a team as code owners September 16, 2026 20:24
@sbaum1994
sbaum1994 requested a review from vrv3814 September 16, 2026 20:24
@coderabbitai

coderabbitai Bot commented Sep 16, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: b0869e1f-db21-4f8f-b711-db81fbaced5f

📥 Commits

Reviewing files that changed from the base of the PR and between c1dd7c6 and c642753.

⛔ Files ignored due to path filters (17)
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/apipersonalkey.png is excluded by !**/*.png, !**/*.png
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/grpc-reconnect-flow.png is excluded by !**/*.png, !**/*.png
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/grpc-single-client.png is excluded by !**/*.png, !**/*.png
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/lls-self-hosted-arch-streaming-proxy.png is excluded by !**/*.png, !**/*.png
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/low-latency-streaming.png is excluded by !**/*.png, !**/*.png
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/nvcf-banner.svg is excluded by !**/*.svg
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/nvcf-gpu-cluster-targeting.svg is excluded by !**/*.svg
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/nvcf-grpc-invocation-path.svg is excluded by !**/*.svg
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/nvcf-grpc-multicluster-invocation.svg is excluded by !**/*.svg
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/nvcf-high-level-stack.svg is excluded by !**/*.svg
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/nvcf-http-invocation-path.svg is excluded by !**/*.svg
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/nvcf-http-multicluster-invocation.svg is excluded by !**/*.svg
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/nvcf-llm-invocation-path.svg is excluded by !**/*.svg
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/nvcf-llm-multicluster-invocation.svg is excluded by !**/*.svg
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/nvcf-lls-session.png is excluded by !**/*.png, !**/*.png
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/nvcf-multi-region-multi-cluster.svg is excluded by !**/*.svg
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/images/self-hosted-min-topology.png is excluded by !**/*.png, !**/*.png
📒 Files selected for processing (106)
  • .markdownlintignore
  • docs/AGENTS.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/api.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/autoscaling/architecture.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/autoscaling/index.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/autoscaling/observability.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/autoscaling/operations.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/caches.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/cli.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/cluster-management/configuration.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/cluster-management/container-cache.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/cluster-management/gang-scheduling.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/cluster-management/gxcache.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/cluster-management/index.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/cluster-management/kai-scheduler.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/cluster-management/model-cache.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/cluster-management/monitoring.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/cluster-management/multi-tenancy.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/cluster-management/nsight-profiling.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/cluster-management/reference.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/cluster-management/self-managed.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/cluster-management/topology-aware-scheduling.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/configure-autoscaling.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/container-functions.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/container-tasks.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/control-plane-installation.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/control-plane-operations.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/csp-end-to-end-example-installation.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/example-dashboards.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/fake-gpu-operator.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/function-creation.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/gateway-routing.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/generic-http-function-invocation.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/grpc-function-invocation.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/grpc-invocation-enablement.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/grpc-load-test-sli-guide.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/grpc-load-testing.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/helm-functions.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/helm-tasks.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/helmfile-installation.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/http-load-test-sli-guide.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/http-load-testing.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/http-soak-testing.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/image-mirroring.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/index.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/infrastructure-sizing.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/installation.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/llm-function-enablement.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/llm-gateway.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/llm-request-router-load-balancing.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/lls-installation.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/local-development.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/local-development/multi-cluster-cli.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/local-development/multi-cluster-helmfile.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/local-development/single-cluster-cli.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/local-development/single-cluster-helmfile.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/manifest.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/metrics/cassandra/metrics.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/metrics/ess/metrics.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/metrics/grpc-proxy/metrics.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/metrics/init-container/metrics.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/metrics/invocation-service/metrics.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/metrics/llm-api-gateway/metrics.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/metrics/llm-function-invocation-path.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/metrics/llm-request-router/metrics.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/metrics/metrics-index.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/metrics/nvcf-api/metrics.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/metrics/sis-spot/metrics.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/metrics/state-metrics/metrics.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/metrics/utils-container/metrics.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/metrics/vault-openbao/metrics.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/nvcf-ui.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/observability.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/optional-enhancements-gpu.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/optional-enhancements-standalone.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/optional-enhancements.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/pod-disruption-budgets.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/quickstart.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/registry-allowlist.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/release-notes/0.20.6.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/release-notes/0.6.1-to-0.20.6-upgrade.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/release-notes/index.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/runbooks/caches.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/runbooks/control-plane-key-rotation-mek.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/runbooks/index.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/runbooks/overview.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/runbooks/transport-tls-rotation.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/runbooks/update-nvcf-account-quota-limits.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/samples/configs/cp-env-eks-example.yaml
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/samples/configs/cp-example-secrets.yaml
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/samples/configs/local-dev-env.yaml
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/samples/scripts/create-nvcr-pull-secrets.sh
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/samples/scripts/force-cleanup-nvcf.sh
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/streaming-functions.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/task-creation.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/third-party-registries.md
  • docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/troubleshooting.md
  • docs/user/image-mirroring.md
  • docs/user/manifest.md
  • docs/version-catalog/cp-0.20.6-compute-0.4.4-obs-0.2.2.yaml
  • docs/version-catalog/main.yaml
  • fern/docs.yml
  • fern/versions/cp-0.20.6-compute-0.4.4-obs-0.2.2.yml
  • fern/versions/dev.yml
  • tools/scripts/cut-docs-version.sh
  • tools/scripts/test/test-cut-docs-version

📝 Walkthrough

Walkthrough

This PR adds a versioned self-hosted NVCF documentation set. It covers deployment, APIs, cluster management, observability, operations, runbooks, samples, release metadata, navigation, manifests, and version publishing updates.

Changes

Versioned self-hosted documentation

Layer / File(s) Summary
Documentation foundation and user workflows
docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/*.md, docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/local-development/*
Added guidance for APIs, CLI usage, functions, tasks, invocation, Gateway routing, installation, autoscaling, and local development.
Cluster management and deployment operations
docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/cluster-management/*, docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/helmfile-installation.md, docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/troubleshooting.md
Added NVCA configuration, scheduling, caching, profiling, installation, registry, deployment, and recovery procedures.
Observability and operational runbooks
docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/metrics/*, docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/*load*, docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/runbooks/*, docs/cp-0.20.6-compute-0.4.4-obs-0.2.2/observability.md
Added metrics references, load-testing guides, streaming operations, key-rotation procedures, TLS-rotation procedures, and quota-management runbooks.
Release metadata and publishing configuration
docs/version-catalog/*, docs/user/manifest.md, docs/user/image-mirroring.md, fern/*, tools/scripts/*
Added the qualified version catalog, updated publication status and stack versions, added Fern navigation, and simplified the generated Latest label.

Estimated code review effort: 4 (Complex) | ~60 minutes

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/cut-cp-0-20-6-compute-0-4-4-obs-0-2-2

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

@sbaum1994
sbaum1994 force-pushed the docs/cut-cp-0-20-6-compute-0-4-4-obs-0-2-2 branch from bef1849 to 08bd7f9 Compare September 16, 2026 20:28
@sbaum1994
sbaum1994 force-pushed the docs/cut-cp-0-20-6-compute-0-4-4-obs-0-2-2 branch 2 times, most recently from faacf8f to 3a21729 Compare September 16, 2026 21:02
@sbaum1994
sbaum1994 requested a review from a team as a code owner September 16, 2026 21:02
Publish the QA-qualified control-plane 0.20.6, compute-plane 0.4.4, and observability 0.2.2 documentation as an immutable Fern version.

Keep development docs synchronized with the newer control-plane 0.20.7 release while preserving the qualified catalog and public stack locations in the frozen snapshot.

Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
@sbaum1994
sbaum1994 force-pushed the docs/cut-cp-0-20-6-compute-0-4-4-obs-0-2-2 branch from 3a21729 to c642753 Compare September 16, 2026 21:07
@sbaum1994
sbaum1994 enabled auto-merge September 16, 2026 21:08
@sbaum1994
sbaum1994 added this pull request to the merge queue Sep 16, 2026
Merged via the queue into main with commit a52285c Sep 16, 2026
21 of 22 checks passed
@sbaum1994
sbaum1994 deleted the docs/cut-cp-0-20-6-compute-0-4-4-obs-0-2-2 branch September 16, 2026 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants