Skip to content

Commit

Permalink
Merge pull request #1098 from EnterpriseDB/bart_262
Browse files Browse the repository at this point in the history
Former-commit-id: 971bbbd
  • Loading branch information
robert-stringer authored Mar 22, 2021
2 parents a65f297 + 2f13fbd commit 6398ef5
Show file tree
Hide file tree
Showing 74 changed files with 8,167 additions and 0 deletions.
429 changes: 429 additions & 0 deletions product_docs/docs/bart/2.6.2/bart_inst/02_installing_bart.mdx

Large diffs are not rendered by default.

643 changes: 643 additions & 0 deletions product_docs/docs/bart/2.6.2/bart_inst/03_configuring_bart.mdx

Large diffs are not rendered by default.

98 changes: 98 additions & 0 deletions product_docs/docs/bart/2.6.2/bart_inst/04_upgrading_bart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
---
title: "Upgrading BART"

legacyRedirectsGenerated:
# This list is generated by a script. If you need add entries, use the `legacyRedirects` key.
- "/edb-docs/d/edb-backup-and-recovery-tool/installation-getting-started/installation-upgrade-guide/2.6.1/upgrading_bart.html"
---

<div id="upgrade" class="registered_link"></div>

This section outlines the process of upgrading BART from an existing version to the latest version.

- [Upgrading from BART 2.0](#upgrading-from-bart-20) describes the upgrade process from BART 2.0 to the latest version.
- [Upgrading from Older Versions of BART (except 2.0)](#upgrading_from_older_versions_except_2_0_to_latest_versions_of_bart) describes the upgrade process from previous BART versions (except 2.0) to the latest version.

**Upgrade Restrictions**

The following restrictions apply with regard to previous BART versions.

- You can take incremental backups using the latest version only when the parent backup (full or incremental backup) has also been taken with the latest version.
- Using the latest version, you can restore incremental backups that are taken only with the latest version of BART. However, using the latest version you can restore full backups that were taken with older versions.

<div id="upgrading_from_older_versions_except_2_0_to_latest_versions_of_bart" class="registered_link"></div>

## Upgrading from Older Versions of BART (except 2.0)

Perform the following steps to upgrade from older versions of BART (except 2.0) to the latest version:

**Step 1:** Assume the identity of the BART user account and invoke the following command to stop the BART WAL scanner program (`bart-scanner`):

```text
bart-scanner STOP
```

**Step 2:** As the `root` user, upgrade to the latest BART version with the `yum upgrade` command.

- To upgrade the BART RPM package directly from the *EDB Yum Repository* website, specify only the package name:

On CentOS 7:

```text
yum upgrade edb-bart
```

You can also use a downloaded RPM package file to upgrade. To use a downloaded BART RPM package file to upgrade, use the `yum` command, specifying the complete RPM package file name:

```text
yum upgrade edb-bart-2.6.2 rhel7.x86_64.rpm
```

**Step 3:** Repeat the process described in this section to upgrade to the latest BART version on each remote hosts where an incremental backup will be restored.

For additional information about restoration of incremental backups on remote hosts, see the EDB Backup and Recovery User Guide available at the [EDB website](/bart/latest/bart_user/).

**Step 4:** If the `bart --version` command returns an error stating the `PATH` is not available after switching from `root` user to another BART user account, adjust the setting of the `PATH` environment variable to include the location of the BART 2.6.2 executable (the `bin` subdirectory) in the `~/.bashrc` or `~/.bash_profile` files of the following user accounts:

- The BART user account on the BART host.
- The remote user account on the remote host to which incremental backups are to be restored. For details, see the EDB Backup and Recovery User Guide available at the [EDB website](/bart/latest/bart_user/).

The `PATH` setting should be the same as set for BART 2.6.2 since all versions use `/usr/edb/bart/bin`.

!!! Note
After upgrading to the latest BART version, you must take a new full backup of your system before performing an incremental backup.

<div id="upgrading_from_bart_2_0" class="registered_link"></div>

## Upgrading from BART 2.0

Perform the following steps to upgrade BART 2.0 to the latest version of BART:

**Step 1:** Install the latest version of BART. For information about how to install, see [installing BART](02_installing_bart/#installing-bart).

**Step 2:** Save a copy of your BART 2.0 configuration file. The default location of the BART 2.0 configuration file is `/usr/edb/bart2.0/etc/bart.cfg`.

**Step 3:** Invoke the following command to remove BART 2.0:

On CentOS 7:

```text
yum remove edb-bart20
```

**Step 4:** Place the BART 2.0 configuration file (`bart.cfg`) that you saved in Step 2 in the newly created `/usr/edb/bart/etc` directory. You can use many of the same configuration parameters for BART 2.6.2, but note that you must use a new directory for the BART backup catalog. A new set of full backups and incremental backups taken using BART 2.6.2 must be stored in a new BART backup catalog.

To specify an alternative configuration file name or location, use the `-c` option with BART subcommands. For more information about the `-c` option, see the EDB Backup and Recovery Us available at the [EDB website](/bart/latest/bart_user/).

!!! Note
The `bart.cfg` configuration file is only required on the BART 2.6.2 host from which you will invoke BART subcommands. BART does not require the `bart.cfg` file on hosts on which an incremental backup will be restored.

**Step 5:** Adjust the setting of the `PATH` environment variable to include the location of the BART 2.6.2 executable (the `bin` subdirectory) in the `~/.bashrc` or `~/.bash_profile` files for the following user accounts:

- The BART user account on the BART host.
- The user account on the remote host to which incremental backups will be restored. For details, see the EDB Backup and Recovery User Guide available at the [EDB website](/bart/latest/bart_user/).

**Step 6:** Perform the BART 2.6.2 installation and BART 2.0 removal process on each remote host on which an incremental backup was restored using BART 2.0.

!!! Note
After upgrading to the latest BART version, you must take a new full backup of your system before performing an incremental backup.
50 changes: 50 additions & 0 deletions product_docs/docs/bart/2.6.2/bart_inst/05_uninstalling_bart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: "Uninstalling BART"

legacyRedirectsGenerated:
# This list is generated by a script. If you need add entries, use the `legacyRedirects` key.
- "/edb-docs/d/edb-backup-and-recovery-tool/installation-getting-started/installation-upgrade-guide/2.6.1/uninstalling_bart.html"
---

<div id="uninstallation" class="registered_link"></div>

This section walks you through uninstalling BART.

## Uninstalling BART on a RHEL/CentOS Host

To uninstall BART on a RHEL/CentOS host, assume the identity of the `root` user and invoke the following command:

On RHEL/CentOS 7:

```text
yum remove edb-bart
```

On RHEL/CentOS 8:

```text
dnf remove edb-bart
```

Uninstalling BART does not delete the backup files and archived WAL files that reside in the BART backup catalog. To permanently delete the backup files and archived WAL files in the BART backup catalog (`/opt/backup`), use one of the following commands:

- `rm –rf /opt/backup`
- BART `DELETE` subcommand

For information about the BART `DELETE` subcommand, see the *EDB Backup and Recovery User Guide* available at the [EDB website](/bart/latest/bart_user/).

## Uninstalling BART on an SLES 12 Host

To uninstall BART on an SLES 12 host, assume the identity of the `root` user and invoke the following command:

```text
zypper remove edb-bart
```

## Uninstalling BART on a Debian/Ubuntu Host

To uninstall BART on a Debian or Ubuntu host, invoke the following command:

```text
apt-get remove edb-bart
```
3 changes: 3 additions & 0 deletions product_docs/docs/bart/2.6.2/bart_inst/images/EDB_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions product_docs/docs/bart/2.6.2/bart_inst/images/edb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions product_docs/docs/bart/2.6.2/bart_inst/images/edb_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions product_docs/docs/bart/2.6.2/bart_inst/images/edblogo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 45 additions & 0 deletions product_docs/docs/bart/2.6.2/bart_inst/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
navTitle: Installation Guide
title: "EDB Postgres Backup and Recovery Installation Guide"
legacyRedirects:
- "/edb-docs/d/edb-backup-and-recovery-tool/installation-getting-started/installation-upgrade-guide/2.6.1/requirements_overview.html"

legacyRedirectsGenerated:
# This list is generated by a script. If you need add entries, use the `legacyRedirects` key.
- "/edb-docs/d/edb-backup-and-recovery-tool/installation-getting-started/installation-upgrade-guide/2.6.1/conclusion.html"
- "/edb-docs/d/edb-backup-and-recovery-tool/installation-getting-started/installation-upgrade-guide/2.6.1/genindex.html"
- "/edb-docs/d/edb-backup-and-recovery-tool/installation-getting-started/installation-upgrade-guide/2.6.1/index.html"
---

This guide provides information about how to install and configure the EDB Backup and Recovery Tool (BART) 2.6.2.

<div id="requirements_overview" class="registered_link"></div>

## Requirements Overview

### Supported Platforms and Database Versions

- To view a complete list of supported platforms, visit the [EDB website.](https://www.enterprisedb.com/services-support/edb-supported-products-and-platforms)

!!! Note
BART 2.6.2 is no longer supported on CentOS/RHEL/OEL 6.x platforms. It is strongly recommended that EDB products running on these platforms be migrated to a supported platform.

- BART supports the following database versions:

- Advanced Server versions 9.6, 10, 11, 12, and 13.
- PostgreSQL versions 9.6, 10, 11, 12, and 13.

### Software Requirements

The following components are required for BART installation.

- BART Host Components - Use EDB packages to add BART host components; see [Installing BART](02_installing_bart/#installing-bart) for information about how to install these components.

- Additional Components - In addition to the BART host components, the following components are required:

- The [Secure Shell (SSH) server daemon and Secure Copy (SCP) client programs](03_configuring_bart/#authorizing_ssh_scp_access) must be enabled and activated on the BART host as well as on the remote database server hosts on which BART will be managing backup and recovery.
- BART uses the `pg_basebackup` utility program when taking full backups.

### Limitation

BART supports taking only a full backup of standby servers; it does not support taking incremental or parallel backups of standby servers.
3 changes: 3 additions & 0 deletions product_docs/docs/bart/2.6.2/bart_qs_7/images/EDB_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions product_docs/docs/bart/2.6.2/bart_qs_7/images/edb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 6398ef5

Please sign in to comment.