1. Using Oracle GoldenGate on Oracle Cloud Marketplace
  2. Additional Topics
  3. Upgrading Oracle GoldenGate Marketplace Image

11 Upgrading Oracle GoldenGate Marketplace Image

This chapter helps you to upgrade an existing (or older version of) Oracle GoldenGate Marketplace stack to the latest release, using the OCI Stacks approach.

Note:

Upgrade from a 19c stack to 21c release is not permitted.
Before any upgrade, ensure to do the following:
  1. Shut down all the Oracle GoldenGate processes in the VM instance.
  2. Backup all the block storage just in case you need revert it back in the future for a failed upgrade/update.

Topics:

Parent topic: Additional Topics

Stacks

Stacks are zip files that contain the latest Terraform code base. These stacks enable you to provision a new compute node and attach your existing block storage. This approach ensures that Oracle GoldenGate does not lose any associated data present in the environment.

When Stacks are available, you can access them through the Oracle Object Store.

Parent topic: Upgrading Oracle GoldenGate Marketplace Image

Retrieving a Stack

Before you upgrade Oracle GoldenGate Marketplace, you have to retrieve the latest stack.

To retrieve a stack:
  1. Go to the Market Place List.
  2. Select a version from the Version drop-down list. This is the Market Place image you will use to upgrade.
  3. Select the I have reviewed and accepted the Oracle Program Limited Use Promotional Terms check box.
  4. Click Download to download the stack zip file and save it on your local drive in the following directory: BundlePatch19c.

Parent topic: Upgrading Oracle GoldenGate Marketplace Image

Identifying the Terraform Version for the Stack to be Upgraded

To identify the Terraform version for the stack to be upgraded:
  1. Log in to the Oracle Cloud Interface (OCI) Console.
  2. On the Home page, under Developer Services, click Resource Manager, and then click Stacks.
  3. Select an existing stack for which, you want to identify the Terraform version.
    Note that under Stack Information, the Terrafom version field lists the Terraform version used by the stack.

    Note:

    If Terraform version of stack to be upgraded and the new stack version are same, then follow the steps in Upgrading an Oracle Cloud Marketplace Image to 1.0.x (Same Terraform Version). If the versions are different, follow the steps in Upgrading an Oracle Cloud Marketplace Image (To Different Versions of Terraform).

Parent topic: Upgrading Oracle GoldenGate Marketplace Image

Upgrading an Oracle Cloud Marketplace Image (To Different Versions of Terraform)

To upgrade an Oracle Cloud Marketplace image, where the pre-upgrade stack Terraform version is updated to a different Terraform version in the new stack, perform the following tasks:

Parent topic: Upgrading Oracle GoldenGate Marketplace Image

Verify that the Stack you want to Upgrade is up to Date

  1. Verify that the stack you want to Upgrade is up to date.
  2. In the left panel, select the compartment containing the stack you need to upgrade.
  3. In the right panel, click the stack you need to upgrade.
  4. In the Stack details page, make a note of the variables that the Stack used. In the left panel, click Variables and copy the variables into a text editor. This is required because you need to use the same compartment, vcn, or subnet eventually.
  5. Make a note of the tags your Stack uses. In the right panel switch to the Tags pane and copy the tags into a text editor.
  6. Confirm there are no pending changes to the stack by clicking the Plan operation on the Terraform Actions menu.
    The job output must display No changes. Infrastructure is up-to-date.

Parent topic: Upgrading an Oracle Cloud Marketplace Image (To Different Versions of Terraform)

Download the Terraform Configuration and Terraform State File from the Old Stack and Create a New Stack

  1. Download the stack's Terraform Configuration and Terraform state file from your old version stack (rename the state file to terraform.tfstate). For details on downloading a stack's state file and Terraform configuration, see Getting a Stack's State File and Downloading a Terraform Configuration File.
  2. Copy the Terraform Configuration and Terraform state file into a local workspace and unzip the file.
  3. Remove the zip file named ocid* after unzipping.
  4. Use Terraform_13 (download from hashicorp and save to local host PATH variable) to upgrade the stack's Terraform Configuration.

    Before running the upgrade, check the main.tf file located in the stack for the required Terraform version. If the Terraform required version is defined as required_version = "~> 0.12", change it to required_version = ">= 0.12".

  5. Run the upgrade command on the bash prompt, as shown:
    bash-4.2$ terraform_13 0.13upgrade
  6. Create a new zip file for the updated stack configuration, as shown in the following code snippet:
    bash-4.2$ zip -qr upgradeTF013_Oracle1923.zip *
    In this snippet, TF013_Oracle1923.zip is the name of the new zip file.

Parent topic: Upgrading an Oracle Cloud Marketplace Image (To Different Versions of Terraform)

Upgrade from Terraform v0.12 to v1.0.x

Upgrading the Oracle GoldenGate on Marketplace with Terraform v0.12 to 1.0.x is a three-part process:

  1. Upgrade the Terraform stack from 0.12 to 0.13

  2. Upgrade the Terraform stack from 0.13 to 0.14

  3. Upgrade the Terraform stack from 0.14 to 1.0.x

Use the following instructions to upgrade from Terraform v 0.12 to v0.13, then from v0.13 to v0.14, and then 0.14 to 1.0.x.
  1. Log in to the Oracle Cloud Interface (OCI) Console.
  2. Login to your Oracle GoldenGate Instance and stop all the running Oracle GoldenGate processes. Ensure that you stop all the Microservices (Administration Service, Distribution Service, Receiver Service and Performance Metrics Service) including Service Manager.
  3. On the Home page, click the navigation menu in the top left corner and under Developer Services, click Resource Manager, and then click Stacks.
  4. Choose the new Stack you created in Download the Terraform Configuration and Terraform State File from the Old Stack and Create a New Stack.
  5. Click Edit from the top menu.
  6. Upload the new zip (terraform_13 upgraded zip).
  7. Update Terraform version to 0.13.x and click Save Changes.
  8. Import the Terraform state file terraform.tfstate to the stack using Import Job.
  9. Go to Compute and select Instances.
  10. Terminate the existing compute instance that needs to be upgraded.
  11. Ensure that the Permanently delete the attached boot volume option is selected.
  12. After the instance is terminated, from the left navigation pane, select Developer Services and click Resource Manager and then click Stacks.
  13. Select the Stack that you edited in step 4, for upgrade.
  14. Click Apply Job. Ensure the step run without errors.

    Wait until the job completes and verify whether the compute node is up and running.

  15. To upgrade from Terraform v0.13 to v.14:

    1. From the Resource Manager, select the stack that you upgraded to 0.13 and click Edit.

    2. Update the Terraform version in the stack to 0.14 and click Next.

    3. Verify that the pre-filled details are accurate and click Save Changes.

    4. Go to Compute and select Instances.

    5. Terminate the existing compute instance that needs to be upgraded.

    6. Ensure that the Permanently delete the attached boot volume option is selected.

    7. After the instance is terminated, from the left navigation pane, select Developer Services and click Resource Manager and then click Stacks.

    8. Select the stack for which the Terraform version is to be upgraded.

    9. Click Apply Job. Wait until the job completes and verify whether the compute node is up and running

  16. After successfully upgrading to Terraform v0.14, follow the steps provided in Upgrading an Oracle Cloud Marketplace Image to 1.0.x (Same Terraform Version).
  17. After upgrade to Terraform v1.0.x completes successfully, remove the compute instance's IP address from the ~/.ssh/known_hosts file, so that you can log in to the compute node to start all the Oracle GoldenGate processes.

Parent topic: Upgrading an Oracle Cloud Marketplace Image (To Different Versions of Terraform)

Upgrading an Oracle Cloud Marketplace Image to 1.0.x (Same Terraform Version)

The upgrade process is only valid for the upgrade or patching within the same major version, for example, from v19c to v19c. Current Marketplace doesn't support major version upgrade through image update.

To upgrade an existing Oracle GoldenGate Marketplace image when the pre-upgrade stack Terraform version is the same the new stack version, perform the following tasks:

Note:

These steps are applicable in Oracle GoldenGate Marketplace that are updated from Terraform v .14 to 1.0.x only.
  1. Download the correct version of the Stack.
  2. Log in to the Oracle Cloud Interface (OCI) Console.
  3. Login to your Oracle GoldenGate Instance and stop all the running Oracle GoldenGate processes. Ensure that you stop all the Microservices (Administration Service, Distribution Service, Receiver Service and Performance Metrics Service) including Service Manager.
  4. On the Home page, click the navigation menu in the top left corner and under Developer Services, click Resource Manager, and then click Stacks.
  5. Select an existing stack that you want to upgrade.
  6. Click Edit from the top menu.
  7. Click Browse to select the downloaded stack.
  8. Upload the new .zip file.
  9. Update the terraform version in the stack to 1.0.x and click Next.
  10. Verify that the pre-filled details are accurate and click Save Changes.
  11. Go to Compute and select Instances.
  12. Terminate the existing compute instance that needs to be upgraded.
  13. Ensure that the Permanently delete the attached boot volume option is selected.
  14. After the instance is terminated, from the left navigation pane, select Developer Services and click Resource Manager and then click Stacks.
  15. Select the Stack that you edited in step 6, for upgrade.
  16. Click Apply Job.

    Wait until the job completes and verify whether the compute node is up and running.

  17. After upgrade, remove the compute instance's IP address from the ~/.ssh/known_hosts file, so that you can log in to the compute node to start all the Oracle GoldenGate processes.

Parent topic: Upgrading Oracle GoldenGate Marketplace Image