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:

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

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

11.3 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 (Terraform Version is Same). If the versions are different, follow the steps in Upgrading an Oracle Cloud Marketplace Image (To Different Versions of Terraform).

11.4 Upgrading an Oracle Cloud Marketplace Image (Terraform Version is Same)

The upgrade process is only valid for the uprade/patching within the same major version, for example, from V19 - > V19 or V21 -> V21. Current Marketplace doesn't support major version upgrade through Image update.

To upgrade an existing Oracle GoldenGate Marketplace image, perform the following tasks:
  1. Download the correct version of the Stack.
  2. Log in to the Oracle Cloud Interface (OCI) Console.
  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. Select an existing stack that you want to upgrade.
  5. Click Edit from the top menu.
  6. Click Browse to select the downloaded stack.
  7. Modify the Display Name as the instance name that you want to see in compute instances page when the upgrade is done. Display Name is the name of the instance that is displayed before uploading the terraform configuration file. The Display Name usually specifies release of the product as part of the name. When the upgrade process is complete and version changes to a higher version, the instance name still shows old instance name in the Compute -> Instances page. When you change the display name during the upgrade process, you can get to know the release version of the instance in the Instances page itself.
  8. Click Next.
  9. Click Next and click Save Changes.
  10. Login to your Oracle GoldenGate Instance and stop all the running GoldenGate processes. If you are running Microservice Architecture, ensure to stop all the services (Admin Server, Distribution Server, Receiver Server and Metrics Performance Server) including Service Manager.
  11. From Terraform Action, select Plan.
  12. When the plan is complete, from the Terraform Action page, select Apply.

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

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

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

To upgrade an Oracle Cloud Marketplace image (to diferent versions of Terraform), perform the tasks detailed in this section:

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

11.5.2 Download the Terraform State File from your old version Stack

  1. Download the Terraform state file from your old version stack.
  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. Click Apply job from the Jobs list to navigate to Job Details page.
  5. Click Download Terraform State and save the file to BundlePatch19c directory.

11.5.3 Create a New Stack

  1. Open the navigation menu. Under Developer Services, click Resource Manager and then Stacks.
  2. In the left panel, select the compartment where you want to create the new stack (should be same as the compartment of the stack you want to upgrade).
  3. Click Create Stack.
  4. In Stack Configuration, click the Zip file and select the zip file you downloaded to BundlePatch19c directory.
  5. Give your stack a name, for example, <OriginalStackName> + " 19cBP".
  6. Click Next.
  7. In the Configure Variables step ensure the variables are set exactly the same as the old stack.
  8. Click Next and Create. Do not click Apply yet.

11.5.4 Import the old Stack State to the new Stack

  1. Choose the new Stack you created in Create a New Stack
  2. In the Stack Detail page, click More actions and then click Import State. Choose the old stack state file you downloaded from Download the Terraform State File from your old version Stack, and then click Import.
  3. Review the Import job output to confirm that the state file was successfully pushed.
  4. Add any require tags by enabling the Tags panel and adding the appropriate tags.
  5. Confirm your new stack imported the state correctly by clicking Terraform Actions and then Plan.
  6. Review the job logs. The plan job output must say Plan: 5 to add, 5 to change, 7 to destroy..
  7. Navigate to the Details page for the new stack and click Apply.
    The Apply job output must say Apply complete! Resources: 5 added, 5 changed, 7 destroyed.

    Note:

    These numbers are for Oracle only and they can vary based on the database.
  8. Rename the old version of the Stack to indicate that it should not be used. For example, <OriginalStackName> + " DO_NOT_USE".
    After upgrade, remove the compute instance's IP address from the ~/.ssh/known_hosts file, so that you can login to the compute node to start all the Oracle GoldenGate processes.