Skip to content

Commit 7a64e2d

Browse files
release-controller[bot]release-controller[bot]
release-controller[bot]
authored and
release-controller[bot]
committed
3.16.0 release
1 parent 8d0d11d commit 7a64e2d

File tree

3 files changed

+152
-4
lines changed

3 files changed

+152
-4
lines changed

‎docs/backup.config-example

+147
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
# GitHub Enterprise Server backup configuration file
2+
3+
# The hostname of the GitHub Enterprise Server appliance to back up. The host
4+
# must be reachable via SSH from the backup host.
5+
GHE_HOSTNAME="github.example.com"
6+
7+
# Path to where backup data is stored. By default this is the "data"
8+
# directory next to this file but can be set to an absolute path
9+
# elsewhere for backing up to a separate partition / mount point.
10+
GHE_DATA_DIR="data"
11+
12+
# The number of backup snapshots to retain. Old snapshots are pruned after each
13+
# successful ghe-backup run. This option should be tuned based on the frequency
14+
# of scheduled backup runs. If backups are scheduled hourly, snapshots will be
15+
# available for the past N hours; if backups are scheduled daily, snapshots will
16+
# be available for the past N days ...
17+
GHE_NUM_SNAPSHOTS=10
18+
19+
# Pruning snapshots can be scheduled outside of the backup process.
20+
# If set to 'yes', snapshots will not be pruned by ghe-backup.
21+
# Instead, ghe-prune-snapshots will need to be invoked separately via cron
22+
#GHE_PRUNING_SCHEDULED=yes
23+
24+
# If --incremental is used to generate incremental MySQL backups with ghe-backup,
25+
# then you need to specify how many cycles of full and incremental backups will be
26+
# performed before the next full backup is created.
27+
# For example, if `GHE_INCREMENTAL_BACKUP_MAX` is set to 14, backup-utils will
28+
# run 1 full backup and then 13 incremental backups before performing another full backup on the next cycle.
29+
#GHE_INCREMENTAL_MAX_BACKUPS=14
30+
31+
# If GHE_ROUTE_VERIFICATION is set to true then ghe-repository-backup and
32+
# ghe-storage-backup will issue a warning if the repositories and objects in
33+
# the backup do not match the pre-backup inventory of routes.
34+
#GHE_ROUTE_VERIFICATION=false
35+
36+
# If GHE_MANAGE_CONSOLE_PW_RESTORE is set to false then management-console password
37+
# will not be restored from backed-up snapshot data, it is restored by default
38+
#GHE_MANAGE_CONSOLE_PW_RESTORE=true
39+
40+
# If GHE_SKIP_CHECKS is set to true (or if --skip-checks is used with ghe-backup) then ghe-host-check
41+
# disk space validation and software version checks on the backup-host will be disabled.
42+
#GHE_SKIP_CHECKS=false
43+
44+
# Cluster filesystem to check if it's writable as part of ghe-host-check
45+
# By default it is /data/user/tmp but can be updated if needed
46+
#GHE_FILE_SYSTEM_WRITE_CHECK="/data/user/tmp"
47+
48+
# The hostname of the GitHub appliance to restore. If you've set up a separate
49+
# GitHub appliance to act as a standby for recovery, specify its IP or hostname
50+
# here. The host to restore to may also be specified directly when running
51+
# ghe-restore so use of this variable isn't strictly required.
52+
#
53+
#GHE_RESTORE_HOST="github-standby.example.com"
54+
55+
# If set to 'yes', ghe-restore will omit the restore of audit logs.
56+
#
57+
#GHE_RESTORE_SKIP_AUDIT_LOGS=no
58+
59+
# If set to 'yes', backup and restore of Elasticsearch indices will be skipped
60+
#
61+
#GHE_SKIP_SEARCH_INDICES=no
62+
63+
# When verbose output is enabled with `-v`, it's written to stdout by default. If
64+
# you'd prefer it to be written to a separate file, set this option.
65+
#
66+
#GHE_VERBOSE_LOG="/var/log/backup-verbose.log"
67+
68+
# Any extra options passed to the SSH command.
69+
# In a single instance environment, nothing is required by default.
70+
# In a clustering environment, "-i abs-path-to-ssh-private-key" is required.
71+
#
72+
#GHE_EXTRA_SSH_OPTS=""
73+
#
74+
# All backup processes are ran with the lowest priority for scheduling by default.
75+
# To change throttling behaviour/allow higher priority for backup processes, set higher values for following variables.
76+
# default value for GHENICE=nice -n 19
77+
# default value for GHE_IONICE=ionice -c 3
78+
#GHE_NICE=""
79+
#GHE_IONICE=""
80+
81+
# Any extra options passed to the rsync command. Nothing required by default.
82+
#
83+
#GHE_EXTRA_RSYNC_OPTS=""
84+
85+
# If set to 'yes', rsync will be set to use compression during backups and restores transfers. Defaults to 'no'.
86+
#
87+
#GHE_RSYNC_COMPRESSION_ENABLED=yes
88+
89+
# If enabled and set to 'no', rsync warning message during backups will be suppressed.
90+
#RSYNC_WARNING=no
91+
92+
93+
# If set to 'yes', logging output will be colorized.
94+
#
95+
#OUTPUT_COLOR=no
96+
97+
# If set to 'no', GHE_DATA_DIR will not be created automatically
98+
# and restore/backup will exit 8
99+
#
100+
#GHE_CREATE_DATA_DIR=yes
101+
102+
# If set to 'yes', git fsck will run on the repositories
103+
# and print some additional info.
104+
#
105+
# WARNING: do not enable this, only useful for debugging/development
106+
#GHE_BACKUP_FSCK=no
107+
108+
# Cadence of MSSQL backups
109+
# <full>,<differential>,<transactionlog> all in minutes
110+
# e.g.
111+
# - Full backup every week (10080 minutes)
112+
# - Differential backup every day (1440 minutes)
113+
# - Transactionlog backup every 15 minutes
114+
#
115+
#GHE_MSSQL_BACKUP_CADENCE=10080,1440,15
116+
117+
# If set to 'yes', ghe-backup jobs will run in parallel. Defaults to 'no'.
118+
#
119+
#GHE_PARALLEL_ENABLED=yes
120+
121+
# Sets the maximum number of jobs to run in parallel. Defaults to the number
122+
# of available processing units on the machine.
123+
#
124+
#GHE_PARALLEL_MAX_JOBS=2
125+
126+
# Sets the maximum number of rsync jobs to run in parallel. Defaults to the
127+
# configured GHE_PARALLEL_MAX_JOBS, or the number of available processing
128+
# units on the machine.
129+
#
130+
# GHE_PARALLEL_RSYNC_MAX_JOBS=3
131+
132+
# When jobs are running in parallel wait as needed to avoid starting new jobs
133+
# when the system's load average is not below the specified percentage. Defaults to
134+
# unrestricted.
135+
#
136+
#GHE_PARALLEL_MAX_LOAD=50
137+
138+
# When running an external mysql database, run this script to trigger a MySQL backup
139+
# rather than attempting to backup via backup-utils directly.
140+
#EXTERNAL_DATABASE_BACKUP_SCRIPT="/bin/false"
141+
142+
# When running an external mysql database, run this script to trigger a MySQL restore
143+
# rather than attempting to backup via backup-utils directly.
144+
#EXTERNAL_DATABASE_RESTORE_SCRIPT="/bin/false"
145+
146+
# If set to 'yes', Pages data will be included in backup and restore. Defaults to 'yes'
147+
#GHE_BACKUP_PAGES=no

‎docs/getting-started.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
**Note**: you will need to use [Backup Utilities v2.11.x][2] or the `legacy` branch to
88
backup and restore GitHub Enterprise Server 2.10 and earlier.
99

10-
2. Copy the `backup.config-example` file to `backup.config` and modify as
10+
2. Copy the [`backup.config-example`][3] file to `backup.config` and modify as
1111
necessary. The `GHE_HOSTNAME` value must be set to the primary GitHub Enterprise Server
1212
hostname. Additional options are available and documented in the
1313
configuration file but none are required for basic backup functionality.
@@ -28,7 +28,7 @@
2828
with the `-i <abs path to private key>` SSH option.
2929

3030
3. Add the backup host's SSH public key to the GitHub Enterprise Server appliance, in order to grant it administrative shell access.
31-
See [Accessing the GitHub Enterprise Server administrative shell (SSH)][3] for instructions.
31+
See [Accessing the GitHub Enterprise Server administrative shell (SSH)][4] for instructions.
3232
3333
4. Run `bin/ghe-host-check` to verify SSH connectivity with the GitHub
3434
appliance.
@@ -37,4 +37,5 @@
3737
3838
[1]: https://github.com/github/backup-utils/releases
3939
[2]: https://github.com/github/backup-utils/releases/tag/v2.11.4
40-
[3]: https://docs.github.com/enterprise-server/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh
40+
[3]: https://github.com/github/enterprise-backup-site/blob/master/docs/backup.config-example
41+
[4]: https://docs.github.com/enterprise-server/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh

‎docs/usage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ These commands are run on the host you [installed][1] Backup Utilities on.
1313

1414
You can supply your own configuration file or use the example configuration file as a template where you can set up your environment for backing up and restoring.
1515

16-
An example configuration file with documentation on possible settings can found in [backup.config-example](../backup.config-example).
16+
An example configuration file with documentation on possible settings can found in [backup.config-example](backup.config-example).
1717

1818
There are a number of command-line options that can also be passed to the `ghe-restore` command. Of particular note, if you use an external MySQL service but are restoring from a snapshot prior to enabling this, or vice versa, you must migrate the MySQL data outside of the context of backup-utils first, then pass the `--skip-mysql` flag to `ghe-restore`.
1919

0 commit comments

Comments
 (0)