You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ro...@apache.org on 2024/09/27 11:36:28 UTC

(cloudstack-documentation) branch main updated: NAS Backup and Recovery plugin usage (#439)

This is an automated email from the ASF dual-hosted git repository.

rohit pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git


The following commit(s) were added to refs/heads/main by this push:
     new 898af0f  NAS Backup and Recovery plugin usage (#439)
898af0f is described below

commit 898af0fd17aa39a2af1fc8f6d200c2817e149f97
Author: Jithin Raju <ra...@gmail.com>
AuthorDate: Fri Sep 27 17:06:22 2024 +0530

    NAS Backup and Recovery plugin usage (#439)
    
    Adding NAS Backup and Recovery plugin usage.
---
 source/adminguide/nas_plugin.rst | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/source/adminguide/nas_plugin.rst b/source/adminguide/nas_plugin.rst
index 9c17802..defaa67 100644
--- a/source/adminguide/nas_plugin.rst
+++ b/source/adminguide/nas_plugin.rst
@@ -56,6 +56,33 @@ admins can create new backup offerings by selecting the zone and the backup
 repository. These backup offerings are then assigned and used with KVM instances
 to perform support B&R actions and operations.
 
+Using the NAS Backup and Recovery Plugin
+----------------------------------------
+To use the NAS Backup and Recovery Plugin, the Backup and Recovery framework needs to be enabled first. Then the backup plugin 'nas' needs to be enabled on either the global setting or on the zone settings. 
+
+================================= ========================
+Configuration                     Value
+================================= ========================
+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. 
+
+=================== ========================
+Field               Value
+=================== ========================
+Name                N suitable name to represent the Backup Repository
+Address             URL, in case of NFS <server IP>:/path
+Type                NFS ( only NFS type in 4.20)
+label.mountopts     Any mount point options to be passed while mouting this storage on the hypervisor. 
+Zone                The zone in CloudStack with which this Backup Repository must be associated.
+=================== ========================
+
+
+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. 
+
 Support Information and Limitation
 ----------------------------------