Installing MongoDB

An instance administrator can install MongoDB on IBM Cloud Pak for Data Version 5.0.

Who needs to complete this task?

Instance administrator To install MongoDB, you must be an instance administrator. An instance administrator has permission to install 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 installation 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 installation 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 install multiple services at the same time, follow the process in Running a batch installation of solutions and services instead.
  • If you didn't install MongoDB as part of a batch installation, complete this task to add MongoDB to your environment.

    Repeat as needed If you are responsible for multiple instances of Cloud Pak for Data, you can repeat this task to install more instances of MongoDB on the cluster.

Information you need to complete this task

Review the following information before you install MongoDB:

Version requirements

All of the components that are associated with an instance of Cloud Pak for Data must be installed at the same release. For example, if the Cloud Pak for Data control plane is installed at Version 5.0.3, you must install MongoDB at Version 5.0.3.

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, run:
    source ./cpd_vars.sh
Security context constraint

MongoDB works with the default Red Hat® OpenShift® Container Platform security context constraint, restricted-v2.

Storage requirements
You don't need to specify storage information when you install MongoDB. However, you do need to specify storage when you provision an instance of 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 installing MongoDB. If this task is not complete, see System requirements.
The workstation from which you will run the installation is set up as a client workstation and includes the following command-line interfaces:
  • Cloud Pak for Data CLI: cpd-cli
  • OpenShift CLI: oc
If this task is not complete, see Setting up a client workstation.
The Cloud Pak for Data control plane is installed. If this task is not complete, see Installing an instance of Cloud Pak for Data.
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-v2 image from the private container registry.
The load balancer timeout settings are adjusted for MongoDB. If this task is not complete, see Changing load balancer settings.
The process IDs limit setting is adjusted for MongoDB. If this task is not complete, see Changing the process IDs limit.
The kernel parameter settings are adjusted for MongoDB. If this task is not complete, see Changing kernel parameter settings.
The simultaneous multithreading (SMT) settings for Kernel-based Virtual Machine (KVM) capable systems and big core PowerVM capable systems are adjusted, if applicable. If this task is not complete, see Changing Power settings.
The operators that are 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 that are 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 installed and configured. If this task is not complete, see Installing App Connect in containers.

Procedure

Complete the following tasks to install MongoDB:

  1. Installing the service
  2. Validating the installation
  3. What to do next

Installing the service

To install 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. Run the following command to create the required OLM objects for MongoDB in the operators project for the instance:
    cpd-cli manage apply-olm \
    --release=${VERSION} \
    --cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
    --components=mongodb_cp4d
    Wait for the cpd-cli to return the following message before you proceed to the next step:
    [SUCCESS]... The apply-olm command ran successfully

    If the apply-olm fails, see Troubleshooting the apply-olm command during installation or upgrade.

  3. Create 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

Validating the installation

MongoDB is installed 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

What to do next

You must complete Post-installation setup for the MongoDB service before users can access MongoDB instances.