Document the steps for backup and restore of appliances #1740

bdunne · 2023-08-10T21:33:41Z

No description provided.

bdunne · 2023-08-10T21:34:27Z

_data/site_menu.yml

@@ -31,6 +31,13 @@ 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)"

+appliance_backup:


Should appliance backup and restore live next to appliance upgrade?

Yes, maybe perhaps under a separate sub-menu?

Fryguy · 2023-08-12T16:28:41Z

appliance_specific/index.md

+  a. Select `12) Stop EVM Server Processes` to stop the server processes
+  b. Select `2) Create Database Backup` and choosea backup location (/tmp/evm_db.backup is the default)
+  c. Select `17) Quit` to return to the shell


Minor, but I suggest remove the 12), 2), etc, because the numbers could change if we insert new stuff (think for Kafka). I think the text is sufficient.

Ironically, I think we kept the number the same and changed the text (Configure Database -> Configure Application) when we added Kafka 😄

Fryguy · 2023-08-12T16:28:49Z

appliance_specific/index.md

+
+1. Launch `appliance_console`
+  a. Select `12) Stop EVM Server Processes` to stop the server processes
+  b. Select `2) Create Database Backup` and choosea backup location (/tmp/evm_db.backup is the default)


Suggested change

b. Select `2) Create Database Backup` and choosea backup location (/tmp/evm_db.backup is the default)

b. Select `2) Create Database Backup` and choose a backup location (/tmp/evm_db.backup is the default)

Fryguy · 2023-08-12T16:29:26Z

appliance_specific/index.md

+  c. Select `17) Quit` to return to the shell
+2. For convenience, create a TGZ containing all files required to restore the database
+
+        # tar -czvf /root/backup.tgz /tmp/evm_db.backup /var/www/miq/vmdb/GUID /var/www/miq/vmdb/certs/v2_key


I suggest using ```bash around this (and then you can remove the comment #

Also, prefer a 3 space indent (that will allow markdown rendering to put it under the 2., but not make it a quote block)

_data/site_menu.yml

miq-bot · 2023-09-12T13:56:16Z

Checked commit bdunne@97a6aeb with ruby 2.6.10, rubocop 1.28.2, haml-lint 0.35.0, and yamllint
1 file checked, 1 offense detected

**

💣 💥 🔥 🚒 - Linter/Yaml - missing config files

Fryguy · 2023-09-14T15:08:00Z

I will have to manually backport this one, so the prior goes to the right location

dehawkins512 · 2023-09-19T15:25:38Z

@miq-bot add_labels petrosian/yes?,oparin/yes?,najdorf/yes?,quinteros/yes?

Fryguy · 2023-09-20T19:50:32Z

@bdunne A conflict occurred during the backport of this pull request to quinteros.

If this pull request is based on another pull request that has not been marked for backport, add the appropriate labels to the other pull request. Otherwise, please create a new pull request direct to the quinteros branch in order to resolve this.

Conflict details:

diff --cc _data/site_menu.yml
index 1e0d476f,263af274..00000000
--- a/_data/site_menu.yml
+++ b/_data/site_menu.yml
@@@ -4,38 -4,42 +4,47 @@@ installation
    title: Installation
    children:
      - title: Amazon Web Services (AWS)
 -      path: "/docs/reference/latest/installing_on_aws/index.html"
 +      path: "/docs/reference/quinteros/installing_on_aws/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on Amazon Web Services (AWS)"
      - title: Kubernetes
 -      path: "/docs/reference/latest/installing_on_kubernetes/index.html"
 +      path: "/docs/reference/quinteros/installing_on_kubernetes/index.html"
        desc: "How to install and configure ManageIQ on Kubernetes"
      - title: IBM Cloud
 -      path: "/docs/reference/latest/installing_on_ibm_cloud/index.html"
 +      path: "/docs/reference/quinteros/installing_on_ibm_cloud/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on IBM Cloud"
      - title: Microsoft Azure
 -      path: "/docs/reference/latest/installing_on_microsoft_azure/index.html"
 +      path: "/docs/reference/quinteros/installing_on_microsoft_azure/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on Microsoft Azure"
      - title: Google Compute Engine
 -      path: "/docs/reference/latest/installing_on_google_compute_engine/index.html"
 +      path: "/docs/reference/quinteros/installing_on_google_compute_engine/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on Google Compute Engine"
      - title: VMware vSphere
 -      path: "/docs/reference/latest/installing_on_vmware_vsphere/index.html"
 +      path: "/docs/reference/quinteros/installing_on_vmware_vsphere/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on VMware vSphere"
      - title: Red Hat Enterprise OpenStack Platform
 -      path: "/docs/reference/latest/installing_on_red_hat_enterprise_linux_openstack_platform/index.html"
 +      path: "/docs/reference/quinteros/installing_on_red_hat_enterprise_linux_openstack_platform/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on Red Hat OpenStack Platform"
      - title: Red Hat Enterprise Virtualization
 -      path: "/docs/reference/latest/installing_on_red_hat_virtualization/index.html"
 +      path: "/docs/reference/quinteros/installing_on_red_hat_virtualization/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on Red Hat Enterprise Virtualization"
      - title: Microsoft System Center Virtual Machine Manager (SCVMM)
 -      path: "/docs/reference/latest/installing_on_scvmm/index.html"
 +      path: "/docs/reference/quinteros/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:
++<<<<<<< HEAD
 +    - title: Appliances
 +      path: "/docs/reference/quinteros/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"
++>>>>>>> 08b7e1a7 (Merge pull request #1740 from bdunne/appliance_backup_restore)
        desc: "How to upgrade appliances"
  
  configuration:

Document the steps for backup and restore of appliances (cherry picked from commit 08b7e1a)

Fryguy · 2023-09-20T19:54:20Z

Manual backport to quinteros via c4aca4a

commit c4aca4a419f918f0e1b183e4730b16dd344c5ad7 (HEAD -> quinteros, upstream/quinteros)
Author: Jason Frey <[email protected]>
Date:   Thu Sep 14 10:30:07 2023 -0400

    Merge pull request #1740 from bdunne/appliance_backup_restore

    Document the steps for backup and restore of appliances

    (cherry picked from commit 08b7e1a78dfc043e100517d26135d3a9fdd90149)

Fryguy · 2023-09-20T19:55:57Z

@bdunne A conflict occurred during the backport of this pull request to petrosian.

If this pull request is based on another pull request that has not been marked for backport, add the appropriate labels to the other pull request. Otherwise, please create a new pull request direct to the petrosian branch in order to resolve this.

Conflict details:

diff --cc _data/site_menu.yml
index 326b020c,263af274..00000000
--- a/_data/site_menu.yml
+++ b/_data/site_menu.yml
@@@ -4,38 -4,42 +4,47 @@@ installation
    title: Installation
    children:
      - title: Amazon Web Services (AWS)
 -      path: "/docs/reference/latest/installing_on_aws/index.html"
 +      path: "/docs/reference/petrosian/installing_on_aws/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on Amazon Web Services (AWS)"
      - title: Kubernetes
 -      path: "/docs/reference/latest/installing_on_kubernetes/index.html"
 +      path: "/docs/reference/petrosian/installing_on_kubernetes/index.html"
        desc: "How to install and configure ManageIQ on Kubernetes"
      - title: IBM Cloud
 -      path: "/docs/reference/latest/installing_on_ibm_cloud/index.html"
 +      path: "/docs/reference/petrosian/installing_on_ibm_cloud/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on IBM Cloud"
      - title: Microsoft Azure
 -      path: "/docs/reference/latest/installing_on_microsoft_azure/index.html"
 +      path: "/docs/reference/petrosian/installing_on_microsoft_azure/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on Microsoft Azure"
      - title: Google Compute Engine
 -      path: "/docs/reference/latest/installing_on_google_compute_engine/index.html"
 +      path: "/docs/reference/petrosian/installing_on_google_compute_engine/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on Google Compute Engine"
      - title: VMware vSphere
 -      path: "/docs/reference/latest/installing_on_vmware_vsphere/index.html"
 +      path: "/docs/reference/petrosian/installing_on_vmware_vsphere/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on VMware vSphere"
      - title: Red Hat Enterprise OpenStack Platform
 -      path: "/docs/reference/latest/installing_on_red_hat_enterprise_linux_openstack_platform/index.html"
 +      path: "/docs/reference/petrosian/installing_on_red_hat_enterprise_linux_openstack_platform/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on Red Hat OpenStack Platform"
      - title: Red Hat Enterprise Virtualization
 -      path: "/docs/reference/latest/installing_on_red_hat_virtualization/index.html"
 +      path: "/docs/reference/petrosian/installing_on_red_hat_virtualization/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on Red Hat Enterprise Virtualization"
      - title: Microsoft System Center Virtual Machine Manager (SCVMM)
 -      path: "/docs/reference/latest/installing_on_scvmm/index.html"
 +      path: "/docs/reference/petrosian/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:
++<<<<<<< HEAD
 +    - title: Appliances
 +      path: "/docs/reference/petrosian/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"
++>>>>>>> 08b7e1a7 (Merge pull request #1740 from bdunne/appliance_backup_restore)
        desc: "How to upgrade appliances"
  
  configuration:

Document the steps for backup and restore of appliances (cherry picked from commit 08b7e1a)

Fryguy · 2023-09-20T19:58:21Z

Manual backport to petrosian via 3f6812d

commit 3f6812d3d1421a33532aecc2a2ee437d71816d87 (HEAD -> petrosian, upstream/petrosian)
Author: Jason Frey <[email protected]>
Date:   Thu Sep 14 10:30:07 2023 -0400

    Merge pull request #1740 from bdunne/appliance_backup_restore

    Document the steps for backup and restore of appliances

    (cherry picked from commit 08b7e1a78dfc043e100517d26135d3a9fdd90149)

Document the steps for backup and restore of appliances (cherry picked from commit 08b7e1a)

Fryguy · 2023-09-20T20:00:47Z

Manual backport to oparin via 2584ddc

commit 2584ddc6d3347b6d60558932657d7bedc6be72d6 (HEAD -> oparin, upstream/oparin)
Author: Jason Frey <[email protected]>
Date:   Thu Sep 14 10:30:07 2023 -0400

    Merge pull request #1740 from bdunne/appliance_backup_restore

    Document the steps for backup and restore of appliances

    (cherry picked from commit 08b7e1a78dfc043e100517d26135d3a9fdd90149)

Fryguy · 2023-09-20T20:01:45Z

@bdunne A conflict occurred during the backport of this pull request to najdorf.

If this pull request is based on another pull request that has not been marked for backport, add the appropriate labels to the other pull request. Otherwise, please create a new pull request direct to the najdorf branch in order to resolve this.

Conflict details:

diff --cc _data/site_menu.yml
index 8921a81c,263af274..00000000
--- a/_data/site_menu.yml
+++ b/_data/site_menu.yml
@@@ -4,38 -4,42 +4,47 @@@ installation
    title: Installation
    children:
      - title: Amazon Web Services (AWS)
 -      path: "/docs/reference/latest/installing_on_aws/index.html"
 +      path: "/docs/reference/najdorf/installing_on_aws/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on Amazon Web Services (AWS)"
      - title: Kubernetes
 -      path: "/docs/reference/latest/installing_on_kubernetes/index.html"
 +      path: "/docs/reference/najdorf/installing_on_kubernetes/index.html"
        desc: "How to install and configure ManageIQ on Kubernetes"
      - title: IBM Cloud
 -      path: "/docs/reference/latest/installing_on_ibm_cloud/index.html"
 +      path: "/docs/reference/najdorf/installing_on_ibm_cloud/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on IBM Cloud"
      - title: Microsoft Azure
 -      path: "/docs/reference/latest/installing_on_microsoft_azure/index.html"
 +      path: "/docs/reference/najdorf/installing_on_microsoft_azure/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on Microsoft Azure"
      - title: Google Compute Engine
 -      path: "/docs/reference/latest/installing_on_google_compute_engine/index.html"
 +      path: "/docs/reference/najdorf/installing_on_google_compute_engine/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on Google Compute Engine"
      - title: VMware vSphere
 -      path: "/docs/reference/latest/installing_on_vmware_vsphere/index.html"
 +      path: "/docs/reference/najdorf/installing_on_vmware_vsphere/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on VMware vSphere"
      - title: Red Hat Enterprise OpenStack Platform
 -      path: "/docs/reference/latest/installing_on_red_hat_enterprise_linux_openstack_platform/index.html"
 +      path: "/docs/reference/najdorf/installing_on_red_hat_enterprise_linux_openstack_platform/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on Red Hat OpenStack Platform"
      - title: Red Hat Enterprise Virtualization
 -      path: "/docs/reference/latest/installing_on_red_hat_virtualization/index.html"
 +      path: "/docs/reference/najdorf/installing_on_red_hat_virtualization/index.html"
        desc: "How to install and configure the ManageIQ Management Engine appliance on Red Hat Enterprise Virtualization"
      - title: Microsoft System Center Virtual Machine Manager (SCVMM)
 -      path: "/docs/reference/latest/installing_on_scvmm/index.html"
 +      path: "/docs/reference/najdorf/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:
++<<<<<<< HEAD
 +    - title: Appliances
 +      path: "/docs/reference/najdorf/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"
++>>>>>>> 08b7e1a7 (Merge pull request #1740 from bdunne/appliance_backup_restore)
        desc: "How to upgrade appliances"
  
  configuration:

Document the steps for backup and restore of appliances (cherry picked from commit 08b7e1a)

Fryguy · 2023-09-20T20:03:58Z

Manual backport to najdorf via eca1a4b

commit eca1a4b4b3d4c779556be689409aeeb64a4fe93f (HEAD -> najdorf, upstream/najdorf)
Author: Jason Frey <[email protected]>
Date:   Thu Sep 14 10:30:07 2023 -0400

    Merge pull request #1740 from bdunne/appliance_backup_restore

    Document the steps for backup and restore of appliances

    (cherry picked from commit 08b7e1a78dfc043e100517d26135d3a9fdd90149)

The prior now lives in the najdorf backport commit eca1a4b

Remove prior now that #1740 has been backported down to najdorf

bdunne added the enhancement label Aug 10, 2023

bdunne commented Aug 10, 2023

View reviewed changes

Fryguy reviewed Aug 12, 2023

View reviewed changes

Fryguy self-assigned this Aug 12, 2023

bdunne force-pushed the appliance_backup_restore branch from 3a5b0f9 to 01a77f7 Compare August 23, 2023 21:56

bdunne added petrosian/yes? quinteros/yes? labels Aug 28, 2023

Fryguy reviewed Aug 28, 2023

View reviewed changes

_data/site_menu.yml Show resolved Hide resolved

Document the steps for backup and restore of appliances

97a6aeb

bdunne force-pushed the appliance_backup_restore branch from 01a77f7 to 97a6aeb Compare September 12, 2023 13:53

Fryguy merged commit 08b7e1a into ManageIQ:master Sep 14, 2023
2 checks passed

github-actions bot pushed a commit to ManageIQ/manageiq.github.io that referenced this pull request Sep 14, 2023

Deploy for ManageIQ/manageiq-documentation#1740

fb0a669

bdunne deleted the appliance_backup_restore branch September 14, 2023 14:58

miq-bot added najdorf/yes? oparin/yes? labels Sep 19, 2023

Fryguy added quinteros/yes najdorf/yes oparin/yes petrosian/yes and removed quinteros/yes? najdorf/yes? oparin/yes? petrosian/yes? labels Sep 20, 2023

Fryguy added the quinteros/conflict label Sep 20, 2023

Fryguy added a commit that referenced this pull request Sep 20, 2023

Merge pull request #1740 from bdunne/appliance_backup_restore

c4aca4a

Document the steps for backup and restore of appliances (cherry picked from commit 08b7e1a)

Fryguy added quinteros/backported and removed quinteros/yes quinteros/conflict labels Sep 20, 2023

Fryguy added the petrosian/conflict label Sep 20, 2023

Fryguy added a commit that referenced this pull request Sep 20, 2023

Merge pull request #1740 from bdunne/appliance_backup_restore

3f6812d

Document the steps for backup and restore of appliances (cherry picked from commit 08b7e1a)

Fryguy added petrosian/backported and removed petrosian/yes petrosian/conflict labels Sep 20, 2023

Fryguy added a commit that referenced this pull request Sep 20, 2023

Merge pull request #1740 from bdunne/appliance_backup_restore

2584ddc

Document the steps for backup and restore of appliances (cherry picked from commit 08b7e1a)

Fryguy added oparin/backported and removed oparin/yes labels Sep 20, 2023

Fryguy added the najdorf/conflict label Sep 20, 2023

Fryguy added a commit that referenced this pull request Sep 20, 2023

Merge pull request #1740 from bdunne/appliance_backup_restore

eca1a4b

Document the steps for backup and restore of appliances (cherry picked from commit 08b7e1a)

Fryguy added najdorf/backported and removed najdorf/conflict najdorf/yes labels Sep 20, 2023

Fryguy added a commit to Fryguy/manageiq-documentation that referenced this pull request Sep 20, 2023

Remove prior now that ManageIQ#1740 has been backported down to najdorf

a739e2a

The prior now lives in the najdorf backport commit eca1a4b

github-actions bot pushed a commit to ManageIQ/manageiq.github.io that referenced this pull request Sep 20, 2023

Deploy for ManageIQ/manageiq-documentation#1740

eabcec6

github-actions bot pushed a commit to ManageIQ/manageiq.github.io that referenced this pull request Sep 20, 2023

Deploy for ManageIQ/manageiq-documentation#1740

eaff124

bdunne added a commit that referenced this pull request Sep 20, 2023

Merge pull request #1744 from Fryguy/remove_prior

656432f

Remove prior now that #1740 has been backported down to najdorf

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document the steps for backup and restore of appliances #1740

Document the steps for backup and restore of appliances #1740

bdunne commented Aug 10, 2023

bdunne Aug 10, 2023

Fryguy Aug 12, 2023

Fryguy Aug 12, 2023

bdunne Aug 14, 2023

Fryguy Aug 12, 2023

Fryguy Aug 12, 2023

Fryguy Aug 12, 2023

miq-bot commented Sep 12, 2023

Fryguy commented Sep 14, 2023

dehawkins512 commented Sep 19, 2023

Fryguy commented Sep 20, 2023

Fryguy commented Sep 20, 2023

Fryguy commented Sep 20, 2023

Fryguy commented Sep 20, 2023

Fryguy commented Sep 20, 2023

Fryguy commented Sep 20, 2023

Fryguy commented Sep 20, 2023

	b. Select `2) Create Database Backup` and choosea backup location (/tmp/evm_db.backup is the default)
	b. Select `2) Create Database Backup` and choose a backup location (/tmp/evm_db.backup is the default)

Document the steps for backup and restore of appliances #1740

Document the steps for backup and restore of appliances #1740

Conversation

bdunne commented Aug 10, 2023

bdunne Aug 10, 2023

Choose a reason for hiding this comment

Fryguy Aug 12, 2023

Choose a reason for hiding this comment

Fryguy Aug 12, 2023

Choose a reason for hiding this comment

bdunne Aug 14, 2023

Choose a reason for hiding this comment

Fryguy Aug 12, 2023

Choose a reason for hiding this comment

Fryguy Aug 12, 2023

Choose a reason for hiding this comment

Fryguy Aug 12, 2023

Choose a reason for hiding this comment

miq-bot commented Sep 12, 2023

Fryguy commented Sep 14, 2023

dehawkins512 commented Sep 19, 2023

Fryguy commented Sep 20, 2023

Fryguy commented Sep 20, 2023

Fryguy commented Sep 20, 2023

Fryguy commented Sep 20, 2023

Fryguy commented Sep 20, 2023

Fryguy commented Sep 20, 2023

Fryguy commented Sep 20, 2023