Skip to content

Commit 9287052

Browse files
committed
Merge pull request #140 from github/difference-from-HA-backup
Explain why backup-utils is useful even if you have the HA replica running
2 parents 0a00e0c + 2eed112 commit 9287052

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This repository includes backup and recovery utilities for [GitHub Enterprise][1
1313
- **[Using the backup and restore commands](#using-the-backup-and-restore-commands)**
1414
- **[Scheduling backups](#scheduling-backups)**
1515
- **[Backup snapshot file structure](#backup-snapshot-file-structure)**
16+
- **[How does backup utilities differ from a High Availability replica?](#how-does-backup-utilities-differ-from-an-ha-high-availability-replica)
1617
- **[Support](#support)**
1718

1819
### Features
@@ -231,6 +232,16 @@ most recent successful snapshot:
231232
Note: the `GHE_DATA_DIR` variable set in `backup.config` can be used to change
232233
the disk location where snapshots are written.
233234

235+
### How does backup utilities differ from a High Availability replica?
236+
It is recommended that both backup utilities and an [High Availability replica](https://help.github.com/enterprise/admin/guides/installation/high-availability-cluster-configuration/) are used as part of a GitHub Enterprise deployment but they serve different roles.
237+
238+
##### The purpose of the High Availability replica
239+
The High Availability replica is a fully redundant secondary GitHub Enterprise instance, kept in sync with the primary instance via replication of all major datastores. This active/passive cluster configuration is designed to minimize service disruption in the event of hardware failure or major network outage affecting the primary instance. Because some forms of data corruption or loss may be replicated immediately from primary to replica, it is not a replacement for the backup utilities as part of your disaster recovery plan.
240+
241+
##### The purpose of the backup utilities
242+
Backup utilities are a disaster recovery tool. This tool takes date-stamped snapshots of all major datastores. These snapshots are used to restore an instance to a prior state or set up a new instance without having another always-on GitHub Enterprise instance (like the High Availability replica).
243+
244+
234245
### Support
235246

236247
If you find a bug or would like to request a feature in backup-utils, please

0 commit comments

Comments
 (0)