Manage deployments

Learn to edit, scale, stop, start, and delete a deployment in the Oracle Cloud console.

Related Topics

View 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%. Learn about OCPU management and billing.
  • Perform actions on the deployment, such as:
  • Launch the OCI GoldenGate deployment console.
  • Launch Admin client.
  • View deployment information, such as the deployment's OCID, Oracle Cloud Infrastructure GoldenGate instance and network details.
  • View the deployment's storage utilization. Storage utilization limit indicates how much file system space the deployment is currently using.

    Note:

    You have starting soft limit of 250 GB of space per deployment OCPU, and a hard limit of 500 GB per base OCPU. For example, for 4 base OCPUs, the soft limit is 1 TB and the hard limit 2 TB. If you exceed the hard limit, the service may be limited in functionality and performance.

    Create alarms to notify you of this event. Manage trail files to free up space.

  • Schedule the deployment's maintenance window.
  • View deployment metrics.
  • Add and view Network Security Groups.

    Note:

    Adding network security groups (NSGs) gives you fine grained control over where the deployment can be accessed from within your subnet. Learn more.
  • Create and view deployment backups.
  • View upgrade history.
  • View, assign, and unassign connections.
  • View trail files details such as size, sequence, producers, and consumers.

    Note:

    Trail files can build up over time and are major contributors to the Storage utilization number you see under Deployment information. Use this information to manage trail files.
  • Import and export Master encryption key wallets.
  • 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

Edit 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.

Upgrade a deployment

See Maintain your OCI GoldenGate deployments to learn about how to upgrade, OCI GoldenGate versions, scheduling upgrades, and more.

Scale 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.

Stop a deployment

When you stop a deployment, Oracle Cloud Infrastructure GoldenGate also stops. You won't be able to access the OCI 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, Oracle Cloud Infrastructure GoldenGate stops all active tasks. You can restart the deployment from the Deployments or deployment details pages.

Start a deployment

After the deployment is created, Oracle Cloud Infrastructure 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 Configure managed processes.

Move a Deployment

You can move a deployment from one compartment to another 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.

Manage 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.

Delete 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.

Assign a connection to a deployment

When you're on the Deployment details page, you can assign connections to the deployment.
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.

Unassign a connection

You can remove, or unassign, a connection from a deployment. First ensure that there are no active processes running in your deployment that involve the connection you want to remove.
To unassign a connection:
  1. On the Deployment details page, under Resources, click Assigned connections.
  2. From the Actions (ellipsis icon) menu for the connection you want to unassign, select Unassign.
  3. In the Unassign connection dialog, confirm that you want to unassign the connection from this deployment, and then click Unassign connection.
The connection no longer appears in the Assigned connections list. Unassigning a connection does not delete the connection. If you want to delete the connection, see Delete a connection.