Access Points for Oracle GoldenGate Microservices
Oracle GoldenGate microservices are accessible from a variety of clients or service interfaces. You can use these service interfaces to connect or log in to the microservices and set up data replication tasks, manage and monitor processes using statistical data, tune performance, configure security options, and many other associated tasks.
The Oracle GoldenGate Microservices Architecture is bundled with the following service interfaces:
- Admin Client: Provides access to microservices from the command line.
- Browser-based user interface for a GUI-based experience
- REST API service endpoints
The following diagram shows a variety of clients (Oracle products, command line interface, browsers, and programmatic REST API interfaces) that you can use to access and manage deployments, microservices, and all other Oracle GoldenGate processes.
Microservices Architecture includes an HTML5 based web interface to administer, manage, monitor, and secure deployments. You can access this web interface with the help of URLs specific to each microservice and the Service Manager. The web interface includes the Service Manager, Administration Service, Distribution Service, Receiver Service, and the Performance Monitoring Service.
You can use these web interface access points to create and run all Extract, Replicat, and Distribution path processes. Along with this, you can set up database credentials, add users that can access the deployment after defining roles for them, and monitor the performance of processes.
See About Extract and About Replicat.
The REST API provides service endpoints to manage Oracle GoldenGate deployments and replication services. See REST API Documentation.
You can use any of these options to work with your Oracle GoldenGate Microservices Architecture setup.
Admin Client
The Admin Client is a command line utility (similar to the classic GGSCI utility). You can use it to issue the complete range of commands that configure, control, and monitor Oracle GoldenGate. See About Admin Client.
Admin Client is used to create, modify, and remove processes, instead of using the MA web user interface. The Admin Client program is located in the $OGG_HOME/bin directory, where $OGG_HOME is the Oracle GoldenGate home directory. If you need to automate the Admin Client connection with the deployment, you can use an Oracle Wallet to store the user credentials. The credentials stored must have the following characteristics:
- Single user name (account) and password
- Local to the environment where the Admin Client runs
- Available only to the currently logged user
- Managed by the Admin Client
- Referenced using a credential name
- Available for Oracle GoldenGate deployments and proxy connections.
Microservices Web Interface
The Oracle GoldenGate Microservices web interface provides GUI-based access to manage and work with microservices and Oracle GoldenGate processes. You can connect to the web interface from a web browser. See unresolvable-reference.html#GUID-56BAB521-EF7D-4219-9DCA-76E431331FDA.
From the web interface, multiple users can log into the same deployment at the same time, and each user can make changes to the environment based on their relative permissions. This means that users should ensure proper change management practices so that two users aren't trying to do things like updating the same parameter file at the same time.
An unsecure deployment uses http in the URL whereas a secure deployment uses https, where all traffic to and from the browser to the deployment is encrypted. To know more about secure and unsecure deployments, see About Deployments