Skip to content

chore(docs): Add details for network clean-up between tenants#3285

Open
bcavnvidia wants to merge 1 commit into
NVIDIA:mainfrom
bcavnvidia:new-docs
Open

chore(docs): Add details for network clean-up between tenants#3285
bcavnvidia wants to merge 1 commit into
NVIDIA:mainfrom
bcavnvidia:new-docs

Conversation

@bcavnvidia

Copy link
Copy Markdown
Contributor

Related issues

#2152

Type of Change

  • Add - New feature or capability
  • Change - Changes in existing functionality
  • Fix - Bug fixes
  • Remove - Removed features or deprecated functionality
  • Internal - Internal changes (refactoring, tests, docs, etc.)

Breaking Changes

  • This PR contains breaking changes

Testing

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed
  • No testing required (docs, internal refactor, etc.)

Additional Notes

Closes #2152

@copy-pr-bot

copy-pr-bot Bot commented Jul 8, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jul 8, 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: abcd03c8-7563-4c29-a5c1-3016129eb0e8

📥 Commits

Reviewing files that changed from the base of the PR and between 2a09d0e and 727b978.

📒 Files selected for processing (2)
  • docs/operations/tenant-lifecycle-cleanup.md
  • docs/overview/lifecycle.md
✅ Files skipped from review due to trivial changes (1)
  • docs/operations/tenant-lifecycle-cleanup.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/overview/lifecycle.md

Summary by CodeRabbit

  • Documentation
    • Expanded tenant lifecycle guidance with more detail on how hosts are cleaned up between tenants, including tenant network removal and fail-closed tenant-free defaults.
    • Added verification steps, troubleshooting guidance for hosts stuck in cleanup-related states, and concrete operator commands for cleanup status checks.
    • Clarified the conditions for when a host is fully released and safe to return to the available pool, based on post-tenant network transition confirmation.

Walkthrough

This PR expands tenant-sanitization documentation with explicit network cleanup behavior between tenants. It adds an operations guide for teardown, verification, and troubleshooting, and updates the lifecycle overview with a more detailed release sequence.

Changes

Tenant Network Cleanup Documentation

Layer / File(s) Summary
Network cleanup operational reference
docs/operations/tenant-lifecycle-cleanup.md
Adds a "Network Cleanup (Between Tenants)" section with a concern-to-action table, verification CLI commands, and troubleshooting guidance for stuck cleanup states.
Lifecycle overview sanitization narrative update
docs/overview/lifecycle.md
Replaces the concise cleanup list with prose detailing network teardown, fail-closed tenant-free state, route/IP/VNI/DPU allocation cleanup, DHCP/metadata reconfiguration, and release gating on DPU confirmation.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation update for tenant network cleanup.
Description check ✅ Passed The description is on-topic and matches the documented network cleanup changes.
Linked Issues check ✅ Passed The docs additions cover the requested cleanup steps: detaching tenant networking, restoring admin state, DHCP changes, and route/BGP withdrawal.
Out of Scope Changes check ✅ Passed The PR appears limited to relevant documentation updates with no unrelated code or scope additions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@bcavnvidia bcavnvidia marked this pull request as ready for review July 8, 2026 21:23
@bcavnvidia bcavnvidia requested a review from polarweasel as a code owner July 8, 2026 21:23
@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown

🔍 Container Scan Summary

No Grype artifacts were found to aggregate.

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown

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.

docs: Add network cleanup details during between tenant sanitization

1 participant