Skip to content

[doc] Align BMC graceful shutdown HLD with implementation - #2594

Open
william8545 wants to merge 1 commit into
sonic-net:masterfrom
william8545:bmc-graceful-shutdown-hld-align
Open

william8545 wants to merge 1 commit into
sonic-net:masterfrom
william8545:bmc-graceful-shutdown-hld-align

Conversation

@william8545

@william8545 william8545 commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Align the BMC graceful shutdown/restart HLD merged in #2500 with the implementation.

Only the existing HLD is changed; its section structure and main flows are retained.

Differences from the merged HLD

Area Updated design
Eligibility Use existing BMC/switch-host identity. Remove the bmc_pairing opt-in and old/mixed-image compatibility promise.
Provisioning Deployment owns credentials, gNMI authorization and CACL. BMC client paths use optional BMC_GNOI|certs; host server paths use existing GNMI|certs. No image-side DB seeding.
Timing Default BMC timeout 120 s, explicit 0 preserved, no CLI upper bound. Host timeout defaults to 60 s without DPU fallback; watchdog 180 s; restart pause 10 s.
Host safeguards Document watchdog readback, the skipped platform pre-reboot hook and firmware auto-update handler, the checked host-partition flush, and immediate propagation of pre-check failures, including the narrow shared-path fixes.
Operation handling Align same-action JOIN ahead of priority displacement, preemption ownership, the startup power-on yielding to an admitted power removal, the repeated-shutdown skip after a recorded power-off, ABANDONED on daemon stop and no automatic power-call retry. Distinguish platform ONLINE from OS/management readiness.

The tagged HALT/RebootStatus protocol, vendor teardown branches and deployment qualification requirements remain. This PR does not claim production security approval or introduce runtime changes.

Validation

@mssonicbld

Copy link
Copy Markdown
Collaborator

/azp run

@azure-pipelines

Copy link
Copy Markdown
No pipelines are associated with this pull request.

@mssonicbld

Copy link
Copy Markdown
Collaborator

/azp run

@azure-pipelines

Copy link
Copy Markdown
No pipelines are associated with this pull request.

@judyjoseph

Copy link
Copy Markdown
Contributor

@william8545 @oleksandrivantsiv can you update all the gracefull restart PR's here in the PR description ?

@oleksandrivantsiv

Copy link
Copy Markdown
Contributor

@william8545 @oleksandrivantsiv can you update all the gracefull restart PR's here in the PR description ?

@judyjoseph, we have it in #2500

## Summary

Align the BMC graceful shutdown/restart HLD merged in sonic-net#2500 with the implementation.

Only the existing HLD is changed; its section structure and main flows are retained.

## Differences from the merged HLD

| Area | Updated design |
| --- | --- |
| Eligibility | Use existing BMC/switch-host identity. Remove the `bmc_pairing` opt-in and old/mixed-image compatibility promise. |
| Provisioning | Deployment owns credentials, gNMI authorization and CACL. BMC client paths use optional `BMC_GNOI\|certs`; host server paths use existing `GNMI\|certs`. No image-side DB seeding. |
| Timing | Default BMC timeout 120 s, explicit 0 preserved, no CLI upper bound. Host timeout defaults to 60 s without DPU fallback; watchdog 180 s; restart pause 10 s. |
| Host safeguards | Document watchdog readback, the skipped platform pre-reboot hook and firmware auto-update handler, the checked host-partition flush, and immediate propagation of pre-check failures, including the narrow shared-path fixes. |
| Operation handling | Align same-action JOIN ahead of priority displacement, preemption ownership, the startup power-on yielding to an admitted power removal, the repeated-shutdown skip after a recorded power-off, ABANDONED on daemon stop and no automatic power-call retry. Distinguish platform `ONLINE` from OS/management readiness. |

The tagged HALT/RebootStatus protocol, vendor teardown branches and deployment qualification requirements remain. This PR does not claim production security approval or introduce runtime changes.

## Validation

- Compared with the implementation proposed in sonic-net/sonic-platform-daemons#923, sonic-net/sonic-host-services#449, sonic-net/sonic-utilities#4906 and sonic-net/sonic-buildimage#30103.
- Checked document structure, link targets and whitespace.
- Documentation only: no build or device test.

Signed-off-by: William Tsai <willtsai@nvidia.com>
@william8545
william8545 force-pushed the bmc-graceful-shutdown-hld-align branch from 6ff62cb to 6c560ea Compare October 15, 2026 22:37
@mssonicbld

Copy link
Copy Markdown
Collaborator

/azp run

@azure-pipelines

Copy link
Copy Markdown
No pipelines are associated with this pull request.

This branch has not been deployed

No deployments
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