diff --git a/source/adminguide/storage.rst b/source/adminguide/storage.rst index 561d1d6423..b9338bdd6e 100644 --- a/source/adminguide/storage.rst +++ b/source/adminguide/storage.rst @@ -1005,6 +1005,46 @@ True. Instances created from this service offering will have their disks reset upon reboot. See `“Creating a New Compute Offering” `_. +Volume delete protection +~~~~~~~~~~~~~~~~~~~~~~~~ + +CloudStack protects volumes from accidental deletion using a delete protection +flag, which is false by default. When delete protection is enabled for a volume, +it cannot be deleted through the UI or API. It can only be deleted after +removing delete protection from the volume. + +Delete protection can be enabled for a volume via updateVirtualMachine API. + +.. code:: bash + + cmk update volume id= deleteprotection=true + +To remove delete protection, use the following command: + +.. code:: bash + + cmk update volume id= deleteprotection=false + +To enable/disable delete protection for a volume using the UI, follow these steps: + +#. Log in to the CloudStack UI as a User or admin. + +#. In the navigation menu on the left, click Volumes under Storage. + +#. Choose the volume for which you want to enable/disable delete protection. + +#. Click on the Edit button |EditButton.png| + +#. Toggle the Delete Protection switch to enable or disable delete protection. + +#. Click Ok button to save the changes. + +.. note:: + The volume delete protection is only considered when the volume is being + deleted through the UI or via `deleteVolume` or `destroyVolume` API. If the + domain/project is deleted, the volumes under the domain/project will be + deleted irrespective of the delete protection status. + Volume Deletion and Garbage Collection ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1515,6 +1555,8 @@ Deleting objects from a bucket :alt: Object store file upload .. |delete-button.png| image:: /_static/images/delete-button.png :alt: Delete button +.. |EditButton.png| image:: /_static/images/edit-icon.png + :alt: button to edit the properties of a volume .. |upload-button.png| image:: /_static/images/upload-button.png :alt: Upload button .. |adding-local-pool-via-ui.png| image:: /_static/images/adding-local-pool-via-ui.png diff --git a/source/adminguide/virtual_machines.rst b/source/adminguide/virtual_machines.rst index 9ca3d87dc7..1640ab0e74 100644 --- a/source/adminguide/virtual_machines.rst +++ b/source/adminguide/virtual_machines.rst @@ -424,6 +424,47 @@ The following table explains how an Instance name is displayed in different scen represents the value of the global configuration - instance.name +Instance delete protection +-------------------------- + +CloudStack protects instances from accidental deletion using a delete protection +flag, which is false by default. When delete protection is enabled for an +instance, it cannot be deleted through the UI or API. It can only be deleted +after removing delete protection from the instance. + +Delete protection can be enabled for an instance via updateVirtualMachine API. + +.. code:: bash + + cmk update virtualmachine id= deleteprotection=true + +To remove delete protection, use the following command: + +.. code:: bash + + cmk update virtualmachine id= deleteprotection=false + +To enable/disable delete protection for an instance using the UI, follow these steps: + +#. Log in to the CloudStack UI as a User or admin. + +#. In the navigation menu on the left, click Instances under Compute. + +#. Choose the Instance for which you want to enable/disable delete protection. + +#. Click on the Edit button |EditButton.png| + +#. Toggle the Delete Protection switch to enable or disable delete protection. + +#. Click Ok button to save the changes. + +.. note:: + The instance delete protection is only considered when the instance is being + deleted through the UI or via `destroyVirtualMachine` or `expungeVirtualMachine` + API. If the domain/project is deleted, the instances under the domain/project + will be deleted irrespective of the delete protection status. + + Changing the Service Offering for an Instance ---------------------------------------------