Skip to content
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

doc/instance/properties: Add missing instance properties #1439

Merged
merged 1 commit into from
Nov 30, 2024
Merged

doc/instance/properties: Add missing instance properties #1439

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
36 changes: 33 additions & 3 deletions doc/reference/instance_properties.md
View file
Open in desktop
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