Oracle GoldenGate Free Release 23ai (23.5.0.24.07) Container Image Documentation
GoldenGate Free is an easy way to create replication pipelines based on GoldenGate technology. GoldenGate lets you perform real time change data capture and high availability data management. Learn the basics as you design, run, orchestrate, and monitor data replication processes using simple building blocks, or guided recipes to get you started quickly.
Using This Image
To try out GoldenGate Free you’ll need to download and run this container from a location that has network access to the database(s) that you want to connect and replicate data with – this can be on a local machine or on cloud compute, but please ensure that the database is accessible from the location you choose to run GoldenGate Free. To make things as easy as possible there is dedicated ‘how-to’ documentation for GoldenGate Free, here are some guides to get started:
As you are using GoldenGate Free, if you need any help or spot any issues that Oracle Development should take a look at, please consider posting a comment or question on the Oracle Developer Community forum for GoldenGate Free, here: https://forums.oracle.com/ords/apexds/domain/dev-community/category/goldengate-free
How to run Oracle GoldenGate Free in a Container
Use the docker run command to create and start a container from the Oracle GoldenGate Free container image.
$ docker run -p 80:80 -p 443:443 container-registry.oracle.com/goldengate/goldengate-free:latest
----------------------------------------------------------------------------------
-- Password for OGG administrative user 'oggadmin' is 'xxxxxxxx'
----------------------------------------------------------------------------------
...
It will instantiate a container with following default options:
- Auto-generated container name
- 80 port for HTTP Server
- 443 port for HTTPS Server
- 'oggadmin' for the name of the administrative account
- Auto-generated the password for the administrative account
- 'Local' for the name of the deployment
- Use container storage for /u02 and /u03 volume
- Auto-generated self-signed certificate
Advanced usage of the image
$ docker run \
--name <container name> \
-p <host port>:80 \
-p <host port>:443 \
-e OGG_ADMIN=<admin user name> \
-e OGG_ADMIN_PWD=<admin password> \
-e OGG_DEPLOYMENT=<deployment name> \
-e OGG_DOMAIN=<domain name> \
-v [<host mount point>:]/u02 \
-v [<host mount point>:]/u03 \
-v [<host mount point>:]/etc/nginx/cert \
container-registry.oracle.com/goldengate/goldengate-free:latest
Parameters:
--name <container name> - A name for the new container (default: auto generated)-p <host-port>:80 - The host port to map to the Oracle GoldenGate HTTP server (default: no mapping)-p <host-port>:443 - The host port to map to the Oracle GoldenGate HTTPS server (default: no mapping)-e OGG_ADMIN - The name of the administrative account to create (default: oggadmin)-e OGG_ADMIN_PWD - The password for the administrative account (default: auto generated)-e OGG_DEPLOYMENT - The name of the deployment (default: Local)-e OGG_DOMAIN - The domain name to use for the self-signed certificate (default: hostname of the container). Not needed if you bring your own ssl certificates.-v /u02 - The volume used for persistent GoldenGate data (default: use container storage)-v /u03 - The volume used for temporary GoldenGate data (default: use container storage)-v /etc/nginx/cert - The volume used for storing the SSL certificate for the HTTPS server (default: create a self-signed certificate)
See the following sections for additional details.
Data Storage Volumes
- /u01 - The volume for GoldenGate system
- /u02 - The volume for persistent GoldenGate data
- /u03 - The volume for temporary GoldenGate data
Administrative Account Password
On the first startup of the container, a random password will be generated for the Oracle GoldenGate administrative user if not provided by the OGG_ADMIN_PWD environment variable. You can find this password at the start of the container log:
$ docker logs <container name> | head -3
----------------------------------------------------------------------------------
-- Password for OGG administrative user 'oggadmin' is 'xxxxxxxx'
----------------------------------------------------------------------------------
Changing the Default Administrative Account Password
On the first startup of the container, a random password will be generated for the Oracle GoldenGate administrative user if not provided. The user has to mandatorily change the password after the container is created and the corresponding container is healthy.
Using the docker exec command, change the password for those accounts by invoking the setPassword.sh script that is found in the container. Note that the container must be running. For example:
$ docker exec <container name> setPassword.sh <new_password>
This new password will be used afterwards.
This utility can only be used once since there is no log or system environment variable to pick up after changing the password.
After using this utility, you can change the password using GoldenGate Administrator Console.
SSL Certificate
By default, a self-signed certificate is generated.
/u02/oggf/certificate/ca.pem contains the issuing CA certificate used in generating the self-signed certificate.
When bringing your own SSL certificate to an Oracle GoldenGate container, several files are needed:
ogg.key - The private key for the SSL certificate of ogg.ogg.pem - The SSL leaf certificate, and a full certificate trust chain of ogg.
If these files are located in a directory called cert, they can be used in the GoldenGate container with a volume mount as shown here:
$ docker run -v ${PWD}/cert:/etc/nginx/cert:ro -p 8443:443 container-registry.oracle.com/goldengate/goldengate-free:latest
...
All certificate files must contain a full certificate chain starting with the leaf certificate, then followed by all other certificates in the Certificate Authority chain.
-----BEGIN CERTIFICATE-----
MIIFBTCCA+2gAwIBAgISBJSzNXE+Ha5eDw76N5lgHhTpMA0GCSqGSIb3DQEBCwUA
MEoxCzAJBgNVBAYTAlVTMRYwFAYDVQQKEw1MZXQncyBFbmNyeXB0MSMwIQYDVQQD
...
dr7wTE+AQwcOLAGjIvFOL7GK8JrhKvuFvnSoys/1O2CK3vVhBgS+mEF6D+QjIGTv
VC01LCPT51q58INy4RtDBPSqlJwrzz+pOOWd5rBWhu2UPktVHz3AtYE=
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
MIIEkjCCA3qgAwIBAgIQCgFBQgAAAVOFc2oLheynCDANBgkqhkiG9w0BAQsFADA/
MSQwIgYDVQQKExtEaWdpdGFsIFNpZ25hdHVyZSBUcnVzdCBDby4xFzAVBgNVBAMT
...
PfZ+G6Z6h7mjem0Y+iWlkYcV4PIWL1iwBi8saCbGS5jN2p8M+X+Q7UNKEkROb3N6
KOqkqm57TH2H3eDJAkSnh6/DNFu0Qg==
-----END CERTIFICATE-----
Best practices to secure Docker containers
Running containers as a non-root helps to mitigate security vulnerabilities. Running your containers on rootless mode will verify that your application environment is safe.
By default, Docker gives root permission to the processes within your containers, which means they have full administrative access to your container and host environments.
Oracle Enterprise Linux is using the docker-compatible Podman to run and manage Open Container Initiative (OCI) compatible containers. Follow the Rootless Podman tutorial to setup Podman in rootless mode.
Diagnostic logging
The logs for Oracle GoldenGate Free can be found from /u02/oggf/logs volume
- oggf-apiserver*.log - The rolling logs from api-server
- deployment.log - The logs from deploying OGG Microservice Architecture
Known Issues
https://docs.oracle.com/en/middleware/goldengate/free/23/uggfe/goldengate-free-release-notes.html#GUID-1DA5AC24-D769-4438-9A0B-C15BCB638C2E
https://www.oracle.com/pls/topic/lookup?ctx=en/middleware/goldengate/core/23.3&id=OGGLC
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at https://www.oracle.com/corporate/accessibility/.
Oracle GoldenGate Free Release 23ai (23.5.0.24.07) Container Image Documentation
Copyright © 2024 Oracle and/or its affiliates.
Oracle Free Use Terms and Conditions
Definitions
"Oracle" refers to Oracle America, Inc. "You" and "Your" refers to (a) a company or organization (each an “Entity”) accessing the Programs, if use of the Programs will be on behalf of such Entity; or (b) an individual accessing the Programs, if use of the Programs will not be on behalf of an Entity. "Program(s)" refers to Oracle software provided by Oracle pursuant to the following terms and any updates, error corrections, and/or Program Documentation provided by Oracle. "Program Documentation" refers to Program user manuals and Program installation manuals, if any. If available, Program Documentation may be delivered with the Programs and/or may be accessed from www.oracle.com/documentation. "Separate Terms" refers to separate license terms that are specified in the Program Documentation, readmes or notice files and that apply to Separately Licensed Technology. "Separately Licensed Technology" refers to Oracle or third party technology that is licensed under Separate Terms and not under the terms of this license.
Separately Licensed Technology
Oracle may provide certain notices to You in Program Documentation, readmes or notice files in connection with Oracle or third party technology provided as or with the Programs. If specified in the Program Documentation, readmes or notice files, such technology will be licensed to You under Separate Terms.
Your rights to use Separately Licensed Technology under Separate Terms are not restricted in any way by the terms herein. For clarity, notwithstanding the existence of a notice, third party technology that is not Separately Licensed Technology shall be deemed part of the Programs licensed to You under the terms of this license.
Source Code for Open Source Software
For software that You receive from Oracle in binary form that is licensed under an open source license that gives You the right to receive the source code for that binary, You can obtain a copy of the applicable source code from https://oss.oracle.com/sources/ or http://www.oracle.com/goto/opensourcecode.
If the source code for such software was not provided to You with the binary, You can also receive a copy of the source code on physical media by submitting a written request pursuant to the instructions in the "Written Offer for Source Code" section of the latter website.
The following license terms apply to those Programs that are not provided to You under Separate Terms.
License Rights and Restrictions
Oracle grants to You, as a recipient of this Program, a nonexclusive, nontransferable, limited license to, subject to the conditions stated herein, (a) internally use the unmodified Programs for the purposes of developing, testing, prototyping and demonstrating your applications, and running the Programs for your own internal business operations; and (b) redistribute unmodified Programs and Programs Documentation, under the terms of this License, provided that You do not charge Your end users any additional fees for the use of the Programs. You may make copies of the Programs to the extent reasonably necessary for exercising the license rights granted herein and for backup purposes. You are granted the right to use the Programs to provide third party training in the use of the Programs and associated Separately Licensed Technology only if there is express authorization of such use by Oracle on the Program's download page or in the Program Documentation.
Your license is contingent on Your compliance with the following conditions:
- You include a copy of this license with any distribution by You of the Programs;
- You do not remove markings or notices of either Oracle's or a licensor's proprietary rights from the Programs or Program Documentation;
- You comply with all U.S. and applicable export control and economic sanctions laws and regulations that govern Your use of the Programs (including technical data);
- You do not cause or permit reverse engineering, disassembly or decompilation of the Programs (except as allowed by law) by You nor allow an associated party to do so.
For clarity, any source code that may be included in the distribution with the Programs is provided solely for reference purposes and may not be modified, unless such source code is under Separate Terms permitting modification.
Ownership
Oracle or its licensors retain all ownership and intellectual property rights to the Programs.
Information Collection
The Programs' installation and/or auto-update processes, if any, may transmit a limited amount of data to Oracle or its service provider about those processes to help Oracle understand and optimize them. Oracle does not associate the data with personally identifiable information. Refer to Oracle's Privacy Policy at www.oracle.com/privacy.
Disclaimer of Warranties; Limitation of Liability
THE PROGRAMS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ORACLE FURTHER DISCLAIMS ALL WARRANTIES, EXPRESS AND IMPLIED, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW WILL ORACLE BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Last updated: 22 July, 2024