diff --git a/source/_static/images/B&R-ConfigureInstance.png b/source/_static/images/B&R-ConfigureInstance.png new file mode 100644 index 0000000000..9d60da25f0 Binary files /dev/null and b/source/_static/images/B&R-ConfigureInstance.png differ diff --git a/source/_static/images/B&R-CreateInstanceFromBackup.png b/source/_static/images/B&R-CreateInstanceFromBackup.png new file mode 100644 index 0000000000..976adb8e8f Binary files /dev/null and b/source/_static/images/B&R-CreateInstanceFromBackup.png differ diff --git a/source/adminguide/backup_and_recovery.rst b/source/adminguide/backup_and_recovery.rst index eb926a345a..39f0cd378e 100644 --- a/source/adminguide/backup_and_recovery.rst +++ b/source/adminguide/backup_and_recovery.rst @@ -161,6 +161,27 @@ of an expunged Instance will not restore nics and recovery any network which may not exist. User may however restore a specific volume from an Instance backup and attach that volume to a specified Instance. +Creating a new Instance from Backup +----------------------------------- + +Since 4.21, Users can create a new Instance from a backup. The backup table will also store +the instance configuration details at the time of taking the backup such as service offering, +template, disk offering of all data volumes, networks attached to etc. +The new Instance will be created with the same configuration as the original Instance +from which the backup was taken with all the data from the backup. + +|B&R-CreateInstanceFromBackup.png| + +Users can also choose to configure the new Instance with different parameters similar to while deploying a new Instance. +The form will be initially prefilled with the values stored in the backup. + +|B&R-ConfigureInstance.png| + +This will also work if the original Instance and the volumes used to create the backup are expunged. +If one or few of the resources stored in the backup such as template, networks etc are no longer available +in the system, the user will be prompted to reconfigure the Instance before creating it from backup. +This feature is supported for Dummy, NAS and Veeam plugins. + Supported APIs: ~~~~~~~~~~~~~~~~ @@ -176,6 +197,7 @@ Supported APIs: - **listBackups**: lists backups. - **restoreBackup**: restore a previous Instance backup in-place of a stopped or destroyed Instance. - **restoreVolumeFromBackupAndAttachToVM**: restore and attach a backed-up volume (of an Instance backup) to a specified Instance. +- **createInstanceFromBackup**: create a new Instance from a backup. .. |B&R-assignOffering.png| image:: /_static/images/B&R-assignOffering.png @@ -196,3 +218,9 @@ Supported APIs: .. |B&R-BackupScheduleEntry.png| image:: /_static/images/B&R-BackupScheduleEntry.png :alt: Creating a backup schedule for an Instance. :width: 400px +.. |B&R-CreateInstanceFromBackup.png| image:: /_static/images/B&R-CreateInstanceFromBackup.png + :alt: Creating a new Instance from a backup. + :width: 400px +.. |B&R-ConfigureInstance.png| image:: /_static/images/B&R-ConfigureInstance.png + :alt: Configure Instance parameters before creating it from backup. + :width: 700px diff --git a/source/adminguide/nas_plugin.rst b/source/adminguide/nas_plugin.rst index bbf3038eb6..f61791e717 100644 --- a/source/adminguide/nas_plugin.rst +++ b/source/adminguide/nas_plugin.rst @@ -28,14 +28,13 @@ to take full instance backups (qcow2) and requires libvirt-7.2.0 and QEMU-4.2, or high versions on the KVM hosts. 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. +network-attached storage (shared storage). It supports NFS, CIFS/Samba and CephFS. When initiating B&R operations on KVM instance, the assigned backup offering is used to infer backup repository (NAS) details which are then used to mount the shared storage temporarily on the KVM host to perform instance backup/restore disks operations. This also requires that admin installs NAS-storage specific -utilities on the KVM hosts such as nfs-utils/nfs-common (ceph-common, cifs-utils). +utilities on the KVM hosts such as nfs-utils/nfs-common, ceph-common and cifs-utils. Consider the following mount, typically performed on a KVM/Linux host to mount storage: @@ -75,7 +74,7 @@ Field Value =================== ======================== Name A suitable name to represent the Backup Repository Address URL, in case of NFS :/path -Type NFS ( only NFS type in 4.20) +Type NFS / CIFS / CEPH 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. =================== ======================== @@ -111,6 +110,5 @@ Currently, only volume(s) restoration is supported only to NFS and local storage based primary storage pools, and restored volumes are fully baked disks (i.e. not using any backing template file). -Restoring fully expunged and unmanaged instances are not supported. Backup and -restore operations are not fully supported for CKS cluster instances and should +Backup and restore operations are not fully supported for CKS cluster instances and should be avoided.