Skip to content

docs(v2.0): add release notes for NTP subchart, REST DB consolidation, and NVSwitch cred rotation - #3631

Merged
shayan1995 merged 3 commits into
NVIDIA:mainfrom
shayan1995:docs/v2.0-release-notes
Jul 22, 2026
Merged

docs(v2.0): add release notes for NTP subchart, REST DB consolidation, and NVSwitch cred rotation#3631
shayan1995 merged 3 commits into
NVIDIA:mainfrom
shayan1995:docs/v2.0-release-notes

Conversation

@shayan1995

Copy link
Copy Markdown
Contributor

Summary

Adds the v2.0 section to docs/release-notes.md and fixes an outdated NTP note in docs/getting-started/quick-start.md.

Changes

docs/release-notes.md — new v2.0 section covering:

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

Test plan

  • Docs render correctly in the docs site
  • All three v2.0 items accurately reflect what shipped in their respective PRs

@shayan1995
shayan1995 requested a review from polarweasel as a code owner July 16, 2026 22:28
@copy-pr-bot

copy-pr-bot Bot commented Jul 16, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@shayan1995
shayan1995 force-pushed the docs/v2.0-release-notes branch from 0583e9b to 8fc8d28 Compare July 16, 2026 22:34
@github-actions

Copy link
Copy Markdown

@github-actions

github-actions Bot commented Jul 16, 2026

Copy link
Copy Markdown

🔍 Container Scan Summary

Service Total Critical High Medium Low Other
boot-artifacts-aarch64 3 0 0 3 0 0
boot-artifacts-x86_64 3 0 0 3 0 0
forge-admin-cli-x86_64 259 16 29 79 7 128
machine-validation-runner 538 41 117 184 15 181
machine_validation 538 41 117 184 15 181
machine_validation-aarch64 538 41 117 184 15 181
TOTAL 1879 139 380 637 52 671

Per-CVE detail lives in the per-service grype-* artifacts (JSON + SARIF). Severity counts only — no CVE IDs published here.

@polarweasel polarweasel left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

BTW, I've just opened a PR to replace the release-notes format with a changelog. Have a look at #3637 if you like.

Comment thread docs/getting-started/quick-start.md Outdated
Comment thread docs/release-notes.md Outdated
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 1e4e07f1-8bad-4075-877e-b9c93e743a44

📥 Commits

Reviewing files that changed from the base of the PR and between 9b2a5c0 and 4fdc450.

📒 Files selected for processing (3)
  • docs/getting-started/quick-start.md
  • docs/release-notes.md
  • helm-prereqs/templates/vault-config-job.yaml
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/release-notes.md
  • docs/getting-started/quick-start.md

Summary by CodeRabbit

  • New Features
    • Added a built-in, highly available NTP service (nico-ntp) with dedicated network endpoints for DPU time synchronization via DHCP.
    • Enabled automated NVSwitch NVOS credential rotation.
  • Upgrade Notes
    • Documented Infra Controller v2.0 migration of the REST API PostgreSQL database from standalone to the shared PostgreSQL cluster, including required database/user provisioning, credential syncing, and the v0.x upgrade path.
  • Documentation
    • Updated quick-start guidance for configuring MetalLB/NTP endpoints and clarified that BMC pre-ingestion time synchronization is configured independently.

Walkthrough

The documentation adds configuration guidance for the built-in nico-ntp service and Infra Controller v2.0 release notes covering NTP, Vault policy changes, and REST database consolidation. The Vault policy grants update capability for NVSwitch credential paths.

Changes

Infra Controller documentation and policy

Layer / File(s) Summary
NTP configuration guidance
docs/getting-started/quick-start.md, docs/release-notes.md
Documents the three-replica nico-ntp chrony StatefulSet, per-pod MetalLB VIPs, DHCP option 42 configuration, and independent BMC time synchronization.
NVSwitch credential policy
helm-prereqs/templates/vault-config-job.yaml
Changes the switch_nvos destroy-path capability from delete to update.
REST database upgrade notes
docs/release-notes.md
Documents migration to nico-pg-cluster, nico_rest provisioning, ESO credential synchronization, updated waitForPostgres behavior, and the v0.x upgrade path.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main documented v2.0 release-note updates and related NTP/Vault changes.
Description check ✅ Passed The description is directly aligned with the docs and policy updates in this pull request.
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

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 435ccdc and 9b2a5c0.

📒 Files selected for processing (2)
  • docs/getting-started/quick-start.md
  • docs/release-notes.md

Comment thread docs/getting-started/quick-start.md Outdated
Comment thread docs/release-notes.md Outdated
Comment thread docs/release-notes.md Outdated
@shayan1995
shayan1995 requested a review from a team as a code owner July 21, 2026 23:55
@shayan1995
shayan1995 force-pushed the docs/v2.0-release-notes branch from 4fdc450 to 09917fb Compare July 22, 2026 20:36
…, 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.
@shayan1995
shayan1995 force-pushed the docs/v2.0-release-notes branch from 09917fb to a86f466 Compare July 22, 2026 20:40
@shayan1995
shayan1995 enabled auto-merge (squash) July 22, 2026 20:44
@mnoori-afk
mnoori-afk self-requested a review July 22, 2026 21:08
@shayan1995
shayan1995 merged commit 71d602f into NVIDIA:main Jul 22, 2026
63 checks passed
shayan1995 added a commit to shayan1995/ncx-infra-controller-core that referenced this pull request Jul 22, 2026
…, 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>
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.

4 participants