Skip to content

Commit d24ae0f

Browse files
committed
Add documetation for delete protection for instances & volumes
1 parent 5f8ef7d commit d24ae0f

File tree

2 files changed

+73
-0
lines changed

2 files changed

+73
-0
lines changed

source/adminguide/storage.rst

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1005,6 +1005,42 @@ True. Instances created from this service offering will have their disks reset
10051005
upon reboot. See `“Creating a New Compute
10061006
Offering” <service_offerings.html#creating-a-new-compute-offering>`_.
10071007

1008+
Volume delete protection
1009+
~~~~~~~~~~~~~~~~~~~~~~~~
1010+
1011+
CloudStack provides a feature to protect volumes from accidental deletion. When
1012+
delete protection is enabled for a volume, it cannot be deleted through the
1013+
UI or API. It can only be delete after removing delete protection from the
1014+
volume.
1015+
1016+
Delete protection can be enabled for a volume via updateVirtualMachine API.
1017+
.. code:: bash
1018+
1019+
cmk update volume id=<volume id> deletionprotection=true
1020+
1021+
To remove delete protection, use the following command:
1022+
.. code:: bash
1023+
1024+
cmk update volume id=<volume id> deletionprotection=false
1025+
1026+
To enable/disable delete protection for a volume using the UI, follow these steps:
1027+
1028+
#. Log in to the CloudStack UI as a User or admin.
1029+
1030+
#. In the navigation menu on the left, click Volumes under Storage.
1031+
1032+
#. Choose the volume for which you want to enable/disable delete protection.
1033+
1034+
#. Click on the Edit button |editbutton.png|
1035+
1036+
#. Toggle the Delete Protection switch to enable or disable delete protection.
1037+
1038+
#. Click Ok button to save the changes.
1039+
1040+
.. note::
1041+
If the volume is part of another ACS service like autoscaling groups or CKS,
1042+
delete protection is ignored.
1043+
10081044

10091045
Volume Deletion and Garbage Collection
10101046
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

source/adminguide/virtual_machines.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -424,6 +424,43 @@ The following table explains how an Instance name is displayed in different scen
424424
<i.n> represents the value of the global configuration - instance.name
425425

426426

427+
Instance delete protection
428+
--------------------------
429+
430+
CloudStack provides a feature to protect Instances from accidental deletion.
431+
When delete protection is enabled for an instance, it cannot be deleted through
432+
the UI or API. It can only be delete after removing delete protection from the
433+
instance.
434+
435+
Delete protection can be enabled for an instance via updateVirtualMachine API.
436+
.. code:: bash
437+
438+
cmk update virtualmachine id=<instance id> deletionprotection=true
439+
440+
To remove delete protection, use the following command:
441+
.. code:: bash
442+
443+
cmk update virtualmachine id=<instance id> deletionprotection=false
444+
445+
To enable/disable delete protection for an instance using the UI, follow these steps:
446+
447+
#. Log in to the CloudStack UI as a User or admin.
448+
449+
#. In the navigation menu on the left, click Instances under Compute.
450+
451+
#. Choose the Instance for which you want to enable/disable delete protection.
452+
453+
#. Click on the Edit button |editbutton.png|
454+
455+
#. Toggle the Delete Protection switch to enable or disable delete protection.
456+
457+
#. Click Ok button to save the changes.
458+
459+
.. note::
460+
If the instance is part of another ACS service like autoscaling groups or CKS,
461+
delete protection is ignored.
462+
463+
427464
Changing the Service Offering for an Instance
428465
---------------------------------------------
429466

0 commit comments

Comments
 (0)