Getting Started with Oracle GoldenGate Microservices

Connecting to the Oracle GoldenGate Compute Node

To access the new Oracle GoldenGate deployment, log in to the compute node using the following steps. For this, you need to identify the IP address of the compute node where Oracle GoldenGate is running.

Note:

If the instance has a public IP address, you can use it to connect using SSH. If the instance only has a private IP address, then use the bastion service to start a bastion session to SSH to the instance.

To identify the IP address:

Log in to your Oracle Cloud Console.
Select Compute -> Instances.
Select the hyperlink name of the compute node. The IP Address is listed under Instance Access.
To access the compute node where Oracle GoldenGate is running, connect as the opc account using SSH. For more information on how to access a node using the opc account, see Connecting to an Instance.

A public SSH key is specified as a part of the deployment process and you can use the private key when you are connecting to the Oracle GoldenGate instance. The following example illustrates how you connect to the Oracle GoldenGate compute node:

ssh -i private-key-filename opc@public-id-address

Next you need the Administrator Password before you connect to the Service Manager.

Setting up Oracle GoldenGate Microservices for Your Database

Before you can start using Oracle GoldenGate Microservices, there are a few tasks that you must perform, depending on your database platform, to ensure that your environment is complete and ready to replicate your data.

Setting up for Oracle

The Oracle GoldenGate image on Oracle Cloud Marketplace contains the latest Oracle GoldenGate release along with Oracle Database Client software for all supported versions of the Oracle database.

For supported Oracle Database platforms for Oracle GoldenGate, see the latest certification matrix.

For more information about setting up the environment variables, such as LD_LIBRARY_PATH andTNS_ADMIN to the instant client directories, see OGGCA User Deployment in Oracle GoldenGate Microservices Documentation.

Starting the Administration Service

To start the Administration Service:

Navigate to the Service Manager login page. You can reach the Service Manager page by using the public IP address that you obtained when you performed a look up of the compute node information for the environment: https://public_ip_address
Under Services, use the Action drop-down for the Administration Service, and select Start.

Creating User Accounts

To secure your Oracle GoldenGate Microservices deployment, you should consider creating new user accounts for your Oracle GoldenGate users and assign each account to the functional role that they are expected to perform. These roles are as follows:

Security
Administrator
Operator
User

Oracle GoldenGate users only have access permissions according to their defined access levels. For more information on how Oracle GoldenGate Security Framework is used, refer to Authentication and Authorization in Oracle GoldenGate in Oracle GoldenGate Microservices Documentation.

Topics:

Creating Users in the Service Manager

After you log in to the Service Manager as Administrator, you can create users with the different roles such as Administrator, Operator, or User. Users with the Security role can administer all Microservices.

To create users in the Service Manager:

Navigate to the Service Manager log in page. You can reach the Service Manager page by using the public IP address that you obtained when you looked up the compute node information for the environment: https://public_ip_address.
Log in using the oggadmin user and the password credentials located in the /home/opc/ogg_credentials.json file.
Click the menu icon present on the top left corner to open the menu section.
Select the User Administration option from the menu.
On the Users screen, select the plus (+) icon to add a new user.
Fill in all the required fields.
Click Submit to create the new user.

Creating Users in the Administration Service

After logging in to the Oracle GoldenGate Microservices Administration Service as the Administrator, for the specified deployment, you can create a new user with the role of Administrator, Operator, or User to administer the deployment.

To create Users in the Administration Service:

Log in to the Administration Service using the Security Role User (oggadmin) credentials.
Click the menu icon present in the top left corner to open the menu.
From the menu, select the User Administration option.
From the Users screen, select the plus (+) icon, to create a new user.
Fill in the details for all the required fields and click Submit.

Note:

Passwords must be 8 to 30 characters long and contain at least 1 uppercase, 1 lowercase, 1 numeric, and 1 special character. Special characters such as ‘$’, ‘^’, or ‘?’are not allowed.

Changing Default Administrator Password

Changing passwords for critical accounts, such as oggadmin, is the first priority in securing your Oracle GoldenGate Microservices deployment. To change the password for oggadmin, you must first change it in the Service Manager and then in Administration Service.

This topic describes the following:

Changing the Administrator Password for the Service Manager

To change the Administrator password for the Service Manager:

Navigate to the Service Manager login page. You can reach the Service Manager page by using the public IP address that you obtained when you performed a look up of the compute node information for the environment.
```
https://public_ip_address
```
Log in using the oggadmin user and password credentials located in the /home/opc/ogg-credentials.json file.
Select the menu icon present on the top left corner to open the menu.
Select User Administration option from the menu.
From the Users screen, select the Pencil icon under Actions column.
Update the password for the oggadmin user and click Submit.
When the password is successfully reset, the current user is logged out.
Log in again to the Service Manager by using the new password.

Note:

Passwords must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric, and 1 special character. Special characters such as ‘$’, ‘^’, or ‘?’ are not allowed.

Changing the Administrator Password for the Administration Service

After changing the Oracle GoldenGate Microservices Service Manager security role user password, you should change the password of the security role user in the underlying deployments.

To change the Administrator password for the Administration Service:

From the Service Manager left-navigation pane, click Deployments and then select the deployment name.
Click Administration Service from the Deployments page to open the Administration Service web interface for the deployment.
Log in using the oggadmin user credentials available in the following location:
```
/home/opc/ogg_credentials.json
```
Select the menu icon present on the top left corner to open the menu.
Select User Administration option from the menu.
From the Users screen, select the Pencil icon under Actions column.
Update the essential details for password and info sections for the oggadmin user and click Submit.
When the password is successfully reset, the current user is logged out.
Log in again to the Administration Service by using the new password.

See Edit Users in Oracle GoldenGate Microservices Documentation.

Note:

Passwords must be 8 to 30 characters long and contain at least 1 uppercase, 1 lowercase, 1 numeric, and 1 special character. Special characters such as ‘$’, ‘^’, or ‘?’ are not allowed.

Changing the Default GGSCHEMA Value

By default, Oracle GoldenGate Microservices deployments on OCI Marketplace creates a default GGSCHEMA of oggadmin.

When connecting deployments to source and target databases, for some databases, such as SQL Server, Oracle GoldenGate needs to create objects in the database. These are created objects using the oggadmin schema, unless otherwise specified.

This means that in the source or target databases, that a schema called oggadmin needs to be created in advance of adding supplemental logging (TRANDATA), creating heartbeat tables, and creating checkpoint tables.

If you prefer to use a different schema instead of the default oggadmin schema, then you can manually modify the value, following the steps listed in the Creating a Parameter File in Oracle GoldenGate Microservices Documentation guide.

After you have modified the GGSCHEMA value, for these processes to recognize the new schema, you need to restart the Administration service and any existing Extracts and Replicats.