Skip to content

Commit ec876ee

Browse files
authored
docs(instance): change server terminate documentation (scaleway#677)
1 parent a47e4a5 commit ec876ee

File tree

2 files changed

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

2 files changed

+6
-8
lines changed

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -931,12 +931,11 @@ async def server_action(
931931
* `stop_in_place`: Stop the Instance, but keep the slot on the hypervisor.
932932
* `reboot`: Stop the instance and restart it.
933933
* `backup`: Create an image with all the volumes of an Instance.
934-
* `terminate`: Delete the Instance along with all attached volumes.
934+
* `terminate`: Delete the Instance along with its attached volumes, except for SBS volumes.
935935
* `enable_routed_ip`: Migrate the Instance to the new network stack.
936936
937-
Keep in mind that terminating an Instance will result in the deletion of all attached volumes, including local and block storage.
938-
If you want to preserve your local volumes, you should use the `archive` action instead of `terminate`. Similarly, if you want to keep your block storage volumes, you must first detach them before issuing the `terminate` command.
939-
For more information, read the [Volumes](#path-volumes-list-volumes) documentation.
937+
Keep in mind that `terminate` an Instance will result in the deletion of `l_ssd`, `b_ssd` and `scratch` volumes types, `sbs_volume` volumes type will only be detached.
938+
If you want to preserve your volumes, you should detach them before the Instance deletion or `terminate` action.
940939
:param server_id: UUID of the Instance.
941940
:param zone: Zone to target. If none is passed will use default zone from the config.
942941
:param action: Action to perform on the Instance.

scaleway/scaleway/instance/v1/api.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -931,12 +931,11 @@ def server_action(
931931
* `stop_in_place`: Stop the Instance, but keep the slot on the hypervisor.
932932
* `reboot`: Stop the instance and restart it.
933933
* `backup`: Create an image with all the volumes of an Instance.
934-
* `terminate`: Delete the Instance along with all attached volumes.
934+
* `terminate`: Delete the Instance along with its attached volumes, except for SBS volumes.
935935
* `enable_routed_ip`: Migrate the Instance to the new network stack.
936936
937-
Keep in mind that terminating an Instance will result in the deletion of all attached volumes, including local and block storage.
938-
If you want to preserve your local volumes, you should use the `archive` action instead of `terminate`. Similarly, if you want to keep your block storage volumes, you must first detach them before issuing the `terminate` command.
939-
For more information, read the [Volumes](#path-volumes-list-volumes) documentation.
937+
Keep in mind that `terminate` an Instance will result in the deletion of `l_ssd`, `b_ssd` and `scratch` volumes types, `sbs_volume` volumes type will only be detached.
938+
If you want to preserve your volumes, you should detach them before the Instance deletion or `terminate` action.
940939
:param server_id: UUID of the Instance.
941940
:param zone: Zone to target. If none is passed will use default zone from the config.
942941
:param action: Action to perform on the Instance.

0 commit comments

Comments
 (0)