Skip to content

docs: publish 1.0.3 with legacy Self-Managed 0.6.2 notes - #2256

Merged
sbaum1994 merged 12 commits into
mainfrom
docs/2195-release-1.0.3
Oct 5, 2026
Merged

sbaum1994 merged 12 commits into
mainfrom
docs/2195-release-1.0.3

Conversation

@sbaum1994

@sbaum1994 sbaum1994 commented Oct 3, 2026 •

Copy link
Copy Markdown
Collaborator

TL;DR

Publish docs-only release 1.0.3 with the legacy Self-Managed 0.6.2 release notes, its focused patch upgrade procedure, and the link repairs from #2253. The default stack combination remains Self-Managed 1.0.1, Compute Plane 1.0.0, and Observability 1.0.0.

Additional Details

  • Port the useful 0.6.2 content from docs(self-managed): add 0.6.2 patch and staged upgrade documentation #2195 into the existing native changelog and Upgrade Notes sidebar. Do not add a separate product, selector entry, copied stack docs tree, or legacy snapshot tooling.
  • Describe 0.6.2 as a Helmfile bundle patch: OpenBao chart 0.30.25 to 0.32.6, JWT catalog refresh before migrations, unchanged runtime image pins. Use the published stable tag and inventory instead of stale candidate-publication wording.
  • Keep one onward migration guide at its existing URL. Require the intermediate 0.6.2 patch, preserve current pod-create waits, and document the recorded availability failures and remaining rehearsal limits.
  • Keep the 1.0.2 release note alongside the new 1.0.3 entry on the same publication date.
  • Register protected docs/releases/1.0.3 at 4890d84c89d0cfb0bc313a54afc3ecee02a098f9 as the default. Its source is the reviewed content commit c8467efa641a60d29dd2a25acf043b827310d7d5. Advance Development to 1.0.4. The existing 1.0.1 and 1.0.2 branch heads remain unchanged.
  • Add preview=canonical to the manual Fern preview workflow so operators can validate the exact published configuration and remote refs before a cutover.

For the Reviewer

#2253 is merged, and this PR targets main. The corrected 1.0.3 release branch already exists and is pinned above. Its effective rules again prohibit updates, deletion, and force pushes with no bypass actors; the user-approved unpublished correction was applied with an exact lease and protection was immediately restored and verified. Merging this PR has no branch-creation dependency.

The guide title, sidebar label, and release-note index now say 0.6.2 to 1.0.1. The existing URL and anchor remain valid. The corrected release preview passed rendered heading, sidebar, link, and anchor checks.

Start with the short 0.6.2 changelog entry, then the new patch procedure, then the existing onward guide's diff. Earlier 0.6.0-to-0.6.1 corrections from #2195 remain tracked by #2191; they are not silently copied into historical snapshots in this port.

For QA

Passed locally: canonical docs/release checks, Development layout validation, external links in the changed Markdown, Markdown lint, 43 parsed Bash snippets, and failure fixtures for pod deletion, creation wait, readiness, and OpenBao status. Verified that existing onward-guide pod-create/wait snippets remain intact.

The fresh stable 0.6.2-to-1.0.1 k3d rehearsal completed on 2026-10-04 as a user-approved limited function/deployment diagnostic. It reached Self-Managed 1.0.1 and Compute Plane 1.0.0 with NVCA/operator 3.10.0. Both full target control-plane and compute installs passed their repeat syncs.

Live QA check Result
Original function/deployment Retained the original IDs, specifications, API/database creation times, and selected database rows. Final invocation through released CLI 1.16.2 and the original API key returned the expected echo.
Cluster and storage Preserved cluster ID, cluster-group ID, backend resource UID, all nine PVC/volume identities, seven NATS stream names, and the NATS user key.
Final health Seven clean migration ledgers, three healthy Cassandra/OpenBao members, 31 ready controllers, and 19 deployed Helm releases. Fresh JWT issuance and secret injection passed.
Availability Failed: 110 failures among 2,664 monitored requests. OpenBao rotation produced 107 HTTP 401s; the later full sync produced two invocation HTTP 504s and one invocation transport error. No new failures during the repeats or compute upgrade.
Worker continuity Failed: utils restarted once after a NATS consumer timeout (#2260). The worker pod and inference container remained unchanged, with zero inference restarts.
Completed tasks Excluded with user approval because released source task-worker images at 2.107.0 were inaccessible (#2196). The retained error-health row migrated, which does not qualify successful tasks.

This is not a clean pass of the unmodified guide. Local QA required same-version upstream helper images (#2197), an explicit receipt version because the published 1.0.1 bundle contains VERSION=1.0.0 (#2258), and an explicit local profile after released CLI 1.16.2 hit the disabled-LLM PKI export bug described in #1550. The packaged VERSION file and released CLI were not edited. The active-instance API timestamps changed despite preserved underlying records (#2199). Cassandra/OpenBao backups were exported and checked; restore and durable queued-message retention were not exercised. Physical GPUs, ingress/TLS, optional add-ons, separate observability, and shared storage were outside this ARM64 single-host k3d test. Full qualification requires a new source run after resolving the blockers.

The earlier rehearsal's results remain accurately described in the guide; this new diagnostic's details are recorded here without modifying the frozen release content. Anonymous NGC resource access returned 403, so the instructions require obtaining and verifying the exact bundle through the operator's artifact distribution channel without claiming guest availability.

Hosted validation:

  • Content preview: native 0.6.2 and 1.0.3/1.0.2 release cards, patch/onward links, and preserved starting-state anchor passed.
  • Prepared 1.0.3 preview: the same checks passed. Both jobs in run 37160661877 succeeded.
  • Canonical preview passed: 1.0.3 is selected by default, all six tabs render, 1.0.2/1.0.1/Development switch correctly, the older 1.0.2 changelog retains its original content, and the new release cards, upgrade links, and historical anchor resolve. Both jobs in run 37161285623 passed.

Edition tooling tests passed. The prepared stack manifest, including source commits and inventory URLs, matches 1.0.2 exactly. On final head 5b28f0a7e364699a2d2b3d147edee4f437bb7ca3, all triggered CI checks and CodeRabbit pass. There are no unresolved review threads or merge conflicts; GitHub still requires review approval. The corrected release branch is already present and protected. No production publication or PR merge was triggered by this preparation.

Dependencies

No additional dependency changes beyond #2253. No runtime artifact changes or additional license/NOTICE impact.

Issues

Relates to #2191
Relates to #2214
Relates to #2254

Related PRs: #2195 (source content), #2190 (stack patch), #2253 (link checks and repairs).

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 an upgrade guide for moving from Self-Managed 0.6.1 to 0.6.2, including health checks, backup and recovery guidance, and deployment validation.
    • Updated the 1.0.1 upgrade guide to start from 0.6.2 and document rehearsal findings and availability limitations.
    • Added release notes for Self-Managed 0.6.2 and updated the 1.0.3 release notes and upgrade navigation.
    • Updated documentation editions and version selectors to include 1.0.3.
  • Chores
    • Added a canonical documentation preview option.

Run a live Fern link check after publication, weekly, or on demand. Retain the source-page report and reject incomplete scans while reporting blocked destinations separately.

Relates to #2214

Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
Correct the Dynamo 1.4.1 guide URL and pin the KAI template download to its verified source. Render the OTLP endpoint example as code and document authentication limitations in Fern reports.

Relates to #2254

Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
Replace the scheduled published-site scan with changed-file HTTP checks inside the existing required docs job, including merge-queue runs. Keep Fern internal and Development checks and retain the link report on failure.

Add checksum-pinned Lychee 0.24.2 for Markdown and MDX parsing and HTTP validation. Its MIT license is allowed; add CI attribution and regenerate NOTICE.

Relates to #2254

Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
Run the required docs validation workflow when a documentation PR targets another docs branch, so phased review has the same link checks before retargeting main.

Relates to #2254

Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
@coderabbitai

coderabbitai Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: NVIDIA/nvcf/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: 5640c734-7806-4cbb-a807-22e168eec9b1
📥 Commits

Reviewing files that changed from the base of the PR and between c8467ef and 5b28f0a.

📒 Files selected for processing (1)
  • fern/editions.yml

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 10 remain after this review.


📝 Walkthrough

Walkthrough

The changes add a 0.6.1-to-0.6.2 upgrade guide and revise the 1.0.1 upgrade guide to start from 0.6.2. They also update changelogs, navigation, edition settings, and manual preview configuration.

Changes

Self-Managed upgrade and documentation release

Layer / File(s) Summary
Prepare and execute the 0.6.2 patch upgrade
docs/overview/release-notes/0.6.1-to-0.6.2-upgrade.md
The guide covers source checks, backups, bundle preparation, OpenBao change review, catalog refresh, migrations, and server rotation checks.
Validate and recover the patch upgrade
docs/overview/release-notes/0.6.1-to-0.6.2-upgrade.md
The guide documents post-upgrade checks, rehearsal scope and results, stop conditions, and recovery requirements.
Align the 1.0.1 upgrade guide with 0.6.2
docs/overview/release-notes/0.6.1-to-1.0.1-upgrade.md
The guide sets 0.6.2 as the starting state and updates configuration references, rehearsal results, snapshot naming, selector details, and recovery instructions.
Update release content and documentation settings
fern/changelog/*, fern/navigation.yml, docs/overview/release-notes/index.md, docs/edition-manifest.json, docs/version-catalog/main.yaml, fern/docs.yml, fern/editions.yml, .github/workflows/fern-docs-ci.yml
The changelogs and navigation cover the 0.6.2 patch and 1.0.3 documentation release. Edition settings advance to 1.0.4, the selector and default edition advance to 1.0.3, and manual preview configuration adds a canonical option.

Priority: ⬇️ Low

Estimated code review effort: 3 (Moderate) | ~25 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 5b28f

The 1.0.3 edition points to the current release snapshot, including the corrected upgrade title and navigation. No release-blocking documentation mismatch is established; proceed with normal integration checks.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title follows Conventional Commits format with the docs type. It accurately describes the main change: publishing documentation for 1.0.3 and adding legacy Self-Managed 0.6.2 notes. The workflow…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@github-actions

github-actions Bot commented Oct 3, 2026

Copy link
Copy Markdown
Contributor

@sbaum1994
sbaum1994 marked this pull request as ready for review October 3, 2026 22:57
@sbaum1994
sbaum1994 requested review from a team as code owners October 3, 2026 22:57
@sbaum1994
sbaum1994 requested a review from along-2017 October 3, 2026 22:57
@sbaum1994

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Oct 3, 2026 •

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Use the parent commit when a push event has an all-zero previous ref and ensure explicitly selected tracked Markdown is not skipped by ignore files. Cover the initial-push fallback in the fixture tests.

Relates to #2254

Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
@sbaum1994
sbaum1994 force-pushed the docs/2195-release-1.0.3 branch from 721ac63 to 2a2d641 Compare October 3, 2026 23:16
@sbaum1994
sbaum1994 requested a review from a team as a code owner October 3, 2026 23:16
@sbaum1994

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Oct 3, 2026 •

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Relates to #2254

Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
Add a concise native changelog entry and the focused patch upgrade guide. Update the existing onward migration URL to require the patch, retain pod-create waits, and document the recorded availability limits. Prepare the 1.0.3 docs-only release note without changing the selected stack combination.

Relates to #2191

Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
Keep existing deep links to the starting-state checks valid after documenting the intermediate 0.6.2 patch.

Relates to #2191

Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
Pin the tested immutable release commit before changing the default selector. Advance Development to 1.0.4 and allow canonical hosted previews to verify the remote release refs before publication.

Relates to #2214

Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
@sbaum1994
sbaum1994 force-pushed the docs/2195-release-1.0.3 branch from 2a2d641 to dea7619 Compare October 3, 2026 23:32
Base automatically changed from docs/2247-link-audit to main October 4, 2026 03:59
Relates to #2191

Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
Relates to #2254

Signed-off-by: Stephanie Baum <sbaum@nvidia.com>
@sbaum1994
sbaum1994 enabled auto-merge October 5, 2026 16:58
@sbaum1994
sbaum1994 disabled auto-merge October 5, 2026 16:58
@sbaum1994
sbaum1994 merged commit 57a774d into main Oct 5, 2026
27 checks passed
@sbaum1994
sbaum1994 deleted the docs/2195-release-1.0.3 branch October 5, 2026 16:58
@balajinvda

Copy link
Copy Markdown
Contributor

This PR is included in version 1.29.3.

The release is available on GitHub release.

@balajinvda

Copy link
Copy Markdown
Contributor

This PR is included in version 1.69.1.

The release is available on GitHub release.

@balajinvda

Copy link
Copy Markdown
Contributor

This PR is included in version 1.25.1.

The release is available on GitHub release.

@balajinvda

Copy link
Copy Markdown
Contributor

This PR is included in version 1.14.2.

The release is available on GitHub release.

@balajinvda

Copy link
Copy Markdown
Contributor

This PR is included in version 1.10.1.

The release is available on GitHub release.

@balajinvda

Copy link
Copy Markdown
Contributor

This PR is included in version 0.5.1.

The release is available on GitHub release.

@balajinvda

Copy link
Copy Markdown
Contributor

This PR is included in version 0.9.1.

The release is available on GitHub release.

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.

3 participants