backup-utils

Backups and Disaster Recovery

• Encrypted column keys from backup snapshots were not always restored.

Changes

• Error handling for MySQL backups has improved. The chosen backup strategy is logged by default, and error coverage and messaging are improved, including new warnings for file size constraints that may affect the backup process.

Backups and Disaster Recovery

• When backing up an instance in a cluster configuration using GitHub Enterprise Server Backup Utilities, if any nodes were offline, pre-flight checks would silently fail.
• Password and Chat Integration secrets were restored without using the settings -c option.
• Verbose logs include the list of storage objects being restored, helping users track the progress of the restore operation and aiding in debugging any issues.
• Encrypted column keys from backup snapshots were not always restored.

Changes

• Error handling for MySQL backups has improved. The chosen backup strategy is logged by default, and error coverage and messaging are improved, including new warnings for file size constraints that may affect the backup process.

Backups and Disaster Recovery

• When backing up an instance in a cluster configuration using GitHub Enterprise Server Backup Utilities, if any nodes were offline, pre-flight checks would silently fail.
• Password and Chat Integration secrets were restored without using the settings -c option.
• Verbose logs include the list of storage objects being restored, helping users track the progress of the restore operation and aiding in debugging any issues.
• Encrypted column keys from backup snapshots were not always restored.

Backups and Disaster Recovery

• When backing up an instance in a cluster configuration using GitHub Enterprise Server Backup Utilities, if any nodes were offline, pre-flight checks would silently fail.

Changes

• Error handling for MySQL backups has improved. The chosen backup strategy is logged by default, and error coverage and messaging are improved, including new warnings for file size constraints that may affect the backup process.

Backups and Disaster Recovery

• When backing up an instance in a cluster configuration using GitHub Enterprise Server Backup Utilities, if any nodes were offline, pre-flight checks would silently fail.
• Verbose logs include the list of storage objects being restored, helping users track the progress of the restore operation and aiding in debugging any issues.

Changes

• As part of the upgrade to GitHub Enterprise Server 3.13, Elasticsearch (ES) is upgraded from version 5.6.16 to 8.7.0. Upgrading platform components improves performance and security posture. For important upgrade considerations, see "preparing for the elastic search upgrade."
• If you restore a backup from an instance running GHES 3.11 or 3.12, then any content that relies on ES will only be available after the ES indexes have been migrated and rebuilt on the 3.13 instance.

Bug Fixes

• Offline nodes would silently fail when backing up a cluster.
• When running a backup of the HA instance, Estimated Data Transfer Sizes are not reported accurately.
• Package storage secrets were restored when -c flag was not used.
• Backing up a stand-alone GHES instance would report incorrect messages in the output. - Clustering is not configured on this host and 0 MB data transfer estimates.

Changes

• As part of the upgrade to GitHub Enterprise Server 3.13, Elasticsearch (ES) is upgraded from version 5.6.16 to 8.7.0. Upgrading platform components improves performance and security posture. For important upgrade considerations, see "preparing for the elastic search upgrade."
• If you restore a backup from an instance running GHES 3.11 or 3.12, then any content that relies on ES will only be available after the ES indexes have been migrated and rebuilt on the 3.13 instance.

Bug Fixes

• Offline nodes would silently fail when backing up a cluster.
• When running a backup of the HA instance, Estimated Data Transfer Sizes are not reported accurately.
• Package storage secrets were restored when -c flag was not used.
• Backing up a stand-alone GHES instance would report incorrect messages in the output. - Clustering is not configured on this host and 0 MB data transfer estimates.

Bug Fixes

• Only restore package storage secrets if -c flag is used.

Bug Fixes

• Only restore package storage secrets if -c flag is used.

Bug Fixes

• Backing up a stand-alone GHES instance would report the incorrect messages in the output - Clustering is not configured on this host. and 0 MB data transfer estimates.
• When running a backup of HA instance, Estimated Data Transfer Sizes were not reported accurately.

Bug Fixes

• Backing up a stand-alone GHES instance would report the incorrect messages in the output - Clustering is not configured on this host. and 0 MB data transfer estimates.
• When running a backup of HA instance, Estimated Data Transfer Sizes were not reported accurately.

Bug Fixes

• Backing up a stand-alone GHES instance would report the incorrect messages in the output - Clustering is not configured on this host. and 0 MB data transfer estimates.
• When running a backup of HA instance, Estimated Data Transfer Sizes were not reported accurately.

Bug Fixes

• Backing up a stand-alone GHES instance would report the incorrect messages in the output - Clustering is not configured on this host. and 0 MB data transfer estimates.
• When running a backup of HA instance, Estimated Data Transfer Sizes were not reported accurately.

Bug Fixes

• When restoring an instance using the ghe-restore command from GitHub Enterprise Server Backup Utilities, restoration of files in /user/data/storage failed with a xrealloc: cannot allocate (...) bytes error.

Backups and Disaster Recovery

• ghe-backup or ghe-restore commands could fail to delete progress files created by older versions of GitHub Enterprise Server Backup Utilities.
• Administrators running ghe-backup will no longer see "Verifying Routes" messages. Route verification has been found to be unnecessary and has been disabled by default. Administrators who prefer to see these messages can enable route verification by setting GHE_ROUTE_VERIFICATION to "true" in their backup-utils configuration file.
• To prevent problems associated with incomplete backups, the ghe-restore process will exit with an error if the snapshot being restored is incomplete.

Bug Fixes

• When restoring an instance using the ghe-restore command from GitHub Enterprise Server Backup Utilities, restoration of files in /user/data/storage failed with a xrealloc: cannot allocate (...) bytes error.

Backups and Disaster Recovery

• Administrators running ghe-backup will no longer see "Verifying Routes" messages. Route verification has been found to be unnecessary and has been disabled by default. Administrators who prefer to see these messages can enable route verification by setting GHE_ROUTE_VERIFICATION to "true" in their backup-utils configuration file.
• To prevent problems associated with incomplete backups, the ghe-restore process will exit with an error if the snapshot being restored is incomplete.

Bug Fixes

• When restoring an instance using the ghe-restore command from GitHub Enterprise Server Backup Utilities, restoration of files in /user/data/storage failed with a xrealloc: cannot allocate (...) bytes error.

Backups and Disaster Recovery

• Administrators running ghe-backup will no longer see "Verifying Routes" messages. Route verification has been found to be unnecessary and has been disabled by default. Administrators who prefer to see these messages can enable route verification by setting GHE_ROUTE_VERIFICATION to "true" in their backup-utils configuration file.
• To prevent problems associated with incomplete backups, the ghe-restore process will exit with an error if the snapshot being restored is incomplete.

Bug Fixes

• When restoring an instance using the ghe-restore command from GitHub Enterprise Server Backup Utilities, restoration of files in /user/data/storage failed with a xrealloc: cannot allocate (...) bytes error.

Backups and Disaster Recovery

• Administrators running ghe-backup will no longer see "Verifying Routes" messages. Route verification has been found to be unnecessary and has been disabled by default. Administrators who prefer to see these messages can enable route verification by setting GHE_ROUTE_VERIFICATION to "true" in their backup-utils configuration file.
• To prevent problems associated with incomplete backups, the ghe-restore process will exit with an error if the snapshot being restored is incomplete.

Changes

• When using GitHub Enterprise Server 3.9.10 or newer, 3.10.8 or newer, or 3.11.5 or newer, with a high availability (HA) configuration,
  you can backup the MySQL database from a HA replica by setting ghe-config mysql.backup.replica <replica-hostname> on your primary node.
  We recommend that replica-hostname resides in the same region as the backup host in order to reduce latency. [Updated 2024-03-01]
• When using GitHub Enterprise Server 3.9.10 or newer, or 3.11.5 or newer, with a cluster configuration,
  backup-utils will backup the MySQL database from one of the MySQL replica nodes instead of the primary node.
• ghe-backup will provide a clear error message if an offline node in a cluster configuration is detected by ghe-cluster-host-check.

Bug Fixes

• On an instance with multiple nodes, backups failed silently if a node was offline or unavailable.
• On an instance with Actions enabled, incorrect backup and restore settings prevented the storage container name from being restored. This made the logs from that container inaccessible, and caused Actions to create a new storage container in a different location.

Backups and Disaster Recovery

• During backups using a version of Backup Utilities 3.8, the log displayed the following warning: management console argon2 secret not set.
• For better compatibility across Linux distributions, the host operating system version displayed in output is obtained from /etc/os-release.

Bug Fixes

• On an instance with multiple nodes, backups failed silently if a node was offline or unavailable.

Backups and Disaster Recovery

• In the Incremental MySQL Backups and Restores documentation, the variable for the number of incremental backups was incorrectly given as GHE_INCREMENTAL_BACKUP_MAX. This has been corrected to GHE_INCREMENTAL_MAX_BACKUPS.
• ghe-backup or ghe-restore commands could fail to delete progress files created by older versions of GitHub Enterprise Server Backup Utilities.
• For better compatibility across Linux distributions, the host operating system version displayed in output is obtained from /etc/os-release.