Create Data Transforms resources

To use Data Transforms in OCI GoldenGate, create a Data Transforms deployment, and then create and assign a Generic connection type to the deployment.

Create a Data Transforms deployment

Before you begin

Before you create a deployment, review the following requirements:

  • If you enable public deployment console access in Step 15, 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.
  • In Oracle Cloud Infrastructure Identity and Access Management (OCI IAM) enabled tenancies, Step 16 requires you to 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.
To create a Data Transforms deployment:
  1. In the Console navigation menu, click Oracle Database, and then select GoldenGate.
  2. On the Deployments page, click Create deployment.
  3. In the Create deployment panel, enter a name and optionally, a description.
  4. From the Compartment dropdown, select a compartment in which to create the deployment.
  5. On the GoldenGate details page, for Choose a deployment type, select Data transforms.
  6. For Version, the latest version is automatically selected. Click Change version to select a different version.

    Note:

    Learn more about versions.
  7. 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.
  8. 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.

    Note:

    One OCPU is equivalent to 16gb of memory. For more information, see OCPU management and billing.
  9. (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.
  10. 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.
  11. Select a license type.
  12. For GoldenGate instance name, enter the name that the deployment will assign to the GoldenGate deployment instance upon creation.
  13. For Credential store, select GoldenGate. The Administrator username automatically populates with SUPERVISOR for you.
  14. For Administrator password, select a password secret for the SUPERVISOR user.
    To create a new password secret:
    1. Click Create password secret.
    2. In the Create secret panel, enter a name for the secret, and optionally, a description.
    3. Select a compartment from the Compartment dropdown in which to save your secret.
    4. Select a vault in the current compartment, or click Change compartment to select a vault in a different compartment.
    5. 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.
    6. 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 '?'.
    7. Confirm the password.
    8. Click Create.
  15. (Optional) Click Show advanced options for network options and to add tags.
    1. In the Network tab,
      1. 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.
      2. 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.

    2. In the Maintenance tab:
      1. Select Customize maintenance window to define the start of the maintenance window to upgrade the deployment.
      2. (Optional) For Major release auto-upgrade period in days, enter the number of days, between 0 and 365.
      3. (Optional) For Bundle release auto-upgrade period in days, enter the number of days, between 0 and 180 days.
      4. (Optional) For Security patch auto-upgrade period in days, enter the number of days, between 0 and 14 days.
      5. Select Enable minor release auto-upgrade, and, optionally, enter the number of days.

      Note:

      Learn more about scheduling upgrades.
    3. In the Tags tab, add tags to help track the resources within your tenancy. Click + Additional tag to add more tags. Learn more about tagging.
  16. 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.

The deployment takes a few minutes to create. Its status changes to Active when it's ready to use. You can then click Launch console from the deployment details page, or select Launch console from the deployment's Actions (three dots) menu on the Deployments page.

Create a Generic connection

You must create a Generic connection for the any connection you intend to use with OCI GoldenGate Data Transforms.

See supported connection types for Data Transforms to ensure your data source is supported.
To create a Generic connection:
  1. From the OCI GoldenGate Overview page, click Connections.
    You can also click Create Connection under the Get started section and skip to step 3.
  2. On the Connections page, click Create Connection.
  3. In the Create Connection panel, complete the General Information fields as follows:
    1. For Name, enter a name for the connection.
    2. (Optional) For Description, enter a description that helps you distinguish this connection from others.
    3. For Compartment, select the compartment in which to create the connection.
    4. From the Type dropdown, under Generic, select Generic connection.
    5. (Optional) Click Show advanced options to manage keys or add tags.
      1. Under Security, select one of the following:
        • Select Use Oracle-managed encryption key to leave all encryption key management to Oracle.
        • Select Use customer-managed encryption key to select a specific encryption key stored in your OCI Vault to encrypt your connection credentials.
      2. Under Tags, add tags to organize your resources.
  4. Click Next.
  5. Complete the Connection details page as follows:
    1. For Host, enter a comma separated list of <host>:<port> entries. Enter the Private IP only if the hostname is not resolvable from your subnet or if it uses SSL/TLS.

      Note:

      If you enter a private IP, then OCI GoldenGate rewrites the private IP in the format, ip-10-0-0-0.ociggsvc.oracle.vcn.com.
    2. For Network connectivity, select a Traffic routing method:
      • Shared endpoint, to share an endpoint with the assigned deployment. You must allow connectivity from the deployment's ingress IP.
      • Dedicated endpoint, for network traffic through a dedicated endpoint in the assigned subnet in your VCN. You must allow connectivity from this connection's ingress IPs. Then, select a subnet from the dropdown.
  6. Click Create.
It takes a few minutes for the connection to become Active. Ensure that you assign the connection to a deployment to use it in Data Transforms. After assigning the connection to the Data Transforms deployment, launch the console, and then log in. You must then create a connection for each data source in the Data Transforms console using the Host name(s) provided in the Generic connection(s).

Assign a connection to a deployment

Ensure that you have connections created for your source and target technologies.
To assign a connection to a deployment:
  1. On the deployment details page, under Resources, click Assigned connections.
  2. Click Assign connection.
  3. In the Assign connection dialog, select a connection from the dropdown. If you want to select a connection from a different compartment, click Change Compartment.
  4. Click Assign connection.
The selected connection appears in the Assigned connections list. You can also view and manage this relationship from the Connection details page under Assigned deployments.