Skip to content

update details for the configuration of NAS-based backup and recovery #507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

update details for the configuration of NAS-based backup and recovery #507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
11c930a
update details for the configuration of NAS-based backup and recovery
andrijapanicsb May 22, 2025
809fbce
Add files via upload
andrijapanicsb May 22, 2025
6eec01b
Update nas_plugin.rst
andrijapanicsb May 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added source/_static/images/B&R-Backup-Offerings.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 15 additions & 2 deletions source/adminguide/nas_plugin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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 repository, 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
----------------------------------

Expand Down