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

docs(instances): documentation #1174

Merged
merged 3 commits into from
Apr 6, 2022
Merged

docs(instances): documentation #1174

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4880947
docs(instances): documentation
Monitob Apr 5, 2022
60c357d
fix(docs): remove todo
Monitob Apr 6, 2022
5569a72
Merge branch 'master' into feat-instance-server-set-default-comercial…
remyleone Apr 6, 2022
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
8 changes: 5 additions & 3 deletions docs/resources/instance_server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: |-

Creates and manages Scaleway Compute Instance servers. For more information, see [the documentation](https://developers.scaleway.com/en/products/instance/api/#servers-8bf7d7).

Please check our [FAQ - Instances](https://www.scaleway.com/en/docs/faq/instances).

## Examples

### Basic
Expand Down Expand Up @@ -135,12 +137,12 @@ The following arguments are supported:
You find all the available types on the [pricing page](https://www.scaleway.com/en/pricing/).
Updates to this field will recreate a new resource.

[//]: # (TODO: Improve me)

- `image` - (Required) The UUID or the label of the base image used by the server. You can use [this endpoint](https://api-marketplace.scaleway.com/images?page=1&per_page=100)
to find either the right `label` or the right local image `ID` for a given `type`.

[//]: # (TODO: Improve me)
You can check the available labels with our [CLI](https://www.scaleway.com/en/docs/compute/instances/api-cli/creating-managing-instances-with-cliv2/). ```scw marketplace image list```

To retrieve more information by label please use: ```scw marketplace image get label=<LABEL>```

- `name` - (Optional) The name of the server.

Expand Down