Skip to content

Commit d0422d4

Browse files
Update instructions for setup backup service in HA and cluster (#59885)
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent 6807572 commit d0422d4

File tree

3 files changed

+11
-5
lines changed

3 files changed

+11
-5
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ For high availability, you can designate a replica node as your backup server. T
1616
> [!IMPORTANT]
1717
> Backups from cache replica nodes or active geo replica nodes are not supported.
1818
19-
To configure your backup server, run the following commands, replacing `HOSTNAME` with the hostname of the node:
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).
2020

2121
```shell
22-
ghe-config cluster.HOSTNAME.backup-server true
22+
ghe-storage-init-backup /dev/YOUR_DEVICE_NAME
2323

2424
ghe-config-apply
2525
```

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ For clustering, you can designate a node as your backup server. To minimize late
1616
> [!IMPORTANT]
1717
> Only one node can be specified as a `backup-server` node.
1818
19-
1. To configure your backup server, 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).
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).
2020

21-
1. After `ghe-storage-init-backup` 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.
21+
```shell
22+
ghe-storage-init-backup /dev/YOUR_DEVICE_NAME
23+
24+
ghe-config-apply
25+
```
26+
27+
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/configuring-the-backup-service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ If the device was already initialized using `ghe-storage-init-backup`, you can r
139139
140140
### Configuring backup settings
141141
142-
After the backup target is mounted, the Backup Service page will become available in the {% data variables.enterprise.management_console %} in the "Backup" section. {% ifversion ghes > 3.19 %} If your instance is part of a clustered environment, the system will automatically detect the node that was initialized with `ghe-storage-init-backup` and treat it as the backup server. {% endif %}
142+
After the backup target is mounted, the Backup Service page will become available in the {% data variables.enterprise.management_console %} in the "Backup" section. {% ifversion ghes > 3.19 %} If your instance is part of a clustered environment, the Backup Service page will be available after `ghe-config-apply`. {% endif %}
143143
144144
>[!NOTE] The settings page won’t appear until the backup storage is mounted at `/data/backup` by completing the initialization or mount steps above.
145145

0 commit comments

Comments
 (0)