This chapter walks you through the process of installing and configuring Oracle GoldenGate Monitor Agent for all non-z/OS platforms (if you are installing Oracle GoldenGate Monitor Agent on a z/OS platform, see Chapter 3, "Installing and Configuring Oracle GoldenGate Monitor Agent for z/OS and DB2 for i").
This chapter contains the following sections:
Use the Oracle Universal Installer (OUI) to install Oracle GoldenGate Monitor Agent for all non-z/OS platforms. Perform the following steps:
To start the installation program:
Log in to the target system.
Go to the directory where you downloaded the installation program.
Launch the installation program by invoking java -jar
from the JDK directory on your system, as shown in the following table:
For this O/S... | Use this command.. |
---|---|
Unix |
$ java -jar -Xmx1024m /path/to/jar/file/ogg_generic.jar |
Windows |
C:\ java -jar -Xmx1024m ogg_generic.jar |
When the installation program appears, you are ready to begin the installation. See Section 2.1.2, "Install the Product" for a description of each installation program screen.
To install the product, navigate through the Installer screens, providing the necessary information as described on the following table. This table lists the screens in the order they will appear and provides instructions for completing any necessary fields. If you want further information on any screen, click its name in the left-hand column.
Screen | Description | Installation Action |
---|---|---|
Welcome | This screen introduces you to the product installer. | Click Next. |
Installation Location | On this screen, specify the location of your Oracle home directory. |
|
Installation Type | On this screen, specify the type of installation you want to perform and thus, which products and features are installed. |
|
Prerequisite Checks | This screen analyzes the host computer to ensure that specific operating system prerequisites have been met. | Click Next. |
Installation Summary | This screen contains a list of the feature sets you selected for installation, along with the approximate amount of disk space to be used by the feature sets once installation is complete.
Note: To display an individual component's approximate installed size, click its name. |
Click Install. |
Installation Progress | This screen shows the progress of the installation. When the progress bar reaches 100%, the installation is complete. Be aware that the Generating Libraries process can take up to 70% of the total installation time on some systems. | When the installation progress is 100%, click Next. |
Installation Complete | This screen appears at the conclusion of the installation and provides a summary of the products and features that were installed. | Click Finish o dismiss the installer.
With this step, OUI installs the Oracle GoldenGate Monitor Agent binaries and configuration files, along with OUI specific file set, under |
Enter the My Oracle Support link into a web browser:
Click Sign In....
Note:
If you are not already logged in, the Oracle Single Sign-On page appears. Enter your Oracle user id and password and click Sign In.The Dashboard page appears.
Click the Patches & Updates tab.
Search for Management Pack for Oracle GoldenGate patches for your operating system.
Download at least Patch 19916072.
Unzip the downloaded file.
Follow the instructions in the README.txt
file, from the patch ZIP file, to verify that the patch is needed for your system and how to install the patch.
This section describes the procedures for creating and configuring an Oracle GoldenGate Monitor Agent instance for non-z/OS platforms. This process requires these six steps:
Note:
These procedures are for non-z/OS applications. If you are installing Oracle GoldenGate Monitor Agent for the z/OS platform, see Section 3.4, "Creating and Configuring an Oracle GoldenGate Monitor Agent Instance".Go to the directory that contains the Oracle GoldenGate Monitor Agent creation script, create_ogg_agent_instance.sh
. For example:
cd OGG_AGENT_BASE_HOME
Run the script:
./create_ogg_agent_instance.sh
The system responds:
Please enter absolute path of Oracle GoldenGate home directory :
Enter the absolute path to your Oracle GoldenGate home directory. For example, /u01/ogg/replication/oggcore1
.
The system responds:
Please enter absolute path of OGG Agent instance :
Enter the directory that contains your Oracle GoldenGate Monitor Agent instance, which can be an existing directory. For example, /u01/ogg/agents/oggmon/agent1
. This directory should be different than the Oracle GoldenGate home directory to avoid overwriting your Oracle GoldenGate Monitor Agent JAR and configuration files the next time you install or patch Oracle GoldenGate.
TheOracle GoldenGate Monitor Agent instance directory can be an existing directory location. In that case, you are prompted:
OGG Agent instance directory already exists, do you want to overwrite the contents (yes | no)".
If you choose yes
, the execution of the script will continue and all the contents related to Oracle GoldenGate Monitor Agent will be overwritten on that location. If you choose no
, the execution of the script will stop.
You can create additional instances using this same process though you must ensure that you create them in unique directories. For example, you might use /u01/ogg/replication/oggcore2
and /u01/ogg/agents/oggmon/agent2
.
Oracle GoldenGate Monitor Agent operates in one of two modes, Oracle GoldenGate Monitor Server or Oracle GoldenGate Enterprise Management Plug-In. You set the configuration properties for the mode you want to operate in using the following steps:
If you are using Oracle GoldenGate Monitor Server (not Oracle GoldenGate Enterprise Management Plug-In), copy the oggmon.properties
file from the OGG_MONITORSERVER_DOMAIN
/config/monitorserver/cfg
directory to the OGG_AGENT_INST_HOME
/cfg
directory of all of your Oracle GoldenGate Monitor Agent Instances, where OGG_AGENT_INST_HOME
is the absolute path to your Oracle GoldenGate Monitor Agent Instance.
Edit the OGG_AGENT_INST_HOME
/cfg/Config.properties
file.
Review and set the properties for one of the following modes:
Oracle GoldenGate Monitor (OGGMON):
jagent.host=
Use the default or change to the complete hostname or IP of the machine where Oracle GoldenGate Monitor Agent (jagent
) is running.
jagent.jmx.port=
Use the default or change to your preferred port.
monitor.host=
Set to the hostname you set during your Oracle GoldenGate Monitor Server installation in monitor.properties
.
monitor.jmx.port=
Set to the port you set during your Oracle GoldenGate Monitor Server installation in monitor.properties
.
monitor.jmx.username=
Set to the user name you provided during your Oracle GoldenGate Monitor Agent installation
jagent.username=
Set a jagent
user name.
agent.type.enabled=
Ensure it is set to OGGMON
.
jagent.backward.compatibility=
Ensure it is set to false
.
jagent.ssl=
Ensure it is set to false
.
Or
Oracle GoldenGate Enterprise Management Plug-In (OEM):
jagent.host=
Use the default or change to the complete hostname or IP of the machine where Oracle GoldenGate Monitor Agent (jagent
) is running.
jagent.username=
Set a jagent
user name.
jagent.rmi.port=
Use the default or change to a specific port.
agent.type.enabled=
Set it to OEM
.
jagent.backward.compatibility=
Ensure it is set to false
.
jagent.ssl=
Ensure it is set to false
.
Close and save the file.
The oggmon.properties
file is required to create the wallet. For instructions, see "Edit Monitor Properties" in Installing and Configuring Oracle GoldenGate Monitor Server.
Navigate to the OGG_AGENT_INST_HOME/bin
directory, and then use one of the following sections to create the Oracle Wallet for your operating mode, Oracle GoldenGate Monitor or Oracle GoldenGate Enterprise Management Plug-In.
Delete any existing dirwlt
directory.
Ensure that the oggmon.properties
file is copied into the cfg
directory.
Start creating the wallet credentials:
For this Operating System | Use this command |
---|---|
Unix |
$ ./pw_agent_util.sh -create |
Windows |
C:\ pw_agent_util.bat -create |
Enter and confirm a user password for your jagent.username
property.
Please create a password for Java Agent: Please confirm password for Java Agent:
Enter and confirm a user password for your monitor.jmx.username
property.
Please enter Monitor Server JMX password:
Please confirm Monitor Server JMX password:
The system responds:
Jan 06, 2014 5:17:22 PM oracle.security.jps.JpsStartup start INFO: Jps initializing. Jan 06, 2014 5:17:24 PM oracle.security.jps.JpsStartup start INFO: Jps started. Wallet is created successfully.
This creates the wallet cwallet.sso
and cwallet.sso.lck
files in dirwlt
in the OGG_AGENT_INST_HOME
/cfg
directory.
Start creating the wallet credentials:
For this Operating System | Use this command |
---|---|
Unix |
$ ./pw_agent_util.sh -jagentonly |
Windows |
C:\ pw_agent_util.bat -jagentonly |
Enter and confirm a user password for your jagent.username
property.
Please create a password for Java Agent: Please confirm password for Java Agent:
The system responds:
Jan 06, 2014 5:17:22 PM oracle.security.jps.JpsStartup start INFO: Jps initializing. Wallet is created successfully.
This creates the wallet cwallet.sso
and cwallet.sso.lck
files in dirwlt
in the OGG_AGENT_INST_HOME
directory.
Note:
This step is required only if the Oracle GoldenGate Monitor Agent is running in SSL mode.Go to the OGG_AGENT_INST_HOME/dircrt
and copy the Keystore and Truststore files.
After copying the keystore and truststore files, do the following:
Using the pw_agent_util.sh
(or .bat
, on Windows) utility, update the wallet with keystore and truststore passwords, as described in "Updating Oracle GoldenGate Monitor Agent Passwords" in Administering Oracle GoldenGate Monitor.
Update the jagent.keystore
and jagent.truststore
values in the config.properties
file; for example:
jagent.keystore.file=jagentKeyStore jagent.truststore.file=jagentTrustStore
Note:
If you are using a self-signed certificate, you can use the same file for both keystore file and truststore. If you are using a third-party signed certificate, you need to update your property file with the appropriate keystore and trust store files.Create a file named GLOBALS
in the OGG_HOME
directory, if this file does not exist.
Edit the GLOBALS
file.
Add ENABLEMONITORING
on a new line.
Close and save the file.
Create the datastore using the CREATE DATASTORE command:
GGSCI> CREATE DATASTORE
Note:
All processes should be stopped before creating the datastore. You can also addautostart jagent
to the mgr.prm
file.Go to the Oracle GoldenGate Core GGSCI console and start Oracle GoldenGate Monitor Agent by executing the start jagent command:
GGSCI>start jagent
Once you have completed the preceding steps and Oracle GoldenGate Monitor Agent is running, the Oracle GoldenGate Monitor Agent log details will be written to ogg_agent.log
, which is in OGG_AGENT_INST_HOME/logs
.