Skip to content

Commit

Permalink
3.12.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
release-controller[bot] authored and release-controller[bot] committed Feb 15, 2024
1 parent 2b993ac commit e4f3ae7
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting started

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

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

Expand Down
20 changes: 9 additions & 11 deletions docs/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,10 @@ storage and must have network connectivity with the GitHub Enterprise Server app

Backup host software requirements are modest: Linux or other modern Unix operating system (Ubuntu is highly recommended) with [bash][1], [git][2] 1.7.6 or newer, [OpenSSH][3] 5.6 or newer, [rsync][4] v2.6.4 or newer* (see [below](april-2023-update-of-rsync-requirements) for exceptions), [jq][11] v1.5 or newer and [bc][12] v1.0.7 or newer. See below for an update on rsync.

Ubuntu is the operating system we use to test `backup-utils` and it’s what we recommend you use too. You are welcome to use a different operating system, and we'll do our best to help you if you run into issues. But we can't guarantee that we'll be able to resolve issues that are specific to that operating system.

Additionally, we encourage the use of [Docker](docker.md), as it ensures compatible versions of the aforementioned software are available to backup-utils.

The parallel backup and restore feature will require [GNU awk][10] and [moreutils][9] to be installed.

We encourage the use of [Docker](docker.md), as it ensures compatible versions of the aforementioned software are available to backup-utils.

The backup host must be able to establish outbound network connections to the GitHub appliance over SSH. TCP port 122 is used to backup GitHub Enterprise Server.

CPU and memory requirements are dependent on the size of the GitHub Enterprise Server appliance. We recommend a minimum of 4 cores and 8GB of RAM for the host running [GitHub Enterprise Backup Utilities](https://github.com/github/backup-utils). We recommend monitoring the backup host's CPU and memory usage to ensure it is sufficient for your environment.
Expand Down Expand Up @@ -67,23 +65,23 @@ Please avoid using an NFS mount for the data directory (where backup data is sto
Starting with Backup Utilities v2.13.0, version support is inline with that of the
[GitHub Enterprise Server upgrade requirements][8] and as such, support is limited to
three versions of GitHub Enterprise Server: the version that corresponds with the version
of Backup Utilities, and the two releases prior to it.
of Backup Utilities, and the two versions prior to it.

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

Backup Utilities v2.11.4 and earlier offer support for GitHub Enterprise Server 2.10
and earlier releases up to GitHub Enterprise Server 2.2.0. Backup Utilities v2.11.0 and earlier
and earlier versions up to GitHub Enterprise Server 2.2.0. Backup Utilities v2.11.0 and earlier
offer support for GitHub Enterprise Server 2.1.0 and earlier.

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

**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.`.

Expand Down

1 comment on commit e4f3ae7

@Aasdfh
Copy link

@Aasdfh Aasdfh commented on e4f3ae7 Mar 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

``

Please sign in to comment.