What are the Key Microservices Architecture Directories and Variables?

The Microservices Architecture is designed with a simplified installation and deployment directory structure.

This directory structure is based on the Linux Foundation Filesystem Hierarchy Standard. Additional flexibility has been added to allow parts of the deployment subdirectories to be placed at other locations in the file system or on other devices, including shared network devices. The design comprises a read-only Oracle GoldenGate home directory where Oracle GoldenGate Microservices Architecture is installed and custom deployment specific directories are created as follows:

bin
cfgtoollogs
deinstall
diagnostics
include
install
inventory
jdk
jlib
lib
- instantclient
- sql
- utl
OPatch
oraInst.loc
oui
srvm

The following figure shows the files and directories under the Services Manager (srvm) directory:

Description of ggcon_dt_003a_dirstruc.png follows

Description of the illustration ggcon_dt_003a_dirstruc.png

The following table describes the key MA directories and the variables that are used when referring to those directories during an Oracle GoldenGate installation. When you see these variables in an example or procedure, replace the variable with the full path to the corresponding directory path in your enterprise topology.

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`

You can change the default location of all of these to customize where you want to store these files.

In a configuration where the OGG_VAR_HOME is a local directory and the OGG_HOME is a shared read-only remote directory, many deployments with local OGG_VAR_HOME can share one read-only shared OGG_HOME.

This directory design facilitates a simple manual upgrade. To upgrade, you stop the services and then set the OGG_HOME in the web interface (or via a REST command) and then restart the processes. On restart, Oracle GoldenGate picks up the updated environment variables. You simply switch a deployment to use a new Oracle GoldenGate release by changing the OGG_HOME directory path in the Service Manager to a new Oracle GoldenGate home directory, which completes the upgrade. Restart the microservices, Extract and Replicat processes.

The following table describes the programs and utilities exclusive to the MA. You should also set the $OGG_HOME/lib/instantclient (among other libraries that are used for the database connectivity)

Name	Description	Default Directory
`adminclient`	The Admin Client is a standalone command line interface used to create processes, rather than using the MA UI.	`$OGG_HOME/bin`
`adminsrvr`	The Administration Service supervises, administers, manages, and monitors processes operating within an Oracle GoldenGate deployment for both active and inactive processes.	`$OGG_HOME/bin`
`distsrvr`	A Distribution Service is a service that functions as a networked data distribution agent in support of conveying and processing data and commands in a distributed deployment.	`$OGG_HOME/bin`
`extract`	Extract data process.	`$OGG_HOME/bin`
`oggca.sh`	The MA Configuration Assistant.	`$OGG_HOME/bin`
`orapki`	Utility to manage public key infrastructure elements, such as wallets and certificate revocation lists,	`$OGG_HOME/bin`
`pmsrvr`	The Performance Metrics Server uses the metrics service to collect and store instance deployment performance results.	`$OGG_HOME/bin`
`recvsrvr`	A Receiver Service is the central control service that handles all incoming trail files.	`$OGG_HOME/bin`
`replicat`	Replicat data process.	`$OGG_HOME/bin`
`ServiceManager`	A Service Manager acts as a watchdog for other services available with the MA.	`$OGG_HOME/bin`
`crypto`		`$OGG_HOME/lib`
`htdocs`	The MA HTML pages for all services.	`$OGG_HOME/lib`
`info`	The various help files that support the MA HTML pages for all services.	`$OGG_HOME/lib`
`sql`	An SQL directory that contains the `healthcheck`, `legacy`, and `sharding` utilities.	`$OGG_HOME/lib`
`SQLPLUS`	The utility to run various commands.	`$OGG_HOME/lib`
`utl`	A utility directory that contains the `install`, `logging`, `reverseproxy`, and `sharding` utilities.	`$OGG_HOME/lib`