Upgrading MongoDB from Version 4.8 to Version 5.1

An instance administrator can upgrade MongoDB from IBM Cloud Pak® for Data Version 4.8 to IBM Software Hub Version 5.1.

Who needs to complete this task?

Instance administrator To upgrade MongoDB, you must be an instance administrator. An instance administrator has permission to manage software in the following projects:

The operators project for the instance

The operators for this instance of MongoDB are installed in the operators project. In the upgrade commands, the ${PROJECT_CPD_INST_OPERATORS} environment variable refers to the operators project.

The operands project for the instance

The custom resources for the control plane and MongoDB are installed in the operands project. In the upgrade commands, the ${PROJECT_CPD_INST_OPERANDS} environment variable refers to the operands project.

When do you need to complete this task?

Review the following options to determine whether you need to complete this task:

  • If you want to upgrade the IBM Software Hub control plane and one or more services at the same time, follow the process in Upgrading an instance of IBM Software Hub instead.
  • If you didn't upgrade MongoDB when you upgraded the IBM Software Hub control plane, complete this task to upgrade MongoDB.

    Repeat as needed If you are responsible for multiple instances of IBM Software Hub, you can repeat this task to upgrade more instances of MongoDB on the cluster.

Information you need to complete this task

Review the following information before you upgrade MongoDB:

Version requirements

All the components that are associated with an instance of IBM Software Hub must be installed at the same release. For example, if the IBM Software Hub control plane is at Version 5.1.3, you must upgrade MongoDB to Version 5.1.3.

Environment variables
The commands in this task use environment variables so that you can run the commands exactly as written.
  • If you do not have the script that defines the environment variables, see Setting up installation environment variables.
  • To use the environment variables from the script, you must source the environment variables before you run the commands in this task. For example, run:
    source ./cpd_vars.sh

Before you begin

This task assumes that the following prerequisites are met:

Prerequisite Where to find more information
The cluster meets the minimum requirements for MongoDB. If this task is not complete, see System requirements.
The workstation from which you will run the upgrade is set up as a client workstation and has the following command-line interfaces:
  • IBM Software Hub CLI: cpd-cli
  • OpenShift® CLI: oc
 If this task is not complete, see Updating client workstations.
The IBM Software Hub control plane is upgraded. If this task is not complete, see Upgrading an instance of IBM Software Hub.
For environments that use a private container registry, such as air-gapped environments, the MongoDB software images are mirrored to the private container registry. If this task is not complete, see Mirroring images to a private container registry.
For environments that use a private container registry, such as air-gapped environments, the cpd-cli is configured to pull the olm-utils-v3 image from the private container registry. If this task is not complete, see Pulling the olm-utils-v3 image from the private container registry.
The operators required to use GPUs are installed. If this task is not complete, see Installing operators for services that require GPUs.
If you plan to use features that require GPUs, the operators required to use GPUs are installed. If this task is not complete, see Installing operators for services that require GPUs.
IBM App Connect in containers is upgraded, if needed. If this task is not complete, see Upgrading App Connect.

Procedure

Complete the following tasks to upgrade MongoDB:

  1. Upgrading the service
  2. Validating the upgrade
  3. Upgrading existing service instances
  4. What to do next

Upgrading the service

Important: The Operator Lifecycle Manager (OLM) objects for MongoDB were updated when you upgraded the IBM Software Hub platform. The cpd-cli manage apply-olm updates all of the OLM objects in the operators project at the same time.

To upgrade MongoDB:

  1. Log the cpd-cli in to the Red Hat® OpenShift Container Platform cluster:
    ${CPDM_OC_LOGIN}
    Remember: CPDM_OC_LOGIN is an alias for the cpd-cli manage login-to-ocp command.
  2. Update the custom resource for MongoDB.
    cpd-cli manage apply-cr \
--components=mongodb_cp4d \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--license_acceptance=true \
--upgrade=true

Validating the upgrade

MongoDB is upgraded when the apply-cr command returns:
[SUCCESS]... The apply-cr command ran successfully

If you want to confirm that the custom resource status is Completed, you can run the cpd-cli manage get-cr-status command:

cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--components=mongodb_cp4d

Upgrading MongoDB Ops Manager instances

Note: As of Cloud Pak for Data Version 5.0.2, the Ops Manager instances are automatically upgraded when you upgrade the MongoDB service. Hence, upgrading the Ops Manager instances is not required when you upgrade to Cloud Pak for Data Version 5.0.2 or a later 5.0 refresh.
Important: When you upgrade to Cloud Pak for Data Version 5.0.3 or a later 5.0 refresh, ensure to complete the following steps before you upgrade the MongoDB service instances:
  1. Log in to the Ops Manager user interface.
  2. Confirm whether all the agents are up to date. If you see the message "One or more agents are out of date", update all the agents by following the instructions in this tutorial.
  3. Update the agents for all the listed databases.
Note: If you want to upgrade your Ops Manager instances from a 6.x.y version to a 8.x.y version, you must first upgrade from version 6.x.y to 7.x.y and then upgrade from 7.x.y to 8.x.y. A direct upgrade from 6.x.y to 8.x.y is not supported. For more information, see Upgrade path

To upgrade a MongoDB Ops Manager instance:

  1. Login to Red Hat OpenShift Container Platform as an instance administrator.
    ${OC_LOGIN}
    Remember: OC_LOGIN is an alias for the oc login command.
  2. Get the list of MongoDB ops manager service instances:
    oc get CPDMongoDBOpsManager \
--namespace=${PROJECT_CPD_INST_OPERANDS}
  3. Set the MongoDB ops manager OPS_MGR_INSTANCE_NAME environment variable to the name of the service instance that you want to upgrade:
    export OPS_MGR_INSTANCE_NAME=<instance-name>
  4. Check the current version of the Ops Manager instance:
    oc get CPDMongoDBOpsManager ${OPS_MGR_INSTANCE_NAME} \
--namespace=${PROJECT_CPD_INST_OPERANDS}

    The command returns a response with the following format:

    NAME                        REPLICAS   VERSION   STATE (OPSMANAGER)   STATE (APPDB)   STATE (BACKUP)   AGE       WARNINGS
mongodb-om622-ops-manager   2          8.0.0    Running              Running         Disabled         7h59m
  5. Use the following table to determine whether you need to upgrade the Ops Manager instance:
    IBM Software Hub version Ops Manager version
    5.1.3 7.0.13, 8.0.3
    5.1.2 7.0.13, 8.0.3
    5.1.1 7.0.12, 8.0.2
    5.1.0 7.0.11, 8.0.0

    The supported version of the Ops Manager instance depends on the version of Cloud Pak for Data on your cluster.

  6. If you need to upgrade the Ops Manager instance, set the MongoDB ops manager OPS_MGR_INSTANCE_VERSION environment variable to the version that corresponds to the version of Cloud Pak for Data on your cluster: 
    export OPS_MGR_INSTANCE_VERSION=<version>
  7. Update the version in the MongoDB ops manager instance custom resource:
    oc patch CPDMongoDBOpsManager ${OPS_MGR_INSTANCE_NAME} \
--namespace=${PROJECT_CPD_INST_OPERANDS} \
--type=merge \
--patch="{\"spec\": {\"parameters\": {\"mgrversion\": \"${OPS_MGR_INSTANCE_VERSION}\"}, \"version\": \"${OPS_MGR_INSTANCE_VERSION}\"}}"
  8. Repeat the preceding steps to upgrade each ops manager instance in the operands project

Upgrading existing service instances

To upgrade the service instances:

  1. Log in to Red Hat OpenShift Container Platform as an instance administrator.
    ${OC_LOGIN}
    Remember: OC_LOGIN is an alias for the oc login command.
  2. Get the list of MongoDB service instances:
    oc get CPDMongoDb \
--namespace=${PROJECT_CPD_INST_OPERANDS}
  3. Set the INSTANCE_NAME environment variable to the name of the service instance that you want to upgrade:
    export INSTANCE_NAME=<instance-name>
  4. Set the INSTANCE_VERSION environment variable to the version that corresponds to the version of Cloud Pak for Data on your cluster:
    export INSTANCE_VERSION=<version>

    Use the following table to determine the appropriate value:

    IBM Software Hub version Service instance versions
    (Pick one)
    5.1.3 7.0.16-ent, 8.0.4-ent
    5.1.2 7.0.16-ent, 8.0.4-ent
    5.1.1 7.0.15-ent, 8.0.3-ent
    5.1.0 7.0.14-ent, 8.0.0-ent
    Important: If you want to upgrade your MongoDB service instances from a 5.x.y version to a 7.x.y version, you must first upgrade from version 5.x.y to 6.x.y and then upgrade from 6.x.y to 7.x.y.
  5. Update the version in the service instance custom resource:
    oc patch CPDMongoDb ${INSTANCE_NAME} \
--namespace=${PROJECT_CPD_INST_OPERANDS} \
--type=merge \
--patch="{\"spec\": {\"parameters\": {\"mdbversion\": \"${INSTANCE_VERSION}\", \"opsmgrversion\": \"${OPS_MGR_INSTANCE_VERSION}\"}, \"version\": \"${INSTANCE_VERSION}\"}}"
  6. Repeat the preceding steps to upgrade each service instance in the operands project.

What to do next

Your existing MongoDB database instances are ready to use. See Post-installation setup for the MongoDB service for more information.