From 97a6aeb9f8c90638829a2e31b8f76b0e12264e85 Mon Sep 17 00:00:00 2001
From: Brandon Dunne <brandondunne@hotmail.com>
Date: Thu, 10 Aug 2023 17:32:56 -0400
Subject: [PATCH] Document the steps for backup and restore of appliances

---
 _data/site_menu.yml                           | 12 ++++--
 appliances/backup_and_restore.md              | 42 +++++++++++++++++++
 .../index.md => appliances/upgrading.md       |  0
 3 files changed, 50 insertions(+), 4 deletions(-)
 create mode 100644 appliances/backup_and_restore.md
 rename upgrading_appliances/index.md => appliances/upgrading.md (100%)

diff --git a/_data/site_menu.yml b/_data/site_menu.yml
index 6f33c7886..263af274c 100644
--- a/_data/site_menu.yml
+++ b/_data/site_menu.yml
@@ -31,11 +31,15 @@ installation:
       path: "/docs/reference/latest/installing_on_scvmm/index.html"
       desc: "How to install and configure the ManageIQ Management Engine appliance on Microsoft System Center Virtual Machine Manager (SCVMM)"
 
-upgrading:
-  title: Upgrading
+appliances:
+  title: Appliances
   children:
-    - title: Appliances
-      path: "/docs/reference/latest/upgrading_appliances/index.html"
+    - title: Backup and Restore
+      path: "/docs/reference/latest/appliances/backup_and_restore.html"
+      desc: "How to backup and restore appliances"
+    - title: Upgrading
+      path: "/docs/reference/latest/appliances/upgrading.html"
+      prior: "/docs/reference/oparin/upgrading_appliances/index.html"
       desc: "How to upgrade appliances"
 
 configuration:
diff --git a/appliances/backup_and_restore.md b/appliances/backup_and_restore.md
new file mode 100644
index 000000000..84bcac296
--- /dev/null
+++ b/appliances/backup_and_restore.md
@@ -0,0 +1,42 @@
+---
+---
+
+# Backup
+Creating a backup of the appliance will be done using SSH or the console.
+
+1. Launch `appliance_console`
+  a. Select `Stop EVM Server Processes` to stop the server processes
+  b. Select `Create Database Backup` and choose a backup location (/tmp/evm_db.backup is the default)
+  c. Select `Quit` to return to the shell
+2. For convenience, create a TGZ containing all files required to restore the database
+   ```bash
+     tar -czvf /root/backup.tgz /tmp/evm_db.backup /var/www/miq/vmdb/GUID /var/www/miq/vmdb/certs/v2_key
+   ```
+
+3. Save and/or rename `/root/backup.tgz`
+
+# Restore
+Restoring a backup of the appliance will be done using SSH or the console.
+
+1. Download a backup TGZ and place it in `/`
+2. On the command line:
+   ```bash
+     cd /
+     tar -zxf /backup
+     rm -f /backup # if desired to save space
+   ```
+
+3. Launch `appliance_console`
+  a. If this is a brand new appliance and the database has not yet been initialized, select `Configure Application`. If this is an existing database appliance, this step can be skipped.
+    1. When prompted to configure the database, select `Create Internal Database`
+    2. When prompted to configure messaging, select `Make No messaging changes`
+    3. Choose a database disk
+    4. Answer y or n to "Should this appliance run as a standalone database server?"
+    5. Enter a region number (0), this is not important and will be overwritten on restore
+    6. Set a database password
+    7. Wait for database initialization to complete.
+  b. Select `Stop EVM Server Processes`
+  c. Select `Restore Database From Backup`
+    1. Decide whether you want to delete the backup file in /tmp after restore. (Yes)
+  d. Select `Start EVM Server Processes`
+4. After a few minutes, you can log into the web UI and see all of the data contained in the backup.
diff --git a/upgrading_appliances/index.md b/appliances/upgrading.md
similarity index 100%
rename from upgrading_appliances/index.md
rename to appliances/upgrading.md