Skip to content

docs(instances): Note crash-aborts-wait and delete-on-stop in status#133

Open
JeromeJaggi wants to merge 1 commit into
prod-stagingfrom
jeromejaggi/docs-instance-status-fields
Open

docs(instances): Note crash-aborts-wait and delete-on-stop in status#133
JeromeJaggi wants to merge 1 commit into
prod-stagingfrom
jeromejaggi/docs-instance-status-fields

Conversation

@JeromeJaggi

Copy link
Copy Markdown
Member

Summary

Two small v0.9 additions to `pages/platform/instances.mdx`:

  1. API wait aborts on crash — when the API is blocking on a state transition (`timeout_s` / `wait_timeout_ms`) and the instance crashes, the platform now returns the response immediately rather than blocking until the timeout elapses. Added a sentence right after the existing timeout note pointing readers to the `state` and `stop_code` fields.
  2. Delete-on-stop in status — the configured `delete-on-stop` feature is now echoed back in the instance status response so callers can confirm it via `GET /instances/{name}`. Added a note inside the existing Delete on stop section.

Verification

  • `make lint` passes 0/0/0 on the modified file.
  • Branched from latest `prod-staging`.

Risk flag

I haven't named a specific status field for delete-on-stop because the team-update slide didn't specify which one. The note describes the behavior generically ("reports the configured `delete-on-stop` feature back"). If the actual field name should be cited (e.g., `features` echoed back, or a dedicated `delete_on_stop` boolean), please flag during review and I'll add the field name.

Audit reference

Items #7 (abort API waits on crash) and #10 (delete-on-stop status reporting) from the v0.9 docs audit.


This PR was created by an AI agent.

Two small additions to the Instances page reflecting v0.9 behavior:

- After the timeout_s/wait_timeout_ms section: note that the
  platform aborts the API wait and returns the response
  immediately if the instance crashes during the wait, so callers
  see the failure right away rather than blocking until timeout.
- Inside the Delete on stop section: note that the feature is
  echoed back in the instance status response, so callers can
  confirm it via GET /instances/{name}.

Signed-off-by: Jerome Jaggi <jerome@unikraft.io>
@JeromeJaggi JeromeJaggi temporarily deployed to pull-requests April 30, 2026 08:42 — with GitHub Actions Inactive
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.

1 participant