Oracle GoldenGate 23ai Operations Guide: Startup/Shutdown Procedures and Permission Settings

26ai_en

This document outlines the standard startup and shutdown procedures for Oracle GoldenGate 23ai (Microservices Architecture), as well as the necessary OS user permission settings for operation. Unlike the traditional Classic Architecture, 23ai utilizes a service hierarchy topped by the Service Manager, making the correct operation order crucial for ensuring data integrity.

1. Prerequisites: Operation User Permission Settings (Sudoers)

From the perspective of security and preventing operational errors, configure the settings so that the GoldenGate owner user (e.g., oracle) can operate OS services, rather than the root user.

Configuration Procedure

Execute the visudo command as the root user and append the following line to /etc/sudoers. This allows the oracle user to start, stop, and check the status of GoldenGate services without a password.

# Append using visudo
oracle ALL=(root) NOPASSWD: /usr/bin/systemctl start OracleGoldenGate, /usr/bin/systemctl stop OracleGoldenGate, /usr/bin/systemctl restart OracleGoldenGate, /usr/bin/systemctl status OracleGoldenGate

Adding Alias to User Profile (Recommended)

By adding the following to the ~/.bash_profile of the oracle user, operations can be simplified.

alias oggstart='sudo systemctl start OracleGoldenGate'
alias oggstop='sudo systemctl stop OracleGoldenGate'
alias oggstatus='sudo systemctl status OracleGoldenGate'

2. Startup Procedures (Startup)

Startup is performed in the order of OS Service (Service Manager) $\rightarrow$ GG Processes (Extract/Replicat).

Step 1: Start Service Manager

Start the Service Manager registered as an OS service. This will automatically start the subordinate Admin Server and Distribution Server.

[oracle@26ai-gg23ais ~]$ sudo systemctl start OracleGoldenGate

Step 2: Start Extract / Replicat Processes

Use adminclient to connect to each Deployment and start the data integration processes.

Connection Command Syntax (CONNECT)

CONNECT { url } DEPLOYMENT { deployment_name } AS { user } PASSWORD { password } [ ! ]

Notes:

  • url: The URL of the Service Manager (e.g., http://localhost:9000 or https://ogghost:9000)
  • deployment_name: The name of the destination Deployment
  • user: The connection username (usually oggadmin, etc.)
  • !: Used to skip SSL certificate verification (appended to the end)

Startup Command Syntax (START)

START { EXTRACT | REPLICAT } { group_name | * }

Notes:

  • group_name: Specifies the group name to start (e.g., EXT01).
  • * (Wildcard): Batch starts all processes of the corresponding type in the current Deployment.

2-1. Source Side Startup Example

Environment: 192.168.56.101 (Source) / Deployment: Deployment23ai

[oracle@26ai-gg23ais ~]$ /opt/oracle/goldengate/23ai/ogg_home/bin/adminclient

# Connect to Deployment
OGG (not connected) 1> connect [http://192.168.56.101:9000](http://192.168.56.101:9000) deployment Deployment23ai as oggadmin password Oracle#1234

# Check Status (Confirm STOPPED)
OGG ([http://192.168.56.101:9000](http://192.168.56.101:9000) Deployment23ai) 2> info all
Program     Status      Group       Type             Lag at Chkpt        Time Since Chkpt
ADMINSRVR   RUNNING
DISTSRVR    RUNNING
PMSRVR      RUNNING
RECVSRVR    RUNNING
EXTRACT     STOPPED     EXT01       INTEGRATED            00:00:03        6d:20:57:15

# Start Extract (Wildcard allowed)
OGG ([http://192.168.56.101:9000](http://192.168.56.101:9000) Deployment23ai) 3> start extract *
2026-01-25T14:31:02Z  INFO    OGG-00975  Extract group EXT01 starting.
2026-01-25T14:31:02Z  INFO    OGG-15426  Extract group EXT01 started.

# Confirm Startup
OGG ([http://192.168.56.101:9000](http://192.168.56.101:9000) Deployment23ai) 4> info all
Program     Status      Group       Type             Lag at Chkpt        Time Since Chkpt
ADMINSRVR   RUNNING
DISTSRVR    RUNNING
PMSRVR      RUNNING
RECVSRVR    RUNNING
EXTRACT     RUNNING     EXT01       INTEGRATED            00:00:03        6d:20:57:33

2-2. Target Side Startup Example

Environment: 192.168.56.102 (Target) / Deployment: Deployment23ai

[oracle@26ai-gg23ait ~]$ /opt/oracle/goldengate/23ai/ogg_home/bin/adminclient
Oracle GoldenGate Administration Client for Oracle
Version 23.4.1.24.05 OGGCORE_23.4.0.0.0OGGR_LINUX.X64_240529.0500_FBO

Copyright (C) 1995, 2024, Oracle and/or its affiliates. All rights reserved.

Linux, x64, 64bit (optimized) on May 29 2024 09:21:59
Operating system character set identified as UTF-8.

# Connect to Deployment
OGG (not connected) 1> connect [http://192.168.56.102:9000](http://192.168.56.102:9000) deployment Deployment23ai as oggadmin password Oracle#1234

# Check Status
OGG ([http://192.168.56.102:9000](http://192.168.56.102:9000) Deployment23ai) 2> info all
Program     Status      Group       Type             Lag at Chkpt        Time Since Chkpt

ADMINSRVR   RUNNING
DISTSRVR    RUNNING
PMSRVR      RUNNING
RECVSRVR    RUNNING
REPLICAT    STOPPED     REP01       INTEGRATED            00:00:00           00:00:28

# Start Replicat (Use Wildcard)
OGG ([http://192.168.56.102:9000](http://192.168.56.102:9000) Deployment23ai) 3> start replicat *
2026-01-25T14:35:12Z  INFO    OGG-00975  Replicat group REP01 starting.
2026-01-25T14:35:12Z  INFO    OGG-15445  Replicat group REP01 started.

# Confirm Startup
OGG ([http://192.168.56.102:9000](http://192.168.56.102:9000) Deployment23ai) 4> info all
Program     Status      Group       Type             Lag at Chkpt        Time Since Chkpt

ADMINSRVR   RUNNING
DISTSRVR    RUNNING
PMSRVR      RUNNING
RECVSRVR    RUNNING
REPLICAT    RUNNING     REP01       INTEGRATED            00:00:00           00:00:00

OGG ([http://192.168.56.102:9000](http://192.168.56.102:9000) Deployment23ai) 5>

3. Shutdown Procedures (Shutdown)

To maintain data integrity, stop in the reverse order of startup: GG Processes (Extract/Replicat) $\rightarrow$ OS Service (Service Manager).

Step 1: Stop Extract / Replicat Processes

Perform a Graceful Stop using adminclient.

Command Syntax

STOP { EXTRACT | REPLICAT } { group_name | * } [ ! ]

Notes:

  • !: Forced stop option. Use this when the process is unresponsive or hung (e.g., stop extract EXT01 !).
  • Caution: Using ! may cause the transaction to roll back, so do not use it during normal operations; use it only when issues like timeouts occur.

Shutdown Execution Example

# After connecting to adminclient

# Individual Stop of Extract (Source Side)
OGG > stop extract EXT01

# Batch Stop of Extract (Source Side - Using Wildcard)
OGG > stop extract *

# Individual Stop of Replicat (Target Side)
OGG > stop replicat REP01

# Batch Stop of Replicat (Target Side - Using Wildcard)
OGG > stop replicat *

Step 2: Stop Service Manager

After confirming that all processes are STOPPED, stop the OS service.

[oracle@26ai-gg23ais ~]$ sudo systemctl stop OracleGoldenGate

4. Troubleshooting Tips

  • Admin Client Connection Error:
    • Check if the Service Manager is running using sudo systemctl status OracleGoldenGate.
    • Since 23ai may use a reverse proxy like Nginx, check the Nginx status as well.
  • Process does not start:
    • Check the latest error logs with the view report <process_name> command.
    • When using start extract * or start replicat *, it is recommended to check with info all beforehand to ensure no specific processes are stopped for maintenance.

5. FAQ (Frequently Asked Questions)

Q. Does GoldenGate start automatically upon OS reboot? A. If systemctl enable OracleGoldenGate is configured, the Service Manager starts automatically upon OS boot. Furthermore, Extract/Replicat processes within the Deployment will also start automatically if the Auto Start property is enabled.

Q. I do not want to hardcode the connection password in the script. A. You can conceal the password by using an Oracle Wallet. Create an Alias in advance and connect using the format connect https://... deployment ... as <alias>.

Q. The status became ABENDED in info all. A. The process terminated abnormally. Check the latest errors with view report <process_name>. You must eliminate the cause (DB shutdown, network disconnection, trail file corruption, etc.) before attempting to restart.

Q. Can I use the ggsci command? A. In Microservices Architecture (MA), adminclient is the successor CLI to ggsci. Since ggsci is a command for the Classic Architecture, it is generally not used (or its functionality is restricted) in 23ai environments.

6. Summary

The three most important points in the operation of GoldenGate 23ai are as follows:

  1. Adhere to Startup Order: Always start in the order of Service Manager (OS Layer) $\rightarrow$ Deployment (Middleware Layer) $\rightarrow$ Processes (App Layer). Shutdown is in the reverse order.
  2. Proper Permission Management: Minimize root tasks and utilize sudoers to build an environment where routine operations are completed solely by the oracle user.
  3. Utilize adminclient: Getting used to CLI operations with adminclient, rather than just the WebUI, makes it easier to keep operation records (logs) and facilitates automation through scripting.

By adhering to the procedures in this guide, you can ensure the stable operation of your data integration infrastructure.

[reference]
Start and Stop the Service Manager

コメント

Copied title and URL