Add doc for importing and unmanaging volumes

apache · Apr 3, 2024 · 7a60517 · 7a60517
1 parent 5a47bef
commit 7a60517
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 0 deletions.
diff --git a/source/_static/images/import-volume.png b/source/_static/images/import-volume.png
diff --git a/source/_static/images/list-unmanaged-managed-volumes.png b/source/_static/images/list-unmanaged-managed-volumes.png
diff --git a/source/_static/images/unmanage-volume.png b/source/_static/images/unmanage-volume.png
diff --git a/source/adminguide/storage.rst b/source/adminguide/storage.rst
@@ -1011,6 +1011,53 @@ Following is the example for checkVolume API usage and the result in the volume
    },
    }
 
+
+Importing and Unmanaging Volumes from Storage Pools
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Since Apache CloudStack 4.19.1.0, importing and unmanaging volumes from primary storage pools are supported, only for KVM hypervisor.
+
+#. Log in to the CloudStack UI as an administrator.
+
+#. In the left navigation bar, click *Tools > Import DATA Volumes* section.
+
+#. Select the scope of the storage pool (Zone, Cluster, Host).
+
+#. Select the zone/pod/cluster/host of the storage pool
+
+#. Select the storage pool
+
+The unmanaged volumes on the storage pool are listed on the left panel. The managed volumes on the storage pool are listed on the right panel.
+
+|list-unmanaged-managed-volumes.png|
+
+To import a volume, 
+- select a unmanaged volume from the left panel, click "Import Volume" icon. 
+- In the Import Volume pop-up, select the Account Type, Domain/Account/Project and a disk offering.
+- Click OK.
+
+|import-volume.png|
+
+.. note::
+   The supported storage types are: NFS, Ceph and Local storage.
+
+.. note::
+   The volume to be imported must be placed in the root directory of the storage pool.
+
+.. note::
+   By default, the volume is imported for the caller if Domain/Account/Project are not set.
+
+.. note::
+   By default, the imported volumes use the default disk offering "Default Custom Offering for Volume Import"
+   (on shared storage) or ""Default Custom Offering for Volume Import - Local" (on local storage).
+
+To unmanage volume(s), 
+- select the volumes to be unmanaged from the right panel
+- click "Unmanage Volume" or "Unmanage Volumes" icon
+- click OK in the confirmation dialog.
+
+|unmanage-volume.png|
+
 Working with Volume Snapshots
 -----------------------------
 
@@ -1342,3 +1389,10 @@ Deleting objects from a bucket
    :alt: Upload button
 .. |adding-local-pool-via-ui.png| image:: /_static/images/adding-local-pool-via-ui.png
    :alt: Adding Local Storage Pool via UI
+.. |list-unmanaged-managed-volumes.png| image:: /_static/images/list-unmanaged-managed-volumes.png
+   :alt: List of Unmanaged and Managed Volumes
+.. |import-volume.png| image:: /_static/images/import-volume.png
+   :alt: Import Volume
+.. |unmanage-volume.png| image:: /_static/images/unmanage-volume.png
+   :alt: Unmanage Volume
+