Skip to content

Commit f4239d9

Browse files
authored
docs(instance): fix terminate action documentation and remove b_ssd volumes documentation (#1024)
1 parent 96c32f1 commit f4239d9

File tree

2 files changed

+8
-8
lines changed
  • scaleway-async/scaleway_async/instance/v1
  • scaleway/scaleway/instance/v1

2 files changed

+8
-8
lines changed

scaleway-async/scaleway_async/instance/v1/api.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -934,11 +934,11 @@ async def server_action(
934934
* `stop_in_place`: Stop the Instance, but keep the slot on the hypervisor.
935935
* `reboot`: Stop the instance and restart it.
936936
* `backup`: Create an image with all the volumes of an Instance.
937-
* `terminate`: Delete the Instance along with its attached volumes, except for SBS volumes.
937+
* `terminate`: Delete the Instance along with its attached local volumes.
938938
* `enable_routed_ip`: Migrate the Instance to the new network stack.
939939
940-
The `terminate` action will result in the deletion of `l_ssd`, `b_ssd` and `scratch` volumes types, `sbs_volume` volumes type will only be detached.
941-
If you want to preserve your volumes, you should detach them before the Instance deletion or `terminate` action.
940+
The `terminate` action will result in the deletion of `l_ssd` and `scratch` volumes types, `sbs_volume` volumes will only be detached.
941+
If you want to preserve your `l_ssd` volumes, you should stop your Instance, detach the volumes to be preserved, then delete your Instance.
942942
943943
The `backup` action can be done with:
944944
* No `volumes` key in the body: an image is created with snapshots of all the server volumes, except for the `scratch` volumes types.
@@ -2208,7 +2208,7 @@ async def update_volume(
22082208
) -> UpdateVolumeResponse:
22092209
"""
22102210
Update a volume.
2211-
Replace the name and/or size properties of a volume specified by its ID, with the specified value(s). Any volume name can be changed, however only `b_ssd` volumes can currently be increased in size.
2211+
Replace the name and/or size properties of a volume specified by its ID, with the specified value(s).
22122212
:param volume_id: UUID of the volume.
22132213
:param zone: Zone to target. If none is passed will use default zone from the config.
22142214
:param name: Volume name.

scaleway/scaleway/instance/v1/api.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -934,11 +934,11 @@ def server_action(
934934
* `stop_in_place`: Stop the Instance, but keep the slot on the hypervisor.
935935
* `reboot`: Stop the instance and restart it.
936936
* `backup`: Create an image with all the volumes of an Instance.
937-
* `terminate`: Delete the Instance along with its attached volumes, except for SBS volumes.
937+
* `terminate`: Delete the Instance along with its attached local volumes.
938938
* `enable_routed_ip`: Migrate the Instance to the new network stack.
939939
940-
The `terminate` action will result in the deletion of `l_ssd`, `b_ssd` and `scratch` volumes types, `sbs_volume` volumes type will only be detached.
941-
If you want to preserve your volumes, you should detach them before the Instance deletion or `terminate` action.
940+
The `terminate` action will result in the deletion of `l_ssd` and `scratch` volumes types, `sbs_volume` volumes will only be detached.
941+
If you want to preserve your `l_ssd` volumes, you should stop your Instance, detach the volumes to be preserved, then delete your Instance.
942942
943943
The `backup` action can be done with:
944944
* No `volumes` key in the body: an image is created with snapshots of all the server volumes, except for the `scratch` volumes types.
@@ -2208,7 +2208,7 @@ def update_volume(
22082208
) -> UpdateVolumeResponse:
22092209
"""
22102210
Update a volume.
2211-
Replace the name and/or size properties of a volume specified by its ID, with the specified value(s). Any volume name can be changed, however only `b_ssd` volumes can currently be increased in size.
2211+
Replace the name and/or size properties of a volume specified by its ID, with the specified value(s).
22122212
:param volume_id: UUID of the volume.
22132213
:param zone: Zone to target. If none is passed will use default zone from the config.
22142214
:param name: Volume name.

0 commit comments

Comments
 (0)