Noting backup-utils does not support replica backups#398
Conversation
…e, updating documentation to reflect this.
…e, updating documentation to reflect this.
…h/backup-utils into documentation-update
…h/backup-utils into documentation-update
…h/backup-utils into documentation-update
joshuajleigh
changed the title
|
|
||
| Backup Utilities cannot be used on a GitHub Enterprise instance running as a High | ||
| Availability replica. If you promote your High Availability replica to become the | ||
| primary instance, you will need to add Backup Utilities at that time. |
There was a problem hiding this comment.
Thanks for the PR. I think this addition is best suited in a more prominent place like point 2 of "Getting started".
Something like the following change (some of the wording my need tweaking):
backup and restore GitHub Enterprise 2.10 and earlier.
2. Copy the [`backup.config-example`][3] file to `backup.config` and modify as
- necessary. The `GHE_HOSTNAME` value must be set to the GitHub Enterprise
+ necessary. The `GHE_HOSTNAME` value must be set to the primary GitHub Enterprise
host name. Additional options are available and documented in the
configuration file but none are required for basic backup functionality.
+ As the data on a High Availability replica may be in a transient state at the time of backup,
+ Backup Utilities should not be used to backup data from a High Availability replica.
+
* Backup Utilities will attempt to load the backup configuration from the following
locations, in this order:I've deliberately left off your last sentence as this shouldn't be needed as you'd still be performing the backup using the same hostname after failover.
Thoughts on wording @github/backup-utils ?
|
What would it take to enable backup for clustering environments? Is it feasible if the node is taken out of the cluster temporarily, then restored to the cluster? |
@nkadel your question is better suited to an issue of its own rather than tacking onto this PR, but in short, there's nothing to do. Backup Utilities already fully supports backing up a cluster. If you want further details or to discuss further please open a new issue so we don't derail this PR. |
|
Closing in favour of #436 |
…rted-version Update minimum supported version to be 3.7
3 participants
Working with Github Enterprise Support I have learned that Github Backup Utilities does not currently support backing up a High Availability Replica instance. I wanted to be sure this was documented for others in the future.