docs(v2.0): add release notes for NTP subchart, REST DB consolidation, and NVSwitch cred rotation - #3631
Conversation
0583e9b to
8fc8d28
Compare
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3631.docs.buildwithfern.com/infra-controller |
🔍 Container Scan Summary
Per-CVE detail lives in the per-service |
polarweasel
left a comment
There was a problem hiding this comment.
BTW, I've just opened a PR to replace the release-notes format with a changelog. Have a look at #3637 if you like.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (2)
Summary by CodeRabbit
WalkthroughThe documentation adds configuration guidance for the built-in ChangesInfra Controller documentation and policy
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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/getting-started/quick-start.md`:
- Line 227: Update the NTP setup guidance in the quick-start documentation to
explicitly require setting nico-ntp.externalService.enabled to true alongside
assigning the VIPs and configuring ntpServer. Preserve the existing distinction
between DPU DHCP NTP configuration and siteConfig.ntp_servers for BMC
synchronization.
In `@docs/release-notes.md`:
- Line 13: Update the release-note sentence around “To enable” so the
imperative/action phrase is plain text, while retaining bold formatting only for
literal configuration values or user-entered text.
- Around line 31-35: Update the Vault policy configuration for the
nico-vault-policy role so the KV v2 destroy/switch_nvos/* path grants update
instead of delete, while preserving metadata delete access and the documented
destroy-path capability. Ensure the release notes reflect the corrected destroy
capability.
🪄 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: a3e47ff2-785e-49af-a7dc-de54dc9c9a56
📒 Files selected for processing (2)
docs/getting-started/quick-start.mddocs/release-notes.md
4fdc450 to
09917fb
Compare
…, and NVSwitch cred rotation - Add Infra Controller v2.0 section to release-notes.md covering: - nico-ntp chrony subchart with per-pod MetalLB VIPs (NVIDIA#2167) - REST DB consolidation onto shared nico-pg-cluster with upgrade path (NVIDIA#3182) - NVSwitch NVOS credential rotation via expanded Vault policy (NVIDIA#2760) - Update outdated NTP note in quick-start.md: nico-ntp is now bundled, replace the "NICo does not run a standalone NTP service" paragraph
- Split the quick-start NTP note into feature description and usage guidance per review suggestion. - Correct upgrade-note version references: there was no 1.x release; the REST DB consolidation upgrade path is v0.x -> v2.0.
… docs - Grant update instead of delete on the KV v2 destroy/switch_nvos path: Vault KV v2 destroys secret versions via POST (update capability); the delete grant was inert. Metadata delete access is unchanged. - Reflect the corrected capability in the release notes. - Document that nico-ntp.externalService.enabled must be set alongside the per-pod VIP annotations in the quick-start. - Unbold the imperative 'To enable' phrase per docs style.
09917fb to
a86f466
Compare
…, and NVSwitch cred rotation (NVIDIA#3631) Adds the v2.0 section to `docs/release-notes.md` and fixes an outdated NTP note in `docs/getting-started/quick-start.md`. **`docs/release-notes.md` — new v2.0 section covering:** - `nico-ntp` chrony NTP subchart with per-pod MetalLB VIPs and configuration instructions (NVIDIA#2167) - REST database consolidation onto shared `nico-pg-cluster`, including what changed and a step-by-step upgrade path from v1.x (NVIDIA#3182) - NVSwitch NVOS credential rotation enabled via expanded Vault policy for `switch_nvos` paths (NVIDIA#2760) **`docs/getting-started/quick-start.md`:** - Replaces the outdated "NICo does not run a standalone NTP service" note with accurate guidance reflecting the bundled `nico-ntp` subchart - [ ] Docs render correctly in the docs site - [ ] All three v2.0 items accurately reflect what shipped in their respective PRs Signed-off-by: Shayan Namaghi <snamaghi@nvidia.com>
Summary
Adds the v2.0 section to
docs/release-notes.mdand fixes an outdated NTP note indocs/getting-started/quick-start.md.Changes
docs/release-notes.md— new v2.0 section covering:nico-ntpchrony NTP subchart with per-pod MetalLB VIPs and configuration instructions (feat(nico-ntp): add chrony NTP helm subchart #2167)nico-pg-cluster, including what changed and a step-by-step upgrade path from v1.x (chore(v2.0): Consolidate REST service DBs into shared nico-pg-cluster #3182)switch_nvospaths (fix(helm-prereqs): Add switch_nvos vault policy paths for switch ingestion #2760)docs/getting-started/quick-start.md:nico-ntpsubchartTest plan