Repository navigation
docs: clarify graceful shutdown and reboot action completion - #712
Open
UmutAlisoglu wants to merge 1 commit into
Open
UmutAlisoglu wants to merge 1 commit into
UmutAlisoglu wants to merge 1 commit into
Conversation
Signed-off-by: Umut Alisoglu <umutalisoglu@gmail.com>
jooola
reviewed
Oct 29, 2026
jooola
left a comment
jooola
left a comment
Member
There was a problem hiding this comment.
Thanks for the contribution. Only a few nits.
Comment on lines
+282
to
+285
| The returned action finishes when the request has been sent. Waiting | ||
| for it does not guarantee that the guest operating system has rebooted | ||
| or that its services are ready. The guest may ignore ACPI requests. | ||
|
|
Member
There was a problem hiding this comment.
Suggested change
| The returned action finishes when the request has been sent. Waiting | |
| for it does not guarantee that the guest operating system has rebooted | |
| or that its services are ready. The guest may ignore ACPI requests. | |
| The returned action finishes when the ACPI request has been sent. Waiting | |
| for it does not guarantee that the guest operating system has rebooted | |
| or that its services are ready. The guest may ignore ACPI requests. | |
Comment on lines
+300
to
+304
| The returned action finishes when the request has been sent, not when | ||
| the guest operating system has stopped. After waiting for the action, | ||
| reload the server and poll its status until it is ``off`` before an | ||
| operation that requires a stopped server. The guest may ignore ACPI, | ||
| so polling should have a timeout. |
Member
There was a problem hiding this comment.
Suggested change
| The returned action finishes when the request has been sent, not when | |
| the guest operating system has stopped. After waiting for the action, | |
| reload the server and poll its status until it is ``off`` before an | |
| operation that requires a stopped server. The guest may ignore ACPI, | |
| so polling should have a timeout. | |
| The returned action finishes when the ACPI request has been sent, not when | |
| the guest operating system has stopped. After waiting for the action, | |
| reload the server and poll its status until it is ``off`` before an | |
| operation that requires a stopped server. The guest may ignore ACPI, | |
| so polling should have a timeout. |
Comment on lines
+874
to
+877
| The returned action finishes when the request has been sent. Waiting | ||
| for it does not guarantee that the guest operating system has rebooted | ||
| or that its services are ready. The guest may ignore ACPI requests. | ||
|
|
Member
There was a problem hiding this comment.
Suggested change
| The returned action finishes when the request has been sent. Waiting | |
| for it does not guarantee that the guest operating system has rebooted | |
| or that its services are ready. The guest may ignore ACPI requests. | |
| The returned action finishes when the ACPI request has been sent. Waiting | |
| for it does not guarantee that the guest operating system has rebooted | |
| or that its services are ready. The guest may ignore ACPI requests. | |
Comment on lines
+902
to
+906
| The returned action finishes when the request has been sent, not when | ||
| the guest operating system has stopped. After waiting for the action, | ||
| reload the server and poll its status until it is ``off`` before an | ||
| operation that requires a stopped server. The guest may ignore ACPI, | ||
| so polling should have a timeout. |
Member
There was a problem hiding this comment.
Suggested change
| The returned action finishes when the request has been sent, not when | |
| the guest operating system has stopped. After waiting for the action, | |
| reload the server and poll its status until it is ``off`` before an | |
| operation that requires a stopped server. The guest may ignore ACPI, | |
| so polling should have a timeout. | |
| The returned action finishes when the ACPI request has been sent, not when | |
| the guest operating system has stopped. After waiting for the action, | |
| reload the server and poll its status until it is ``off`` before an | |
| operation that requires a stopped server. The guest may ignore ACPI, | |
| so polling should have a timeout. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #712 +/- ##
=======================================
Coverage 97.40% 97.40%
=======================================
Files 76 76
Lines 4128 4128
=======================================
Hits 4021 4021
Misses 107 107 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Waiting for an ACPI shutdown action can finish while the guest is still running, so immediately changing the server type can raise
server_not_stopped. Add this distinction to bothBoundServerandServersClientshutdown/reboot docstrings, as requested in #495.The server reference includes a bounded status-polling example: wait for the action, reload before checking
Server.STATUS_OFF, and raise a timeout after 60 checks. It does not silently force the power off. Reboot notes distinguish sending the ACPI request from guest/service readiness.Validation on Windows / Python 3.13.7:
-E -W: passes.Refs #495; the broader helper/API design request remains open. AI assistance was used to prepare and validate the documentation. Signed off.