Skip to content

Commit ddc0d09

Browse files
committed
Add docs
Signed-off-by: Patrik Cyvoct <[email protected]>
1 parent eaf3daf commit ddc0d09

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/resources/instance_server.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ to find either the right `label` or the right local image `ID` for a given `type
143143
- `placement_group_id` - (Optional) The [placement group](https://developers.scaleway.com/en/products/instance/api/#placement-groups-d8f653) the server is attached to.
144144

145145

146-
~> **Important:** Updates to `placement_group_id` may trigger a stop/start of the server.
146+
~> **Important:** When updating `placement_group_id` the `state` must be set to `stopped`, otherwise it will fail.
147147

148148
- `root_volume` - (Optional) Root [volume](https://developers.scaleway.com/en/products/instance/api/#volumes-7e8a39) attached to the server on creation.
149149
- `size_in_gb` - (Required) Size of the root volume in gigabytes.
@@ -152,12 +152,14 @@ to find either the right `label` or the right local image `ID` for a given `type
152152
Updates to this field will recreate a new resource.
153153
- `delete_on_termination` - (Defaults to `true`) Forces deletion of the root volume on instance termination.
154154

155-
~> **Important:** Updates to `root_volume.size_in_gb` will trigger a stop/start of the server.
155+
~> **Important:** Updates to `root_volume.size_in_gb` will be ignored after the creation of the server.
156156

157157
- `additional_volume_ids` - (Optional) The [additional volumes](https://developers.scaleway.com/en/products/instance/api/#volumes-7e8a39)
158158
attached to the server. Updates to this field will trigger a stop/start of the server.
159159

160-
~> **Important:** If this field contains local volumes, updates will trigger a stop/start of the server.
160+
~> **Important:** If this field contains local volumes, the `state` must be set to `stopped`, otherwise it will fail.
161+
162+
~> **Important:** If this field contains local volumes, you have to first detach them, in one apply, and then delete the volume in another apply.
161163

162164
- `enable_ipv6` - (Defaults to `false`) Determines if IPv6 is enabled for the server.
163165

0 commit comments

Comments
 (0)