Skip to content

Commit

Permalink
Merge pull request #1344 from EnterpriseDB/release/2021-05-05a
Browse files Browse the repository at this point in the history
Former-commit-id: 03ee8d5
  • Loading branch information
robert-stringer authored May 5, 2021
2 parents 9eaec9e + 202f789 commit d79005e
Show file tree
Hide file tree
Showing 985 changed files with 72,457 additions and 131 deletions.
1 change: 1 addition & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*
4 changes: 2 additions & 2 deletions product_docs/docs/bart/2.6/bart_inst/02_installing_bart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ The following section demonstrates installing BART on a CentOS host using an RPM
The `bart --version` command should return the current BART version. If the `bart --version` command returns an error stating the PATH is not available after switching from the root user to another BART user account, adjust the setting of the `PATH` environment variable to include the directory location of the BART `bin` subdirectory in the `~/.bashrc` or `~/.bash_profile` files of the following user accounts:

- The BART user account on the BART host. See [Configuring BART](03_configuring_bart/#path) for details.
- 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 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/2.6/bart_user/).

Upon successful installation, BART is installed in the `BART_HOME` directory:

Expand Down Expand Up @@ -231,7 +231,7 @@ The following section demonstrates installing BART on a RHEL host using an RPM p
The `bart --version` command should return the current BART version. If the `bart --version` command returns an error stating the PATH is not available after switching from the root user to another BART user account, adjust the setting of the `PATH` environment variable to include the directory location of the BART `bin` subdirectory in the `~/.bashrc` or `~/.bash_profile` files of the following user accounts:

- The BART user account on the BART host. See [Configuring BART](03_configuring_bart/#path) for details.
- 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 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/2.6/bart_user/).

Upon successful installation, BART is installed in the `BART_HOME` directory:

Expand Down
12 changes: 6 additions & 6 deletions product_docs/docs/bart/2.6/bart_inst/03_configuring_bart.mdx

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions product_docs/docs/bart/2.6/bart_inst/04_upgrading_bart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,12 @@ bart-scanner STOP

**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/).
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/2.6/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 x.y.z (x denotes the major version of BART, and y and z denotes the minor version) 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 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/2.6/bart_user/).

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Uninstalling BART does not delete the backup files and archived WAL files that r
- `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/).
For information about the BART `DELETE` subcommand, see the *EDB Backup and Recovery User Guide* available at the [EDB website](/bart/2.6/bart_user/).

## Uninstalling BART on an SLES 12 Host

Expand Down
8 changes: 4 additions & 4 deletions product_docs/docs/bart/2.6/bart_qs_7/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ legacyRedirectsGenerated:

This tutorial demonstrates using `yum` to [install](#installing) and [configure](../bart_qs_8/#configuring) Backup and Recovery Tool (BART) 2.6 on a CentOS 7 host with minimal configuration settings.  The tutorial assumes that the user has some knowledge of installation and system administration procedures, and has administrative privileges on the host.

For detailed information about BART installation and configuration, see the *BART Installation and Upgrade Guide*, available at the [EDB website](/bart/latest/bart_inst/).
For detailed information about BART installation and configuration, see the *BART Installation and Upgrade Guide*, available at the [EDB website](/bart/2.6/bart_inst/).

- BART is tested with the following database versions:

Expand Down Expand Up @@ -113,7 +113,7 @@ Before configuring BART, establish the BART user account (the operating system u
cp bart.cfg.sample bart.cfg
```

3. Open the BART configuration file (`bart.cfg`) using an editor of your choice and scroll through the BART configuration file to edit the file as required; sample settings are included for your reference. You must add the mandatory parameters to the `[BART]` and `[ServerName]` sections. Default values may be used for optional parameters. For detailed information about parameter settings, see the *BART Installation and Upgrade Guide*, available at the [EDB website](/bart/latest/bart_inst/).
3. Open the BART configuration file (`bart.cfg`) using an editor of your choice and scroll through the BART configuration file to edit the file as required; sample settings are included for your reference. You must add the mandatory parameters to the `[BART]` and `[ServerName]` sections. Default values may be used for optional parameters. For detailed information about parameter settings, see the *BART Installation and Upgrade Guide*, available at the [EDB website](/bart/2.6/bart_inst/).

Parameters set in the `[BART]` section are applicable to all BART managed database servers, while parameters set in the `[ServerName]` section are applicable only to the specific server; `[ServerName]` settings override `[BART]` section settings.

Expand Down Expand Up @@ -188,7 +188,7 @@ The following table describes only mandatory parameters:
bart CHECK-CONFIG [ -s <server_name> ]
```

BART is now configured successfully. For detailed information about using BART, see the *EDB Backup and Recovery Tool User Guide*, available at the [EDB website](/bart/latest/bart_user/).
BART is now configured successfully. For detailed information about using BART, see the *EDB Backup and Recovery Tool User Guide*, available at the [EDB website](/bart/2.6/bart_user/).

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

Expand Down Expand Up @@ -254,7 +254,7 @@ The following example enables SSH/SCP access on a CentOS 7.x host; similar (plat

If backups are to be taken from a given database server host, but restored to a different database server host, the passwordless SSH/SCP connections must be configured from the BART host to the database server host from which the backup is to be taken as well as from the BART host to the database server host to which the backup is to be restored.

An example of how to create a passwordless connection is documented in the *EDB Backup and Recovery Reference Guide*, available at the [EDB website](/bart/latest/bart_ref/).
An example of how to create a passwordless connection is documented in the *EDB Backup and Recovery Reference Guide*, available at the [EDB website](/bart/2.6/bart_ref/).

Even when the Advanced Server database is on the same host as BART, and the Advanced Server database cluster owner is also the BART user account, a passwordless SSH/SCP connection must be established from the same user account to itself.

Expand Down
8 changes: 4 additions & 4 deletions product_docs/docs/bart/2.6/bart_qs_8/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ legacyRedirectsGenerated:

This tutorial demonstrates using the `dnf` command to install and configure the EDB Backup and Recovery Tool (BART) 2.6 on a CentOS 8 host with minimal configuration settings.  The tutorial assumes that the user has some knowledge of installation and system administration procedures and has administrative privileges on the host.

For detailed information about BART installation and configuration, see the *BART Installation and Upgrade Guide* available at the [EDB website](/bart/latest/bart_inst/).
For detailed information about BART installation and configuration, see the *BART Installation and Upgrade Guide* available at the [EDB website](/bart/2.6/bart_inst/).

- BART is tested with the following database versions:

Expand Down Expand Up @@ -109,7 +109,7 @@ Before configuring BART, establish the BART user account (the operating system u
cp bart.cfg.sample bart.cfg
```

3. Open the BART configuration file (`bart.cfg`) using an editor of your choice and scroll through the BART configuration file to edit the file as required; sample settings are included for your reference. You must add the mandatory parameters to the `[BART]` and `[ServerName]` sections. Default values may be used for optional parameters. For detailed information about parameter settings, see the *BART Installation and Upgrade Guide*, available at the [EDB website](/bart/latest/bart_inst/).
3. Open the BART configuration file (`bart.cfg`) using an editor of your choice and scroll through the BART configuration file to edit the file as required; sample settings are included for your reference. You must add the mandatory parameters to the `[BART]` and `[ServerName]` sections. Default values may be used for optional parameters. For detailed information about parameter settings, see the *BART Installation and Upgrade Guide*, available at the [EDB website](/bart/2.6/bart_inst/).

Parameters set in the `[BART]` section are applicable to all BART managed database servers, while parameters set in the `[ServerName]` section are applicable only to the specific server; `[ServerName]` settings override `[BART]` section settings.

Expand Down Expand Up @@ -184,7 +184,7 @@ The following table describes only mandatory parameters:
bart CHECK-CONFIG [ -s <server_name> ]
```

BART is now configured successfully. For detailed information about using BART, see the *EDB Backup and Recovery Tool User Guide* available at the [EDB website](/bart/latest/bart_user/).
BART is now configured successfully. For detailed information about using BART, see the *EDB Backup and Recovery Tool User Guide* available at the [EDB website](/bart/2.6/bart_user/).

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

Expand Down Expand Up @@ -250,7 +250,7 @@ The following example enables SSH/SCP access on a CentOS 7.x host; similar (plat

If backups are to be taken from a given database server host, but restored to a different database server host, the passwordless SSH/SCP connections must be configured from the BART host to the database server host from which the backup is to be taken as well as from the BART host to the database server host to which the backup is to be restored.

An example of how to create a passwordless connection is documented in the *EDB Backup and Recovery Reference Guide*, available at the [EDB website](/bart/latest/bart_ref/).
An example of how to create a passwordless connection is documented in the *EDB Backup and Recovery Reference Guide*, available at the [EDB website](/bart/2.6/bart_ref/).

Even when the Advanced Server database is on the same host as BART, and the Advanced Server database cluster owner is also the BART user account, a passwordless SSH/SCP connection must be established from the same user account to itself.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ bart BACKUP –s <server_name> [-Fp]
[ { --checksum-algorithm } ]
```

Before performing an incremental backup, you must take a full backup. For more details about incremental backup, refer to *Block-Level Incremental Backup* in the *EDB Backup and Recovery User Guide* available at the [EDB website](/bart/latest/bart_user/).
Before performing an incremental backup, you must take a full backup. For more details about incremental backup, refer to *Block-Level Incremental Backup* in the *EDB Backup and Recovery User Guide* available at the [EDB website](/bart/2.6/bart_user/).

The following table describes the `BACKUP` options:

Expand All @@ -46,8 +46,8 @@ The following table describes the `BACKUP` options:
| `-F { p \| t }`<br />`--format { p \| t }` | Use this option to specify the backup file format.<br />Specify `p` option to take backup in plain text format and specify `t` option to take backup in tar format. If the `p` or `t` option is omitted, the default is tar format.<br />Use `p` option with the `BACKUP` subcommand when streaming is used as a backup method.<br />An incremental backup can only be taken in plain text format (`p`). |
| `-z`<br />`(--gzip)` | This option is applicable only for full backup and `tar` format. Use this option to enable gzip compression of tar files using the default compression level (typically 6). |
| `-c <compression_level>`<br />`--compress-level <compression_level>` | This is applicable only for full backup and tar format. Use this option to specify the gzip compression level on the tar file output. `<compression_level>` is a digit from 1 through 9, with 9 being the best compression. |
| `--backup-name <backup_name>` | Use this option to assign a user-defined, alphanumeric friendly name to the backup. The maximum permitted length of backup name is 49 characters.<br />For detailed information about this parameter, see the EDB Backup and Recovery User Guide available at the [EDB website](/bart/latest/bart_user/).<br />If the option `--backup-name` is not specified and the `backup_name` parameter is not set for this database server in the BART configuration file, then the backup can only be referenced in other BART subcommands by the BART assigned backup identifier. |
| `--thread-count <number_of_threads>` | Use this option to specify the number of worker threads to run in parallel to copy blocks for a backup.<br />For detailed information about the `--thread-count` parameter, see the EDB Backup and Recovery Installation and Upgrade Guide available at the [EDB website](/bart/latest/bart_inst/). |
| `--backup-name <backup_name>` | Use this option to assign a user-defined, alphanumeric friendly name to the backup. The maximum permitted length of backup name is 49 characters.<br />For detailed information about this parameter, see the EDB Backup and Recovery User Guide available at the [EDB website](/bart/2.6/bart_user/).<br />If the option `--backup-name` is not specified and the `backup_name` parameter is not set for this database server in the BART configuration file, then the backup can only be referenced in other BART subcommands by the BART assigned backup identifier. |
| `--thread-count <number_of_threads>` | Use this option to specify the number of worker threads to run in parallel to copy blocks for a backup.<br />For detailed information about the `--thread-count` parameter, see the EDB Backup and Recovery Installation and Upgrade Guide available at the [EDB website](/bart/2.6/bart_inst/). |
| `--with-pg_basebackup` | This is applicable only for full backup. Use this option to specify the use of `pg_basebackup` to take a full backup. The number of thread counts in effect is ignored as given by the `thread_count` parameter in the BART configuration file.<br />When taking a full backup, if the thread count in effect is greater than `1`, then the `pg_basebackup` utility is not used to take the full backup (parallel worker threads are used) unless the `--with-pg_basebackup` option is specified with the `BACKUP` subcommand. |
| `--no-pg_basebackup` | This is applicable only for full backup. Use this option to specify that `pg_basebackup` is not to be used to take a full backup.<br />When taking a full backup, if the thread count in effect is only `1`, then the `pg_basebackup` utility is used to take the full backup unless the `--no-pg_basebackup` option is specified with the `BACKUP` subcommand. |
| `--parent { <backup_id> \| <backup_name> }` | Use this option to take an incremental backup. The parent backup is a backup taken prior to the incremental backup; it can be either a full backup or an incremental backup. `<backup_id>` is the backup identifier of a parent backup and `<backup_name>` is the user-defined alphanumeric name of a parent backup. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ bart DELETE –s <server_name>

Note that when invoking the `DELETE` subcommand, you must specify a database server.

For database servers under a retention policy, there are conditions where certain backups may not be deleted. For more information, see the EDB Backup and Recovery User Guide available at the [EDB website](/bart/latest/bart_user/).
For database servers under a retention policy, there are conditions where certain backups may not be deleted. For more information, see the EDB Backup and Recovery User Guide available at the [EDB website](/bart/2.6/bart_user/).

The following table describes the `DELETE` options:

Expand Down
Loading

0 comments on commit d79005e

Please sign in to comment.