Skip to content

Commit 7c01d3a

Browse files
authored
Merge pull request #44867 from github/repo-sync
Repo sync
2 parents d19ad45 + 4b0a834 commit 7c01d3a

64 files changed

Lines changed: 760 additions & 385 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/about-the-backup-service-for-github-enterprise-server.md renamed to content/admin/backing-up-and-restoring-your-instance/about-the-backup-service-for-github-enterprise-server.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ versions:
77
contentType: concepts
88
category:
99
- 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
1012
---
1113

1214
{% ifversion ghes < 3.20 %}
@@ -48,7 +50,7 @@ The backup service is a disaster recovery solution. It captures full, timestampe
4850

4951
## Further reading
5052

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)

content/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/backup-from-replica-in-high-availability.md renamed to content/admin/backing-up-and-restoring-your-instance/backup-from-replica-in-high-availability.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,18 @@ versions:
77
contentType: how-tos
88
category:
99
- 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
1012
---
1113

1214
## Configuring backups from a replica node
1315

1416
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.
1517

16-
> [!IMPORTANT]
18+
> [!IMPORTANT]
1719
> Backups from cache replica nodes or active geo replica nodes are not supported.
1820
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).
2022

2123
```shell
2224
ghe-storage-init-backup /dev/YOUR_DEVICE_NAME

content/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/backup-in-clustering-mode.md renamed to content/admin/backing-up-and-restoring-your-instance/backup-in-clustering-mode.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,23 @@ versions:
77
contentType: how-tos
88
category:
99
- 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
1012
---
1113

1214
## Configuring backups from a cluster node
1315

1416
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.
1517

16-
> [!IMPORTANT]
18+
> [!IMPORTANT]
1719
> Only one node can be specified as a `backup-server` node.
1820
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).
2022

2123
```shell
2224
ghe-storage-init-backup /dev/YOUR_DEVICE_NAME
2325

2426
ghe-config-apply
2527
```
26-
28+
2729
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.

content/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/index.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

content/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/backup-service-settings-reference.md renamed to content/admin/backing-up-and-restoring-your-instance/backup-service-settings-reference.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ versions:
77
contentType: reference
88
category:
99
- 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
1012
---
1113

1214
You can configure the following options in the "Backup Service" section of the {% data variables.enterprise.management_console %}.

content/admin/backing-up-and-restoring-your-instance/configuring-backups-on-your-instance.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Configuring backups on your instance using Backup Utilities
2+
title: Configuring backups on your instance with Backup Utilities
33
allowTitleToDifferFromFilename: true
4-
shortTitle: Configuring backups
4+
shortTitle: Backup Utilities (legacy)
55
redirect_from:
66
- /enterprise/admin/categories/backups-and-restores
77
- /enterprise/admin/articles/backup-and-recovery
@@ -19,18 +19,13 @@ redirect_from:
1919
- /admin/configuration/configuring-your-enterprise/configuring-backups-on-your-instance
2020
intro: As part of a disaster recovery plan, you can protect production data on {% data variables.location.product_location %} by configuring automated backups.
2121
versions:
22-
ghes: '*'
22+
ghes: '< 3.22'
2323
contentType: how-tos
2424
category:
2525
- Back up and upgrade your instance
2626
---
2727

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
3429
3530
## About {% data variables.product.prodname_enterprise_backup_utilities %}
3631

@@ -54,7 +49,7 @@ Physical storage requirements will vary based on Git repository disk usage and e
5449

5550
| Hardware | Recommendation |
5651
| -------- | --------- |
57-
| **vCPUs** | 4 |
52+
| **vCPUs** | 4 |
5853
| **Memory** | 8 GB |
5954
| **Storage** | Five times the primary instance's allocated storage |
6055

@@ -208,4 +203,4 @@ Optionally, you can run the following command to print the current progress, the
208203
209204
```shell copy
210205
bin/ghe-backup-progress --once
211-
```
206+
```

content/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/configuring-remote-archives-for-backups.md renamed to content/admin/backing-up-and-restoring-your-instance/configuring-remote-archives-for-backups.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ versions:
77
contentType: how-tos
88
category:
99
- 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
1012
---
1113

1214
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
1517

1618
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.
1719

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).
1921
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:
2022

2123
```bash

content/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/configuring-the-backup-service.md renamed to content/admin/backing-up-and-restoring-your-instance/configuring-the-backup-service.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ versions:
77
contentType: how-tos
88
category:
99
- 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
1012
---
1113

1214
Before configuring the backup service, ensure you have:

content/admin/backing-up-and-restoring-your-instance/backup-service-for-github-enterprise-server/creating-and-monitoring-backups.md renamed to content/admin/backing-up-and-restoring-your-instance/creating-and-monitoring-backups.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ versions:
77
contentType: how-tos
88
category:
99
- 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
1012
---
1113

1214
## About backup types

content/admin/backing-up-and-restoring-your-instance/index.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,20 @@ intro: 'You can configure backups for your instance and troubleshoot common back
55
versions:
66
ghes: '*'
77
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
819
- /configuring-backups-on-your-instance
9-
- /backup-service-for-github-enterprise-server
1020
redirect_from:
1121
- /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
1223
---
1324

0 commit comments

Comments
 (0)