3 Installing Oracle GoldenGate Microservices for Big Data

The Oracle GoldenGate Microservices Architecture (MA) for Big Data is installed using OUI. You can also use a command line silent installation using OUI.

This chapter describes how to install a new instance of Oracle GoldenGate Microservices for Big Data. The Installation is a three-step process:

• Install the Oracle GoldenGate MA.
• Set the necessary environment variables.
• Deploy an Oracle GoldenGate instance using the configuration assistant.

The installer registers the Oracle GoldenGate home directory 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.

Topics:

• Installing Oracle GoldenGate MA for Big Data Using the UI
  Interactive installation provides a graphical user interface that prompts for the required installation information. These instructions apply to new installations and upgrades.
• Silent Installation
  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.
• Setting Up Secure or Non-Secure Deployments
  You can choose to set up a secure or non-secure deployment.

3.1 Installing Oracle GoldenGate MA for Big Data Using the UI

Interactive installation provides a graphical user interface that prompts for the required installation information. These instructions apply to new installations and upgrades.

To install Oracle GoldenGate for Big Data using the UI:

1. Create a temporary staging directory into which you will install Oracle GoldenGate. For example, mkdir /u01/stage/oggsc.
2. Extract the installation ZIP file into the temporary staging directory. For example: unzip .ggs_Linux_x64_BigData_64bit_services.zip -d ./temp directory
3. From the expanded directory, run the ggs_Linux_x64_BigData_64bit_services/Disk1/runInstaller program on UNIX or Linux to display the Installation Wizard.
4. On the Select Installation Option page, select the Oracle Database version for your environment, then click Next.
5. If you are on Windows and running Manager as a service, set the system variable PATH to include jvm.dll, then delete the Manager service and re-add it.
6. On the Specify Installation Details page, ensure that the following environment variable is set:
   • OGG_HOME
7. Click Next to display the Summary page.
8. Confirm that there is enough space for the installation and that the installation selections are correct.
   • (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.
   • 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.
   • If you created a central inventory directory, then 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.

9. Click Close to complete the installation.

3.2 Silent Installation

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 binaries.

The Oracle GoldenGate response file contains a standard set of Oracle configuration parameters in addition to parameters that are specific to Oracle GoldenGate. These parameters correspond to the fields in the interactive session. The response file location is

unzipped_directory/ggs_Linux_x64_BigData_64bit_services/Disk1/response

To perform the installation using a response file, issue the following command:

unzipped_directory/ggs_Linux_x64_BigData_64bit_services.zip/Disk1/runInstaller -silent -nowait -responseFile absolute_path_to_response_file

3.3 Setting Up Secure or Non-Secure Deployments

You can choose to set up a secure or non-secure deployment.

A secure deployment involves making RESTful API calls and conveying trail data between the Distribution Server and Receiver Server, over SSL/TLS. You can use your own existing business cerificate from your Certificate Authority (CA) or you might create your own certificates. When first creating the SSL/TLS security certificates, you must ensure that the SSL/TLS security environment variables.

For a non-secure deployment, the RESTful API calls occur over plain-text HTTP and conveyance between Distribution Server and Receiver Server is performed using the wss, ogg, and ws protocols.

This section describes the steps to configure a non-secure deployment and prerequisites and tasks to configure a secure deployment.

• How to Add Secure or Non-Secure Deployments
  Adding deployments is the first task in the process of setting up a data replication platform. Deployments are managed from the Service Manager.
• How to Remove a Deployment
  You can remove a deployment using OGGCA or in silent mode.

3.3.1 How to Add Secure or Non-Secure Deployments

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

Note:

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

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 Microservices 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.

      Note:

      For more information on TCP/IP encryption options with RMTHOST, see RMTHOST in Reference for Oracle GoldenGate.

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. See Supported Operating Systems for UDS.

       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 BDB informtion, see Oracle Berkeley DB 12c Release 1. 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.

3.3.2 How to Remove a Deployment

You can remove a deployment using OGGCA or in silent mode.

Topics:

• How to Remove a Deployment: GUI
  You can remove a deployment using the Oracle GoldenGate Configuration Assistnat wizard.
• How to Remove a Deployment: Silent Mode
  You can remove a deployment silently using the Oracle GoldenGate Configuration Assistant (oggca) from the Oracle GoldenGate Home bin directory.

3.3.2.1 How to Remove a Deployment: GUI

You can remove a deployment using the Oracle GoldenGate Configuration Assistnat wizard.

To remove a deployment:

Note:

When you remove a deployment or uninstall Oracle GoldenGate Microservices, the system does not automatically stop processes. As a result, you may have to stop processes associated with the deployment and you must clean files manually.

1. Run the Oracle GoldenGate Configuration Assistant wizard:

   $OGG_HOME/bin

2. Select Existing Service Manager from the Select Service Manager Options screen. Click Next

3. Select Remove Existing Oracle GoldenGate Deployment from the Configuration Options screen.

4. Select the deployment you need to remove from the Deployment Name list box. Also select the Delete Deployment Files from Disk check box if you want to remove all the deployment files (including configuration files) from the host.

5. Enter the Administration account user name and password and click Next.

6. See the list of settings that are deleted with the deployment and click Finish.

To remove a Service Manager:

1. Run Oracle GoldenGate Configuration Assistant wizard:

   $OGG_HOME/bin

2. Select Existing Service Manager from the Select Service Manager Options screen. Click Next.

3. If there are no other deployments to remove, then the option to remove the Service Manager is available in the drop down. Select Remove Service Manager Deployment from the Configuration Options screen.

4. Click Finish.

Files to be Removed Manually After Removing Deployment

It’s mandatory to delete some files manually only in case there's a Service Manager registered but you have to unregister it and register a new one. To remove files manually, you must have root or sudo privileges. The files to be deleted include:

Operating System	Files to be Removed Manually to Unregister an Existing Service Manager
Linux 6	/etc/init.d/OracleGoldenGate /etc/rc.d/*OracleGoldenGate /etc/rc*.d/*OracleGoldenGate /etc/oggInst.loc
Linux 7	/etc/systemd/system/OracleGoldenGate.service

The following commands are executed to stop the Service Manager:

systemctl stop OracleGoldenGate 
systemctl disable OracleGoldenGate *

Note:

If the Service Manager is not registered as a service (with or without the integration with XAG), OGGCA stops the Service Manager deployment, otherwise, a script called unregisterServiceManager is created, and when executed by the user, it runs the systemctl commands and deletes the mentioned files.

3.3.2.2 How to Remove a Deployment: Silent Mode

You can remove a deployment silently using the Oracle GoldenGate Configuration Assistant (oggca) from the Oracle GoldenGate Home bin directory.

By removing a deployment, you can delete various components of the deployment, including, Extracts, Replicats, paths, and configuration files. However, the Service Manager is not deleted.

To remove a deployment silently:

Note:

If the Service Manager is registered as a system service, removing a deployment silently will not unregister the service.

1. Ensure that you have a deployment response file. To get the deployment response file, run the OGGCA and the save the response file.

2. Update the following lines within the deployment response file:

   CONFIGURATION_OPTION=REMOVE
   ADMINISTRATOR_PASSWORD=********
   CREATE_NEW_SERVICEMANAGER=false
   DEPLOYMENT_NAME=deployment_name
   REMOVE_DEPLOYMENT_FROM_DISK=true

   In case of multiple deployments, you must specify the deployment name using the DEPLOYMENT_NAME field. You can use the REMOVE_DEPLOYMENT_FROM_DISK option to remove physical files and folders associated with deployment.

3. Run the OGGCA program from the following location using the -silent and -responseFile options. Providing the exact path to the deployment response is needed.

   $OGG_HOME/bin/oggca.sh -silent -responseFile
   path_to_response_file/response_file.rsp

   Example:

   $OGG_HOME/bin/oggca.sh -silent -responseFile
           /home/oracle/software/ogg_deployment.rsp