Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JeromeJaggi wants to merge 1 commit into
base: prod-staging
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions pages/platform/instances.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,9 @@ When set, the platform rounds the value up to the next full second.
Use `timeout_s` instead.
:::

If the instance crashes while the API is waiting, the platform returns the response immediately with the failure rather than blocking until the timeout elapses.
The `state` and `stop_code` fields in the response describe what happened.

### Delete on stop

Pass `delete-on-stop` in the features array to automatically delete the instance when it stops:
Expand All @@ -216,6 +219,8 @@ This is useful for ephemeral workloads—batch jobs, one-shot tasks—where you
To use the "delete-on-stop" feature, set the `restart_policy` to `never`.
:::

The platform reports the configured `delete-on-stop` feature back in the instance status response, so you can confirm it from a [`GET /instances/{name}`](/api/platform/v1/instances#get-instance) call without having to reread your own creation request.

## Stopping instances

### Drain timeout
Expand Down
Loading