Skip to content

Commit e9e8231

Browse files
authored
doc(instance): document volume resize options (#3452)
1 parent b341137 commit e9e8231

File tree

4 files changed

+10
-2
lines changed

4 files changed

+10
-2
lines changed

docs/resources/instance_server.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,8 @@ To retrieve more information by label please use: ```scw marketplace image get l
245245
- `delete_on_termination` - (Defaults to `true`) Forces deletion of the root volume on instance termination.
246246
- `sbs_iops` - (Optional) Choose IOPS of your sbs volume, has to be used with `sbs_volume` for root volume type.
247247

248-
~> **Important:** Updates to `root_volume.size_in_gb` will be ignored after the creation of the server.
248+
~> **Important:** It is not possible to change `root_volume.size_in_gb` for local volumes (`l_ssd`). Changes to this field will recreate the server.
249+
It is possible to increase `root_volume.size_in_gb` for SBS volumes, but they cannot be resized down without recreating the server.
249250

250251
- `additional_volume_ids` - (Optional) The [additional volumes](https://www.scaleway.com/en/developers/api/instance/#path-volume-types-list-volume-types)
251252
attached to the server. Updates to this field will trigger a stop/start of the server.

docs/resources/instance_volume.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ The following arguments are supported:
2424

2525
- `type` - (Required) The type of the volume. The possible values are: `l_ssd` (Local SSD), `scratch` (Local Scratch SSD).
2626
- `size_in_gb` - (Optional) The size of the volume. Only one of `size_in_gb` and `from_snapshot_id` should be specified.
27+
28+
~> **Important:** It is not possible to resize local and scratch volumes. Updates to this field will recreate the resource.
29+
2730
- `from_snapshot_id` - (Optional) If set, the new volume will be created from this snapshot. Only one of `size_in_gb` and `from_snapshot_id` should be specified.
2831
- `name` - (Optional) The name of the volume. If not provided it will be randomly generated.
2932
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the volume should be created.

templates/resources/instance_server.md.tmpl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,8 @@ To retrieve more information by label please use: ```scw marketplace image get l
246246
- `delete_on_termination` - (Defaults to `true`) Forces deletion of the root volume on instance termination.
247247
- `sbs_iops` - (Optional) Choose IOPS of your sbs volume, has to be used with `sbs_volume` for root volume type.
248248

249-
~> **Important:** Updates to `root_volume.size_in_gb` will be ignored after the creation of the server.
249+
~> **Important:** It is not possible to change `root_volume.size_in_gb` for local volumes (`l_ssd`). Changes to this field will recreate the server.
250+
It is possible to increase `root_volume.size_in_gb` for SBS volumes, but they cannot be resized down without recreating the server.
250251

251252
- `additional_volume_ids` - (Optional) The [additional volumes](https://www.scaleway.com/en/developers/api/instance/#path-volume-types-list-volume-types)
252253
attached to the server. Updates to this field will trigger a stop/start of the server.

templates/resources/instance_volume.md.tmpl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ The following arguments are supported:
2525

2626
- `type` - (Required) The type of the volume. The possible values are: `l_ssd` (Local SSD), `scratch` (Local Scratch SSD).
2727
- `size_in_gb` - (Optional) The size of the volume. Only one of `size_in_gb` and `from_snapshot_id` should be specified.
28+
29+
~> **Important:** It is not possible to resize local and scratch volumes. Updates to this field will recreate the resource.
30+
2831
- `from_snapshot_id` - (Optional) If set, the new volume will be created from this snapshot. Only one of `size_in_gb` and `from_snapshot_id` should be specified.
2932
- `name` - (Optional) The name of the volume. If not provided it will be randomly generated.
3033
- `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the volume should be created.

0 commit comments

Comments
 (0)