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 MA installation, you can add initial and subsequent deployments using the Configuration Assistant (OGGCA) wizard.

Use OGGCA to add multiple deployments to a Service Manager. This allows you to upgrade the same Service Manager with new releases or patches. The source and target deployments serve as endpoints for setting up the distribution path for data replication.

1. From the OGG_HOME directory, run the $OGG_HOME/bin/oggca.sh program on UNIX or Linux.

   The Oracle GoldenGate Configuration Assistant (oggca) is started. Run this program, each time you want to add a deployment.

2. In the Select Service Manager Options step:

   1. Select whether you want to use an existing Service Manager or create a new one. In most configurations, you only have one Service Manager that is responsible for multiple deployments.

   2. For a new Service Manager, enter or browse to the directory that you want to use for your deployment. Oracle recommends that you create a ServiceManager directory within the deployment sub-directory structure to store the Service Manager files.

   3. Enter the hostname or IP Address of the server.

   4. Enter a unique port number that the Service Manager will listen on, or choose the port already in use if selecting an existing Service Manager.

   5. (Optional) You can register the Service Manager to run as a service so as to avoid manually starting and stopping it.

      You can choose to run one Service Manager as a service (daemon). If there is an existing Service Manager registered as a service and you select a new Service Manager to register as a service, an alert is displayed indicating that you cannot register the new one as a service. All other Service Managers are started and stopped using scripts installed in the bin directory of the deployment. You cannot register an existing Service Manager as a service.

3. In the Configuration Options step, you can add or remove deployments.

   You can only add or remove one deployment for one Service Manager at a time.

   Note:

   Ensure that your Service Manager is up and running prior to launching OGGCA.

4. In the Deployment Details step:

   1. Enter the deployment name using these conventions:

      • Must begin with a letter.

      • Can be a standard ASCII alphanumeric string not exceeding 32 characters.

      • Cannot include extended ASCII characters.

      • Special characters that are allowed include underscore (‘_’), hyphen (‘/’), dash (‘-’), period (‘.’). The name before the / symbol should be "slash" or "forward slash".

      • Cannot be “ServiceManager”.

   2. Enter or select the Oracle GoldenGate installation directory. If you have set the $OGG_HOME environment variable, the directory is automatically populated. Otherwise, the parent directory of the oggca.sh (Linux) or oggca.bat (Windows) script is used.

   3. Click Next.

5. On the Select Deployment Directories page:

   1. Enter or select a deployment directory where you want to store the deployment registry and configuration files. When you enter the deployment directory name, it is created if it doesn’t exist. Oracle recommends that you do not locate your deployment directory inside your $OGG_HOME and that you create a separate directory for easier upgrades. The additional fields are automatically populated based on the specified deployment directory.

      Note:

      The deployment directory name (user deployment directory) needs to be different than the directory name chosen in the first screen (Service Manager deployment directory).

   2. You can customize the deployment directories so that they are named and located differently from the default.

   3. Enter or select different directories for the various deployment elements.

   4. Click Next.

6. On the Environment Variables page:

   Enter the requested values for the environment variables. Double-click in the field to edit it. You can copy and paste values in the environment variable fields. Make sure that you tab or click outside of the field after entering each value, otherwise it’s not saved. If you have set any of these environment variables, the directory is automatically populated.

   OGG_HOME

   The directory where you installed Oracle GoldenGate. This variable is fixed and cannot be changed.

   Note:

   On a Windows platform, ensure that there's no space in the OGG_HOME directory path otherwise OGGCA will not run.

   LD_LIBRARY_PATH

   This variable is used to specify the path to search for libraries on UNIX and Linux. It may have a different name on some operating systems, such as LIBPATH on IBM AIX on POWER Systems (64-Bit), and SHLIB_PATH on HP-UX. This path points to the Oracle GoldenGate installation directory and the underlying instant client directory by default. It might be extended if USER EXITS are in use.

   You can add additional environment variables to customize your deployment or remove variables. For instance, you can enter the following variable to default to another international charset: ENV_LC_ALL=zh_CN.UTF-8

   Click Next.

7. On the Administrator Account page:

   1. Enter a user name and password that you want to use to sign in to the Oracle GoldenGate MA Service Manager and the other servers. This user is the security user for this deployment. Select the Enable strong password policy in the new deployment checkbox to ensure setting a highly secure password for your user account. The strong password policy has the following requirements:

      • At least one lowercase character [a...z]

      • At least one upposercase character [A...Z]

      • At least one digit [0...9]

      • At least one special character [- ! @ % & * . #]

      • The length should be between 8 and 30 characters.

      If you are using an existing Service Manager, you must enter the same log in credentials that were used when adding the first deployment.

   2. Select the check box that allows you to enable a strong password policy for your new deployment. If you select this option, then the password must adhere to restrictions, otherwise an error occurs, which requires you to specify a stronger password.

   3. Click Next.

8. On the Security Options page:

   1. You can choose whether or not you want to secure your deployment. Oracle recommends that you enable SSL/TLS security. If you do not want to use security for your deployment, deselect the check box.

      This operation exposes the option This non-secure deployment will be used to send trail data to a secure deployment. Select this check box if the non-secure target deployment is meant to communicate with a secure source deployment.

      However, you must enable security if configuring for Oracle GoldenGate sharding support.

   2. Also see: About Target-Initiated Paths in Step by Step Data Replication Using Oracle GoldenGate Microservices Architecture Guide.

   3. (Optional) You can specify a client wallet location so that you can send trail data to a secure deployment. This option is useful when Distribution Server from the source deployment is unsecured whereas the Receiver Server on the target deployment is secured. So, the sender may be configured for public access while the Receiver Server requires authentication and authorization, which is established using PKI before the incoming data is applied. For more information, see Creating a Self Signed Certificate and Creating a Client Certificate Certificate in Oracle GoldenGate Security Guide.

   4. For your Server, select one of the options, and then provide the required file locations. When using an existing wallet, it must have the appropriate certificates already imported into it. If you choose to use a certificate, enter the corresponding pass phrase.

      When using a self-signed certificate, a new Oracle Wallet is created in the new deployment and these certificates are imported into it. For certificates, enter the location of the private key file and the pass phrase. The private key files must be in the PKCS#8 format.

   5. For your Client, select one of the options, and then provide the required information as you did for your server.

   6. Click Next.

9. (If Security is enabled) On the Advanced Security Settings page, the TLS 1.1 and TLS 1.2 options are available. TLS 1.2 is selected by default.

   When you open the Advanced Security Settings for the first time with TLS 1.2, the following cipher suites are listed:

   TLS_RSA_WITH_AES_128_CBC_SHA256 
   TLS_RSA_WITH_AES_128_GCM_SHA256
   TLS_RSA_WITH_AES_256_CBC_SHA256 
   TLS_RSA_WITH_AES_256_GCM_SHA384
   TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 
   TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
   TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 
   TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
   TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 
   TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
   TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 
   TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
   TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 
   TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
   TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 
   TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
   TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 
   TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
   TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 
   TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
   TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 
   TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
   TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 
   TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384

   1. Use the arrows to add or remove cipher suites.

   2. Use Up and Down to reorder how the cipher suites are applied

   3. Click Next.

10. (If Sharding is enabled) On the Sharding Options page:

    1. Locate and import your Oracle GoldenGate Sharding Certificate. Enter the distinguished name from the certificate that will be used by the database sharding code to identify itself when making REST API calls to the Oracle GoldenGate MA services.

    2. Enter a unique name for the certificate.

    3. Click Next.

11. On the Port Settings page:

    1. Enter the Administration Server port number, and then when you leave the field the other port numbers are populated in ascending numbers. Optionally, you can enter unique ports for each of the servers.

    2. Select Enable Monitoring to use the Performance Metrics Server.

    3. Click inside the Performance Metrics Server port fields to populate or enter the ports you want to use. Ensure that you choose available ports for TCP.

       Select the UDP port for performance monitoring. The option to select the UDP port is displayed only with deployments on Windows and other operating systems that don't support UDS communication with Performance Metric Server.

       You can change the TCP port from the Service Manager console after the deployment is done. For more information on PMSRVR, see ENABLEMONITORING.

    4. Select the type of datastore that you want the Performance Metrics Server to use, the default Berkeley Database (BDB) data store or Open LDAP Lightning Memory-Mapped Database (LMDB). You can also designate the Performance Monitor as a Critical Service if integrating the Service Manager with XAG.

       For LMDB information, see http://www.lmdb.tech/doc/.

    5. Select the location of your datastore. BDB and LMDB are in-memory and disk-resident databases. The Performance Metrics server uses the datastore to store all performance metrics information.

    6. Click Next.

    Note:

    The oggca utility validates whether or not the port you entered is currently in use or not.

12. On the Summary page:

    1. Review the detailed configuration settings of the deployment before you continue.

    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 to the deployment.

    4. Click Next.

13. On the Configure Deployment page:

    Displays the progress of the deployment creation and configuration.

    1. If the Service Manager is being 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.

    2. Click Next.

14. On the Finish page:

    Click Close to close the Configuration Assistant.