Skip to content

Commit

Permalink
Merge pull request #1439 from stgraber/doc
Browse files Browse the repository at this point in the history
doc/instance/properties: Add missing instance properties
  • Loading branch information
hallyn authored Nov 30, 2024
2 parents 6532073 + dbfa605 commit 34789c0
Showing 1 changed file with 33 additions and 3 deletions.
36 changes: 33 additions & 3 deletions doc/reference/instance_properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,42 @@ The following instance properties are available:
* - Property
- Read-only
- Description
* - `name`
- yes
- Instance name (see {ref}`instance-name-requirements`)
* - `architecture`
- no
- Instance architecture
* - `created_at`
- yes
- Timestamp of the instance creation
* - `description`
- no
- User provided description of the instance
* - `ephemeral`
- no
- Whether the instance is ephemeral (gets deleted when stopped)
* - `last_used_at`
- yes
- Timestamp of the instance last usage
* - `location`
- no
- Current location of the instance within a cluster
* - `name`
- yes
- Instance name (see {ref}`instance-name-requirements`)
* - `project`
- yes
- Project that the instance is a part of
* - `stateful`
- yes
- Whether saved runtime state is currently present
* - `status`
- yes
- Human readable status of the instance
* - `status_code`
- yes
- Machine readable status of the instance
* - `type`
- yes
- Type of instance (container or virtual machine)
```

(instance-name-requirements)=
Expand Down

0 comments on commit 34789c0

Please sign in to comment.