2 Installing Oracle GoldenGate

This chapter includes the instructions for installing Oracle GoldenGate for the first time. Installing Oracle GoldenGate installs all of the components that are required to run and manage the processing (excluding any components required from other vendors, such as drivers or libraries) and it installs the Oracle GoldenGate utilities.

These instructions are for installing Oracle GoldenGate for the first time. Additionally, they are for downloading the base release of a new version of Oracle GoldenGate.

To download and install subsequent patches to the base release, go to the Patches and Updates tab of My Oracle Support at:

http://support.oracle.com

To upgrade Oracle GoldenGate from one version to another, follow the upgrade instructions at:

http://docs.oracle.com/goldengate/1212/gg-winux/docs.htm

This chapter includes the following sections:

2.1 Downloading Oracle GoldenGate

Download the appropriate Oracle Oracle GoldenGate build to each system that will be part of the Oracle Oracle GoldenGate configuration. In an Oracle RAC configuration, download to the shared disk of the cluster.

See Section 2.4, "Preparing to Install Oracle GoldenGate Within a Cluster" for more information about installing Oracle GoldenGate in a cluster.

See Section 1.2.2, "Disk Requirements" for disk-space requirements.

To Download Oracle GoldenGate

  1. Navigate to http://edelivery.oracle.com">>http://edelivery.oracle.com.

    The Oracle Software Delivery Cloud page appears.

  2. Click Sign-in/Register.

    Note:

    If you are not already logged in, the Single Sign-on page appears. Enter your Oracle ID and password and click Sign In.

    The Terms & Restrictions page appears

  3. Accept the Oracle Software Delivery Cloud Trial License Agreement and the Export Restrictions and click Continue.

    The Media Pack Search page appears.

  4. On the Media Pack Search page, do the following:

    1. Click the Select Product Pack drop-down control and, from the list, select Oracle Fusion Middleware.

    2. Click the Platform drop-down control and, from the list, select the platform on which you are installing Oracle GoldenGate.

    3. Click Go.

    The Results list expands to show all available media packs that include your search criteria.

  5. On the Results list, select the media pack you want to download and click Continue.

    The media pack's download page appears. Additional download selections may appear, such as separate builds for different databases or versions of a database. Note that this page contains the part number and size of each downloadable file.

  6. To ensure that you download the files successfully, first review the Media Pack Readme for download instructions and product information by clicking Readme.

  7. To begin the download process, click Download next to the name of the Oracle GoldenGate build that you want to download.

    A File Download dialog box appears.

  8. Select either Open with or Save File:

    To... Select...
    Install media pack immediately Open, select the desired file extraction utility, and extract the files to a designated location on your file system.
    Save the file for later installation Save and point to a designated location on your file system.

2.2 Setting ORACLE_HOME and ORACLE_SID

Make certain that the ORACLE_HOME and ORACLE_SID system environment variables are set to the correct Oracle instance. The Oracle GoldenGate processes refer to them when connecting to the database.

Section 2.2.1, "Specifying Oracle Variables on UNIX and Linux Systems"

Section 2.2.2, "Specifying Oracle Variables on Windows Systems"

2.2.1 Specifying Oracle Variables on UNIX and Linux Systems

If there is one instance of Oracle Database on the system, set the ORACLE_HOME and ORACLE_SID environment variables at the system level. If you cannot set them that way, use the following SETENV statements in the parameter file of every Extract and Replicat group that will be connecting to the instance. The SETENV parameters override the system settings and allow the Oracle GoldenGate process to set the variables at the session level when it connects to the database.

SETENV (ORACLE_HOME = "path to Oracle home location")

SETENV (ORACLE_SID = "SID")

If there are multiple Oracle instances on the system with Extract and Replicat processes connecting to them, you will need to use a SETENV statement in the parameter file of each process group. As input to the SETENV parameter, use the ORACLE_HOME and ORACLE_SID environment variables to point Oracle GoldenGate to the correct Oracle instance. For example, the following shows parameter files for two Extract groups, each capturing from a different Oracle instance.

Group 1:

EXTRACT ora9a
SETENV (ORACLE_HOME = "/home/oracle/ora/product")
SETENV (ORACLE_SID = "oraa")
USERIDALIAS tiger1
RMTHOST sysb
RMTTRAIL /home/ggs/dirdat/rt
TABLE hr.emp;
TABLE hr.salary;

Group 2:

EXTRACT orab
SETENV (ORACLE_HOME = "/home/oracle/ora/product")
SETENV (ORACLE_SID = "orab")
USERIDALIAS tiger1
RMTHOST sysb
RMTTRAIL /home/ggs/dirdat/st
TABLE fin.sales;
TABLE fin.cust;

2.2.2 Specifying Oracle Variables on Windows Systems

If there is one instance of Oracle on the system, the Registry settings for ORACLE_HOME and ORACLE_SID should be sufficient for Oracle GoldenGate. If those settings are incorrect in the Registry and cannot be changed, you can set an override as follows.

  1. On the Desktop or Start menu (depending on the Windows version), right-click My Computer, and then select Properties.

  2. In Properties, click the Advanced tab.

  3. Click Environment Variables.

  4. Under System Variables, click New.

  5. For Variable Name, type ORACLE_HOME.

  6. For Variable Value, type the path to the Oracle binaries.

  7. Click OK.

  8. Click New again.

  9. For Variable Name, type ORACLE_SID.

  10. For Variable Value, type the instance name.

  11. Click OK.

If there are multiple Oracle instances on the system with Extract and Replicat processes connecting to them, do the following.

  1. Use the preceding procedure (single Oracle instance on system) to set the ORACLE_HOME and ORACLE_SID system variables to the first Oracle instance.

  2. Start all of the Oracle GoldenGate processes that will connect to that instance.

  3. Repeat the procedure for the next Oracle instance, but first edit the existing ORACLE_HOME and ORACLE_SID variables to specify the new information.

  4. Start the Oracle GoldenGate processes that will connect to that instance.

  5. Repeat the edit and startup procedure for the rest of the Oracle instances.

2.3 Setting Library Paths for Dynamic Builds on UNIX

Oracle GoldenGate uses shared libraries. When you install Oracle GoldenGate on a UNIX system, the following must be true before you run GGSCI or any other Oracle GoldenGate process.

  1. Make certain that the database libraries are added to the shared-library environment variables of the system. This procedure is usually performed at database installation time. Consult your Database Administrator if you have any questions.

    When Oracle GoldenGate is running on the same server as the database, all of the following must be 64-bit:

    • Oracle library versions

    • Oracle GoldenGate version

    • Database versions

    When Oracle GoldenGate connects remotely to the database server through SQL*Net, the following are required:

    • Replicat: The Oracle client library and the Oracle GoldenGate build must have the same Oracle version, bit type (64-bit or IA64), and operating system version.

    • Extract: The Oracle client library and the Oracle GoldenGate build must have the same Oracle version, bit type (64-bit or IA64), and operating system version. In addition, both operating systems must be the same endian.

  2. If you will be running an Oracle GoldenGate program from outside the Oracle GoldenGate installation directory on a UNIX system:

    • (Optional) Add the Oracle GoldenGate installation directory to the PATH environment variable.

    • (Required) Add the Oracle GoldenGate installation directory to the shared-libraries environment variable.

    For example, given an Oracle GoldenGate installation directory of /users/ogg, the second command in the following example requires these variables to be set:

    Command Requires GG libraries in environment variable?
    $ users/ogg > ./ggsci No
    $ users > ./ogg/ggsci Yes

To Set the Variables in Korn Shell

PATH=installation_directory:$PATH
export PATH
shared_libraries_variable=absolute_path_of_installation_directory:$shared_libraries_variable
export shared_libraries_variable

To Set the Variables in Bourne Shell

export PATH=installation_directory:$PATH
export shared_libraries_variable=absolute_path_of_installation_directory:$shared_libraries_variable

To Set the Variables in C Shell

setenv PATH installation_directory:$PATH
setenv shared_libraries_variable absolute_path_of_installation_directory:$shared_libraries_variable

Where shared libraries variable is one of the variables shown in Table 2-1:

Table 2-1 UNIX/Linux Library Path Variables Per Platform

Platform Environment variable

IBM AIX

LIBPATH

HP-UX

LD_LIBRARY_PATH

Sun Solaris

LINUX

LD_LIBRARY_PATHFoot 1 


Footnote 1 In 64-bit environments with 32-bit Oracle databases, Oracle GoldenGate requires the LD_LIBRARY_PATH to include the 32-bit Oracle libraries.

The following is an example of how to set the path in Bourne shell:

export LD_LIBRARY_PATH=/ggs/11.0:$LD_LIBRARY_PATH

Note:

To view the libraries that are required by an Oracle Oracle GoldenGate process, use the ldd goldengate_process shell command before starting the process. This command also shows an error message for any that are missing.

2.4 Preparing to Install Oracle GoldenGate Within a Cluster

This topic covers the installation requirements that apply when Oracle GoldenGate will be installed in a cluster environment. Oracle GoldenGate can be used with any cluster-management solution that has the ability to automate failover. The Oracle Clusterware solution provides the advantage of being able to be used with or without an Oracle RAC database, which enables you to include any non-database servers that are running Oracle GoldenGate.

2.4.1 Supported Oracle Cluster Storage

You will need to install at least some Oracle GoldenGate objects on shared storage. Select cluster-aware shared storage that is independent of, but available to, all nodes of the cluster. You can use any of the following:

2.4.2 Deciding Where to Install Oracle GoldenGate Binaries and Files in the Cluster

The best practice is to install Oracle GoldenGate entirely on shared storage. This allows you to start the Oracle GoldenGate processes from any of the nodes without having to make changes to the parameter files. If the active node fails, the processes can be started quickly on another node, using the processing checkpoints that are preserved in the installation directory.

If you decide to install the Oracle GoldenGate binaries and files on each node, rather than on shared storage, the following must be true:

  • The Oracle GoldenGate installation must have the same location path on every node.

  • At minimum, install the following directories on the shared storage to support Oracle GoldenGate recovery requirements. On UNIX or Linux, you can create symbolic links to them from the installation directory on each node.

    • br

    • dirchk

    • dirdat

    These directories are among those created when you issue CREATE SUBDIRS during installation.

  • The parameter files in the dirprm directory, if not placed on the shared drive, must be identical on all nodes. To resolve environment settings that must be different from one node to the other, you can set environment settings so they are inherited from the local Manager process or reference a node-specific Oracle GoldenGate macro file. Because this scenario can be difficult to enforce, the inherent concerns can be avoided by storing the parameter files on the shared drive.

See Section 2.6, "Integrating Oracle GoldenGate into a Cluster" after you install Oracle GoldenGate.

For more information about installing and using Oracle GoldenGate in a cluster, see http://support.oracle.com">>http://support.oracle.com. In the Knowledge tab, search for document ID 1313703.1 (Oracle GoldenGate Best Practices: Oracle GoldenGate high availability using Oracle Clusterware).

2.5 Installing Oracle GoldenGate

Oracle GoldenGate for Oracle Database is installed from the Oracle Universal Installer (OUI). The OUI is a graphic installation program that prompts you for the input required to install the Oracle GoldenGate binaries and working files, and set the correct database environment in which Oracle GoldenGate will operate.

You can use OUI on any of the Linux, UNIX, and Windows platforms that OUI supports and which Oracle GoldenGate supports.

OUI is supported for Oracle versions 11g and later. An instance of Oracle GoldenGate can be installed for only one Oracle version in any given Oracle home. You can install multiple instances of Oracle GoldenGate for the same or different database versions on the same host.

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, provided the product was installed using OUI.

2.5.1 Performing an Interactive Installation with OUI

The interactive installation provides a graphical user interface that prompts for the required installation information. These instructions apply to new installations as well as upgrades. However, to perform an upgrade to Oracle GoldenGate, follow the instructions in Upgrading Oracle GoldenGate for Windows and UNIX, which include a prompt to run OUI at the appropriate time.

  1. Expand the installation file.

  2. From the expanded directory, run the runInstaller program on UNIX or Linux, or run setup.exe on Windows.

  3. On the Select Installation Option page, select the Oracle GoldenGate version to install, and then click Next to continue.

  4. On the Specify Installation Details page, specify the following:

    • For Software Location, specify the Oracle GoldenGate installation directory. It can be a new or existing directory (for any Oracle GoldenGate version prior to 12.1.2.0.0) that is empty and has the amount of disk space shown on the screen or in the existing Oracle GoldenGate installation location (if you are upgrading an existing Oracle GoldenGate installation). The default location is under the installing user's home directory, but Oracle recommends changing it to a local directory that is not mounted and has no quotas. The specified directory cannot be a registered home in the Oracle central inventory. If installing in a cluster, install Oracle GoldenGate on shared storage that is accessible by all of the cluster nodes. See Section 2.4, "Preparing to Install Oracle GoldenGate Within a Cluster" for more information about installing Oracle GoldenGate in a cluster.

    • (Optional) Select Start Manager to perform configuration functions, such as creating the Oracle GoldenGate subdirectories in the installation location, setting library paths, and starting Manager on the specified port number. To proceed, a database must exist on the system. When Start Manager is selected, the Database Location and Manager Port fields are displayed.

      • For Database Location, the database version in the specified location must be Oracle Database 12c if you are installing Oracle GoldenGate for Oracle Database 12c or Oracle Database 11g if you are installing Oracle GoldenGate for Oracle Database11g. The database must have a registered home in the Oracle central inventory. The installer registers the Oracle GoldenGate home directory with the central inventory.

      • For Manager Port, accept the default port number or enter a different unreserved, unrestricted port number for the Manager process to use for interprocess communication. The default port is the first available one starting with 7809. If you are installing multiple instances of Oracle GoldenGate on the same system, each must use a different port number.

    • Click Next to continue. If this is an upgrade to an existing Oracle GoldenGate installation, OUI prompts that the selected software location has files or directories. Click Yes.

  5. The Create Inventory page is displayed if this is the first Oracle product to be installed from OUI on a host that does not have a central inventory.

    • For Inventory Directory, specify a directory for the central inventory. It can be a new directory or an existing directory that is empty and has the amount of disk space shown on the screen. The directory cannot be on a shared drive.

    • Select an operating system group in which the members have write permission to the inventory directory. This group is used to add inventory information to the Oracle GoldenGate subfolder.

  6. On the Summary page, confirm that there is enough space for the installation and that the installation selections are correct. Optionally, 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. See Section 2.5.2, "Performing a Silent Installation with OUI."

  7. 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. You are notified when the installation is finished.

  8. If you created a central inventory directory, 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).

2.5.2 Performing a Silent Installation with OUI

These instructions apply to new installations as well as upgrades. However, to perform an upgrade to Oracle GoldenGate, follow the instructions in Upgrading Oracle GoldenGate for Windows and UNIX, which include a prompt to run OUI at the appropriate time.

You can perform a silent installation from the command console if the system has no X-Windows interface or to perform an automated installation. Silent installations can ensure that multiple users in your organization use the same installation options when they install your Oracle products.

You perform a silent installation by running a response file. You can create a response file by selecting the Save Response File option during an interactive OUI session or by editing a template, as shown in Example 2-1. To run a response file, issue the following command.

-silent -nowait -responseFile path_to_file

The response files and the template are stored in the response sub-directory of the Oracle GoldenGate installation directory. 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.

Example 2-1 Oracle GoldenGate Response File Template

####################################################################
## Copyright(c) Oracle Corporation 2013. All rights reserved.     ##
##                                                                ##
## Specify values for the variables listed below to customize     ##
## your installation.                                             ##
##                                                                ##
## Each variable is associated with a comment. The comment        ##
## can help to populate the variables with the appropriate        ##
## values.                                                        ##
##                                                                ##
## IMPORTANT NOTE: This file should be secured to have read       ##
## permission only by the oracle user or an administrator who     ##
## own this installation to protect any sensitive input values.   ##
##                                                                ##
####################################################################
#-------------------------------------------------------------------------------
# Do not change the following system generated value. #-------------------------------------------------------------------------------
oracle.install.responseFileVersion=/oracle/install/rspfmt_ogginstall_response_
schema_v12_1_2################################################################################
##                                                                            ##
## Oracle GoldenGate installation option and details                          ####                                                                            ##
################################################################################
#-------------------------------------------------------------------------------
# Specify the installation option.
# Specify ORA12c for installing Oracle GoldenGate for Oracle Database 12c and
#         ORA11g for installing Oracle GoldenGate for Oracle Database 11g 
#-------------------------------------------------------------------------------
INSTALL_OPTION=

#-------------------------------------------------------------------------------
# Specify a location to install Oracle GoldenGate#-------------------------------------------------------------------------------
SOFTWARE_LOCATION=

#-------------------------------------------------------------------------------
# Specify true to start the manager after installation.
 
#-------------------------------------------------------------------------------
START_MANAGER=

#-------------------------------------------------------------------------------
# Specify a free port within the valid range for the manager process.
# Required only if START_MANAGER is true.
#-------------------------------------------------------------------------------
MANAGER_PORT=

#-------------------------------------------------------------------------------
# Specify the location of the Oracle Database.
# Required only if START_MANAGER is true.
#-------------------------------------------------------------------------------
DATABASE_LOCATION=

################################################################################
##                                                                            ##
## Specify details to Create inventory for Oracle installs                    ##
## Required only for the first Oracle product install on a system.            ##
##                                                                            ##
################################################################################

#-------------------------------------------------------------------------------
# Specify the location which holds the install inventory files.
# This is an optional parameter if installing on# Windows based Operating System.#-------------------------------------------------------------------------------INVENTORY_LOCATION=

#-------------------------------------------------------------------------------
# UNIX group to be set for the inventory directory.  # This parameter is not applicable if installing on
# Windows based Operating System.
#-------------------------------------------------------------------------------
UNIX_GROUP_NAME=

Note:

If you are upgrading an existing Oracle GoldenGate installation with the silent option, you might get the following warning:

WARNING:OUI-10030:You have specified a non-empty directory to install this product. It is recommended to specify either an empty or a non-existent directory. You may, however, choose to ignore this message if the directory contains Operating System generated files or subdirectories like lost+found.Do you want to proceed with installation in this Oracle Home?

Press ENTER to continue.

2.6 Integrating Oracle GoldenGate into a Cluster

If you installed Oracle GoldenGate in a cluster, take the following steps to integrate Oracle GoldenGate within the cluster solution.

For more information about installing and using Oracle GoldenGate in a cluster, see http://support.oracle.com">>http://support.oracle.com. In the Knowledge tab, search for document ID 1313703.1 (Oracle GoldenGate Best Practices: Oracle GoldenGate high availability using Oracle Clusterware).

2.6.1 General Requirements in a Cluster

  1. Register the Oracle GoldenGate Manager process (and only Manager) as a cluster-managed resource as you would any other application. Manager must be the only Oracle GoldenGate process that the cluster-management software starts and stops, because it is the parent process that manages all other processes.

  2. If the cluster uses a virtual IP address (such as Oracle Clusterware), you may need to obtain an available fixed IP address for the Manager process. The VIP must be an available IP address on the public subnet and cannot be determined through DHCP. In the parameter files of the Extract data pumps, specify the VIP of the remote Manager as the input value of the RMTHOST parameter. Other Oracle GoldenGate products that access Manager also should use the VIP.

  3. Make certain that all nodes in the cluster have the same COMPATIBLE parameter setting.

  4. When you configure Manager, add the AUTOSTART and AUTORESTART parameters so that Manager starts the replication processes automatically. You can, when needed, control Extract, Replicat, and other Oracle GoldenGate processes from within the Oracle GoldenGate user interfaces.

  5. Mount the shared drive on one node only. This prevents processes from being started on another node. Use the same mount point on all nodes.

  6. Configure Oracle GoldenGate as directed in this documentation.

2.6.2 Adding Oracle GoldenGate as a Windows Cluster Resource

When installing Oracle GoldenGate in a Windows cluster, follow these instructions to establish Oracle GoldenGate as a cluster resource and configure the Manager service correctly on all nodes.

  • In the cluster administrator, add the Manager process to the group that contains the database instance to which Oracle GoldenGate will connect.

  • Make sure all nodes on which Oracle GoldenGate will run are selected as possible owners of the resource.

  • Make certain the Manager Windows service has the following dependencies (can be configured from the Services control panel):

    • The database resource

    • The disk resource that contains the Oracle GoldenGate directory

    • The disk resource that contains the database transaction log files

    • The disk resource that contains the database transaction log backup files