From 42a69236fa10de90a793041c5b4cd0b1ebe50196 Mon Sep 17 00:00:00 2001 From: Adin Ermie Date: Tue, 7 Sep 2021 11:31:45 -0400 Subject: [PATCH] Backup config clarity and restore example (#21313) * Backup config clarity and restore example Added clarity on backup configuration against a cluster or HA configuration. Added restore example in relation to version upgrades. * Apply suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --- .../configuring-backups-on-your-appliance.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md b/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md index f02d9a9c80..8b04106d7e 100644 --- a/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md +++ b/content/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance.md @@ -64,13 +64,20 @@ More resources may be required depending on your usage, such as user activity an ``` 2. Copy the included `backup.config-example` file to `backup.config` and open in an editor. 3. Set the `GHE_HOSTNAME` value to your primary {% data variables.product.prodname_ghe_server %} instance's hostname or IP address. + + {% note %} + + **Note:** If your {% data variables.product.product_location %} is deployed as a cluster or in a high availability configuration using a load balancer, the `GHE_HOSTNAME` can be the load balancer hostname, as long as it allows SSH access (on port 122) to {% data variables.product.product_location %}. + + {% endnote %} + 4. Set the `GHE_DATA_DIR` value to the filesystem location where you want to store backup snapshots. 5. Open your primary instance's settings page at `https://HOSTNAME/setup/settings` and add the backup host's SSH key to the list of authorized SSH keys. For more information, see [Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/guides/installation/accessing-the-administrative-shell-ssh/). -5. Verify SSH connectivity with {% data variables.product.product_location %} with the `ghe-host-check` command. +6. Verify SSH connectivity with {% data variables.product.product_location %} with the `ghe-host-check` command. ```shell $ bin/ghe-host-check ``` - 6. To create an initial full backup, run the `ghe-backup` command. + 7. To create an initial full backup, run the `ghe-backup` command. ```shell $ bin/ghe-backup ``` @@ -95,6 +102,14 @@ In the event of prolonged outage or catastrophic event at the primary site, you {% endnote %} {% endif %} +{% note %} + +**Note:** When performing backup restores to {% data variables.product.product_location %}, the same version supportability rules apply. You can only restore data from at most two feature releases behind. + +For example, if you take a backup from GHES 3.0.x, you can restore it into a GHES 3.2.x instance. But, you cannot restore data from a backup of GHES 2.22.x onto 3.2.x, because that would be three jumps between versions (2.22 > 3.0 > 3.1 > 3.2). You would first need to restore onto a 3.1.x instance, and then upgrade to 3.2.x. + +{% endnote %} + To restore {% data variables.product.product_location %} from the last successful snapshot, use the `ghe-restore` command. You should see output similar to this: ```shell