Skip to content

Commit

Permalink
Merge pull request #2860 from EnterpriseDB/release/2022-06-27
Browse files Browse the repository at this point in the history
Release: 2022-06-27
  • Loading branch information
drothery-edb authored Jun 27, 2022
2 parents 4d771ba + 23bb6ef commit 4c9b9ad
Show file tree
Hide file tree
Showing 71 changed files with 1,142 additions and 655 deletions.
1 change: 1 addition & 0 deletions .github/workflows/deploy-draft.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ jobs:
deploy-message: ${{ github.event.pull_request.title }}
enable-commit-comment: false
github-deployment-environment: ${{ env.BUILD_ENV_NAME }}
alias: deploy-preview-${{ github.event.number }}
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_DEVELOP_SITE_ID }}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: 'Partner Information'
description: 'Details for Commvault'

---
|   |   |
| ----------- | ----------- |
| **Partner Name** | Commvault |
| **Partner Product** | Commvault Backup & Recovery |
| **Web Site** | https://www.commvault.com/ |
| **Version** | Commvault Backup & Recovery 11.24 |
| **Product Description** | Wherever your data resides, ensure availability via a single interface with Commvault Backup & Recovery. Comprehensive workload coverage, files, apps, and databases including EDB Postgres Advanced Server and EDB Postgres Extended Server from a single extensible platform and user interface. Commvault Backup & Recovery provides a comprehensive backup and archiving solution for your trusted recovery, ransomware protection, and security. |
11 changes: 11 additions & 0 deletions advocacy_docs/partner_docs/CommVaultGuide/03-SolutionSummary.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: 'Solution Summary'
description: 'Brief explanation of the solution and its purpose'
---
Commvault enables your business to streamline management of its continuously evolving data environment, whether the data is on-premises or in the cloud.

Commvault PostgreSQL iDataAgent provides the flexibility to backup PostgreSQL, EDB Postgres Advanced Server and EDB Postgres Extended Server databases in different modes and restore them when needed. You can perform a full/log backup or restore of database servers/individual databases/archive logs at any time and have full control over the process.

Managing your data means knowing that it is protected and being able to effectively report on success or failure. Through an easy-to-use interface, you can quickly check on the progress of your jobs to ensure things are moving as expected. You can also use pre-built reports in an on-demand fashion, or scheduled, to keep you in the know.

![Commvault Architecture](Images/Final-SolutionSummaryImage.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
---
title: 'Configuring Commvault Backup & Recovery'
description: 'Walkthrough on configuring Commvault Backup & Recovery'
---

Implementing Commvault Backup & Recovery with an EDB database requires the following components:

- EDB Postgres Advanced Server or EDB Postgres Extended Server
- Commvault Backup & Recovery software

## Prerequisites

- A running EDB Postgres Advanced Server or EDB Postgres Extended Server instance.
- Commvault Backup & Recovery installed.
- EDB Postgres Advanced Server or EDB Postgres Extended Server application path and library directory path (e.g. `c:\Program Files\edb\as13\bin` and `c:\Program Files\edb\as13\lib`).
- The login credentials used to access the EDB Postgres Advanced Server or EDB Postgres Extended Server database.
- EDB Postgres Advanced Server or EDB Postgres Extended Server archive log directory configured.

## Configure Commvault Backup & Recovery for EDB Postgres Advanced Server or EDB Postgres Extended Server

### Setup a Disk Storage Pool and Database Server Backup Plan
1. Run the Core Setup Wizard from Commvault Backup & Recovery's Command Center from the Machine where Commvault Backup & Recovery is installed. The wizard helps to set up a disk storage pool and to modify the server backup plan according to your requirements.
2. Setup Storage Pool/Disk Storage: From the Welcome page, click `Let's get started`. On the `Disk` tab, in the `Name` box, enter a name for the storage pool.
3. In the `MediaAgent` box, accept the default value.
4. Click `Local` on the radio button for `Type`.
5. In the `Backup` location box, click `Browse` to assign a path where backups will be stored.
6. To enable deduplication on the storage, move the `Use` deduplication toggle key to the right, and in the `Deduplication DB` location box, browse to select the path to the deduplication database.
7. To move to the next setup option, click `Save`.

![Setup Storage Pool/Disk Storage](Images/DiskStorageConf.png)

8. Creating a Server Backup Plan in Core Setup: In order to create a server backup plan in Core Setup, define where the data is stored and how often must the data undergo a backup.
9. In the `Plan` name box,type the name of the plan e.g. `EPAS Server Plan`.
10. In the `Backup destinations` section, select the Storage and Retention Period.
11. In the `RPO` section, select the Backup frequency and Start time for the backup to start as per the backup frequency.

![Creating a Server Backup Plan in Core Setup](Images/BackupPlanConf.png)

### Install a client on an EDB database
1. From the `Navigation` pane of the Commvault Backup & Recovery's Command Center, go to `Protect > Databases`.
2. Click `Add server`.
3. Select the database type for EDB database, which in this case is PostgreSQL.

![Creating a Server Backup Plan in Core Setup](Images/ServerAdd1.png)

4. In the `Database` server name box, enter the server name.
5. In the `Username` and `Password` boxes, enter the credentials to connect to the server.
6. From the Plan list, select the server plan created in step 8 under Setup a Disk Storage Pool and Database Server Backup Plan section for use with your EDB database.

![Creating a Server Backup Plan in Core Setup](Images/ServerAdd2.png)

7. Once the server is added, a Job will run to install a client on the Server. The screen shots below display the process from Job creation to software installation.

![Creating a Server Backup Plan in Core Setup](Images/ServerAdd3.png)

![Creating a Server Backup Plan in Core Setup](Images/ServerAdd4.png)

![Creating a Server Backup Plan in Core Setup](Images/ServerAdd5.png)

![Creating a Server Backup Plan in Core Setup](Images/ServerAdd6.png)

### Configure the EDB Database Instances to backup and protect
1. From the navigation pane, go to `Protect > Databases > DB Instances`.
2. Click `Add instance`, and then select `PostgreSQL`.

![Creating a Server Backup Plan in Core Setup](Images/CreateInstance1.png)

3. From the Server name list, select a server where you want to create the new instance.
4. In the `Instance Name` box, type the EDB database instance name.
5. From the `Plan` list, select the server plan created in step 8 under Setup a Disk Storage Pool and Database Server Backup Plan section for use with your EDB database.
6. Under `Connection details`, enter the following information.
- In the `Database` user box, type the user name to access the EDB database instance.
- In the `Password` box, type the EDB database user account password.
- In the `Port` box, type the port to open the communication between the EDB database and the clients.
- In the `Maintenance DB` box, type the name of a system database which is used as a maintenance database.
- In the `PostgreSQL` section, enter paths for `Binary Directory`, `Lib Directory` and `Archive Log Directory`.


![Creating a Server Backup Plan in Core Setup](Images/CreateInstance2.png)


7. Your database instance to backup is now created. You can now view its configuration.

![Creating a Server Backup Plan in Core Setup](Images/CreateInstance3.png)

![Creating a Server Backup Plan in Core Setup](Images/CreateInstance4.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
---
title: 'Using Commvault Backup & Recovery'
description: 'Walkthroughs of multiple Commvault Backup & Recovery usage scenarios'
---

How to backup and restore an EDB Database using Commvault Backup & Recovery.

## Using Commvault Backup & Recovery

Commvault provides two methods of taking the backup from an EDB database and restoring it.

1. DumpBasedBackupSet Backup and Restore
2. FSBasedBackupSet Backup and Restore

!!! Note
At this time there is a known issue with FSBased Restore that does not allow for proper restoration of the database. See the known issues section of the guide for more information.

### DumpBasedBackupSet Backup and Restore

Dump based backup uses the `pg_dump` Utility to take the backup.

#### Taking DumpBasedBackupSet Backup

1. Open Commvault Backup & Recovery's Command Center and from the navigation pane, go to `Protect > Databases`.

![Instances Page](Images/Dumpbackup1.png)

2. Click on the required instance.
3. In the `Backup sets` section, click on `DumpBasedBackupSet` backup set.

![Instances Page](Images/Dumpbackup2.png)

4. In the `Database groups` section, click the database group that you want to back up. In this case it is `default`.

![Select Database Group](Images/Dumpbackup3.png)

5. In the `Backup` section, click `Back up now`.

![Backup Section](Images/Dumpbackup4.png)

6. Select `Full` in the `Select Backup Level` screen.

![Backup Level Screen](Images/Dumpbackup5.png)

7. A Job will be created to take the backup.

![Backup Job](Images/Dumpbackup6.png)

8. Once the Backup Job is completed then its status will be changed to `Completed`.

![Backup Job](Images/Dumpbackup7.png)

#### Restoring DumpBasedBackupSet Backup

DumpBased backupset can be used to restore the individual databases.

1. From the navigation pane, go to `Protect > Databases`.
2. Click the instance that you want to restore.
3. In the `Recovery points` calendar, select `DumpBasedBackupSet`.

![Recovery Points Calendar](Images/Dumprestore1.png)

4. Select a date from the calendar, and then click `Restore`.
5. The `Backup Content` screen will display the databases to be restored, select the required database to restore or select all of them to restore all.

![Backup Content Screen](Images/Dumprestore2.png)

6. Click `Restore`.
7. From the `Restore Options` screen, select the `Destination Server` and `Destination Instance` and click on `submit`.

![Restore Options Screen](Images/Dumprestore3.png)

8. A Job will be created to restore the backup.

![Restore Job](Images/Dumprestore4.png)

![Restore Job](Images/Dumprestore5.png)

9. Once the Restore is completed successfully, login to the EDB database and check that the restore operation recovered the data. In our example below we connected to an EDB Postgres Advanced Server instance.

```bash
edb=#
edb=# \l
List of databases
Name | Owner | Encoding | Collate | Ctype | ICU | Access privileges
-------------+--------------+----------+----------------------------+----------------------------+-----+-------------------------------
edb | enterprisedb | UTF8 | English_United States.1252 | English_United States.1252 | |
epas13_test | enterprisedb | UTF8 | English_United States.1252 | English_United States.1252 | |
postgres | enterprisedb | UTF8 | English_United States.1252 | English_United States.1252 | |
template0 | enterprisedb | UTF8 | English_United States.1252 | English_United States.1252 | | =c/enterprisedb +
| | | | | | enterprisedb=CTc/enterprisedb
template1 | enterprisedb | UTF8 | English_United States.1252 | English_United States.1252 | | =c/enterprisedb +
| | | | | | enterprisedb=CTc/enterprisedb
(5 rows)


edb=#
edb=# \c epas13_test
You are now connected to database "epas13_test" as user "enterprisedb".
epas13_test=# \dt
List of relations
Schema | Name | Type | Owner
--------+------------------+-------+--------------
public | tp_department_db | table | enterprisedb
public | tp_sales_db | table | enterprisedb
(2 rows)


epas13_test=# select * from tp_department_db;
deptno | dname | location
--------+-------------+----------
10 | Development | Pakistan
20 | Testing | Pakistan
30 | CM | Pakistan
40 | Marketing | India
(4 rows)


epas13_test=# select * from tp_sales_db;
salesman_id | salesman_name | sales_region | sales_amount | deptno
-------------+---------------+--------------+--------------+--------
100 | Person 1 | CITY 1 | 1 | 10
110 | Person 2 | CITY 2 | 2 | 20
120 | Person 3 | CITY 3 | 3 | 30
130 | Person 4 | CITY 4 | 10000 | 40
(4 rows)


epas13_test=# select * from v1;
dept_no | dept_name | sales_no | sales_name | sales_salary | sales_dept_no
---------+-------------+----------+------------+--------------+---------------
10 | Development | 100 | Person 1 | 1 | 10
20 | Testing | 110 | Person 2 | 2 | 20
30 | CM | 120 | Person 3 | 3 | 30
40 | Marketing | 130 | Person 4 | 10000 | 40
(4 rows)


epas13_test=# desc tp_sales_db;
Table "public.tp_sales_db"
Column | Type | Collation | Nullable | Default
---------------+-----------------------+-----------+----------+------------------------------
salesman_id | integer | | |
salesman_name | character varying(30) | | |
sales_region | character varying(30) | | |
sales_amount | integer | | | nextval('sal_seq'::regclass)
deptno | integer | | |
Indexes:
"lower_reg_idx" btree (lower(sales_region::text))
"reg1_idx" btree (salesman_id)
Foreign-key constraints:
"department_employee_fk" FOREIGN KEY (deptno) REFERENCES tp_department_db(deptno)


epas13_test=#
epas13_test=#

```

## Known Issues
FSBaseBackupSet Restore has an issue if the default edb directory (for example, `*:\Program files\edb`) has been lost or deleted. If this occurs then after a restore is performed, the permissions on the restored directories are not recovered. Instead the directory inherits the permissions from the parent directory which does not allow EDB Postgres Advanced Server services to start on the restored directory. We are working with Commvault to resolve the issue.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: 'Certification Environment'
description: 'Overview of the certification environment used in the certification of Commvault Backup & Recovery'
---

|   |   |
| ----------- | ----------- |
| **Certification Test Date** | June 16, 2022 |
| **EDB Postgres Advanced Server** | 11, 12, 13, 14 |
| **EDB Postgres Extended Server** | 11, 12, 13 |
| **Commvault Backup & Recovery** | 11.24 |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 4c9b9ad

Please sign in to comment.