Working with Deployments

3 Working with Deployments

Once you log into your Service Manager instance, you can create deployments or edit existing ones. You can work with multiple deployments from a single Service Manager instance.

After you have completed the Oracle GoldenGate Microservices installation, you need to create a deployment (secure or non-secure) using the Oracle GoldenGate Configuration Assistant (OGGCA). You can use this wizard to add multiple deployments to one Service Manager.

Oracle recommends the usage of a secure configuration within Oracle GoldenGate Microservices. There are two options for setting up a secure Microservices deployment:

Run Microservices on loopback address and front it with an HTTPS reverse proxy (nginx). See Reverse Proxy Support.
- Interoperability between Oracle GoldenGate Classic andOracle GoldenGate Microservices is configured through the ogg protocol using data pump Extract from Oracle GoldenGate Classic with SOCKSPROXY.
Run Oracle GoldenGate Microservices with TLS version 1.2 enabled on all services.

Topics:

How to Connect to a Service Manager
The Service Manager is the primary watchdog service within Oracle GoldenGate Microservices that enables controlling the deployments and associated services running on the host machine.
How to Start and Stop Service Manager and Deployments
The Service Manager is the central hub from where you can start and stop deployments and other microservices such as Administration Server, Distribution Server, Performance Metrics Server, and Receiver Server.
How to Remove a Deployment
You can remove a deployment using OGGCA or in silent mode.
View and Edit Services Configuration
The services configuration and restart options for Administration Server, Distribution Server, Performance Metrics Server, and Receiver Server can be viewed and edited from the Services Manager.

3.1 How to Connect to a Service Manager

The Service Manager is the primary watchdog service within Oracle GoldenGate Microservices that enables controlling the deployments and associated services running on the host machine.

The ServiceManager can be configured in three different modes:

Manually
As a Daemon
Integrated with XAG agent

Note:

If the Service Manager is registered as a system daemon, then the Service Manager, Administration Server (AS), Distribution Server (DS), Receiver Server (RS), and the Performance Metrics Server are automatically started when the host is (re)started.

To start using your Oracle GoldenGate Microservices deployment, you have to connect to the Service Manager:

Note:

When you log into the Service Manager for the first time, it is recommended to change the password.

Open a web browser and connect to the Service Manager that you created with Oracle GoldenGate Configuration Assistant. The URL is similar to http://localhost:9001, where 9001 is the port where you have deployed your Service Manager instance. For a secure deployment, the URL is similar to https://localhost:9001.
Enter the user name and password you created during deployment and sign in.

In the Service Manager, you can check if the Service Manager and all the other servers are all up and running. Use the links to connect you to their specific interfaces, review details, and administer your deployments.

For more information on setting up the Service Manager as a daemon service, see How to Create Secure and Non-Secure Deployments.

Quick Tour of the Service Manager
When you complete the Oracle GoldenGate Microservices installation, the Service Manager opens up at the specified URL. This page acts as an access point for performing deployment, configuring the Administration Server, Distribution Server, Receiver Server, Performance Metrics Server, and the Admin Client.
How to Start and Stop the Service Manager
The start and stop process of the Service Manager within Oracle GoldenGate Microservices is different based on how the Service Manager is configured within your environment.
How to Change Deployment Details and Configuration
How to Interpret the Log Information
How to Enable and Use Debug Logging

Parent topic: Working with Deployments

3.1.1 Quick Tour of the Service Manager

When you complete the Oracle GoldenGate Microservices installation, the Service Manager opens up at the specified URL. This page acts as an access point for performing deployment, configuring the Administration Server, Distribution Server, Receiver Server, Performance Metrics Server, and the Admin Client.

The Service Manager home page is a dashboard where you can see the services that have been deployed and access inventory and configuration information pertaining to your deployments. You can also view the status of your deployments, and start and stop services.

Now, that you have an overview of the Service Manager, let’s go through some of the actions you can perform using the Service Manager home page.

Action	Task
View the service status	Review Status Changes
Start and stop deployments	Starting and Stopping Deployments and Services
Access various servers	You can click the respective links to access the following: Administration Server to add, modify, and delete Extracts and Replicats. Distribution Server to add, modify, and delete Paths Performance Metrics Server to Review Messages and Review Status Changes Receiver Server to view details of the path, including path network statistics and file I/O statistics.
Access details for Administration Server, Distribution Server, Performance Metrics Server, and Receiver Server	Click Details for the server for which you need to see the details. See View and Edit Services Configuration.
Application Navigation pane	Click the icon to expand and access the Service Manager or the Diagnosis home pages.

Parent topic: How to Connect to a Service Manager

3.1.2 How to Start and Stop the Service Manager

The start and stop process of the Service Manager within Oracle GoldenGate Microservices is different based on how the Service Manager is configured within your environment.

The following provide context on how the start and stop processes can be done for the Service Manager:

If the Service Manager is configured in manual mode then there are scripts in the $DEPLOYMENT_BASE/ServiceManager/bin directory that can be run to start or stop the Service Manager.
Run the scripts to start or stop the Service Manager from the following locations:
- To start the Service Manager: OGG_Deployment_Home/bin/startSM.sh
- To stop the Service Manager: OGG_Deployment_Home/bin/stopSM.sh
If the Service Manager is configured as a daemon, the scripts required to start or stop for manual interaction are not created. The operating system is responsible for starting or stopping the Service Manager.

For OEL 6:

stop/start/status for Service Manager

/etc/init.d/OracleGoldenGate start

/etc/init.d/OracleGoldenGate stop

/etc/init.d/OracleGoldenGate status

For OEL 7:

systemctl start OracleGoldenGate

systemctl status OracleGoldenGate

systemctl stop OracleGoldenGate
If the Service Manager is configured to run with the XAG agent in an Oracle Cluster Ready Service (CRS); then the start and stop process is handled by the CRS stack.

Parent topic: How to Connect to a Service Manager

3.1.3 How to Change Deployment Details and Configuration

You can review and change the selected service (server) configuration.

Details Tab

Use to review the selected deployment configuration. All the deployment directories that you configured with the Configuration Assistant are displayed. For Oracle database, the only directory that you can edit is the Oracle GoldenGate home (OGG_HOME). This allows you to use a different installation than the one you originally configured.

Configuration Tab

Use to review and change the selected deployment environment variables. The environment variables that you configured for your deployment are displayed. You can add new variables, modify existing variables, and delete selected variables.

When using Oracle GoldenGate Microservices on an AIX operating with Oracle database RU11 and higher, the AIXTHREAD_STK value needs to be set to atleast 1048576 (1 MB). You can set the AIXTHREAD_STK value from this tab, as follows:

Add an environment variable for AIXTHREAD_STK for the deployment.

Restart the deployment.

Check the Extract report file to these updates.

The Extract thread IXAsyncTrans is set to a minimum size of 2M.

The default stack size on AIX is 196,608 bytes for 64-bit applications.

Certificates

Use this tab to manage certificates for client and CA certificates.

Parent topic: How to Connect to a Service Manager

3.1.4 How to Interpret the Log Information

You can review all of the messages logged for your Service Manager with this page.

Using the Table

An updated log of Extract and Replicat server messages is displayed. You can sort the list by date or severity by clicking on the adjacent arrow. Also, you can refresh this log and choose how many pages you want to view.

To search, you select Date, Severity, or Message, and then select the appropriate options to construct your search.

Notice the Notifications tab at the bottom of the page. It displays server messages, which are not updated in the log due to transaction errors. For example, failure to log in to the database using the database credentials.

Parent topic: How to Connect to a Service Manager

3.1.5 How to Enable and Use Debug Logging

You can enable debug logging and download debug log files from this page.

Enabling Debug Logging:

To enable debug logging:

Click the Debug Log option from the Navigation Pane of the Service Manager page.
Click the Enable Debug Log option to start logging debug information.

Using the Debug Log

You can use the access and use the debug log file from this page:

Click the Download Log File option to save a local copy of the debug log
Click the Load Debug Log File option to view the debug log on this page.
Search for specific entries in the debug log using the Search By box, if required. You can click Refresh to get the latest log information, if it doesn't get refreshed automatically.

Parent topic: How to Connect to a Service Manager

3.2 How to Start and Stop Service Manager and Deployments

The Service Manager is the central hub from where you can start and stop deployments and other microservices such as Administration Server, Distribution Server, Performance Metrics Server, and Receiver Server.

To start and stop servers you need security admin privileges. In some cases, you may choose to only have incoming trail sources and thereby choose to stop or disable the Distribution Server. In a DMZ setup, you may choose to disable Administation Server.

Using Service Manager Start or Stop a Deployment

Note:

If Oracle GoldenGate Service Manager is registered as a system daemon, then the Service Manager along with the other servers, are automatically started when the host is (re)started.

Parent topic: Working with Deployments

3.2.1 Using Scripts to Start and Stop a Deployment

The Service Manager deployment include startup and shutdown scripts (startSM.sh and stopSM.sh) for starting and stopping the deployment locally from the command line.

Here are the steps to access and run the scripts:

Ensure that your environment variables, mainly the ETC_HOME and the VAR_HOME, are set up correctly. See How to Add Secure or Non-Secure Deployments for environment variable setup.
Navigate to DEPLOYMENT_HOME/bin directory for the Service Manager.

Note:
If you selected to run the Service Manager as a system daemon, then these script files will not be in this location. Instead, the bin directory would contain the file, oggInst.loc, which is used to register the Service Manager as a daemon.
Run the following command to stop the Service Manager:
```
./stopSM.sh
```
Run the folloiwng command, to start or restart the Service Manager:
```
./startSM.sh
```

3.3 How to Remove a Deployment

You can remove a deployment using OGGCA or in silent mode.

Topics:

How to Remove a Deployment: GUI
You can remove a deployment using the Oracle GoldenGate Configuration Assistnat wizard.
How to Remove a Deployment: Silent Mode
You can remove a deployment silently using the Oracle GoldenGate Configuration Assistant (oggca) from the Oracle GoldenGate Home bin directory.

Parent topic: Working with Deployments

3.3.1 How to Remove a Deployment: GUI

You can remove a deployment using the Oracle GoldenGate Configuration Assistnat wizard.

To remove a deployment:

Note:

When you remove a deployment or uninstall Oracle GoldenGate Microservices, the system does not automatically stop processes. As a result, you may have to stop processes associated with the deployment and you must clean files manually.

Run the Oracle GoldenGate Configuration Assistant wizard:

$OGG_HOME/bin
Select Existing Service Manager from the Select Service Manager Options screen. Click Next
Select Remove Existing Oracle GoldenGate Deployment from the Configuration Options screen.
Select the deployment you need to remove from the Deployment Name list box. Also select the Delete Deployment Files from Disk check box if you want to remove all the deployment files (including configuration files) from the host.
Enter the Administration account user name and password and click Next.
See the list of settings that are deleted with the deployment and click Finish.

To remove a Service Manager:

Run Oracle GoldenGate Configuration Assistant wizard:

$OGG_HOME/bin
Select Existing Service Manager from the Select Service Manager Options screen. Click Next.
If there are no other deployments to remove, then the option to remove the Service Manager is available in the drop down. Select Remove Service Manager Deployment from the Configuration Options screen.
Click Finish.

Files to be Removed Manually After Removing Deployment

It’s mandatory to delete some files manually only in case there's a Service Manager registered but you have to unregister it and register a new one. To remove files manually, you must have root or sudo privileges. The files to be deleted include:

Operating System	Files to be Removed Manually to Unregister an Existing Service Manager
Linux 6	`/etc/init.d/OracleGoldenGate` `/etc/rc.d/OracleGoldenGate` `/etc/rc.d/*OracleGoldenGate` `/etc/oggInst.loc`
Linux 7	`/etc/systemd/system/OracleGoldenGate.service`

The following commands are executed to stop the Service Manager:

systemctl stop OracleGoldenGate 
systemctl disable OracleGoldenGate *

Note:

If the Service Manager is not registered as a service (with or without the integration with XAG), OGGCA stops the Service Manager deployment, otherwise, a script called unregisterServiceManager is created, and when executed by the user, it runs the systemctl commands and deletes the mentioned files.

Parent topic: How to Remove a Deployment

3.3.2 How to Remove a Deployment: Silent Mode

You can remove a deployment silently using the Oracle GoldenGate Configuration Assistant (oggca) from the Oracle GoldenGate Home bin directory.

By removing a deployment, you can delete various components of the deployment, including, Extracts, Replicats, paths, and configuration files. However, the Service Manager is not deleted.

To remove a deployment silently:

Ensure that you have a deployment response file. To get the deployment response file, run the OGGCA and the save the response file.

Update the following lines within the deployment response file:

CONFIGURATION_OPTION=REMOVE
ADMINISTRATOR_PASSWORD=********
CREATE_NEW_SERVICEMANAGER=false

Run the OGGCA program from the following location using the

-silent

and -responseFile options. Providing the exact path to the deployment response is needed.

$OGG_HOME/bin/oggca.sh -silent -responseFile
path_to_response_file/response_file.rsp

Example:

$OGG_HOME/bin/oggca.sh -silent -responseFile
        /home/oracle/software/ogg_deployment.rsp

Parent topic: How to Remove a Deployment

3.4 View and Edit Services Configuration

The services configuration and restart options for Administration Server, Distribution Server, Performance Metrics Server, and Receiver Server can be viewed and edited from the Services Manager.

You can access the services configuration for each of the servers, from the Service Manager home page. Click the Details button for the server that you need to check the service configuration for. The Service Configuration page is displayed. This page allows you to view and edit the service configuration and the restart options for the corresponding server. The configuration and restart options for all the servers are the same.

The following table explains the Service Configuration and Restart Options on the Services Configuration page.

Service Configuration Options

Description

Port

Port Number for the corresponding server

Enable Legacy Protocol

Enables legacy communication for services that are compatible.

Enabled Async Operation

Enables asynchronous RESTful API method execution

Default Sync Wait

The default time a service will wait before responding with an asynchronous REST API response

Enabled Task Manager

Enable task management for services that provide it.

U-Mask

File mode creation mask

Quiet

Starts the service in quiet mode.

Enabled

Indicates that the service is managed by Service Manager.

Status

Indicates that the service is running.

Restart Options

Description

Enabled

If set to true, then it restart a task if it gets terminated.

On Success

If set to false, then the task is only restarted if it fails.

Delay

The time (in minutes) to pause between discovering that a process is terminated abruptly and restarting it.

Retries

The maximum number of trials to restart the service, before aborting the retry effort.

Window

The time interval in which the retries are counted. The default is 120 minutes.

Disable on Failure

If set to true, the task is disabled after it fails all execution attempts in an execution window.

Parent topic: Working with Deployments