From 8649735154f982dab7336800c84018ca0ccfeaea Mon Sep 17 00:00:00 2001
From: Mel Kiyama
Date: Mon, 11 Jun 2018 11:55:30 -0700
Subject: [PATCH] docs - gpbackup ddboost plugin - add replication feature
(#5127)
* docs - gpbackup ddboost plugin - add replication feature
* docs - gpbackup ddboost plugin - fix typos
---
.../managing/backup-ddboost-plugin.xml | 121 ++++++++++++++++--
1 file changed, 109 insertions(+), 12 deletions(-)
diff --git a/gpdb-doc/dita/admin_guide/managing/backup-ddboost-plugin.xml b/gpdb-doc/dita/admin_guide/managing/backup-ddboost-plugin.xml
index aa44588d36..efa8b70863 100644
--- a/gpdb-doc/dita/admin_guide/managing/backup-ddboost-plugin.xml
+++ b/gpdb-doc/dita/admin_guide/managing/backup-ddboost-plugin.xml
@@ -13,7 +13,8 @@
gpbackup and gprestore
- utilities to perform faster backups to the Dell EMC Data Domain storage appliance.
+ utilities to perform faster backups to the Dell EMC Data Domain storage appliance. You can
+ also replicate a backup on a separate, remote Data Domain system for disaster recovery.
To use the DD Boost storage plugin application, you first create a configuration file to
specify the location of the plugin, the DD Boost login, and the backup location. When you run
gpbackup or gprestore, you specify the configuration file
@@ -22,6 +23,15 @@
If you perform a backup operation with the gpbackup option
--plugin-config, you must also specify the --plugin-config
option when you restore the backup with gprestore.
+ To replicate a backup set on a separate Data Domain system for disaster recovery, add the
+ backup replication options to the configuration file. Set the replication
+ option to on and add the options that the plugin uses to access the remote
+ Data Domain system that stores the replicated backup. During the backup operation, the DD
+ Boost storage plugin replicates the backup set on the remote Data Domain system with DD Boost
+ managed file replication.
+ To restore data from a replicated backup, you can use gprestore with the DD
+ Boost storage plugin and specify the location of the backup in the DD Boost configuration
+ file.
DD Boost Storage Plugin Configuration File Format
The configuration file specifies the absolute path to the Greenplum Database DD Boost
@@ -37,11 +47,17 @@
This is the structure of a DD Boost storage plugin configuration file.
executablepath: <absolute-path-to-gpbackup_ddboost_plugin>
options:
- hostname: <data-domain-host>
- username: <ddboost-ID>
- password: <ddboost-pwd>
- storage_unit: <data-domain-id>
- directory: <data-domain-dir>
+ hostname: "<data-domain-host>"
+ username: "<ddboost-ID>"
+ password: "<ddboost-pwd>"
+ storage_unit: "<data-domain-id>"
+ directory: "<data-domain-dir>"
+ replication: "on" | "off"
+ remote_hostname: "<remote-dd-host>"
+ remote_username: "<remote-ddboost-ID>"
+ remote_password: "<remote-dd-pwd>"
+ remote_storage_unit: "<remote-dd-ID>"
+ remote_directory: "<remote-dd-dir>"
executablepath
@@ -59,7 +75,7 @@
username
- Required. the Data Domain Boost user name. There is a 30-character limit.
+ Required. The Data Domain Boost user name. There is a 30-character limit.
password
@@ -82,6 +98,56 @@
/<data-domain-dir>/YYYYMMDD/YYYYMMDDHHMMSS/.
+
+ replication
+ Optional. Enables or disables backup replication with DD Boost managed file
+ replication when gpbackup performs a backup operation. Value is
+ either on or off. Default value is
+ off, backup replication is disabled. When the value is
+ on, the DD Boost plugin replicates the backup on the Data
+ Domain system that you specify with the remote_* options.
+ The replication option and remote_* options
+ are ignored when performing a restore operation with gprestore.
+ The remote_* options are ignored if replication
+ is off.
+
+
+ remote_hostname
+ Required if replication is on. The IP address
+ or hostname of the Data Domain system that is used for remote backup storage.
+ There is a 30-character limit.
+
+
+ remote_username
+ Required if replication is on. The Data Domain
+ Boost user name that accesses the remote Data Domain system. There is a
+ 30-character limit.
+
+
+ remote_password
+ Required if replication is on. The passcode
+ for the DD Boost user to access the Data Domain storage unit on the remote
+ system.
+
+
+ remote_storage-unit
+ Required if replication is on. A valid storage
+ unit name for the remote Data Domain system that is used for backup
+ replication.
+
+
+ remote_directory
+ Required if replication is on. The location
+ for the replicated backup files, configuration files, and global objects on the
+ remote Data Domain system. The location on the system is
+ /<remote-dd-dir> in the storage unit of
+ the remote system.
+ During a backup operation, the plugin creates the directory location if it does
+ not exist in the storage unit of the remote Data Domain system and stores the
+ replicated backup in this directory
+ /<remote-dd-dir>/YYYYMMDD/YYYYMMDDHHMMSS/.
+
+
@@ -93,11 +159,11 @@
ddboost-test-config.yaml.
executablepath: $GPHOME/bin/gpbackup_ddboost_plugin
options:
- hostname: 192.0.2.230
- username: test-ddb-user
- password: asdf1234asdf
- storage_unit: gpdb-backup
- directory: test/backup
+ hostname: "192.0.2.230"
+ username: "test-ddb-user"
+ password: "asdf1234asdf"
+ storage_unit: "gpdb-backup"
+ directory: "test/backup"
This gpbackup example backs up the database demo using the DD Boost
storage plugin. The absolute path to the DD Boost storage plugin configuration file is
/home/gpadmin/ddboost-test-config.yml.gpbackup --dbname demo --single-data-file --plugin-config /home/gpadmin/ddboost-test-config.yaml
@@ -106,6 +172,30 @@ options:
/test/backup/YYYYMMDD/YYYYMMDDHHMMSS/
+ This is an example DD Boost storage plugin configuration file that enables
+ replication.executablepath: $GPHOME/bin/gpbackup_ddboost_plugin
+options:
+ hostname: "192.0.2.230"
+ username: "test-ddb-user"
+ password: "asdf1234asdf"
+ storage_unit: "gpdb-backup"
+ directory: "test/backup"
+ replication: "on"
+ remote_hostname: "192.0.3.20"
+ remote_username: "test-dd-remote"
+ remote_password: "qwer2345erty"
+ remote_storage_unit: "gpdb-remote"
+ remote_directory: "test/replication"
+ To restore from the replicated backup in the previous example, you can run
+ gprestore with the DD Boost storage plugin and specify a configuration
+ file with this
+ information.executablepath: $GPHOME/bin/gpbackup_ddboost_plugin
+options:
+ hostname: "192.0.3.20"
+ remote_username: "test-dd-remote"
+ remote_password: "qwer2345erty"
+ storage_unit: "gpdb-remote"
+ directory: "test/replication"
Notes
@@ -124,6 +214,13 @@ options:
Where <directory> is the location you specified in the DD Boost
configuration file, and <datestamp> and
<timestamp> are the backup date and time stamps.
+ When performing a backup operation with replication, the Data Domain system where the
+ backup is stored must have access to the remote Data Domain system where the replicated
+ backup is stored.
+ Performing a backup operation with replication increases the time required to perform a
+ backup. The backup set is copied to the local Data Domain system, and then replicated on the
+ remote Data Domain system using DD Boost managed file replication. The backup operation
+ completes after the backup set is replicated on the remote system.