Commit e7acac0
Gate backup-utils documentation and remove preview marker from backup-service on appropriate versions (#61656)
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: isaacmbrown <isaacmbrown@github.com>
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>1 parent 9b47ccd commit e7acac0
25 files changed
Lines changed: 72 additions & 58 deletions
File tree
- content
- admin
- backing-up-and-restoring-your-instance
- backup-service-for-github-enterprise-server
- configuring-settings/configuring-network-settings
- managing-accounts-and-repositories/managing-users-in-your-enterprise
- monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources
- upgrading-your-instance/preparing-to-upgrade
- get-started/onboarding
- data/release-notes/enterprise-server
- 3-17
- 3-20
- src/workflows
Lines changed: 6 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -7,6 +7,8 @@ versions: | |||
| 7 | 7 | contentType: concepts | |
| 8 | 8 | category: | |
| 9 | 9 | - Back up and upgrade your instance | |
| 10 | + redirect_from: | ||
| 11 | + - /admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/about-the-backup-service-for-github-enterprise-server | ||
| 10 | 12 | --- | |
| 11 | 13 | ||
| 12 | 14 | {% ifversion ghes < 3.20 %} | |
@@ -48,7 +50,7 @@ The backup service is a disaster recovery solution. It captures full, timestampe | |||
| 48 | 50 | ||
| 49 | 51 | ## Further reading | |
| 50 | 52 | ||
| 51 | - * [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/understanding-the-backup-service) | ||
| 52 | - * [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/configuring-the-backup-service) | ||
| 53 | - * [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/restoring-from-a-backup) | ||
| 54 | - * [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/restoring-with-github-actions-enabled) | ||
| 53 | + * [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/understanding-the-backup-service) | ||
| 54 | + * [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/configuring-the-backup-service) | ||
| 55 | + * [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/restoring-from-a-backup) | ||
| 56 | + * [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/restoring-with-github-actions-enabled) | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -7,16 +7,18 @@ versions: | |||
| 7 | 7 | contentType: how-tos | |
| 8 | 8 | category: | |
| 9 | 9 | - Back up and upgrade your instance | |
| 10 | + redirect_from: | ||
| 11 | + - /admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/backup-from-replica-in-high-availability | ||
| 10 | 12 | --- | |
| 11 | 13 | ||
| 12 | 14 | ## Configuring backups from a replica node | |
| 13 | 15 | ||
| 14 | 16 | For high availability, you can designate a replica node as your backup server. To minimize latency, {% data variables.product.github %} recommends picking a replica node in the same region or datacenter as your primary node. | |
| 15 | 17 | ||
| 16 | - > [!IMPORTANT] | ||
| 18 | + > [!IMPORTANT] | ||
| 17 | 19 | > Backups from cache replica nodes or active geo replica nodes are not supported. | |
| 18 | 20 | ||
| 19 | - To configure your backup server on a replica, run the following commands. See [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/configuring-the-backup-service). | ||
| 21 | + To configure your backup server on a replica, run the following commands. See [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/configuring-the-backup-service). | ||
| 20 | 22 | ||
| 21 | 23 | ```shell | |
| 22 | 24 | ghe-storage-init-backup /dev/YOUR_DEVICE_NAME | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -7,21 +7,23 @@ versions: | |||
| 7 | 7 | contentType: how-tos | |
| 8 | 8 | category: | |
| 9 | 9 | - Back up and upgrade your instance | |
| 10 | + redirect_from: | ||
| 11 | + - /admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/backup-in-clustering-mode | ||
| 10 | 12 | --- | |
| 11 | 13 | ||
| 12 | 14 | ## Configuring backups from a cluster node | |
| 13 | 15 | ||
| 14 | 16 | For clustering, you can designate a node as your backup server. To minimize latency, {% data variables.product.github %} recommends picking a data node (for example, a `mysql-server` node or a `git-server` node) instead of a frontend node. | |
| 15 | 17 | ||
| 16 | - > [!IMPORTANT] | ||
| 18 | + > [!IMPORTANT] | ||
| 17 | 19 | > Only one node can be specified as a `backup-server` node. | |
| 18 | 20 | ||
| 19 | - 1. To configure your backup server, run the following commands to set up a backup disk on one of the cluster nodes of your choice. See [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/configuring-the-backup-service). | ||
| 21 | + 1. To configure your backup server, run the following commands to set up a backup disk on one of the cluster nodes of your choice. See [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/configuring-the-backup-service). | ||
| 20 | 22 | ||
| 21 | 23 | ```shell | |
| 22 | 24 | ghe-storage-init-backup /dev/YOUR_DEVICE_NAME | |
| 23 | 25 | ||
| 24 | 26 | ghe-config-apply | |
| 25 | 27 | ``` | |
| 26 | - | ||
| 28 | + | ||
| 27 | 29 | 1. After `ghe-config-apply` is executed, the `backup-server` role will be set on this cluster node. You can now run `ghe-backup` directly on this node, or use the management console to schedule backups. | |
Lines changed: 0 additions & 19 deletions
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -7,6 +7,8 @@ versions: | |||
| 7 | 7 | contentType: reference | |
| 8 | 8 | category: | |
| 9 | 9 | - Back up and upgrade your instance | |
| 10 | + redirect_from: | ||
| 11 | + - /admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/backup-service-settings-reference | ||
| 10 | 12 | --- | |
| 11 | 13 | ||
| 12 | 14 | You can configure the following options in the "Backup Service" section of the {% data variables.enterprise.management_console %}. | |
Lines changed: 6 additions & 11 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,7 +1,7 @@ | |||
| 1 | 1 | --- | |
| 2 | - title: Configuring backups on your instance using Backup Utilities | ||
| 2 | + title: Configuring backups on your instance with Backup Utilities | ||
| 3 | 3 | allowTitleToDifferFromFilename: true | |
| 4 | - shortTitle: Configuring backups | ||
| 4 | + shortTitle: Backup Utilities (legacy) | ||
| 5 | 5 | redirect_from: | |
| 6 | 6 | - /enterprise/admin/categories/backups-and-restores | |
| 7 | 7 | - /enterprise/admin/articles/backup-and-recovery | |
@@ -19,18 +19,13 @@ redirect_from: | |||
| 19 | 19 | - /admin/configuration/configuring-your-enterprise/configuring-backups-on-your-instance | |
| 20 | 20 | intro: As part of a disaster recovery plan, you can protect production data on {% data variables.location.product_location %} by configuring automated backups. | |
| 21 | 21 | versions: | |
| 22 | - ghes: '*' | ||
| 22 | + ghes: '< 3.22' | ||
| 23 | 23 | contentType: how-tos | |
| 24 | 24 | category: | |
| 25 | 25 | - Back up and upgrade your instance | |
| 26 | 26 | --- | |
| 27 | 27 | ||
| 28 | - ## About backup options for {% data variables.product.prodname_ghe_server %} | ||
| 29 | - | ||
| 30 | - {% data variables.product.company_short %} offers two options for backing up your {% data variables.product.prodname_ghe_server %} instance: | ||
| 31 | - | ||
| 32 | - * **{% data variables.product.prodname_enterprise_backup_utilities %}**: An open-source backup system that you install on a separate host. For more information, see the sections below. | ||
| 33 | - * **{% data variables.product.prodname_enterprise_backup_service %} (in {% data variables.release-phases.public_preview %})**: A managed backup service available in {% data variables.product.prodname_ghe_server %}. See [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server). | ||
| 28 | + >[!IMPORTANT] [{% data variables.product.prodname_enterprise_backup_service %}](/admin/backing-up-and-restoring-your-instance/about-the-backup-service-for-github-enterprise-server) is now the preferred solution for backing up a {% data variables.product.prodname_ghe_server %} appliance. {% data variables.product.prodname_enterprise_backup_utilities %} is scheduled for removal in {% data variables.product.prodname_ghe_server %} version 3.22 | ||
| 34 | 29 | ||
| 35 | 30 | ## About {% data variables.product.prodname_enterprise_backup_utilities %} | |
| 36 | 31 | ||
@@ -54,7 +49,7 @@ Physical storage requirements will vary based on Git repository disk usage and e | |||
| 54 | 49 | ||
| 55 | 50 | | Hardware | Recommendation | | |
| 56 | 51 | | -------- | --------- | | |
| 57 | - | **vCPUs** | 4 | | ||
| 52 | + | **vCPUs** | 4 | | ||
| 58 | 53 | | **Memory** | 8 GB | | |
| 59 | 54 | | **Storage** | Five times the primary instance's allocated storage | | |
| 60 | 55 | ||
@@ -208,4 +203,4 @@ Optionally, you can run the following command to print the current progress, the | |||
| 208 | 203 | ||
| 209 | 204 | ```shell copy | |
| 210 | 205 | bin/ghe-backup-progress --once | |
| 211 | - ``` | ||
| 206 | + ``` | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -7,6 +7,8 @@ versions: | |||
| 7 | 7 | contentType: how-tos | |
| 8 | 8 | category: | |
| 9 | 9 | - Back up and upgrade your instance | |
| 10 | + redirect_from: | ||
| 11 | + - /admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/configuring-remote-archives-for-backups | ||
| 10 | 12 | --- | |
| 11 | 13 | ||
| 12 | 14 | If you are running {% data variables.product.prodname_ghe_server %} on a cloud platform or virtualization platform that supports disk snapshots, we recommend that you use snapshots to archive your backup disk, and recreate a new backup disk for testing, restoring, or disaster recovery purposes. However, if your infrastructure does not support disk snapshots or similar solutions, you can setup a {% data variables.product.prodname_ghe_server %} backup archive on a remote {% data variables.product.prodname_ghe_server %} appliance for data replication and restoration purposes. | |
@@ -15,7 +17,7 @@ If you are running {% data variables.product.prodname_ghe_server %} on a cloud p | |||
| 15 | 17 | ||
| 16 | 18 | Remote archives are required to be saved on a backup disk of a {% data variables.product.prodname_ghe_server %} appliance, which is used as a staging or testing {% data variables.product.prodname_ghe_server %} appliance. Follow these steps to configure remote backup archives. | |
| 17 | 19 | ||
| 18 | - 1. Set up a backup disk on a remote {% data variables.product.prodname_ghe_server %} appliance. See [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/configuring-the-backup-service). | ||
| 20 | + 1. Set up a backup disk on a remote {% data variables.product.prodname_ghe_server %} appliance. See [AUTOTITLE](/admin/backing-up-and-restoring-your-instance/configuring-the-backup-service). | ||
| 19 | 21 | 1. From the production appliance, run the following command to initiate configuration and display the SSH public key that needs to be added to the remote {% data variables.product.prodname_ghe_server %} appliance: | |
| 20 | 22 | ||
| 21 | 23 | ```bash | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -7,6 +7,8 @@ versions: | |||
| 7 | 7 | contentType: how-tos | |
| 8 | 8 | category: | |
| 9 | 9 | - Back up and upgrade your instance | |
| 10 | + redirect_from: | ||
| 11 | + - /admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/configuring-the-backup-service | ||
| 10 | 12 | --- | |
| 11 | 13 | ||
| 12 | 14 | Before configuring the backup service, ensure you have: | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -7,6 +7,8 @@ versions: | |||
| 7 | 7 | contentType: how-tos | |
| 8 | 8 | category: | |
| 9 | 9 | - Back up and upgrade your instance | |
| 10 | + redirect_from: | ||
| 11 | + - /admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/creating-and-monitoring-backups | ||
| 10 | 12 | --- | |
| 11 | 13 | ||
| 12 | 14 | ## About backup types | |
Lines changed: 12 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -5,9 +5,20 @@ intro: 'You can configure backups for your instance and troubleshoot common back | |||
| 5 | 5 | versions: | |
| 6 | 6 | ghes: '*' | |
| 7 | 7 | children: | |
| 8 | + - /about-the-backup-service-for-github-enterprise-server | ||
| 9 | + - /understanding-the-backup-service | ||
| 10 | + - /configuring-the-backup-service | ||
| 11 | + - /creating-and-monitoring-backups | ||
| 12 | + - /restoring-from-a-backup | ||
| 13 | + - /configuring-remote-archives-for-backups | ||
| 14 | + - /backup-from-replica-in-high-availability | ||
| 15 | + - /backup-in-clustering-mode | ||
| 16 | + - /restoring-with-github-actions-enabled | ||
| 17 | + - /backup-service-settings-reference | ||
| 18 | + - /understanding-the-snapshot-file-structure | ||
| 8 | 19 | - /configuring-backups-on-your-instance | |
| 9 | - - /backup-service-for-github-enterprise-server | ||
| 10 | 20 | redirect_from: | |
| 11 | 21 | - /admin/backing-up-and-restoring-your-instance/known-issues-with-backups-for-your-instance | |
| 22 | + - /admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server | ||
| 12 | 23 | --- | |
| 13 | 24 | ||
0 commit comments