About High Availability Architecture: High Availability (HA) architecture for Oracle GoldenGate services is designed to ensure that the data replication and integration processes continue to function without interruption, even in the event of system failures or disruptions. This is achieved through a combination of redundant components, failover mechanisms, and data synchronization strategies.
AGCTL
Agent Control (AGCTL) is a command line tool used to manage bundled agents within Oracle Grid Infrastructure for keeping applications available. It helps integrate an application as a resource under agent control within this infrastructure.
After setup, AGCTL is used to manage resources like starting or stopping the resource, relocating it, checking its status, and changing agent configurations.
Requirements for Running AGCTL
AGCTL, a tool in Oracle Grid Infrastructure, can be used by the owner of the infrastructure or a designated application administrator. This administrator must be part of the same primary OS group as the owner.
Administrators can run any AGCTL command and have two options for creating application virtual IPs. They can use the 'appvipcfg' utility in the Oracle Grid Infrastructure bin directory, or the AGCTL utility. Both methods require root access.
If an application VIP is pre-created by an administrator with root privileges, the application administrator only needs to provide the '--vip_name' when using AGCTL, without needing root privileges.
Oracle Grid Infrastructure bundled agents and the AGCTL management interface can support multiple administrators for different applications. Security, execution privileges, and ownership for an application are defined using UNIX-like ACL definitions through the AGCTL management interface.
AGCTL Syntax and Use
Usage: agctl <verb> goldengate [<options>]
verbs: add|check|config|disable|enable|modify|relocate|remove|start|status|stop
For detailed help on each verb and its options use:
agctl <verb> --help or
AGCTL is the designated command for managing application resources, specifically those of type XAG. It's important to note that the Oracle Grid Infrastructure utility CRSCTL should not be used to manage these resources. However, CRSCTL can be used to check the status of resources, which is fully supported.
Version Support Matrix
The following combination of Clusterware/GoldenGate releases is supported as per the Oracle doc.
XAG Agent Functions:
Handle GoldenGate application's failover.
Start the GoldenGate instance and related dependencies.
Monitor GoldenGate instance extract, replicat & manager processes.
Stop the GoldenGate instance and related dependencies.
Move the GoldenGate instance and related dependencies.
Clean up the GoldenGate instance and related dependencies after a failure that can't be recovered.
Goldengate Instance States:
ONLINE – The GoldenGate instance is online
OFFLINE – The GoldenGate instance is offline
INTERMEDIATE – The GoldenGate manager is online, however some or all extract and replicate processes are offline or have timed out when attempting to start
UNKNOWN - The state when Oracle Clusterware is unable to manage the resource and manual Oracle Clusterware intervention is required to stop it and fix the root cause. Once corrected, agctl start/stop commands should be used.
The GoldenGate instance resource will transition to states : ONLINE, OFFLINE based on the operations and state of the manager. This resource will transition to state INTERMEDIATE if any of the specified extract or replicat processes are detected not to be running.
AGCTL Command Options
AGCTL Syntax Complete AGCTL usage for the goldengate resource is exposed using agctl –h. The following are common AGCTL operations for the GoldenGate application.
AGCTL command to register and configure a GoldenGate resource for a GoldenGate instance:
agctl [add | modify] goldengate instance_name
--gg_home <GoldenGate installation directory>
--serverpool <serverpool name> | --nodes <node1,node2,...>
--instance_type <source|target|dual>
--oracle_home <path>
--db_services <associated database services>
--databases <associated database resources>
--environment_vars <name1=value1,name2=value2,...>
--monitor_extracts <ext1,ext2,ext3,...>
--monitor_replicats <rep1,rep2,rep3,...>
--network <network_number>
--ip <new VIP address>
--vip_name <VIP resource name>
--filesystems <acfs1,acfs2,...>
--attribute <name1=value1,name2=value2,...>
Where the options for AGCTL add and modify commands for GoldenGate are:
Note: When it comes to creating the application VIP, there are two scenarios to consider:
Pre-creation by Grid Admin (root): The Grid Administrator, who has root privileges, can pre-create the application VIP using the 'appvipcfg' command. Then, when running the 'agctl add' command, the GoldenGate Administrator only needs to specify the '--vip_name' parameter.
Creation with agctl (run as root): If you choose to create the application VIP using 'agctl,' you need to run the command as the root user. In this case, don't use the '--vip_name.' Instead, use the '--network,' '--ip,' and '--user' flags to set up the VIP correctly.
The following are examples of common agctl commands for GoldenGate.
This command shows the current configuration of the GoldenGate instance.
agctl config goldengate <instance_name>
Command to enable the Goldengate instance:
agctl enable goldengate <instance_name>
Note: When the resource is first registered, it is enabled by default.
Command to disable the goldengate instance:
agctl disable goldengate <instance_name>
Command to relocate the goldengate instance from one node to another:
agctl relocate goldengate instance_name [--serverpool serverpool_name | --node node_name]
Command to delete the Goldengate instance:
agctl remove goldengate instance_name [--force]
Command to check the Goldengate instance status:
agctl status goldengate instance_name [-node node_name]
Command to stop the Goldengate instance:
agctl stop goldengate instance_name