Managing Deployments

Deployments let you create and organize your Oracle Cloud Infrastructure GoldenGate resources.

About OCPU Utilization

Before you create an OCI GoldenGate deployment, it's important to understand how the OCPU shape affects the OCI GoldenGate user experience.

When you create an OCI GoldenGate deployment, you must select how many OCPUs the deployment will use. Here are some things to consider when making your selection:

  • 1 OCPU shapes are highly recommended for non-production environments.
  • Enabling Auto Scale ensures additional OCPUs are available when they're needed. You're only billed when the additional OCPU cycles are consumed.
  • Extract and Replicat are high priority processes and take precedence in OCPU cycles.
  • OCI GoldenGate Deployment Console also consumes OCPU cycles. If the current OCPU utilization is near 100%, then the OCI GoldenGate Deployment Console may be very slow to return or not return at all.
  • The OCI GoldenGate Backup process also consume OCPU cycles. If the current OCPU utilization is near 100%, the backup process can take a long time to complete.
  • If an OCI GoldenGate deployment is running at or near 100% OCPU utilization, consider changing the base OCPU count or enabling Auto Scale, if it's not already enabled.
  • You can monitor OCPU Utilization on the OCI GoldenGate Deployment Details page and the Metrics Explorer in the OCI Console.
  • You can set alarms in the OCI Console to notify you when OCPU utilization reaches certain levels.

Creating a Deployment

To create a deployment:

  1. In the Console navigation menu, under Oracle Database, 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.
    Note

    A deployment can only access the database registrations within the same tenancy on the same VCN. You must also have explicit access to the database.

  5. For OCPU Count enter the number of Oracle Compute units (OCPUs) to use.
    Note

    One OCPU is equivalent to 16gb of memory. For more information, see About OCPU Utilization.
  6. (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.
  7. 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.

  8. Select a license type.
  9. (Optional) Click Show Advanced Options for network options and to add tags.
    1. In the Network tab,
      1. Select Create Public Endpoint if you want to include a public endpoint in addition to a private endpoint.
      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.

        A self-signed certificate is generated for you, if you don't provide one.

    2. 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.
  10. Click Next.
  11. For GoldenGate Instance Name, enter the name that the deployment will assign to the GoldenGate deployment instance upon creation.
  12. For Administrator Username, enter the adminstrator name that the deployment will use to create the GoldenGate deployment instance.
  13. For Administrator Password and Confirm Administrator Password, enter password for the administrator.
    Note

    Take note of the administrator name and password. You will use the same credentials to log in to the GoldenGate deployment console.
  14. Click Create.

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.

Viewing Deployment Details

Select a deployment from the Deployments page to view its details. On the Deployment Details page, you can:

  • View the deployment's status, which can be one of the following:
    • Creating
    • Updating
    • Active
    • Inactive
    • Deleting
    • Deleted
    • Failed
    • Needs Attention
      Note

      If the deployment's status is Needs Attention, then the deployment health is less than 100%. See About OCPU Utilization.
  • Perform actions on the deployment, such as edit, start or stop, scale, move, add tags, and delete
  • Launch the Oracle Cloud Infrastructure GoldenGate Deployment Console
  • View deployment information, such as the deployment's OCID, GoldenGate instance and network details
  • Apply patches
  • View metrics for instance health, throughput, inbound and output lag
  • Create and view deployment backups
  • View Upgrade History
  • Add and view Network Security Groups
  • View the status of work requests and any log messages, error messages, and resources associated with them. Deployment operations that create work requests include:
    • Create
    • Update
    • Delete
    • Move
    • Restore
    • Stop
    • Start
    • Patch

Editing a Deployment

To edit a deployment:

  1. On the Deployments page, select a deployment, and then click Edit from the Deployment Details page.

    You can also select Edit from the Actions (three dots) menu of the deployment you want to edit.

  2. In the Edit Deployment dialog, you can update the following fields:
    • Name
    • Description
    • Create Public Endpoint
    • FQDN Prefix
    • Certificate and private key pair (keep, remove, or replace)
  3. Click Save Changes.

Stopping a Deployment

When you stop a deployment, GoldenGate also stops. You won't be able to access the Oracle Cloud Infrastructure GoldenGate deployment console while the deployment is stopped and you won't be billed until you restart it.

To stop a deployment:

  1. From the Deployments page, select a deployment, and then click Stop on the Deployment Details page.

    You can also select Stop from the Actions (three dots) menu of the deployment you want to stop on the Deployments page.

  2. In the Stop Deployment dialog, click Stop.

When you stop a deployment, GoldenGate stops all active tasks. You can restart the deployment from the Deployments or Deployment Details pages.

Starting a Deployment

After the deployment is created, GoldenGate is automatically started. If you stop a deployment, you can restart it using the Start option in the deployment's Actions (three dots) menu. When you start the deployment, billing also resumes.

To start a deployment:

  1. From the Deployments page, select a deployment, and then click Start on the Deployment Details page.

    You can also select Start from the Actions (three dots) menu of the deployment you want to start on the Deployments page.

  2. In the Start Deployment dialog, click Start.

The deployment starts and you can now launch the Deployment Console. Oracle resumes billing for the amount of Oracle compute units (OCPUs) used.

You can also configure Extracts and Replicats to automatically start when you start the deployment. For more information, see Working with Data Replications.

Scaling a Deployment

You can scale a deployment up or down depending on the amount of Oracle Compute Units (OCPUs) you need.

When you enable auto scaling, the deployment can scale up to three times more memory than the number of OCPUs currently shown in the Scale dialog. One OCPU is equivalent to 16 GB memory. If your workload requires additional OCPUS, then the deployment automatically uses the resources without any manual intervention required when auto scaling is enabled.

To see OCPU usage, you can view the OCPU Consumption graph in the Metrics section of the Deployment Details page in the Console.

To scale a deployment:

  1. On the Deployments page, from the Actions (three dots) menu of the deployment you want to scale, select Scale.

    You can also click Scale on the deployment's Details page.

  2. For OCPU Count, enter the number of OCPUs between 1 and 24.
  3. (Optional) Enable Auto Scaling.
    Enabling auto scaling allows the service to scale up to three time the designated number of OCPUs, for a maximum of 24 OCPUs.
  4. Click Save Changes.
Your deployment restarts to reflect the changes made.

Moving a Deployment

You can move a deployment from one compartment to another compartment. If the deployment referenced database registrations in the original compartment, it will no longer be able to access them from the new compartment.

To move a deployment:
  1. From the Deployments page, select a deployment, and then in the Actions menu, select Move Resource from the Deployment Details page.

    You can also select Move Resource from the Actions (three dots) menu of the deployment you want to move on the Deployments page.

  2. In the Move Resource to a Different Comparment dialog, select the compartment to move the deployment to from the dropdown.
  3. Click Move Resource.

After you move the deployment to the new compartment, inherent policies apply immediately and may affect access to the deployment through the Console. For more information, see Managing Compartments.

If you want to move database registrations to the new compartment, see Moving a Database Registration.

Managing Tags for a Deployment

Tags help you locate resources within your tenancy. You can add and view a deployment's tags from the Deployments page and from the Deployment Details page.

On the Deployments page, from a deployment's Actions (three dots) menu, select Add Tags or View Tags.

On the Deployment Details page, you can select Add Tags from the More Actions menu, or click the Tags tab to view and edit tags.

Learn more about tagging.

Deleting a Deployment

When you delete a deployment, all active Oracle GoldenGate tasks within that deployment stop. Deleting a deployment doesn't remove references, such as checkpoint tables and Extract information, from the databases the deployment used. After a deployment is deleted, it cannot be restored.

To delete a deployment:

  1. On the Deployments page, select a deployment, and then from the More Actions menu, select Delete.

    You can also select Delete from the Actions (three dots) menu for the deployment you want to delete on the Deployments page.

  2. In the Delete Deployment dialog, click Delete.

You may need to manually remove files that remain in the source and target databases after a deployment is deleted. For more information, see Files to be Removed Manually After Removing a Deployment under How to Remove a Deployment.

Using the Deployment API

You can use the following operations to manage deployments:

For information about using the API and signing requests, see REST APIs and Security Credentials. For more information about SDKs, see Software Development Kits and Command Line Interface.