-
Notifications
You must be signed in to change notification settings - Fork 249
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2322 from EnterpriseDB/release/2022-02-11
Release: 2022-02-11
- Loading branch information
Showing
27 changed files
with
339 additions
and
13 deletions.
There are no files selected for viewing
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...artner_docs/Markdown Implementation Guide Template/Images/EDBPartnerProgram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 12 additions & 0 deletions
12
advocacy_docs/partner_docs/VeritasGuide/02-PartnerInformation.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: 'Partner Information' | ||
description: 'Details for Veritas and NetBackup for PostgreSQL' | ||
|
||
--- | ||
| | | | ||
| ----------- | ----------- | | ||
| **Partner Name** | Veritas | | ||
| **Partner Product** | NetBackup for PostgreSQL | | ||
| **Web Site** | https://www.veritas.com/ | | ||
| **Version & Platform** | NetBackup for PostgreSQL 9.1: Linux, Windows | | ||
| **Product Description** | NetBackup gives enterprise IT a simple and powerful way to ensure the integrity and availability of their data – from edge to core to cloud. NetBackup for PostgreSQL Agent extends the capabilities of NetBackup to include backup and restore of PostgreSQL databases. | |
9 changes: 9 additions & 0 deletions
9
advocacy_docs/partner_docs/VeritasGuide/03-SolutionSummary.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: 'Solution Summary' | ||
description: 'Brief explanation of the solution and its purpose' | ||
--- | ||
NetBackup provides a non-distruptive way of validating your resiliency plan for assurance and compliance through automated recovery and rehearsal of business-critical applications. Moving data and spinning up applications when and where you need to without risking data loss requires business-level resiliency. Veritas NetBackup for PostgreSQL Agent extends the capabilities of NetBackup to include backup and restore of PostgreSQL databases. If a NetBackup environment is operational within an organization, then users can backup and restore EDB Postgres Advanced Server and EDB Postgres Extended Server with the help of Veritas NetBackup for PostgreSQL Agent. | ||
|
||
<p align="center"> | ||
<img src="Images/ArchitectureUpdate4.png"> | ||
</p> |
123 changes: 123 additions & 0 deletions
123
advocacy_docs/partner_docs/VeritasGuide/04-ConfiguringTheIntegration.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,123 @@ | ||
--- | ||
title: 'Configuring the Integration' | ||
description: 'Walkthrough on configuring Veritas NetBackup for PostgreSQL' | ||
--- | ||
|
||
**Implementing Veritas NetBackup solution for backup/restore of PostgreSQL databases requires the following components:** | ||
|
||
- EDB Postgres Advanced Server (EPAS). | ||
- Veritas NetBackup Server. | ||
- Veritas NetBackup Client. | ||
- Veritas NetBackup Agent for PostgreSQL. | ||
|
||
### Prerequisites | ||
|
||
- A running EDB Postgres Advanced Server (EPAS). | ||
- A running Veritas NetBackup Server. | ||
- Veritas NetBackup Client installed on the EPAS host. | ||
- Veritas NetBackup PostgreSQL Agent installed on the EPAS host. | ||
|
||
|
||
Configuring Veritas NetBackup for PostgreSQL consists of configuring the following components: | ||
- Veritas NetBackup Agent for PostgreSQL. | ||
- PostgreSQL server. | ||
|
||
The steps below show an example of how to configure Veritas NetBackup for PostgreSQL for EPAS. | ||
|
||
### Configuring Veritas NetBackup for PostgreSQL | ||
|
||
1. Log on to the NetBackup Administration Console: | ||
|
||
a. Use the credentials for the **root** user | ||
|
||
b. Select the hostname for the NetBackup Master Server you want to administer | ||
|
||
<p align="center"> | ||
<img src="Images/NetBackupAdminConsole.png"> | ||
</p> | ||
|
||
2. Create a policy for EDB Postgres Advanced Servers: | ||
|
||
!!! Note | ||
Refer to the [Veritas NetBackup Administrator's Guide](https://www.veritas.com/content/support/en_US/doc/18716246-126559472-0/v42176014-126559472) for detailed information on policies. | ||
|
||
a. Click on **NetBackup Management > Policies**, select the NetBackup server | ||
|
||
b. Right mouse click and select **New Policy** | ||
|
||
<p align="center"> | ||
<img src="Images/NetBackupDataPolicy1.png"> | ||
</p> | ||
|
||
c. Enter the policy name in the **Add New Policy** dialog box and click OK | ||
|
||
<p align="center"> | ||
<img src="Images/NetBackupDataPolicy2.png"> | ||
</p> | ||
|
||
d. Select the **Clients** tab | ||
|
||
e. Click on **New** | ||
|
||
f. Enter the NetBackup client name in the **Add Client** dialog box, and click **OK** | ||
|
||
<p align="center"> | ||
<img src="Images/NetBackupDataPolicy3.png"> | ||
</p> | ||
|
||
g. Select the **Attributes** tab | ||
|
||
h. Select **DataStore** for **Policy type** | ||
|
||
i. Select **Policy storage** from available values | ||
|
||
j. Set any other parameters you require for your policy and then click **OK** | ||
|
||
<p align="center"> | ||
<img src="Images/NetBackupDataPolicy4.png"> | ||
</p> | ||
|
||
|
||
3. On the NetBackup Client, update the agent configuration file `/usr/NBPostgreSQLAgent/nbpgsql.conf` to set the necessary parameters to make the agent work successfully with EPAS: | ||
``` | ||
DB_USER= enterprisedb | ||
DB_PORT=5444 | ||
DB_INSTANCE_NAME=edb | ||
PGSQL_LIB_INSTALL_PATH= /usr/edb/as13/lib | ||
MASTER_SERVER_NAME=<netbackup-master-server> | ||
POLICY_NAME=<datastore-policy> | ||
SCHEDULE_NAME= Default-Application-Backup | ||
SNAPSHOT_SIZE=4MB | ||
``` | ||
|
||
!!! Note | ||
Value of **PGSQL_LIB_INSTALL_PATH** will be dependent on the version of EPAS installed. | ||
Values of **MASTER_SERVER_NAME** and **POLICY_NAME** parameters must match the names of your NetBackup Master Server and DataStore Policy respectively. | ||
|
||
In the sample configuration file above, the values for **DB_USER**, **DB_PORT**, **DB_INSTANCE_NAME**, and **PGSQL_LIB_INSTALL_PATH** have been substituted for EPAS as the default values are for Postgres. | ||
Refer to the [Veritas NetBackup for PostgreSQL Administrator's Guide](https://www.veritas.com/content/support/en_US/doc/129277259-150015228-0/v129276458-150015228) for detailed description of the parameters. | ||
|
||
|
||
|
||
### Configuring EDB Postgres Advanced Server | ||
|
||
Set up WAL archiving on the EPAS server by using the steps below. WAL archiving prepares Postgresql/EPAS database servers for backup/recovery operations and is a precondition for any backup/recovery tool to work with the database server. | ||
|
||
1. Create a writeable `<archivedir>` directory at your desired location. | ||
|
||
2. Set the required parameters in the `postgresql.conf` file to turn on WAL archiving: | ||
``` | ||
wal_level = archive | ||
archive_mode = on | ||
archive_timeout = 0 | ||
statement_timeout = 0 | ||
archive_command = test ! -f <archivedir>/%f && cp %p <archivedir>/%f | ||
``` | ||
|
||
!!! Note | ||
Replace `<archivedir>` in the `archive_command` parameter with the location of the directory created in Step 1. | ||
|
||
3. Restart the PostgreSQL server. | ||
|
||
Refer to the [Veritas NetBackup for PostgreSQL Administrator's Guide](https://www.veritas.com/content/support/en_US/doc/129277259-150015228-0/v129903049-150015228) for detailed information on how to configure EPAS for Veritas NetBackup Agent for PostgreSQL. | ||
|
95 changes: 95 additions & 0 deletions
95
advocacy_docs/partner_docs/VeritasGuide/05-UsingNetBackupForPostgreSQL.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
--- | ||
title: 'Using Veritas NetBackup for PostgreSQL' | ||
description: 'Walkthroughs of example usage scenarios' | ||
--- | ||
|
||
Common backup/restore operations for PostgreSQL databases using Veritas NetBackup for PostgreSQL are: | ||
- Performing backups - takes backup of the database and stores it in a predetermined location. | ||
- Querying backups - lists available database backups. | ||
- Performing restores - restores the database from a backup previously taken: | ||
- Local restore - database files are restored to the same host as the client. | ||
- Redirected restore - database files are restored to a different host than the client. | ||
|
||
|
||
|
||
### Performing Backups | ||
|
||
To take a backup of the database, enter the command on the NetBackup Client: | ||
|
||
`/usr/NBPostgreSQLAgent/nbpgsql -o backup` | ||
|
||
|
||
### Querying Backups | ||
|
||
To list available database backups, enter the command on the NetBackup Client: | ||
|
||
`/usr/NBPostgreSQLAgent/nbpgsql -o query` | ||
<p align="center"> | ||
<img src="Images/BackupQuery.png"> | ||
</p> | ||
|
||
### Performing Restores | ||
|
||
Database restores can be performed in the following two scenarios: | ||
|
||
- Local Restore. | ||
- Redirected Restore. | ||
|
||
|
||
#### Local Restore | ||
|
||
In this scenario, the database files are restored on the original (source) database server host (default | ||
option). | ||
|
||
To perform a local restore, use the steps below: | ||
|
||
1. Stop the database server. | ||
|
||
2. Create the target directory to store the database files to be used for the restore operation. | ||
|
||
3. Determine the database backup id you want to use for the restore by querying available backups: | ||
|
||
`/usr/NBPostgreSQLAgent/nbpgsql -o query` | ||
|
||
4. Restore the database files to the target directory: | ||
|
||
`/usr/NBPostgreSQLAgent/nbpgsql -o restore -t <target-directory> -id <db-backup-id>` | ||
|
||
5. Once the restore operation is completed, replace the data directory (PGDATA) with the contents | ||
of the target directory. | ||
|
||
6. Set the `restore_command` parameter in the `postgresql.conf` file: | ||
``` | ||
restore_command = 'cp /var/lib/edb/as13/data/pgarchive/%f %p' | ||
``` | ||
|
||
7. Start the PostgreSQL server. | ||
|
||
|
||
|
||
#### Redirected Restore | ||
|
||
In this scenario, the database files are restored on a (target) database server host which is different from the original (source) database server. | ||
|
||
To perform a redirected restore, use the steps below: | ||
|
||
1. Stop the database server on the target host. | ||
|
||
2. Create the target directory on the target host to store the database files to be used for the restore operation. | ||
|
||
3. Determine the database backup id you want to use for the restore by querying available backups on the source host: | ||
|
||
`/usr/NBPostgreSQLAgent/nbpgsql -o query -C <source-db-server-host>` | ||
|
||
4. Restore the database files to the target directory on the target host: | ||
|
||
`/usr/NBPostgreSQLAgent/nbpgsql -o restore -t <target-directory> -id <db-backup-id> -C <source-db-server-host>` | ||
|
||
5. Once the restore operation is completed, replace the data directory `PGDATA` on the target host with the contents of the target directory. | ||
|
||
6. Set the `restore_command` parameter in the `postgresql.conf` file on the target host: | ||
``` | ||
restore_command = 'cp /var/lib/edb/as13/data/pgarchive/%f %p' | ||
``` | ||
|
||
7. Start the PostgreSQL server on the target host. |
13 changes: 13 additions & 0 deletions
13
advocacy_docs/partner_docs/VeritasGuide/06-CertificationEnvironment.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: 'Certification Environment' | ||
description: 'Overview of the certification environment used in the certification of NetBackup for PostgreSQL' | ||
--- | ||
|
||
| | | | ||
| ----------- | ----------- | | ||
| **Certification Test Date** | December 28, 2021 | | ||
| **EDB Postgres Advanced Server** | 11,12,13,14 | | ||
| **Veritas NetBackup for PostgreSQL** | 9.1 | | ||
| **Veritas NetBackup Server** | 9.1 | | ||
| **Veritas NetBackup Client** | 9.1 | | ||
|
3 changes: 3 additions & 0 deletions
3
advocacy_docs/partner_docs/VeritasGuide/Images/ArchitectureUpdate4.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
3
advocacy_docs/partner_docs/VeritasGuide/Images/BackupQuery.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
3
advocacy_docs/partner_docs/VeritasGuide/Images/EDBPartnerProgram.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
3
advocacy_docs/partner_docs/VeritasGuide/Images/NetBackupAdminConsole.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
3
advocacy_docs/partner_docs/VeritasGuide/Images/NetBackupDataPolicy1.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
3
advocacy_docs/partner_docs/VeritasGuide/Images/NetBackupDataPolicy2.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
3
advocacy_docs/partner_docs/VeritasGuide/Images/NetBackupDataPolicy3.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
3
advocacy_docs/partner_docs/VeritasGuide/Images/NetBackupDataPolicy4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: 'Veritas Implementation Guide' | ||
indexCards: simple | ||
directoryDefaults: | ||
iconName: handshake | ||
--- | ||
|
||
<p align="center"> | ||
<img src="Images/EDBPartnerProgram.png"> | ||
</p> | ||
<h1 style="text-align: center;">EDB GlobalConnect Technology Partner Implementation Guide</h1> | ||
<h3 style="text-align: center;">Veritas NetBackup for PostgreSQL</h3> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.