Skip to content

feat: vastai wait instance — blocking instance status command (CLN-3213) #378

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
guthrie-vast wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat: vastai wait instance — blocking instance status command (CLN-3213) #378

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b9ce49
Add enum+description tables for status fields in OpenAPI YAML and CLI…
guthrie-vast Apr 3, 2026
ad2c50e
feat: add vastai wait instance command (CLN-3213)
guthrie-vast Apr 24, 2026
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
138 changes: 134 additions & 4 deletions openapi/yaml/combined_api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7080,15 +7080,59 @@ paths:
actual_status:
type: string
nullable: true
enum:
- loading
- running
- stopped
- frozen
- exited
- rebooting
- unknown
- offline
description: "Current status of the instance container.\
\ `null` while provisioning.\n\n- `loading` \u2014 Docker\
\ image downloading or container starting up.\n- `running`\
\ \u2014 Container executing. GPU charges apply.\n- `stopped`\
\ \u2014 Container halted. Disk charges continue; no GPU\
\ charges.\n- `frozen` \u2014 Container paused with memory\
\ preserved. GPU charges apply.\n- `exited` \u2014 Container\
\ process exited unexpectedly.\n- `rebooting` \u2014 Container\
\ restarting (transient).\n- `unknown` \u2014 No recent\
\ heartbeat from the host.\n- `offline` \u2014 Host machine\
\ disconnected from Vast servers (computed, not stored).\n"
example: running
cur_state:
type: string
enum:
- running
- stopped
- unloaded
description: "Current state of the machine contract (hardware\
\ allocation).\n\n- `running` \u2014 Allocation active.\n\
- `stopped` \u2014 Allocation paused.\n- `unloaded` \u2014\
\ Allocation released (instance destroyed).\n"
example: running
next_state:
type: string
enum:
- running
- stopped
- unloaded
description: "Target state for the machine contract. The\
\ daemon transitions `cur_state` toward this value.\n\n\
- `running` \u2014 Should be active.\n- `stopped` \u2014\
\ Should be paused.\n- `unloaded` \u2014 Should be released.\n"
example: running
intended_status:
type: string
enum:
- running
- stopped
- frozen
description: "User's desired target state for the container.\n\
\n- `running` \u2014 Should be executing.\n- `stopped`\
\ \u2014 Should be halted.\n- `frozen` \u2014 Should be\
\ paused with memory preserved.\n"
example: running
label:
type: string
Expand Down Expand Up @@ -7562,15 +7606,59 @@ paths:
actual_status:
type: string
nullable: true
enum:
- loading
- running
- stopped
- frozen
- exited
- rebooting
- unknown
- offline
description: "Current status of the instance container.\
\ `null` while provisioning.\n\n- `loading` \u2014 Docker\
\ image downloading or container starting up.\n- `running`\
\ \u2014 Container executing. GPU charges apply.\n- `stopped`\
\ \u2014 Container halted. Disk charges continue; no GPU\
\ charges.\n- `frozen` \u2014 Container paused with memory\
\ preserved. GPU charges apply.\n- `exited` \u2014 Container\
\ process exited unexpectedly.\n- `rebooting` \u2014 Container\
\ restarting (transient).\n- `unknown` \u2014 No recent\
\ heartbeat from the host.\n- `offline` \u2014 Host machine\
\ disconnected from Vast servers (computed, not stored).\n"
example: running
cur_state:
type: string
enum:
- running
- stopped
- unloaded
description: "Current state of the machine contract (hardware\
\ allocation).\n\n- `running` \u2014 Allocation active.\n\
- `stopped` \u2014 Allocation paused.\n- `unloaded` \u2014\
\ Allocation released (instance destroyed).\n"
example: running
next_state:
type: string
enum:
- running
- stopped
- unloaded
description: "Target state for the machine contract. The\
\ daemon transitions `cur_state` toward this value.\n\n\
- `running` \u2014 Should be active.\n- `stopped` \u2014\
\ Should be paused.\n- `unloaded` \u2014 Should be released.\n"
example: running
intended_status:
type: string
enum:
- running
- stopped
- frozen
description: "User's desired target state for the container.\n\
\n- `running` \u2014 Should be executing.\n- `stopped`\
\ \u2014 Should be halted.\n- `frozen` \u2014 Should be\
\ paused with memory preserved.\n"
example: running
label:
type: string
Expand Down Expand Up @@ -9081,19 +9169,61 @@ components:
actual_status:
type: string
nullable: true
description: Current status of the instance container.
enum:
- loading
- running
- stopped
- frozen
- exited
- rebooting
- unknown
- offline
description: "Current status of the instance container. `null` while the\
\ instance is still being provisioned.\n\n- `loading` \u2014 Docker image\
\ is downloading or the container is starting up.\n- `running` \u2014\
\ Container is actively executing. GPU charges apply.\n- `stopped` \u2014\
\ Container is halted. Disk charges continue; no GPU charges.\n- `frozen`\
\ \u2014 Container is paused with memory preserved. GPU charges apply.\n\
- `exited` \u2014 Container process exited unexpectedly.\n- `rebooting`\
\ \u2014 Container is restarting (transient).\n- `unknown` \u2014 Status\
\ cannot be determined; no recent heartbeat from the host.\n- `offline`\
\ \u2014 Machine hosting this instance has disconnected from Vast servers.\
\ Computed at query time; the underlying `actual_status` value in the\
\ database is preserved.\n"
example: running
intended_status:
type: string
description: Intended status of the instance container.
enum:
- running
- stopped
- frozen
description: "The user's desired target state for the container. The system\
\ continuously works to reconcile `actual_status` with this value.\n\n\
- `running` \u2014 Container should be executing.\n- `stopped` \u2014\
\ Container should be halted.\n- `frozen` \u2014 Container should be paused\
\ with memory preserved.\n"
example: running
cur_state:
type: string
description: Current state of the machine contract.
enum:
- running
- stopped
- unloaded
description: "Current state of the machine contract (the hardware allocation\
\ for this instance).\n\n- `running` \u2014 Allocation is active; hardware\
\ is in use.\n- `stopped` \u2014 Allocation is paused.\n- `unloaded` \u2014\
\ Allocation has been released (instance is destroyed).\n"
example: running
next_state:
type: string
description: Next scheduled state for the machine contract.
enum:
- running
- stopped
- unloaded
description: "Target state for the machine contract. The daemon transitions\
\ `cur_state` toward this value.\n\n- `running` \u2014 Allocation should\
\ be active.\n- `stopped` \u2014 Allocation should be paused.\n- `unloaded`\
\ \u2014 Allocation should be released (set when destroying an instance).\n"
example: running
label:
type: string
Expand Down
37 changes: 33 additions & 4 deletions openapi/yaml/show_instance.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,19 +91,48 @@ components:
actual_status:
type: string
nullable: true
description: Current status of the instance container.
enum: [loading, running, stopped, frozen, exited, rebooting, unknown, offline]
description: |
Current status of the instance container. `null` while the instance is still being provisioned.

- `loading` — Docker image is downloading or the container is starting up.
- `running` — Container is actively executing. GPU charges apply.
- `stopped` — Container is halted. Disk charges continue; no GPU charges.
- `frozen` — Container is paused with memory preserved. GPU charges apply.
- `exited` — Container process exited unexpectedly.
- `rebooting` — Container is restarting (transient).
- `unknown` — Status cannot be determined; no recent heartbeat from the host.
- `offline` — Machine hosting this instance has disconnected from Vast servers. Computed at query time; the underlying `actual_status` value in the database is preserved.
example: running
intended_status:
type: string
description: Intended status of the instance container.
enum: [running, stopped, frozen]
description: |
The user's desired target state for the container. The system continuously works to reconcile `actual_status` with this value.

- `running` — Container should be executing.
- `stopped` — Container should be halted.
- `frozen` — Container should be paused with memory preserved.
example: running
cur_state:
type: string
description: Current state of the machine contract.
enum: [running, stopped, unloaded]
description: |
Current state of the machine contract (the hardware allocation for this instance).

- `running` — Allocation is active; hardware is in use.
- `stopped` — Allocation is paused.
- `unloaded` — Allocation has been released (instance is destroyed).
example: running
next_state:
type: string
description: Next scheduled state for the machine contract.
enum: [running, stopped, unloaded]
description: |
Target state for the machine contract. The daemon transitions `cur_state` toward this value.

- `running` — Allocation should be active.
- `stopped` — Allocation should be paused.
- `unloaded` — Allocation should be released (set when destroying an instance).
example: running
label:
type: string
Expand Down
33 changes: 33 additions & 0 deletions openapi/yaml/show_instances.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,48 @@ paths:
actual_status:
type: string
nullable: true
enum: [loading, running, stopped, frozen, exited, rebooting, unknown, offline]
description: |
Current status of the instance container. `null` while provisioning.

- `loading` — Docker image downloading or container starting up.
- `running` — Container executing. GPU charges apply.
- `stopped` — Container halted. Disk charges continue; no GPU charges.
- `frozen` — Container paused with memory preserved. GPU charges apply.
- `exited` — Container process exited unexpectedly.
- `rebooting` — Container restarting (transient).
- `unknown` — No recent heartbeat from the host.
- `offline` — Host machine disconnected from Vast servers (computed, not stored).
example: running
cur_state:
type: string
enum: [running, stopped, unloaded]
description: |
Current state of the machine contract (hardware allocation).

- `running` — Allocation active.
- `stopped` — Allocation paused.
- `unloaded` — Allocation released (instance destroyed).
example: running
next_state:
type: string
enum: [running, stopped, unloaded]
description: |
Target state for the machine contract. The daemon transitions `cur_state` toward this value.

- `running` — Should be active.
- `stopped` — Should be paused.
- `unloaded` — Should be released.
example: running
intended_status:
type: string
enum: [running, stopped, frozen]
description: |
User's desired target state for the container.

- `running` — Should be executing.
- `stopped` — Should be halted.
- `frozen` — Should be paused with memory preserved.
example: running
label:
type: string
Expand Down
33 changes: 33 additions & 0 deletions openapi/yaml/show_instances_v1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,15 +101,48 @@ paths:
actual_status:
type: string
nullable: true
enum: [loading, running, stopped, frozen, exited, rebooting, unknown, offline]
description: |
Current status of the instance container. `null` while provisioning.

- `loading` — Docker image downloading or container starting up.
- `running` — Container executing. GPU charges apply.
- `stopped` — Container halted. Disk charges continue; no GPU charges.
- `frozen` — Container paused with memory preserved. GPU charges apply.
- `exited` — Container process exited unexpectedly.
- `rebooting` — Container restarting (transient).
- `unknown` — No recent heartbeat from the host.
- `offline` — Host machine disconnected from Vast servers (computed, not stored).
example: running
cur_state:
type: string
enum: [running, stopped, unloaded]
description: |
Current state of the machine contract (hardware allocation).

- `running` — Allocation active.
- `stopped` — Allocation paused.
- `unloaded` — Allocation released (instance destroyed).
example: running
next_state:
type: string
enum: [running, stopped, unloaded]
description: |
Target state for the machine contract. The daemon transitions `cur_state` toward this value.

- `running` — Should be active.
- `stopped` — Should be paused.
- `unloaded` — Should be released.
example: running
intended_status:
type: string
enum: [running, stopped, frozen]
description: |
User's desired target state for the container.

- `running` — Should be executing.
- `stopped` — Should be halted.
- `frozen` — Should be paused with memory preserved.
example: running
label:
type: string
Expand Down
Loading