Step-by-Step Installation of Oracle GolgenGate (OGG) 21c Microservices

Oracle GoldenGate Microservices Architecture (MA):

Oracle GoldenGate Microservices Architecture (MA) is a modern, web-based framework designed to manage data replication in a more flexible, scalable, and cloud-friendly way compared to the traditional Oracle GoldenGate Classic Architecture. Introduced in Oracle GoldenGate 12c, the Microservices Architecture offers an improved user experience through RESTful APIs and web-based user interfaces. Here are the key features and components of Oracle GoldenGate Microservices:

Key Components of OGG Microservices:

  • Service Manager: The Service Manager acts as the central point to monitor and manage all other services. It provides a web interface to view and manage deployments, configure processes, and monitor system health.
  • Administration Service: The Administration Service is the primary component responsible for the management of Oracle GoldenGate configurations. You can configure, start, stop, and manage replication tasks here.
  • Receiver Service: This service handles the receipt of trail files from the source system. It is designed to be fault-tolerant and ensures that data is reliably transferred between environments.
  • Distribution Service: This service is responsible for sending trail files (data) from the source to the target in a secure and efficient manner. It supports both push and pull models.
  • Performance Metrics Service: This service collects, processes, and presents performance-related data, allowing administrators to monitor the performance and health of the GoldenGate replication setup.
  • Deployment Service: The Deployment Service manages the actual Oracle GolgenGate processes (Extract, Replicat) and is used to deploy and manage the replication configurations.

Download the Binary:

User the below link to download the binary:

https://edelivery.oracle.com/osdc/faces/SoftwareDelivery

Search with Oracle GoldenGate and Select the OGG version from the list:

Select the binary based on your requirement: (For MA- make sure you selected the correct one)

Upload the downloaded binary file to the server and unzip the the binary:

[oracle@orclprd ogg_ma_binary]$ pwd
/u01/goldengate/ogg_ma_binary

[oracle@orclprd ogg_ma_binary]$ ls -lrt
-rw-r--r--. 1 oracle oinstall 381014026 Sep 11 20:58 V1011471-01.zip

[oracle@orclprd ogg_ma_binary]$ unzip V1011471-01.zip
[oracle@orclprd ogg_ma_binary]$ ls -lrt
total 372396
drwxr-xr-x. 3 oracle oinstall      4096 Jul 29  2021 fbo_ggs_Linux_x64_Oracle_services_shiphome
-rw-r--r--. 1 oracle oinstall    306395 Aug 10  2021 oracle-goldengate-release-notes_21.3.pdf
-rw-r--r--. 1 oracle oinstall      2409 Aug 10  2021 OGG-21.3.0.0-README.txt
-rw-r--r--. 1 oracle oinstall 381014026 Sep 11 20:58 V1011471-01.zip

We need to create three directories on OGG Home:

[oracle@orclprd goldengate]$ pwd
/u01/goldengate
[oracle@orclprd goldengate]$ ls -lrt
total 24
drwxr-xr-x.  2 oracle oinstall 4096 Sep 11 21:09 ogg21c_ma
drwxr-xr-x.  2 oracle oinstall 4096 Sep 11 21:13 ogg21c_sm
drwxr-xr-x.  2 oracle oinstall 4096 Sep 11 21:13 ogg12c_deploy
  • Directory ogg21c_ma for OGG Home.
  • Directory ogg21c_sm for Service Manager Home.
  • Directory ogg21c_deploy for Deployment Home.

Oracle GoldenGate 21c Unified Build Feature:

One of the key enhancements in OGG 21c is the introduction of a unified build architecture. Unlike previous versions, where administrators had to manually select the database version during installation, OGG 21c simplifies the process by eliminating this requirement entirely.

With this new unified build, OGG automatically includes the latest Oracle Database client libraries. This means that the same installation can support multiple Oracle Database versions, reducing complexity and ensuring compatibility without the need for additional configuration.

Run the runInstaller file to start the Installation process with GUI mode:

[oracle@orclprd Disk1]$ pwd
/u01/goldengate/ogg_ma_binary/fbo_ggs_Linux_x64_Oracle_services_shiphome/Disk1

[oracle@orclprd Disk1]$ ls -lrt
total 16
drwxr-xr-x.  4 oracle oinstall 4096 Jul 29  2021 install
drwxr-xr-x. 12 oracle oinstall 4096 Jul 29  2021 stage
-rwxr-xr-x.  1 oracle oinstall  918 Jul 29  2021 runInstaller
drwxrwxr-x.  2 oracle oinstall 4096 Jul 29  2021 response

[oracle@orclprd Disk1]$ ./runInstaller

Choose the Software Location where it will be installed and Click Next:

Installation Summary:

Installation in Progress.. You can monitor for details by clicking on Details button.

Installation completed successfully. Click on Close.

Installation Directories:

[oracle@orclprd ogg21c_ma]$ pwd
/u01/goldengate/ogg21c_ma

[oracle@orclprd ogg21c_ma]$ ls -lrt
-rw-r-----.  1 oracle oinstall   56 Nov 16  2023 oraInst.loc
drwxr-xr-x.  3 oracle oinstall 4096 Sep 11 21:32 diagnostics
drwxr-xr-x.  3 oracle oinstall 4096 Sep 11 21:32 srvm
drwxr-xr-x.  2 oracle oinstall 4096 Sep 11 21:32 deinstall
drwxr-xr-x.  8 oracle oinstall 4096 Sep 11 21:33 lib
drwxr-xr-x.  2 oracle oinstall 4096 Sep 11 21:33 jlib
drwxr-xr-x.  2 oracle oinstall 4096 Sep 11 21:33 include
drwxr-xr-x.  7 oracle oinstall 4096 Sep 11 21:33 jdk
drwxr-xr-x. 13 oracle oinstall 4096 Sep 11 21:33 OPatch
drwxr-xr-x.  2 oracle oinstall 4096 Sep 11 21:33 bin
drwxr-xr-x.  8 oracle oinstall 4096 Sep 11 21:33 oui
drwxr-x---. 13 oracle oinstall 4096 Sep 11 21:33 inventory
drwxr-xr-x.  3 oracle oinstall 4096 Sep 11 21:33 install
drwxr-xr-x.  3 oracle oinstall 4096 Sep 11 21:35 cfgtoollogs

All fills under the bin directory:

[oracle@orclprd bin]$ pwd
/u01/goldengate/ogg21c_ma/bin

[oracle@orclprd bin]$ ls -lrt
total 113596
-rwxrwxr-x. 1 oracle oinstall     6809 Oct 18  2018 XAGTask
-rwxr-x---. 1 oracle oinstall    10362 Dec 16  2020 oggca.sh
-rwxrwxr-x. 1 oracle oinstall     4369 Jul 28  2021 orapki
-rwxrwx---. 1 oracle oinstall 12413968 Jul 29  2021 distsrvr
-rwxrwxr-x. 1 oracle oinstall  8483888 Jul 29  2021 ServiceManager
-rwxrwxr-x. 1 oracle oinstall  1690360 Jul 29  2021 retrace
-rwxrwxr-x. 1 oracle oinstall  1694456 Jul 29  2021 oggerr
-rwxrwxr-x. 1 oracle oinstall  5568576 Jul 29  2021 logdump
-rwxrwxr-x. 1 oracle oinstall  1645280 Jul 29  2021 cachefiledump
-rwxrwxr-x. 1 oracle oinstall 11692320 Jul 29  2021 adminsrvr
-rwxrwxr-x. 1 oracle oinstall  5111424 Jul 29  2021 adminclient
-rwxrwx---. 1 oracle oinstall 11236912 Jul 29  2021 replicat
-rwxrwxr-x. 1 oracle oinstall  8977080 Jul 29  2021 pmsrvr
-rwxrwxr-x. 1 oracle oinstall  5676840 Jul 29  2021 defgen
-rwxrwxr-x. 1 oracle oinstall  1903992 Jul 29  2021 convchk
-rwxrwxr-x. 1 oracle oinstall  5013192 Jul 29  2021 ggcmd
-rwxrwx---. 1 oracle oinstall 11182752 Jul 29  2021 extract
-rwxrwxr-x. 1 oracle oinstall  4976136 Jul 29  2021 emsclnt
-rwxrwxr-x. 1 oracle oinstall  3075192 Jul 29  2021 convprm
-rwxrwxr-x. 1 oracle oinstall  2325248 Jul 29  2021 checkprm
-rwxrwxr-x. 1 oracle oinstall  3185008 Jul 29  2021 certstore
-rwxrwx---. 1 oracle oinstall 10299008 Jul 29  2021 recvsrvr
-rwxrwxr-x. 1 oracle oinstall   112920 Jul 29  2021 keygen

OGG Microservice Deployment:

Setup the Environment Variable:

[oracle@orclprd ~]$ pwd
/home/oracle

[oracle@orclprd ~]$ cat ogg_21c.env
export ORACLE_HOME=/u01/app/oracle/product/19.3.0/dbhome_1
export ORACLE_SID=ORCLPRD
export LD_LIBRARY_PATH=$ORACLE_HOME/lib:$LD_LIBRARY_PATH
export TNSADMIN=$ORACLE_HOME/network/admin
export OGG_HOME=/u01/goldengate/ogg21c_ma
cd $OGG_HOME/bin

Run the oggca.sh file under bin to start the deployment process of OGG Microservice:

[oracle@orclprd bin]$ pwd
/u01/goldengate/ogg21c_ma/bin

[oracle@orclprd bin]$ ls -lrt oggca.sh
-rwxr-x---. 1 oracle oinstall 10362 Dec 16  2020 oggca.sh
[oracle@orclprd bin]$ ./oggca.sh

Choose the “Create New Service Manager” for the first time and provide the Deployment Home location.

Checked the Register Service Manager otherwise have to register manually.

Listening Port will use for Service Manager Connection.

For 1st Installation the only option to Add new GoldenGate deployment.

Provide the Deployment Name. Software Home will be the MA Home location.

Provide the Deployment Home Location. If you want to customize directories then Checked it and provide the path for each configuration:

Provide the OGG_HOME and TNS_ADMIN Path:

Provide the Administrator account details:

If the replication is part of very sensitive data, then use the Wallet or Certification.

My case this Test Env so I am not using the SSL or TLS Security option.

Provide the port for each service.

Provide Schema name to add it in the GLOBALS file:

Run the script from root user:

[root@orclprd ~]# cd /u01/goldengate/ogg21c_sm/bin/
[root@orclprd bin]# ./registerServiceManager.sh
Copyright (c) 2017, 2020, Oracle and/or its affiliates. All rights reserved.
----------------------------------------------------
     Oracle GoldenGate Install As Service Script
----------------------------------------------------
OGG_HOME=/u01/goldengate/ogg21c_ma
OGG_CONF_HOME=/u01/goldengate/ogg21c_sm/etc/conf
OGG_VAR_HOME=/u01/goldengate/ogg21c_sm/var
OGG_USER=oracle
Running OracleGoldenGateInstall.sh...
Created symlink from /etc/systemd/system/multi-user.target.wants/OracleGoldenGate.service to /etc/systemd/system/OracleGoldenGate.service.

Note: As registered the Service Manager as daemon during installation, it will be started automatically.

Status of the Service Manager:

[oracle@orclprd bin]$ ps -ef|grep ServiceManager
oracle    9464     1  0 23:03 ?        00:00:00 /u01/goldengate/ogg21c_ma/bin/ServiceManager --inventory '/u01/goldengate/ogg21c_sm/etc/conf'

Check the status of the others services:

[oracle@orclprd bin]$ ps -ef|grep /u01/goldengate/ogg21c_ma
oracle    8968     1  0 23:00 ?        00:00:01 /u01/goldengate/ogg21c_ma/bin/adminsrvr --config /u01/goldengate/ogg21c_sm/var/temp/OGG21c-adminsrvr-config.dat --force --quiet
oracle    8971     1  0 23:00 ?        00:00:00 /u01/goldengate/ogg21c_ma/bin/distsrvr --config /u01/goldengate/ogg21c_sm/var/temp/OGG21c-distsrvr-config.dat --force --quiet
oracle    8975     1  0 23:00 ?        00:00:01 /u01/goldengate/ogg21c_ma/bin/recvsrvr --config /u01/goldengate/ogg21c_sm/var/temp/OGG21c-recvsrvr-config.dat --force --quiet
oracle    9012     1  0 23:00 ?        00:00:05 /u01/goldengate/ogg21c_ma/bin/pmsrvr --config /u01/goldengate/ogg21c_sm/var/temp/OGG21c-pmsrvr-config.dat --force --quiet
oracle    9464     1  0 23:03 ?        00:00:00 /u01/goldengate/ogg21c_ma/bin/ServiceManager --inventory '/u01/goldengate/ogg21c_sm/etc/conf'

Administration Service: We create Extract and Replicat processes on Administration Service.

Login to the Administration Server: From Service Manager Page (on above) click on port number link to redirect the Administration Server Link.