From 9256ab0a86202cf5475d5e2811dc235547a42d39 Mon Sep 17 00:00:00 2001 From: Carlos Camacho Date: Fri, 3 Feb 2023 13:58:12 +0100 Subject: [PATCH] bnr - missing docs for the role This commit includes the initial documentation for the snapshot and recovery role. Change-Id: Id662eb3a2d53f5f3477c22ea4ffcee3aa75aac67 --- doc/source/roles/snapshot_and_revert.rst | 49 ++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 doc/source/roles/snapshot_and_revert.rst diff --git a/doc/source/roles/snapshot_and_revert.rst b/doc/source/roles/snapshot_and_revert.rst new file mode 100644 index 000000000..c561938e3 --- /dev/null +++ b/doc/source/roles/snapshot_and_revert.rst @@ -0,0 +1,49 @@ +========================== +Role - snapshot_and_revert +========================== + +.. ansibleautoplugin:: + :role: tripleo_ansible/roles/snapshot_and_revert + +Usage +~~~~~ + +This Ansible role allows to +do the following tasks: + +1. Take LVM snapshots in both the Controller and Compute nodes. +2. Revert the state to the previously created snapshots. +3. Remove the snapshots. + +LVM snapshots are a feature of Linux Logical Volume Manager (LVM) +that allows users to create a temporary, read-only copy of a +the logical volumes of the Overcloud nodes. +The copy is a point-in-time representation of the original volume +and can be used for various purposes like data backup, testing, and recovery. +The ext4 file system must be used on top of LVM logical volumes, otherwise +this feature can not be used. + +This example is meant to describe a very simple +use case in which the user needs to create a set +of recovery LVM snapshots from the Controller and Compute nodes. + +Login in the Undercloud node and run: + +:: + + # Create snapshots in the Compute and Controller nodes + openstack overcloud backup snapshot + +To revert the snapshots run: + +:: + + # Revert snapshots in the Compute and Controller nodes + openstack overcloud backup snapshot --revert + +Then, to remove the created snapshots run: + +:: + + # Remove snapshots in the Controller and Compute nodes + openstack overcloud backup snapshot --remove