This is an automated email from the ASF dual-hosted git repository. andrijapanic pushed a commit to branch andrija-nas-backup-doc-update in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git
commit 11c930a69f70588b834be743401eeda228763189 Author: Andrija Panic <[email protected]> AuthorDate: Thu May 22 22:35:03 2025 +0200 update details for the configuration of NAS-based backup and recovery --- source/adminguide/nas_plugin.rst | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/source/adminguide/nas_plugin.rst b/source/adminguide/nas_plugin.rst index bbf3038..9db403c 100644 --- a/source/adminguide/nas_plugin.rst +++ b/source/adminguide/nas_plugin.rst @@ -27,6 +27,9 @@ instances to any shared storage (NAS). It is based on `libvirt push backup mode to take full instance backups (qcow2) and requires libvirt-7.2.0 and QEMU-4.2, or high versions on the KVM hosts. +Currently, only backup of VMs from the NFS-based Primary Storage are tested to work. +You can also make backups of CEPH-based VMs, but restoring is not possible yet. + The NAS B&R plugin requires admin to first add backup repositories which are network-attached storage (shared storage). Currently it supports NFS, and may support other shared storage such as CephFS and CIFS/Samba in future. @@ -67,8 +70,8 @@ backup.framework.enabled true backup.framework.provider.plugin nas ================================= ======================== -Once the above two configurations are set, restart the cloudstack-management service. Once the service is restarted we can add the backup repository for the 'nas' Backup and Recovery plugin. -Navigate to the configuration -> Backup Repository. Click on 'Add Backup Repository' and fill the form. +Once the above two configurations are set, restart the cloudstack-management service. After restart check the Settings of the Zone where you want to enable NAS backups - make sure that the "backup.framework.enabled"="true" on the Setting tab of the Zone. Once this is done, we can add the backup repository for the 'nas' Backup and Recovery plugin. +Navigate to the Configuration -> Backup Repository. Click on 'Add Backup Repository' and fill the form. =================== ======================== Field Value @@ -84,8 +87,18 @@ Zone The zone in CloudStack with which this Backup Repository mus :align: center :alt: NAS Backup repository +Pay attention to the "Name" given to this reposutory, as you will have to specify this in the "External ID" field when creating Backup Offerings (Importing backup offering) + Once the Backup Repository is created, we need to add a Backup Offering, in this plugin the Backup offering is a placeholder to associate an instance to a Backup Repository. While creating the Backup Offering, select the desired Backup Repository. Associate the Backup Offering on an instance to create an Adhoc or scheduled backup. +For the "External ID", please specify the name of the previously created backup repository. + +.. image:: /_static/images/B&R-Backup-Offerings.png + :align: center + :alt: NAS Backup offerings + +After this has been done, you can go to any Instance view and there will be buttons available for either ad-hoc backup or a scheduled backup of the VM + Support Information and Limitation ----------------------------------
