Add a Deployment

Follow the instructions on this page to add a deployment using the OGGCA wizard.

Before Adding a Deployment

If you need a secure deployment (recommended for production databases, or unsecured networks) make sure to check the Enable Security option in the Select Service Manager Options screen of the OGGCA wizard.

Start the OGGCA Wizard

Adding deployments is the first task in the process of setting up a data replication platform. Deployments are managed from the Service Manager.

After completing the Oracle GoldenGate Microservices Architecture installation, you can add initial and subsequent deployments using the Oracle GoldenGate Configuration Assistant (OGGCA) wizard.

You can also run OGGCA in silent mode. For steps to run OGGCA in silent mode, see Add a Deployment in Silent Mode using OGGCA.

Note:

Oracle recommends that you maintain a single Service Manager per host, to avoid redundant upgrade and maintenance tasks with Oracle GoldenGate releases.

To start the OGGCA wizard:

1. Navigate to the $OGG_HOME/bin directory to access the Oracle GoldenGate Configuration Assistant (oggca) utility.

2. On Linux, run the oggca.sh program.

   or,

   On Windows, right-click the oggca.bat program.

The Oracle GoldenGate Configuration Assistant (oggca) wizard is displayed.

The following topics provide details on the configuration that you can set on each of the OGGCA wizard screens.

Select Service Manager Options

1. Select the Create a New Service Manager option if you are running OGGCA for the first time. When you run OGGCA for the first time, the Existing Service Manager option is disabled. If it's not the first time, then you can choose the Existing Service Manager option, which would load the port and other settings as configured for the existing Service Manager. The deployment would be added to this Service Manager.

   
   
   

2. For new Service Manager deployment, configure the options as described in the following table:

   Option	Description
   Create New Service Manager	This option is preselected when you start OGGCA for the first time, and no other Service Manager instance is running.
   Software Home	Browse and select the Oracle GoldenGate software location.
   Deployment Home	For a new Service Manager deployment, browse and enter the directory that you want to use for storing the deployment directories. Oracle recommends that you create a ServiceManager directory within the deployment sub-directory structure to store the Service Manager files.
   Hostname/IP address	Enter the server details for the Oracle GoldenGate instance.
   Listening Port	Enter the port number where Service Manager would be listening to service calls.
   Register Service Manager as a system service/daemon	Select this check box to avoid manually starting and stopping it if the machine is rebooted. This ensure that Service Manager automatically starts with a server boot or restarts after a reboot of the server.
   Integrate with XAG	Select this option to integrate your deployment with an Oracle Grid Infrastructure for Oracle. This option is only applicable when using clustered environments managed by Oracle Grid Infrastructure.
   StatsD	Enable the StatsD check box to enable the recording the metrics for the Service Manager.
   StatsD Host	Enter the hostname or IP address of the StatsD server. This information would be used by the Service Manager to connect to the StatsD host.
   StatsD Port	Enter the port number for the StatsD host. The default port number is 8125.
   Enable Security	Selected by default. Specify the security options to be configured with the Service Manager. Using the security options, you can add server, client, and trusted rootCA certificates and also set the protocol options for TLS.
   TLS 1.2	Select this check box to use the TLS 1.2 protocol.
   TLS 1.3	Select this check box to use the TLS 1.3 protocol.
   Server Certificate	Browse and select the server certificate file (.pem) that you want to associate with the Service Manager.
   Server Private Key	Browse and select the server certificate private key file (.key) for the server certificate.
   Server CA Certificate	Browse and select the trusted RootCA certificate for the Service Manager.
   Enable FIPS	Enable Oracle GoldenGate services to be compliant with the Federal Information Processing Standards (FIPS).
   Configuration Service	Enable this service to store the Oracle GoldenGate configuration files on a different location such as a high available filesystem or database. Click the Configuration Service button on the Service Manager Deployment Options screen. The Configuration Service dialog appears. Select the Enable Configuration Service check box and set up the back end options. The default option is Filesystem. If you choose the Oracle Database option, you can either use the source/target database or a different database outside the replication. Here are the details you need to specify for the database: Username: The username of the database user. Password: Password for the database user credential. Connection String: The URL used to connect to the database. This is the backend connection string. The connection string can use the data source in the format: host [:port]/service_name or a TNS_ALIAS. For example: localhost:1521/cdb1_pdb1.rdbms.oracle.com is an example of hostname, port number, and service name format. Table Name: Database backend table name where the configuration files would be stored. The backend table might be in any schema. In this example, the Oracle GoldenGate Admin schema (ggadmin) is used. Example: ggadmin.ggs_backendtable. For more details on using the Configuration Service, see Configuration Service.

Service Manager Administrator Account

On this screen, enter the login credentials for the Service Manager. Make sure to enable the strong password policy for better security. The criteria for a strong password includes:

• 1 uppercase letter (A - Z)

• 1 lowercase letter (a -z)

• 1 digit (0 - 9)

• 1 special character (- ! @ % & * . # _)

• Length of the password must be between 8 and 30 characters

For details on the different types of users, see Add New Users to the Deployment.

User Deployment

Configure the deployment options from the User Deployment screen, as described in the following steps:

1. Use the following table to configure the deployment options.

   Option	Description
   Deployment Name	Specify a deployment name.
   Deployment Home	Browse and select the location of your deployment. This location must be outside the Service Manager and Oracle GoldenGate installation location.
   Customize	Click the Customize button to specify a different location for the configuration directories such as OGG_ETC_HOME, OGG_CONF_HOME, OGG_SSL_HOME, OGG_VAR_HOME, OGG_DATA_HOME, OGG_ARCHIVE_HOME, and Performance Metrics DataStore Home.
   Ports	Enter the port numbers to be used by each of the Microservices: Administration Service Distribution Service Receiver Service Performance Metrics Service.
   Data Store Type	Select the type of data store you need for storing Performance Metrics data. Options include BDB, and LMDB.
   Data Store Home	Browse and select a location for the data store home directory.
   StatsD	Enable this check box to specify the connection details of the StatsD server, which needs to be connected to the deployment. You need to specify the host name and a unique port number of the StatsD server using the options that get enabled after you select the StatsD enable checkbox.
   StatsD Host	Enter the hostname or IP address of the StatsD server. This information would be used by the Service Manager to connect to the StatsD host. The StatsD server can be located on the same host machine where Oracle GoldenGate deployment exists, or it could be a remote host.
   StatsD Port	Enter the port number for the StatsD host. The default port number is 8125.
   Server Certificates	This box is disabled as the server certificate file (.pem) is already selected while configuring the Service Manager options.
   Server Private Key	The server certificate private key file (.key) is preselected.
   Server CA Certificate	The trusted RootCA certificate is also preselected.
   Client Certificates	Browse and select the client certificate file (.pem) if required.
   Client Private Key	Browse and select the client certificate private key file (.key) for the associated client certificate.
   Client CA Certificate	Browse and select the trusted rootCA certificate that would verify the associated client certificate.
   TNS_ADMIN	(Oracle only) Enter the value for this environment variable based on the location of the tnsnames.ora and sqlnet.ora files. The TNS_ADMIN parameter specifies the directory path of Oracle Net Services in which files such as the tnsnames.ora and sqlnet.ora reside. The tnsnames.ora file is the configuration file that contains the net service names that are mapped to the connect descriptors of the database services.
   Replication Schema	Set the GGSCHEMA parameter for deployment. For more information about this setting, see GGSCHEMA in Parameters and Functions Reference for Oracle GoldenGate.
   Environment Variables	Click this button to open the Environment Variables dialog box. It includes the paths for the preset environment variables, $OGG_HOME, and $LD_LIBRARY_PATH. Some variables are fixed, others can be extended, and you can add additional variables.

   
   
   

2. Click Next to move to the User Deployment Administrator screen.

User Deployment Administrator

On this screen, you can create another local administrator user specifically for the deployment. This user can be the same the Service Manager administrator also.

If you select the Same as Service Manager administrator credentials option, then you do not need to specify a different set of login credentials for the user deployment administrator. You will be able to log in to the Administration Service and other microservices using the same login credentials that are used to log in to the Service Manager.

Deselect the Same as Service Manager administrator credentials option to create a new administrator user for the deployment, specifically. Specify the username and password for the deployment administrator and use the strong password policy to ensure security.

This user would be able to log in to the Administration Service and other microservices. However, the Service Manger administrator log in credentials would be required to log in to the Service Manger.

Summary

1. Review the detailed configuration settings of the deployment before you continue, as shown in the following image.

   
   
   

2. (Optional) You can save the configuration information to a response file. Oracle recommends that you save the response file. You can run the installer from the command line using this file as an input to duplicate the results of a successful configuration on other systems. You can edit this file or a new one from the provided template.

   Note:

   When saving to a response file, the administrator password is not saved for security reasons. You must edit the response file and enter the password if you want to reuse the response file for use on other systems.

3. Click Finish and then click Next.

Configure Deployment

This screen displays the progress of the deployment creation and configuration. There could be some notifications during the progress if the Service Manager is registered as a service.

A pop-up appears that directs you how to run the script to register the service. The Configuration Assistant verifies that these scripts have been run. If you did not run them, you are queried if you want to continue. When you click Yes, the configuration completes successfully. When you click No, a temporary failed status is set and you click Retry to run the scripts.

Click Ok after you run the script to continue.

After the creation and configuration process completes, you'll see a message that the deployment is added successfully. Click Next.

Finish

On the Finish screen, click Close to exist OGGCA.