Manage deployment backups

Deployment Backups can help you troubleshoot issues, clone deployments, and restore deployments.

Note: This information applies only to Data replication deployments.

About deployment backups

There are three ways you can take a backup of your deployment: automatic, manual, and scheduled.

• Automatic: Created daily without user input or configuration changes, and backs up unprocessed or currently in process trail files.

• Manual: A backup that you generate at any time, and can include only metadata or metadata and trail files.

• Scheduled: A manual backup that you can schedule to occur on a regular basis.

Note: Automatic and manual backups cannot run concurrently. Only one backup process can run at a time.

Automatic backups are retained for twelve days, after which they are automatically deleted. To retain data contained within automatic backups for more than twelve days, you can archive the data and save them to your Oracle Object Storage tenancy. Associated storage charges apply. Manual backups are kept until you delete them.

To view deployment backups, select Deployment backups on the deployment details page.

Schedule backups

You can schedule deployment backups to occur daily, weekly, or monthly when you create or edit the deployment.

Before you schedule backups, ensure that you add the minimum required policies for OCI GoldenGate and Oracle Object Storage.

1. To schedule backups when creating a deployment, in the Backup schedule section of the Create deployment page:

   1. Select Configure backup schedule.

   2. Select the Date and Time to start creating backups.

   3. Select the Frequency for creating backups, either Daily, Weekly, or Monthly.

   4. Select Backup metadata only, to create backups without trail files.

   5. Select the Compartment in which to create backups.

   6. Select the Compartment and the Object storage bucket in which to save backups.

2. To schedule backups, or edit a backup schedule, for a deployment already created:

   1. On the deployment's details page, locate the Backups section, and then select Edit.

   2. In the Configure backup schedule panel, select Configure backup schedule.

   3. Select the Compartment in which to create backups.

   4. Select the Compartment and the Object storage bucket in which to save backups.

   5. Select the Date and Time to start creating backups.

   6. Select the Frequency for creating backups, either Daily, Weekly, or Monthly.

   7. Select Backup metadata only, to create backups without trail files.

To view deployment backups, select Deployment backups on the deployment details page.

Creating a Manual Backup

To create a backup:

1. On the deployment details page, select Deployment backups.

2. Select Create backup.

3. In the Create backup panel, enter a name for the backup.

4. From the Compartment dropdown, select the compartment of your tenancy's Oracle Object Storage.

5. From the Oracle Object Storage in <compartment_name> dropdown, select the Object Storage bucket where your backup will be stored.

6. For Object name, enter a name for the backup as it'll appear in Object Storage. Ensure to add the file extension .xz at the end of the object name.

   Note: You can then download the manual backup and use a client that supports .xz file types to unzip it.

7. Select Backup metadata only to create a backup without Trail files.

8. Select Create backup.

To view deployment backups, select Deployment backups on the deployment details page.

Manual backup directory structure

You can create a manual backup of your OCI GoldenGate and save it to your Oracle Object Storage tenancy. From there, you can download the manual backup locally, and then access a full directory of the GoldenGate deployment’s files, including log and trail files.

The directory structure of a manual backup appears similar to the following:

• bin

• cfgtoollogs

• deinstall

• diagnostics

• include

• install

• inventory

• jdk

• jlib

• lib

  • instantclient

  • sql

  • utl

• OPatch

• oraInst.loc

• oui

• srvm

The following table describes the key Oracle GoldenGate directories and the variables used to reference them. When you see these variables in an example or procedure, replace the variable with the full path to the corresponding directory path in your manual backup directory.

Directory Name	Variable	Description	Default Directory Path
Oracle GoldenGate home	OGG_HOME	The Oracle GoldenGate home that is created on a host computer is the directory that you choose to install the product. This read-only directory contains binary, executable, and library files for the product.	/ogg_install_location
Deployment configuration home	OGG_CONF_HOME	The location where each deployment information and configuration artifacts are stored.	/ogg_deployment_location/etc/conf
Deployment security home	OGG_SSL_HOME	The location where each deployment security artifacts (certificates, wallets) are stored.	/ogg_deployment_location/etc/ssl
Deployment data home	OGG_DATA_HOME	The location where each deployment data artifacts (trail files) are stored.	/ogg_deployment_location/var/lib/data
Deployment variable home	OGG_VAR_HOME	The location where each deployment logging and reporting processing artifacts are stored.	/ogg_deployment_location/var
Deployment etc home	OGG_ETC_HOME	The location where your deployment configuration files are stored including parameter files.	/ogg_deployment_location/etc

Viewing deployment backup details

To view details of a deployment backup, select Deployment backups on the deployment details page, and then select a backup from the list to view its details.

On the Deployment backup details page, you can:

• Restore

• Create Clone

• Move it to another compartment

• Add Tags

• Delete it

• View Deployment Backup information:

  • Deployment Backup OCID

  • Compartment

  • When the backup was created

  • When the backup was last updated

  • When the backup started

  • When the backup finished

  • Backup type

  • Backup size

  • Source type (manual or automatic)

  • Backup source

  • Backup location

  • Object name in Oracle Object Store

  • GoldenGate version

• View Work Requests

Copy deployment backup

To copy a deployment backup:

1. Choose one of the following options:

   1. On the Deployment Backups page, from the Actions menu of a deployment backup, select Copy.

   2. On the Deployment Backups page, select a deployment backup. In the Deployment backup details page, from the Actions menu, select Copy .

2. On the Copy backup panel, select a compartment from the dropdown and an Object storage bucket from the dropdown.

3. Select Copy.

Your copy appears in the list of deployment backups.

Note: If you want a local copy of your deployment backup, you can download it from your Object Storage bucket.

Restore a deployment from a backup

You can use a backup to restore a deployment to the state when the backup was created.

To restore a deployment backup:

1. On the deployment details page, select Deployment backups.

2. From the list of Deployment backups, select a backup to restore.

   You can also select Restore from the deployment backup's Actions menu.

3. On the Deployment backup details page, select Restore.

4. In the Restore backup dialog, select Restore.

Create a deployment clone

You can use deployment backups to create a clone of a deployment.

You can create a deployment clone from the Deployment Backup details page. From the Actions menu, select Create Clone, and then complete the Create deployment clone wizard, which is identical to the Create deployment workflow. For more information, see Create deployments.