docs(self-managed): update 0.6.1 RC stack artifacts - #462
Conversation
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe 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. ChangesDeployment documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
🌿 Preview your docs: https://nvidia-preview-docs-0-6-1-rc-stack-tag.docs.buildwithfern.com/nvcf |
There was a problem hiding this comment.
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 winFrozen versioned docs need an explicit exception
docs/v0.6.1-rc/manifest.mdsits in the frozendocs/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
📒 Files selected for processing (1)
docs/v0.6.1-rc/manifest.md
|
Still waiting on an additional cassandra migration version - do not merge. |
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>
171d5a8 to
f855983
Compare
There was a problem hiding this comment.
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
📒 Files selected for processing (7)
docs/user/csp-end-to-end-example-installation.mddocs/user/grpc-invocation-enablement.mddocs/user/helmfile-installation.mddocs/user/installation.mddocs/v0.6.1-rc/image-mirroring.mddocs/v0.6.1-rc/manifest.mdfern/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
Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
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
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
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
Summary by CodeRabbit
0.6.1-rc.6for control-plane artifact selection/download.0.6.1-rc.6bundle.