Skip to content
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.

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

Document the steps for backup and restore of appliances #1740

Merged
merged 1 commit into from
Sep 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 8 additions & 4 deletions _data/site_menu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Fryguy marked this conversation as resolved.
Show resolved Hide resolved
prior: "/docs/reference/oparin/upgrading_appliances/index.html"
desc: "How to upgrade appliances"

configuration:
Expand Down
42 changes: 42 additions & 0 deletions appliances/backup_and_restore.md
Original file line number Diff line number Diff line change
@@ -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.
File renamed without changes.