Table of contents

Installing Data Virtualization

A project administrator can install Data Virtualization on IBM® Cloud Pak for Data.

Permissions you need for this task
You must be an administrator of the OpenShift® project (Kubernetes namespace) where you will deploy Data Virtualization.
Information you need to complete this task
  • Data Virtualization requires a custom security context constraint (SCC). For details, see Creating required SCCs.
  • Data Virtualization must be installed in the same project as Cloud Pak for Data.
  • Data Virtualization requires the Cloud Pak for Data common core services. If the common core services are not installed in the project where you plan to install Data Virtualization, the common core services will be automatically installed when you install Data Virtualization, which will increase the amount of time the installation takes to complete.
  • Data Virtualization uses the following storage classes. If you don't use these storage classes on your cluster, ensure that you have a storage class with an equivalent definition:
    • OpenShift Container Storage: ocs-storagecluster-cephfs
    • NFS: managed-nfs-storage
    • Portworx: portworx-db2-rwx-sc
    • IBM Cloud File Storage: ibmc-file-gold-gid or ibm-file-custom-gold-gid

Before you begin

Ensure that the cluster meets the minimum requirements for installing Data Virtualization. For details, see System requirements.

Additionally, ensure that a cluster administrator completed the required Pre-installation tasks for your environment. Specifically, verify that a cluster administrator completed the following tasks:

  1. Cloud Pak for Data is installed. For details, see Installing Cloud Pak for Data.
  2. For environments that use a private container registry, such as air-gapped environments, the Data Virtualization software images are mirrored to the private container registry. For details, see Mirroring images to your container registry.
  3. The cluster is configured to pull the Data Virtualization software images. For details, see Configuring your cluster to pull images.
  4. The Data Virtualization operator subscription exists. For details, see Creating operator subscriptions.
  5. The security context constraints (SCCs) required to run Data Virtualization exists. For details, see Creating required SCCs.
  6. The node settings are adjusted for Data Virtualization. For details, see Changing required node settings.
  7. Run the following commands to ensure that you can install the Redis operator. This step is required for Db2® Data Management Console to be installed as part of the Data Virtualization installation.
    1. Log in to your Red Hat® OpenShift cluster as a cluster administrator.
      oc login OpenShift_URL:port
    2. Run this command to support watching multiple namespaces using the NamespaceScope operator.
      oc patch namespacescope common-service --type='json' -p='[{"op":"replace", 
      "path": "/spec/csvInjector/enable", 
      "value":true}]' -n ibm-common-services

If these tasks are not complete, the Data Virtualization installation will fail.

Procedure

Complete the following tasks to install Data Virtualization:

  1. Install the service.
  2. Verify the installation.
  3. Find out what to do next.

Installing the service

To install Data Virtualization:

  1. Log in to Red Hat OpenShift Container Platform as a user with sufficient permissions to complete the task:
    oc login OpenShift_URL:port
  2. You do not need to create a custom resource to install Data Virtualization. Data Virtualization uses the custom resource that is created by the Db2U operator when Data Virtualization is provisioned. The custom resources has the following format according to your environment:
    • The recommended storage class names are described in Setting up shared persistent storage.

      cat <<EOF |oc apply -f -
      apiVersion: db2u.databases.ibm.com/v1
      kind: DvService
      metadata:
        name: dv-service     # This is the recommended name, but you can change it
        namespace: project-name     # Replace with the project where you will install Data Virtualization
      spec:
        license:
          accept: true
          license: Enterprise|Standard     # Specify the license you purchased
        version: 1.7.0
        size: "small"                     # Default size
        docker_registry_prefix: "<docker_registry_prefix>"   # Where the customer cluster pulls down CP4D Docker images from
      EOF
    • Important: Use a storage class with attributes similar to the storage class described in the Service persistent storage requirements section of Storage requirements.
      cat <<EOF |oc apply -f -
      apiVersion: db2u.databases.ibm.com/v1
      kind: DvService
      metadata:
        name: dv-service     # This is the recommended name, but you can change it
        namespace: project-name     # Replace with the project where you will install Data Virtualization
      spec:
        license:
          accept: true
          license: Enterprise|Standard     # Specify the license you purchased
        version: 1.7.0
        size: "small"                     # Default size
        docker_registry_prefix: "<docker_registry_prefix>"                     # Where the customer cluster pulls down CP4D Docker images from
      EOF

Verifying the installation

When you create the Data Virtualization custom resource, the Data Virtualization operator processes the contents of the custom resource and starts up the microservices that comprise the Data Virtualization service, including the Data Virtualization addon and the Data Virtualization service provider. (The DvService microservice is defined by the dv-service custom resource.) Data Virtualization is installed when the DvService status is Completed.

To check the status of the installation:

  1. Change to the project where you installed Data Virtualization:
    oc project project-name
  2. Get the status of Data Virtualization (dv-service):
    • Run the following command:
      oc get dvservice dv-service

      The result is similar to the following example, where the READY field indicates whether the DvService is installed.

      NAME         READY
      dv-service   True
    • Alternatively, run the following command:
      oc get DvService dv-service -o jsonpath="{.status.reconcileStatus}"

      Data Virtualization is installed when the command returns Completed. You must now provision a Data Virtualization instance to use Data Virtualization. For more information, see Provisioning the service (Data Virtualization).

What to do next