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 MA installation, you must then create a new deployment using the Configuration Assistant. You can use this wizard to add multiple deployments to one Service Manager. So, you only have to upgrade the one Service Manager with new releases or patches.

Topics:

How to Connect to a Service Manager
You can select the Service Manager as a daemon service that enables you to control all other services in MA and run as a system service, while creating a deployment.
How to Start and Stop Deployments and Servers
The Service Manager is the central hub from where you can start and stop deployments, Administration Server, Distribution Server, Performance Metrics Server, Receiver Server.
How to Remove a Deployment
You can remove the deployment using the oggca program.
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

You can select the Service Manager as a daemon service that enables you to control all other services in MA and run as a system service, while creating a deployment.

Check that the Service Manager is Running

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.

You must ensure that the Service Manager is running before you connect to it. To start a Service Manager:

On a Linux platform, type:
```
cd $OGG_HOME/bin
```
Run the command:
./ServiceManager

To start using Oracle GoldenGateMA, you have to connect to Service Manager:

Open a web browser and connect to the Service Manager that you created with the 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 click Sign In.

In the Service Manager, you can see that the other services 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.

How to Start and Stop the Service Manager
Quick Tour of the Service Manager Home Page
When you complete the Oracle GoldenGate MA installation, the Service Manager Home page 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 Interpret the Log Information

Parent topic: Working with Deployments

3.1.1 How to Start and Stop the Service Manager

You can run scripts to start and stop the Service Manager in Oracle GoldenGate Microservices Architecture. Run the scripts from the following locations:

To start the Service Manager: Deployment_Home/bin/startSM.sh
To stop the Service Manager: Deployment_Home/bin/stopSM.sh

Parent topic: How to Connect to a Service Manager

3.1.2 Quick Tour of the Service Manager Home Page

When you complete the Oracle GoldenGate MA installation, the Service Manager Home page 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.3 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.2 How to Start and Stop Deployments and Servers

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

To 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.

Connect to Service Manager using the URL specified during installation. For example, let’s assume the Service Manager URL in this case is http://localhost:9001
Log in with your user name and password.
In the Deployments section of the Service Manager home page, locate the deployment that you need to start or stop.
In the Actions column, click start.
Check to see if all the services associated with the deployment have started, once your Deployment starts. The Action column automatically shows the stop option, which you can use to stop the deployment. By default, all server instances are in Running state when they are deployed.
To start or stop a service, such as the Administration Server or the Distribution server, associated with your Deployment, go to the Services section.
Identify the server (or service) that you need to start (or stop) and click start in the Actions column, the same way you did for Deployments.

Parent topic: Working with Deployments

3.3 How to Remove a Deployment

You can remove the deployment using the oggca program.

By removing a deployment, you get to delete various components of the deployment, including, extracts, replicats, paths, and configuration files. However, the Service Manager is not deleted.

To remove a deployment:

Run the oggca program from the following location: $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.

Note:
When you remove a deployment or uninstall Oracle GoldenGate MA, 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. For details, see “Files to be Removed Manually After Removing Deployment”.
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.

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`

Parent topic: Working with Deployments

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
Config Force	Forces the configuration data.
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