Deployments let you create and organize Oracle Cloud Infrastructure GoldenGate
resources, and enables the OCI GoldenGate deployment console, where you can add and manage data
replication processes. You can create deployments for Oracle Database, Big Data, Db2 for
z/OS, Db2 for i, Microsoft SQL Server, MySQL, and PostgreSQL sources or targets.
Before you beginBefore you create a
deployment, review the following requirements:
- Ensure that you have the appropriate policies added if you want to:
- Enable public deployment console access in the Advanced options. OCI GoldenGate creates a load balancer in your tenancy VCN on your behalf. To
ensure successful creation of the deployment and load balancer, you must have the
appropriate policies, quotas, and limits in place.
- Use Zero Trust Packet Routing (ZPR) to
control access to this deployment.
- In Oracle Cloud Infrastructure Identity and Access Management (OCI IAM)
enabled tenancies, select the credential store you'll use to log in to the deployment
console.
- Depending on your source and target technology types, you may need more
than one deployment. If you're not sure how many deployments you need for your solution,
see Example topologies for details.
- In the Console navigation menu, click Oracle AI Database, and then select
GoldenGate.
- On the Deployments page, click Create deployment.
- In the Create deployment panel, enter a name and optionally, a description.
- If creating this deployment for GoldenGate on Multicloud, select your
Subscription.
- From the Compartment dropdown, select the compartment in which the
Resource Anchor resides
- Select the Multicloud partner region.
- Select your Partner availability zone. The available options populate based
on the selected Multicloud partner region.
- From the Compartment dropdown, select a compartment in which to create the
deployment.
- For Automatically select the best availability domain placement:
- Select this option for the service to select the Availability domain
and Fault domain on your behalf.
- Deselect this option to select the Availability domain and Fault
domain yourself.
- For Choose a deployment type, select Data replication.
- From the Select a technology dropdown, select one of the following technology
types:
- Oracle AI Database
- Big Data
- MySQL
- PostgreSQL
- Microsoft SQL Server
- IBM Db2 for i
- IBM Db2 for z/OS
See what's supported to learn which
databases and technologies you can use as OCI GoldenGate sources and
targets.
- For Version, the latest version is automatically selected. Click
Change version to select a different version.
- Select one of the following options:
- Development or testing: Sets up a deployment
with recommended defaults for a development or testing environment. The minimum number
of OCPUs is 1.
- Production: Sets up a deployment with
recommended default of 4 OCPUs with auto-scaling enabled for a production environment.
The minimum number of OCPUs needed is 3, with auto-scaling enabled.
- For Select OCPU enter the number or
click Change shape to use the slider to choose the number of Oracle
Compute units (OCPUs) to use.
- (Optional) Select Auto scaling.
Note
Auto scaling enables OCI GoldenGate to scale up to three times the number of OCPUs you specify for
OCPU Count, up to 24 OCPUs. For example, if you specify your OCPU Count as 2 and enable
Auto Scaling, then your deployment can scale up to 6 OCPUs. If you specify your OCPU
Count as 20 and enable Auto Scaling, OCI GoldenGate can only scale up to 24
OCPUs.
- From the Subnet in <Compartment> dropdown, select the
subnet to which a private endpoint is created from the OCI GoldenGate service
tenancy. This ensures that the deployment is always available over this subnet, as long as
the policies for this subnet allow access.
To select a subnet in a different compartment, click Change
compartment.
Note
You can only select a private subnet
when creating or updating a deployment.
- Choose a License type:
- License included, to subscribe to a new software license for
the service.
- Bring your own license (BYOL), to bring existing Oracle
GoldenGate licenses to the service. Enable BYOL OCPU limit to control the number
of OCPUs covered by BYOL. The minimum number of OCPUs covered is 1.
- For GoldenGate instance name, enter the name that the deployment
will assign to the GoldenGate deployment instance upon creation.
- For Credential store, select one of the following:
- OCI Identity and Access Management (OCI IAM), to enable users
to log in to the deployment console using their Oracle Cloud account (single sign on) in
IAM (Identity and Access Management) enabled tenancies.
Note
- Once you select IAM, you won't be able to switch to GoldenGate when
you edit the deployment settings at a later time.
- This option is preferred for a Db2 for i deployment, to prevent
issues with log in and Distribution Paths.
- (Optional - applies only to Data Replication deployments) Select
Customize group to role mappings to map user groups to
specific GoldenGate roles. At minimum, you must assign the Security role
group to a user group. Learn more about Oracle GoldenGate user
roles and privileges.
- GoldenGate, for GoldenGate to manage users.
- Enter the Administrator username
- Select a password secret in your compartment or click Change
compartment to select one in a different compartment. You can also create a
new password secret.
To create a new password secret:
- Click Create password secret.
- In the Create secret panel, enter a name for the secret, and
optionally, a description.
- Select a compartment from the Compartment
dropdown in which to save your secret.
- Select a vault in the current compartment, or click Change
compartment to select a vault in a different compartment.
- Select an Encryption key.
Note
Only AES keys, Software
protected keys, and HSM keys are supported. RSA and ECDSA keys are not
supported for GoldenGate password secret keys.
- Enter a password 8 to 30 characters in length, containing at least
1 uppercase, 1 lowercase, 1 numeric and 1 special character. The special
characters must not be '$', '^' or '?'.
- Confirm the password.
- Click Create.
Note
You can manage GoldenGate
users in the deployment console.
Learn more.
- (Optional) Click Show advanced options for network options and
to add tags.
- In the Network tab,
- Select Enable GoldenGate console public
access to include a public endpoint in addition to a private
endpoint, and allow public access to the deployment console for users. If
selected, OCI GoldenGate creates a load balancer in your tenancy to
create a public IP. Select a public subnet in the same VCN as this deployment in
which to create the load balancer.
Note
The load balancer is a resource
that comes with an additional cost. You can manage this resource, but ensure
that you don't delete the load balancer while your deployment is still in use.
Learn more about load balancer
pricing.
-
Select Customize endpoint to provide a private fully
qualified domain name (FQDN) prefix that you'll use to access the private
service console URL. You can also optionally upload an SSL/TLS certificate
(.pem) and its corresponding private key, however, password protected
certificates are not supported.
- It's your responsibility to ensure that the FQDN resolves to the
deployment's private IP address in the subnet you previously selected.
- If the deployment is public, it's your responsibility to ensure
that the FQDN publicly resolves to the deployment's public IP address.
The services uses its own certificate, if you don't provide one,
and you may encounter security warning when launching the deployment
console.
Note
Your SSL certificate must meet the following requirements:
- It's common name should match the deployment's FQDN. If it
doesn't, you'll encounter warnings when you access the deployment
console.
- It must be signed using a strong hashing algorithm. arcfour,
arcfour128, arcfour256, none algorithm types are not permitted.
- It must not be expired.
- It's maximum validity should not exceed 13 months.
- It must not be a self-signed certificate.
If you encounter "Invalid Private Key" errors, you can
check the correctness of the key using the following OpenSSL commands. Run
this command against the
certificate:
openssl x509 --noout --modulus --in <cert>.pem |openssl md5
Then run this command on the private
key:
openssl rsa --noout --modulus --in <key>.pem |openssl md5
The output of the two commands should return the same
md5 value. If it doesn't, then the certificate and private
key don't match.
- In the Maintenance section:
- Select Customize maintenance window to
define the start of the maintenance window to upgrade the deployment.
- (Optional) For Major release auto-upgrade period in days,
enter the number of days, between 0 and 365.
- (Optional) For Bundle release auto-upgrade period in days,
enter the number of days, between 0 and 180 days.
- (Optional) For Security patch auto-upgrade period in days,
enter the number of days, between 0 and 14 days.
- Select Enable minor release auto-upgrade, and, optionally,
enter the number of days.
- In the Backup schedule section:
- Select Configure backup schedule.
- Select the Date and Time to start creating backups.
- Select the Frequency for creating backups, either Daily, Weekly, or
Monthly.
- Select Backup metadata only, to create backups without trail files.
- Select the Compartment in which to create backups.
- Select the Compartment and the Object storage bucket in which to
save backups.
- In the Security attributes section, add a security attribute to control
access to this deployment using Zero Trust Packet Routing (ZPR).
- In the Tags section, add tags to help track the resources
within your tenancy. Click + Additional tag to add more tags.
Learn more about tagging.
- Click Create to create the deployment, or click Save
as Stack to save this configuration to Resource Manager.
If you select Save as stack, then the Save as stack panel opens, where you can
optionally provide a name and description for the stack and select the compartment to
save it in. Learn more about Resource Manager.
After the deployment is created and becomes Active, it starts automatically.
You can then select Launch console in the deployment's Actions
(three dots) menu on the Deployments page, or click Launch console on
the deployment details page to access the OCI GoldenGate deployment console.
Ensure that you create and assign connections to use with your deployment.