Upgrading MongoDB from Version 4.5 to Version 4.6

A project administrator can upgrade MongoDB from Cloud Pak for Data Version 4.5 to Version 4.6.

What permissions do you need to complete this task?

The permissions that you need depend on which tasks you must complete:

To update the MongoDB operators, you must have the appropriate permissions to create operators and you must be an administrator of the project where the Cloud Pak for Data operators are installed. This project is identified by the ${PROJECT_CPD_OPS} environment variable.
To upgrade MongoDB, you must be an administrator of the project where MongoDB is installed. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.

When do you need to complete this task?: If you didn't upgrade MongoDB when you upgraded the platform to Version 4.6, you can complete this task to upgrade your existing MongoDB installation.
If you want to upgrade all of the Cloud Pak for Data components at the same time, follow the process in Upgrading the platform and services instead.

Important: All of the Cloud Pak for Data components in a deployment must be installed at the same release.

Information you need to complete this task

Review the following information before you upgrade MongoDB:

Environment variables

The commands in this task use environment variables so that you can run the commands exactly as written.

If you don't 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:
```
source ./cpd_vars.sh
```

Installation location: MongoDB is installed in the same project (namespace) as the Cloud Pak for Data control plane. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.

Storage requirements: You don't need to specify storage when you upgrade MongoDB.

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 the `cpd-cli` has the latest version of the `olm-utils-play` image.	If this task is not complete, see Setting up a client workstation.
The Cloud Pak for Data control plane is upgraded.	If this task is not complete, see Upgrading the platform and services.
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.

Procedure

Complete the following tasks to upgrade MongoDB:

Logging in to the cluster

To run cpd-cli manage commands, you must log in to the cluster.

Run the cpd-cli manage login-to-ocp command to log in to the cluster as a user with sufficient permissions to complete this task. For example:
```
cpd-cli manage login-to-ocp \
--username=${OCP_USERNAME} \
--password=${OCP_PASSWORD} \
--server=${OCP_URL}
```
Tip: The login-to-ocp command takes the same input as the oc login command. Run oc login --help for details.

Updating the operator

The MongoDB operator simplifies the process of managing the MongoDB service on Red Hat® OpenShift® Container Platform.

To upgrade MongoDB, ensure that all of the Operator Lifecycle Manager (OLM) objects in the ${PROJECT_CPD_OPS} project, such as the catalog sources and subscriptions, are upgraded to the appropriate release. All of the OLM objects must be at the same release.

Who needs to complete this task?: You must be a cluster administrator (or a user with the appropriate permissions to install operators) to create the OLM objects.

When do you need to complete this task?: Complete this task only if the OLM artifacts have not been updated for the current release using the cpd-cli manage apply-olm command with the --upgrade=true option.
It is not necessary to run this command multiple times for each service that you plan to upgrade. If you complete this task and the OLM artifacts already exist on the cluster, the cpd-cli will recreate the OLM objects for all of the existing components in the ${PROJECT_CPD_OPS} project.

To update the operator:

Update the OLM objects:
```
cpd-cli manage apply-olm \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_OPS} \
--upgrade=true
```
- If the command succeeds, it returns [SUCCESS]... The apply-olm command ran successfully.
- If the command fails, it returns [ERROR] and includes information about the cause of the failure.

What to do next: Upgrade the MongoDB service.

Upgrading the service

After the MongoDB operator is updated, you can upgrade MongoDB.

Who needs to complete this task?: You must be an administrator of the project where MongoDB is installed.

When do you need to complete this task?: Complete this task for each instance of MongoDB that is associated with an instance of Cloud Pak for Data Version 4.6.

To upgrade the service:

Update the custom resource for MongoDB.

cpd-cli manage apply-cr \
--components=mongodb_cp4d \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--license_acceptance=true \
--upgrade=true

Validating the upgrade

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

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

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

Upgrading a MongoDB instance to a newer version

To upgrade a MongoDB instance, modify the version field in the custom resource. The version specified must be within the same major release. Service instances do not need to be upgraded as part of upgrading the MongoDB service.

apiVersion: mongodb.cpd.ibm.com/v1
kind: CPDMongoDBInstance
metadata:
name: <cpdmongodb-sample>     #replace with your instance name
spec:
  license:
    accept: true
  opsManager: <ops_manager_name>     #replace with your ops manager instance name
  replicas: 1
  storageSize: "2G"
  version: "4.2.6"
  storageClass: managed-nfs-storage
  dedicated: false
  resources:
    requests:
      memory: 4Gi
      cpu: 1
    limits:
      memory: 4Gi
      cpu: 1

What to do next

Review the tasks in Post-installation setup for the MongoDB service to determine whether any need to be completed before users can access the MongoDB service.