Installing Data Virtualization

An instance administrator can install Data Virtualization on IBM Software Hub Version 5.2.

Important: Data Virtualization is not supported on Red Hat® OpenShift® Container Platform Version 4.12. You must ensure your cluster is running Red Hat OpenShift Container Platform Version 4.14 or later.
Who needs to complete this task?

Instance administrator To install Data Virtualization, 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 Data Virtualization 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 Data Virtualization are installed in the operands project.

In the installation commands, the ${PROJECT_CPD_INST_OPERANDS} environment variable refers to the operands project.

The tethered projects for the instance

After you install Data Virtualization, you can deploy Data Virtualization service instances to the operands project or to projects that are tethered to the operands project.

Note:

You can run only one Data Virtualization instance in a project. You can run multiple instances of Data Virtualization for the same IBM Software Hub instance by setting up tethered projects and then provisioning one Data Virtualization instance in each of the tethered projects. For information about setting up tethered projects, see Tethering projects to the IBM Software Hub control plane.

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 Data Virtualization as part of a batch installation, complete this task to add Data Virtualization to your environment.

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

Information you need to complete this task

Review the following information before you install Data Virtualization:

Version requirements

All of 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 installed at Version 5.2.2, you must install Data Virtualization at Version 5.2.2.

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

Data Virtualization requires a custom security context constraint (SCC). For more information, see Creating custom security context constraints for services.

Common core services

Data Virtualization requires the IBM Software Hub common core services.

If the common core services are not installed in the operands project for the instance, the common core services are automatically installed when you install Data Virtualization. The common core services installation increases the amount of time the installation takes to complete.

Storage requirements
You don't need to specify storage information when you install Data Virtualization. However, you do need to specify storage when you provision an instance of Data Virtualization.

Before you begin

This task assumes that the following prerequisites are met:

System requirements
This task assumes that the cluster meets the minimum requirements for Data Virtualization.
Where to find more information
If this task is not complete, see System requirements.
Workstation
This task assumes that the workstation from which you will run the installation is set up as a client workstation and has the following command-line interfaces:
  • IBM Software Hub CLI: cpd-cli
  • OpenShift CLI: oc
Where to find more information
If this task is not complete, see Setting up a client workstation.
Control plane
This task assumes that the IBM Software Hub control plane is installed.
Where to find more information
If this task is not complete, see Installing an instance of IBM Software Hub.
Private container registry
If your environment uses a private container registry (for example, your cluster is air-gapped), this task assumes that the following tasks are complete:
  1. The Data Virtualization software images are mirrored to the private container registry.
    Where to find more information
    If this task is not complete, see Mirroring images to a private container registry.
  2. The cpd-cli is configured to pull the olm-utils-v3 image from the private container registry.
    Where to find more information
    If this task is not complete, see Pulling the olm-utils-v3 image from the private container registry.
Custom SCC
This task assumes that the custom security context constraint (SCC) for Data Virtualization exists.
Where to find more information
If this task is not complete, see Creating custom security context constraints for services.
Process IDs limit
The process IDs limit setting is adjusted for Data Virtualization.
Where to find more information
If this task is not complete, see Changing the process IDs limit.
Kernel parameters
The kernel parameter settings are adjusted for Data Virtualization.
Where to find more information
If this task is not complete, see Changing kernel parameter settings.

Prerequisite services

Before you install Data Virtualization, ensure that the following services are installed and running:

  • Db2 Data Management Console: If you do not manually install Db2 Data Management Console, Data Virtualization installs it for you. If you have already installed Db2 Data Management Console, make sure that a Db2 Data Management Console instance has been provisioned. For more information, see Installing Db2 Data Management Console.

Procedure

Complete the following tasks to install Data Virtualization:

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

Installing the service

To install Data Virtualization:

  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 Data Virtualization in the operators project for the instance:
    cpd-cli manage apply-olm \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--components=dv
    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 Data Virtualization.
    cpd-cli manage apply-cr \
--components=dv \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--license_acceptance=true

Validating the installation

Data Virtualization 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=dv

What to do next

Your next steps depend on the version of IBM Software Hub that you installed:

Version 5.2.1 or later
  1. Complete Post installation set-up for Data Virtualization.

After you complete the preceding steps, Data Virtualization is ready to use.

Version 5.2.0
  1. Install the services that you need on this instance of IBM Software Hub
  2. Apply the IBM Software Hub Version 5.2.0 - Day 0 patch

    You must apply the patch to each instance of IBM Software Hub Version 5.2.0 that you install.

  3. Post installation set-up for Data Virtualization

After you complete the preceding steps, Data Virtualization is ready to use.