Data Virtualization Deployment¶

DV Deployment on-premises¶

Here we document the deployment of Data Virtualization in an on-premises environment running RedHat OpenShift v4.6 or higher.

CP4D-topology

We start with a large RedHat OpenShift cluster with 3 Master nodes and 5 Worker nodes, deployed on-prem and then install the base Cloud Pak for Data as described in "cpd_onprem.md".

1 - Prereqs¶

Provision a Large OCP+ Cluster from Technology Zone
Select Reserve now for immediate provisioning of cluster.
Fill the form and Submit.
Check the status of the cluster from My library > My reservations on the top left corner of your Technology Zone dashboard.
Once the Status of your cluster is Ready, open the cluster tile from My reservations page, note down the URL for RedHat OpenShift web console, load balancer IP address and the password to the cluster. Your username is kubeadmin.

Login to your cluster using oc CLI

oc login -u kubeadmin -p <password> api.<clustername>.cp.fyre.ibm.com:6443

or using token obtained from RedHat OpenShift web console

oc login --token=<token> --server=https://api.<clustername>.cp.fyre.ibm.com:6443

Set up local storage operator as per these instructions.
Set up OpenShift Container Storage as per these instructions.

2 - Sealed Secrets¶

Create the sealed-secrets project. This project will host the Sealed Secrets operator that will allow us to decrypt sealed secrets stored in GitHub.
```
oc new-project sealed-secrets
```
Download the private key sealed-secrets-ibm-demo-key.yaml used to seal any secret contained in this demonstration and apply it to the cluster. In our case, we have included a demo IBM Entitlement Key within the GitOps GitHub repository so that we are able to pull down IBM Software.
```
oc apply -f sealed-secrets-ibm-demo-key.yaml
```

Delete the pod

oc delete pod -n sealed-secrets -l app.kubernetes.io/name=sealed-secrets

IMPORTANT WARNING: DO NOT CHECK THE FILE INTO GIT

The private key MUST NOT be checked into GitHub under any circumstances. Please, remove the private key from your workstation to avoid any issues.
```
rm sealed-secrets-ibm-demo-key.yaml
```

For Cloud Pak to consume the entitlement key, restart the Platform Navigator pods

oc delete pod -n tools -l app.kubernetes.io/name=ibm-integration-platform-navigator

3 - RedHat OpenShift GitOps Operator¶

Clone the following GitHub repository that contains the GitOps structure that the Cloud Native Toolkit GitOps Framework understands.
```
git clone https://github.com/cloud-native-toolkit-demos/multi-tenancy-gitops-cp4d.git
```
Change directory into multi-tenancy-gitops-cp4d.
```
cd multi-tenancy-gitops-cp4d
```
Install the RedHat OpenShift GitOps operator on your RedHat OpenShift cluster and wait for it to be available:
- If your RedHat OpenShift cluster version is 4.6
```
oc apply -f setup/ocp46/
while ! kubectl wait --for=condition=Established crd applications.argoproj.io; do sleep 30; done
```
- If your RedHat OpenShift cluster version is 4.7
```
oc apply -f setup/ocp47/
while ! kubectl wait --for=condition=Established crd applications.argoproj.io; do sleep 30; done
```
Once the above command returns, you can open your RedHat OpenShift Web Console and check out that the RedHat OpenShift GitOps operator has been successfully installed in the openshift-gitops project.

As you can see in the image, the RedHat OpenShift GitOps operator also installs the RedHat OpenShift Pipelines operator and ArgoCD (which will be that GitOps tool that synchronizes the Infrastructure/Configuration as Code we have stored in GitHub with the state of the RedHat OpenShift cluster).

Important

The RedHat OpenShift Pipelines operator gets installed by the RedHat OpenShift GitOps Subscription only for RedHat OpenShift version 4.6. If your RedHat OpenShift cluster is version 4.7, you will need to install the RedHat OpenShift Pipelines operator as part of the GitOps process explained in this section. For getting such RedHat OpenShift Pipelines operator installed, you would need to specify that in the kustomize.yaml file for the services layer here.

Once ArgoCD is deployed, get the admin password

If your RedHat OpenShift cluster version is 4.6

oc extract secrets/argocd-cluster-cluster --keys=admin.password -n openshift-gitops --to=-

If your RedHat OpenShift cluster version is 4.7

oc extract secrets/openshift-gitops-cluster --keys=admin.password -n openshift-gitops --to=-

Open the ArgoCD web console by clicking on the ArgoCD console link you can see at the top of your RedHat OpenShift web console and log in.
Once you login, you should see that your ArgoCD web console is empty as we have not deployed any Argo Application yet.

4 - IBM Cloud Pak for Data¶

Install the ArgoCD Bootstrap Application
```
oc apply -n openshift-gitops -f 0-bootstrap/argocd/bootstrap.yaml
```
This ArgoCD Bootstrap Application will bootstrap the deployment of IBM Cloud Pak for Data based on the configuration you have defined in the GitOps GitHub repository we cloned earlier. You can see that we integrate Kustomize for configuration management in the GitOps approach.

As soon as you create this ArgoCD Bootstrap Application, the rest of the ArgoCD Applications and the respective RedHat Openshift resources these manage start to get created as a result of the synchronization process the GitOps approach is based on. You can see these ArgoCD Applications being created in the ArgoCD web console.
If you go to the Operators > Installed Operators section of your RedHat OpenShift cluster web console and select the ibm-common-services project in the Project drop down list at the top, you should see that the Cloud Pak for Data Operator has been successfully installed as well as the IBM Cloud Pak foundational services.
If you go to the Home > Search section of your RedHat OpenShift cluster web console and select the cloudpak project in the Project drop down list at the top, since in our Cloud Pak for Data GitOps process we have configured the IBM Cloud Pak for Data instance to be deployed in the cloudpak project, and search for ZenService in Resources, you should see ZenService listed.
Select the listed ZenService resource and you should see lite-cr listed.
Click on the lite-cr link and you should see it Running and Successful.
If you go back to the ArgoCD web console, you should see all of the Argo Application in green.

5 - IBM Cloud Pak for Data UI¶

Let's make sure that our IBM Cloud Pak for Data instance is up and running. Do that by logging into the IBM Cloud Pak for Data user interface.

Obtain IBM Cloud Pak for Data console URL by executing

echo https://`oc -n cloudpak get ZenService lite-cr -o jsonpath="{.status.url}{'\n'}"`

Open the URL in a browser and you will be presented with the IBM Cloud Pak for Data user interface login option. Enter admin as username.

Obtain admin password by executing

oc -n cloudpak extract secret/admin-user-details --keys=initial_admin_password --to=-

Log into the IBM Cloud Pak for Data UI using the password from previous step.
Click on the navigation menu icon on the top left corner. Click on Services menu option to expand it, then select Services catalog.
The various services installed with IBM Cloud Pak for Data will be displayed.

That is it to get a working instance of IBM Cloud Pak for Data.

6 - Data Virtualization¶

Now we install Data Virtualization.

Enable patch update

oc patch NamespaceScope common-service \
-n ibm-common-services \
--type=merge \
--patch='{"spec": {"csvInjector": {"enable": true} } }'

Install db2u Operator Subscription

cat <<EOF |oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
    name: ibm-db2u-operator
    namespace: ibm-common-services # Pick the project that contains the Cloud Pak for Data operator
spec:
    channel: v1.1
    name: db2u-operator
    installPlanApproval: Automatic
    source: ibm-operator-catalog
    sourceNamespace: openshift-marketplace
EOF

Install Data Virtualization Operator Subscription

cat <<EOF |oc apply -f -
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
    name: ibm-dv-operator-catalog-subscription
    namespace: ibm-common-services    # Project that contains the Cloud Pak for Data operator
spec:
    channel: v1.7
    installPlanApproval: Automatic
    name: ibm-dv-operator
    source: ibm-operator-catalog
    sourceNamespace: openshift-marketplace
EOF

Install Data Virtualization CR

cat <<EOF |oc apply -f -
apiVersion: db2u.databases.ibm.com/v1
kind: DvService
metadata:
    name: dv-service     # This is the recommended name for DV CR
    namespace: cpd-instance     # Project where you will install Data Virtualization
spec:
    license:
        accept: true
    license: Enterprise     # Specify the license you purchased
    version: 1.7.2
    size: "medium"                     # Default size
EOF

After everything is completely configured you can go to the Red Hat OpenShift Console and under Operators->Installed Operators you should see the operators related to Data Virtualization.

CPD DV

Data Virtualization requires kernel parameters and CRI-O configuration settings to be updated.

7 - Verifying the Installation¶

Confirm DataVirtualization subscription was triggered

oc get sub -n ibm-common-services ibm-dv-operator-catalog-subscription \
-o jsonpath='{.status.installedCSV} {"\n"}'

Confirm DataVirtualization CSV is ready

oc get csv -n ibm-common-services ibm-dv-operator.v1.7.2 \
-o jsonpath='{ .status.phase } : { .status.message} {"\n"}'

Confirm DataVirtualization Operator is ready

oc get deployments -n ibm-common-services -l olm.owner="ibm-dv-operator.v1.7.2" \
-o jsonpath="{.items[0].status.availableReplicas} {'\n'}"

Get status of DataVirtualization service
```
oc get dvservice dv-service
```
Check if DataVirtualization service finished
```
oc get DvService dv-service -o jsonpath="{.status.reconcileStatus}"
```
Data Virtualization service is ready when the command returns Completed.

6 - Data Virtualization UI¶

If you haven't logged into the CP4D UI before, get the URL of the Cloud Pak for Data web client and open it in a browser.
```
echo https://`oc get ZenService lite-cr -n tools -o jsonpath="{.status.url}{'\n'}"`
```
The credentials for logging into the Cloud Pak for Data web client are admin/<password> where password is stored in a secret.
```
oc extract secret/admin-user-details -n tools --keys=initial_admin_password --to=-
```
Enter the user ID and password on the login screen.
After you log into the IBM Cloud Pak for Data UI using the password from previous step, you will see the Welcome screen.
Click on the navigation menu icon on the top left corner. Click on Services menu option to expand it, then select Services catalog.
Under Status, select "Enabled" to display only the services that are installed and enabled in Cloud Pak for Data.

You will see the Data Virtualization that says Enabled along with other enabled services.