Skip to content

Commit e454392

Browse files
release-controller[bot]release-controller[bot]
authored and
release-controller[bot]
committed
3.14.1 release
1 parent 36819b4 commit e454392

File tree

3 files changed

+23
-13
lines changed

3 files changed

+23
-13
lines changed

docs/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Getting started
22

3-
1. [Download the latest release version][1] and extract the repository using `tar`:
3+
1. [Download the latest version of backup-utils][1] and extract the repository using `tar`:
44

55
`tar -xzvf /path/to/github-backup-utils-vMAJOR.MINOR.PATCH.tar.gz`
66

docs/requirements.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -69,23 +69,23 @@ Please avoid using an NFS mount for the data directory (where backup data is sto
6969
Starting with Backup Utilities v2.13.0, version support is inline with that of the
7070
[GitHub Enterprise Server upgrade requirements][8] and as such, support is limited to
7171
three versions of GitHub Enterprise Server: the version that corresponds with the version
72-
of Backup Utilities, and the two releases prior to it.
72+
of Backup Utilities, and the two versions prior to it.
7373

7474
For example, Backup Utilities v2.13.0 can be used to backup and restore all patch
75-
releases from 2.11.0 to the latest patch release of GitHub Enterprise Server 2.13.
75+
versions from 2.11.0 to the latest patch version of GitHub Enterprise Server 2.13.
7676
Backup Utilities v2.14.0 will be released when GitHub Enterprise Server 2.14.0 is released
77-
and will then be used to backup all releases of GitHub Enterprise Server from 2.12.0
78-
to the latest patch release of GitHub Enterprise Server 2.14.
77+
and will then be used to backup all versions of GitHub Enterprise Server from 2.12.0
78+
to the latest patch version of GitHub Enterprise Server 2.14.
7979

8080
Backup Utilities v2.11.4 and earlier offer support for GitHub Enterprise Server 2.10
81-
and earlier releases up to GitHub Enterprise Server 2.2.0. Backup Utilities v2.11.0 and earlier
81+
and earlier versions up to GitHub Enterprise Server 2.2.0. Backup Utilities v2.11.0 and earlier
8282
offer support for GitHub Enterprise Server 2.1.0 and earlier.
8383

84-
**Note**: You can restore a snapshot that's at most two feature releases behind
84+
**Note**: You can restore a snapshot that's at most two feature versions behind
8585
the restore target's version of GitHub Enterprise Server. For example, to restore a
8686
snapshot of GitHub Enterprise Server 2.11, the target GitHub Enterprise Server appliance must
8787
be running GitHub Enterprise Server 2.12.x or 2.13.x. You can't restore a snapshot from
88-
2.10 to 2.13, because that's three releases ahead.
88+
2.10 to 2.13, because that's three versions ahead.
8989

9090
**Note**: You _cannot_ restore a backup created from a newer version of GitHub Enterprise Server to an older version. For example, an attempt to restore a snapshot of GitHub Enterprise Server 2.21 to a GitHub Enterprise Server 2.20 environment will fail with an error of `Error: Snapshot can not be restored to an older release of GitHub Enterprise Server.`.
9191

docs/scheduling-backups.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,16 @@
33
Regular backups should be scheduled using `cron(8)` or similar command
44
scheduling service on the backup host. The backup frequency will dictate the
55
worst case [recovery point objective (RPO)][1] in your backup plan. We recommend
6-
hourly backups at the least.
6+
hourly backups as a starting point.
7+
8+
It's important to consider the duration of each backup operation on the
9+
GitHub Enterprise Server (GHES) appliance. Backups of large datasets or
10+
over slow network links can take more than an hour. Additionally,
11+
maintenance queues are paused during a portion of a backup runs.
12+
We recommend scheduling backups to allow sufficient time for jobs
13+
waiting in maintenance queues to process between backup runs
14+
15+
Only one backup may be in progress at a time.
716

817
## Example scheduling of backups
918

@@ -19,21 +28,22 @@ storage.
1928

2029
To schedule hourly backup snapshots with verbose informational output written to
2130
a log file and errors generating an email:
22-
```
31+
32+
```shell
2333
2434

2535
0 * * * * /opt/backup-utils/bin/ghe-backup -v 1>>/opt/backup-utils/backup.log 2>&1
2636
```
2737

2838
To schedule nightly backup snapshots instead, use:
2939

30-
```
40+
```shell
3141
3242

3343
0 0 * * * /opt/backup-utils/bin/ghe-backup -v 1>>/opt/backup-utils/backup.log 2>&1
3444
```
3545

36-
## Example snapshot pruning
46+
## Example snapshot pruning
3747

3848
By default all expired and incomplete snapshots are deleted at the end of the main
3949
backup process `ghe-backup`. If pruning these snapshots takes a long time you can
@@ -44,7 +54,7 @@ If this option is enabled you will need to schedule the pruning script `ghe-prun
4454

4555
To schedule daily snapshot pruning, use:
4656

47-
```
57+
```shell
4858
4959

5060
0 3 * * * /opt/backup-utils/share/github-backup-utils/ghe-prune-snapshots 1>>/opt/backup-utils/prune-snapshots.log 2>&1

0 commit comments

Comments
 (0)