Skip to content

docs(self-managed): update 0.6.1 RC stack artifacts - #462

Merged
sbaum1994 merged 8 commits into
mainfrom
docs/0.6.1-rc-stack-tag
Jul 30, 2026
Merged

docs(self-managed): update 0.6.1 RC stack artifacts#462
sbaum1994 merged 8 commits into
mainfrom
docs/0.6.1-rc-stack-tag

Conversation

@sbaum1994

@sbaum1994 sbaum1994 commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Why

The published 0.6.1-rc.6 artifact list supersedes the earlier RC manifest values. Cassandra migrations must use 0.10.3, which preserves the legacy ESS authorization records needed for task creation.

What changed

  • Updated the versioned self-managed stack resource and download examples to 0.6.1-rc.6.
  • Updated the versioned Cassandra migrations artifact to 0.10.3.
  • Audited all artifacts in the published control-plane RC list against the manifest. The remaining manifest-only entries belong to separately versioned compute-plane or optional bundles.

Customer Release Notes

The 0.6.1 RC documentation now lists the latest qualified control-plane stack and Cassandra migrations artifacts.

Plan Summary

Not applicable. This is a documentation-only change.

Usage

Use 0.6.1-rc.6 when downloading the 0.6.1 RC self-managed stack.

Testing

  • Compared the published 0.6.1-rc.6 artifact list with the versioned manifest.
  • Ran ./tools/ci/check-docs. It passed; the version-sync subcheck was advisory because this isolated PR checkout does not include imports.yaml.
  • Ran git diff --check.

Notes

The artifact list includes one intentionally excluded component; its versioned documentation remains an unpinned placeholder.

References

Relates to #407.

Related Pull Requests

Dependencies

No new or updated third-party dependencies. License review and NOTICE changes are not applicable.

Checklist

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

Summary by CodeRabbit

  • Documentation
    • Updated image-mirroring command snippets to use release version 0.6.1-rc.6 for control-plane artifact selection/download.
    • Refreshed self-managed deployment artifact inventory (Cassandra, migrations, and stack bundle versions) to match the latest 0.6.1-rc.6 bundle.
    • Updated installation and grpc-proxy docs to reference the local “CSP End-to-End Example” page.
    • Added the “CSP End-to-End Example” page to the documentation navigation.

@sbaum1994
sbaum1994 requested a review from a team as a code owner July 26, 2026 15:05
@sbaum1994
sbaum1994 requested a review from FamousDirector July 26, 2026 15:05
@coderabbitai

coderabbitai Bot commented Jul 26, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

The documentation adds a CSP end-to-end Helmfile installation guide, links it from related installation pages and navigation, and updates v0.6.1-rc artifact references for the stack bundle, Cassandra, and migrations images.

Changes

Deployment documentation

Layer / File(s) Summary
CSP end-to-end installation guide
docs/user/csp-end-to-end-example-installation.md
Adds prerequisites and ordered instructions for Gateway, control-plane configuration and installation, CLI setup, GPU registration, NVCA installation, verification, cluster comparison, and troubleshooting.
CSP guide documentation links
fern/versions/dev.yml, docs/user/grpc-invocation-enablement.md, docs/user/helmfile-installation.md, docs/user/installation.md
Adds the guide to deployment navigation and replaces external CSP example links with the local documentation path.
Release artifact references
docs/v0.6.1-rc/image-mirroring.md, docs/v0.6.1-rc/manifest.md
Updates stack references to 0.6.1-rc.6, Cassandra to 5.0.8-nv-2.0.1, and Cassandra migrations to 0.10.3.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: famousdirector

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title follows Conventional Commits and accurately summarizes this docs-only update to self-managed 0.6.1 RC artifacts.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/0.6.1-rc-stack-tag

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

@github-actions

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/v0.6.1-rc/manifest.md (1)

143-143: 📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win

Frozen versioned docs need an explicit exception
docs/v0.6.1-rc/manifest.md sits in the frozen docs/v*/ tree; these artifact/version updates should only land with an explicit historical-docs exception, otherwise move them to the unfrozen source.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/v0.6.1-rc/manifest.md` at line 143, Do not update the frozen versioned
manifest entry for cassandra in docs/v0.6.1-rc/manifest.md without an explicit
historical-docs exception; move the artifact/version change to the unfrozen
source documentation instead, unless that exception is provided.

Source: Coding guidelines

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@docs/v0.6.1-rc/manifest.md`:
- Line 143: Do not update the frozen versioned manifest entry for cassandra in
docs/v0.6.1-rc/manifest.md without an explicit historical-docs exception; move
the artifact/version change to the unfrozen source documentation instead, unless
that exception is provided.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 2464c835-d65b-4a38-9ca0-65008c755bf4

📥 Commits

Reviewing files that changed from the base of the PR and between 1709c56 and 0a1d9a6.

📒 Files selected for processing (1)
  • docs/v0.6.1-rc/manifest.md

@sbaum1994

Copy link
Copy Markdown
Contributor Author

Still waiting on an additional cassandra migration version - do not merge.

@sbaum1994 sbaum1994 changed the title docs(self-managed): update 0.6.1 RC stack artifacts Draft: docs(self-managed): update 0.6.1 RC stack artifacts Jul 27, 2026
@sbaum1994 sbaum1994 changed the title Draft: docs(self-managed): update 0.6.1 RC stack artifacts docs(self-managed): update 0.6.1 RC stack artifacts Jul 29, 2026
Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
Align the versioned manifest and download examples with the published 0.6.1-rc.6 artifact list.

Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
Port the CSP Helmfile installation example into the current documentation and link it from the deployment guides.

Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
@sbaum1994
sbaum1994 force-pushed the docs/0.6.1-rc-stack-tag branch from 171d5a8 to f855983 Compare July 30, 2026 04:09
@sbaum1994
sbaum1994 requested a review from a team as a code owner July 30, 2026 04:09

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/user/csp-end-to-end-example-installation.md`:
- Around line 42-50: Update the fenced block containing the end-to-end
installation steps to use an explicit text language identifier by changing its
opening fence to ```text, without modifying the documented steps.
- Around line 16-18: Update the relative links in the new guide, including the
Helmfile Installation and Image Mirroring references and the additional
occurrences noted by the review, to use ./ paths targeting documents under
docs/user. Ensure the cluster-management link uses
./cluster-management/self-managed.md#prerequisites and apply the same correction
consistently to all affected links.
- Around line 93-120: Separate the DNS domain from the load-balancer endpoint
throughout the guide: add a STACK_DOMAIN environment variable that users must
back with DNS records or a wildcard, retain GATEWAY_ADDR solely for connecting
to the load balancer, and replace hostname construction and related route hosts,
worker endpoints, CLI host fields, and Host-header overrides in the documented
setup flow with STACK_DOMAIN.
- Around line 554-555: Update the kubeconfig generation instructions around
COMPUTE_KUBECONFIG to protect the raw credential-bearing file: create it with
restrictive permissions using umask 077, and add cleanup guidance or a trap to
remove it when no longer needed. Clearly warn users not to commit the generated
file, while preserving the existing COMPUTE_KUBECONFIG usage.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 248c82ee-d268-4405-8c33-50c3e9915682

📥 Commits

Reviewing files that changed from the base of the PR and between 171d5a8 and f855983.

📒 Files selected for processing (7)
  • docs/user/csp-end-to-end-example-installation.md
  • docs/user/grpc-invocation-enablement.md
  • docs/user/helmfile-installation.md
  • docs/user/installation.md
  • docs/v0.6.1-rc/image-mirroring.md
  • docs/v0.6.1-rc/manifest.md
  • fern/versions/dev.yml
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/v0.6.1-rc/manifest.md
  • docs/v0.6.1-rc/image-mirroring.md

Comment thread docs/user/csp-end-to-end-example-installation.md
Comment thread docs/user/csp-end-to-end-example-installation.md
Comment thread docs/user/csp-end-to-end-example-installation.md
Comment thread docs/user/csp-end-to-end-example-installation.md
Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
@sbaum1994
sbaum1994 enabled auto-merge July 30, 2026 05:12
@sbaum1994
sbaum1994 added this pull request to the merge queue Jul 30, 2026
Merged via the queue into main with commit f52ce65 Jul 30, 2026
17 checks passed
@sbaum1994
sbaum1994 deleted the docs/0.6.1-rc-stack-tag branch July 30, 2026 05:33
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