Installing Oracle GoldenGate

Learn about the steps for installing Oracle GoldenGate Microservices Architecture for the first time and includes instructions to download the base release of a new version of Oracle GoldenGate.

To download and install subsequent patches to the base release, go to the Patches and Updates tab of My Oracle Support at:

http://support.oracle.com

Also see Installing Patches for Oracle GoldenGate Microservices Architecture.

Installing Oracle GoldenGate Microservices Architecture

The steps for installing Oracle GoldenGate Microservices Architecture for Oracle and Non-Oracle databases are the same. However, there are some prerequisites before you begin the installation.

Verify that you meet the operating system and required database configuration before beginning the installation. See:

The Oracle GoldenGate Microservices Architecture (MA) installation involves the following steps:

Install the Oracle GoldenGate software. See Performing an Interactive Installation with OUI for MA and Performing a Silent Installation with OUI.
Set the necessary environment variables for your database, if required.

Note:

(Oracle only) From the Oracle GoldenGate 21c release onward, ORACLE_HOME and LD_LIBRARY_PATH do not point to any database directories. With the unified build feature, these environment variables now point to the OGG_HOME (sub)directories as the Oracle Database Client Software is embedded in Oracle GoldenGate.
Run the Oracle GoldenGate Configuration Assistant (oggca) wizard to add a deployment for the Oracle GoldenGate installation. For steps to run the OGGCA utility, see Add a Deployment.

The installer registers the Oracle GoldenGate home directory ($OGG_HOME) with the central inventory that is associated with the selected database. The inventory stores information about all Oracle software products installed on a host if the product was installed using OUI.

Disk space is also required for the Oracle GoldenGate Bounded Recovery feature. Bounded Recovery is a component of the general Extract checkpointing facility. It caches long-running open transactions to disk at specific intervals to enable fast recovery upon a restart of Extract. At each bounded recovery interval (controlled by the BRINTERVAL option of the BR parameter) the disk required is as follows: for each transaction with cached data, the disk space required is usually 64k plus the size of the cached data rounded up to 64k. Not every long-running transaction is persisted to disk.

For complete information about Bounded Recovery, see the BR parameter in Parameters and Functions Reference for Oracle GoldenGate.

Performing an Interactive Installation with OUI for MA

Use the graphical user interface to install Oracle GoldenGate with prompts for required installation information. These instructions apply to new installations and upgrades:

Create a temporary staging directory where you will install Oracle GoldenGate.
For example, on Linux the directory would be mkdir /u01/stage/oggsc.
For Windows, create a directory where you will install Oracle GoldenGate such as, gghome, and a directory where you will keep the installation .zip file such as ogg. For example: C:\>mkdir gghome ogg
Extract the installation .zip file into the temporary staging directory. For example:

For Linux: unzip ./fbo_ggs_Linux_x64_Oracle_services_shiphome.zip -d ./temp directory

For Windows: C:\ogg>unzip fbo_ggs_Windows_x64_Oracle_services_shiphome.zip -d temp
From the expanded directory, run the fbo_ggs_Linux_x64_Oracle_services_shiphome/Disk1/runInstaller program on UNIX or Linux. On Windows, run the fbo_ggs_Windows_x64_Oracle_services_shiphome/Disk1/setup.exe program.
The OUI Install Wizard is started.
On the Select Installation Option page, select the Oracle Database version for your environment, then click Next.
On the Specify Installation Details page, specify the following:
1. For Software Location, specify the location where Oracle GoldenGate software will be installed. This will be your Oracle GoldenGate Home (OGG_HOME) after the installation is complete. For example: C:\gghome for Windows. If you have the $OGG_HOME environment variable set, this should be the path displayed. The specified directory cannot be a registered home in the Oracle Central Inventory.
2. Click Next.
On the Summary page, confirm that there is enough space for the installation and that the installation selections are correct.
1. (Optional) Click Save Response File to save the installation information to a response file. You can run the installer from the command line with this file as input to duplicate the results of a successful installation on other systems. You can edit this file or create a new one from a template.
2. Click Install to begin the installation or Back to go back and change any input specifications. When upgrading an existing Oracle GoldenGate installation, OUI notifies you that the software location has files or directories. Click Yes to continue.
3. If you created a central inventory directory, you are prompted to run the INVENTORY_LOCATION/orainstRoot.sh script. This script must be executed as the root operating system user. This script establishes the inventory data and creates subdirectories for each installed Oracle product (in this case, Oracle GoldenGate).
You are notified when the installation is finished.
Click Close to complete the installation.

Performing a Silent Installation with OUI

Silent installation from the command line interface can be performed if your system does not have an X-Windows or graphical interface or you want to perform the installation in an automated way. Silent installations ensure that multiple users in your organization use the same installation options when installing Oracle products.

Silent installations are driven by using a response file. Response files can be saved by selecting the Save Response File option during an interactive Oracle Universal Installer session or by editing the oggcore.rsp template located in the response directory after unzipping the Oracle GoldenGate binaries.

Editing the Default Response File

You can edit the default response file without having to save the settings from an interactive Oracle Universal Installer session. If you are manually editing the response file, provide the following information and save the file:

INSTALL_OPTION - The valid values are DB2ZOS, DB2400, DB2LUW,MSSQL, MySQL, ora23ai, ORA21c, and PostgreSQL. Set the value based on the database platform for the specific Oracle GoldenGate build to be installed.

Example:

INSTALL_OPTION=ora23ai
SOFTWARE_LOCATION - Absolute path to where Oracle GoldenGate will be installed. Do not use spaces in the path and ensure that the directory has been created and is empty.

Example:

SOFTWARE_LOCATION=/u01/userhome/oracle/ogg23ai_ora
INVENTORY_LOCATION - Location of the Oracle Inventory files. This is optional for Windows installations.

Example:

INVENTORY_LOCATION=/u01/app/oraInventory
UNIX_GROUP - The Unix group to be set for the inventory directory. Not valid for Windows installations.

Example:

UNIX_GROUP=oinstall

Installing Oracle GoldenGate

To perform a silent installation using a response file, perform the following steps:

Run the following command to unzip the folder that contains the Oracle GoldenGate installation program.
```
cd unzipped_directory/[fbo_]ggs_OS_database_services_shiphome/Disk1
```
Run the following command to launch the installer program.
```
./runInstaller -silent -nowait -responseFile absolute_path_to_response_file
```

You'll need to set the ODBCINI environment varaible for PostgreSQL after installing Oracle GoldenGate. This is required only when you are installing Oracle GoldenGate for PostgreSQL. See Prepare Database Connection for steps to perform this task.

Integrating Oracle GoldenGate Microservices Architecture into a Cluster

If you installed Oracle GoldenGate in a cluster, take the following steps to integrate Oracle GoldenGate within the cluster solution.

Oracle GoldenGate Microservices Architecture provides REST-enabled services with features including remote configuration, administration, and monitoring through HTML5 web pages, command line interfaces, and APIs.

For more information about installing and using Oracle GoldenGate in a cluster, see the Oracle GoldenGate Microservices Architecture with Oracle Real Application Clusters Configuration Best Practices technical brief.