Adding a database instance to an Azure Redhat OpenShift (ARO) cluster using the Db2 Operator

Use the information in the following tables to determine the size requirements of your Db2 or Db2 Warehouse instance. Based on your selection, go to the list of Azure VM instance types to find the Azure VM instance type that's right for your database deployment. In addition to the sizing values shown in the tables, the instance type list shows other factors to consider, such as cost and region. 

For Online Transactional Processing (OLTP) database workloads, choose an instance from the General Purpose or Memory Optimized categories. 

Table 1. Sizing guidelines for Db2 OLTP on ARO systems:

This document describes configuring OpenShift Data Foundation (ODF) as the storage solution for Db2u. ODF requires a minimum of  three nodes and can currently only be installed using internal mode. 

Resource requirements for basic services: 

• 30 CPU (logical) 

• 72 GB memory 

• 3 storage devices 

Refer to the Red Hat ODF planning your deployment documentation for understanding resource requirements. 

• NUM_NODES: The minimum number of VM nodes for the Azure cluster: 

  • For single-partition Db2 instances, use  3.

    export NUM_NODES=3

  • For single-partition Db2 Warehouse instances, use  3. 

    export NUM_NODES=3

  • For multi-partition (small) Db2 Warehouse instances, use 6. 

    export NUM_NODES=6

  • NOTE: Single-partition Db2 instances only require one node. In this case, the minimum number of nodes is set to 3 to support ODF installation. 

• NODE_VM_DISK_SIZE: The worker node disk size in Gigabytes (per node). This should be determined in sizing based on the number of nodes, workload size and the kind of storage that is being installed. This tutorial uses ODF as the storage provider and its corresponding requirements.

  export NODE_VM_DISK_SIZE=1024

Create an Azure account 

Before you begin to create your Azure cluster, you need to have an Azure account. 

1. From a web browser, go to https://azure.microsoft.com/. 

2. Follow the online instructions. 
   NOTE: You will be contacted by phone and be required to enter a verification code on your phone keypad.

Sign in with Azure CLI 

Azure provides numerous authentication methods. We describe the two most common methods bellow. 

• Interactively using device code flow which will open a browser page with the one-time-passcode (OTP) that you can enter into the CLI terminal to complete the login process: 

  az login

• Non-interactively by providing the credentials in the CLI command: 

  az login – u <user> -p <password>

Refer to Azure topic Sign in with Azure CLI for details on all the supported authentication methods. 

az aro create \ 
      --resource-group ${RESOURCE_GROUP} \ 
      --name ${ARO_CLUSTER} \ 
      --client-id ${appID} \ 
      --client-secret ${appPassword} \ 
      --vnet ${ARO_VNET} \ 
      --master-subnet ${ARO_MASTER_SUBNET} \ 
      --worker-subnet ${ARO_WORKER_SUBNET} \ 
      --worker-count ${NUM_NODES} \ 
      --worker-vm-size ${NODE_VM_SIZE} \ 
      --worker-vm-disk-size-gb ${NODE_VM_DISK_SIZE} \ 
      --pull-secret @path-to-redhat-pull-secret.txt 

oc login ${url} -u ${kube_user} -p ${kube_password}

1. Log in to your ARO cluster. 
2. Install the ibm-db2uoperator-catalog in the namespace where openshift-marketplace is installed: 

   cat << EOF | oc apply -f -
   apiVersion: operators.coreos.com/v1alpha1
   kind: CatalogSource
   metadata:
     name: ibm-db2uoperator-catalog
     namespace: openshift-marketplace
   spec:
     displayName: IBM Db2U Catalog
     image: icr.io/cpopen/ibm-db2uoperator-catalog@sha256:d8b79c87951e3c6659a5901f8e85136cc803b8553e7c05e77a1031704906519b
     publisher: IBM
     sourceType: grpc
     updateStrategy:
       registryPoll:
         interval: 45m
   EOF
   

3. Create a namespace for installing the Db2 operator: 

   cat <<EOF | oc apply -f - 
   apiVersion: v1 
   kind: Namespace 
   metadata: 
     name: ${NAMESPACE} 
   spec: {} 
   EOF 

4. Install an operator group in the namespace: 

   cat << EOF | oc apply -f -  
   apiVersion: operators.coreos.com/v1  
   kind: OperatorGroup  
   metadata:  
     name: db2u-operator-group  
     namespace: ${NAMESPACE}  
   spec:  
     targetNamespaces:  
     - ${NAMESPACE}  
   EOF  

5. Create a subscription in the namespace to deploy the Db2 operator: 

   cat << EOF | oc create -f -
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: ibm-db2uoperator-catalog-subscription
     namespace: ${NAMESPACE}
     generation: 1
   spec:
     channel: v110508.0
     name: db2u-operator
     installPlanApproval: Automatic
     source: ibm-db2uoperator-catalog
     sourceNamespace: olm
     startingCSV: db2u-operator.v110508.0.0
   EOF

6. Check that the db2u-operator pod is deployed: 

   oc get pods -n ${NAMESPACE} | grep db2u-operator 

7. After the db2u-operator pod is up and running, run the YAML code to deploy your database instance. 
   Choose from the following: 

   • YAML for the Db2 instance.
   • YAML for the single-partition Db2 Warehouse instance.
   • YAML for the multi-partition Db2 Warehouse instance.

   Parameters common to this code include:

   Parameters common to this code include:

   Field	Values  (with examples)	Description
   metadata.name	db2oltp-test	The name of the Db2uCluster CR.
   metadata.namespace	db2u	The namespace where the database instance will be deployed.
   .spec.size	1	The number of Db2 nodes.  For single-partition Db2 and Db2 Warehouse instances, the value is 1; For multi-partition Db2 Warehouse instances, the value can be 2 or greater.
   .spec.environment.database.name	BLUDB	The database name for the instance.
   .spec.environment.dbType	db2oltp	Accepted values: db2wh, db2oltp.
   .spec.environment.ldap.enabled	false	To enable LDAP, set this to true.
   .spec.license.accept	true	This is a required value that must be set to true.
   .spec.podConfig.resource.db2u.limits.cpu	"2"	The CPU limits for the db2u engine pods. Limits and request are set to the same value (which is the expected value).
   .spec.podConfig.resource.db2u.limits.memory	8Gi	The memory limits for the db2u engine pods. Limits and request are set to same value (which is the expected value).
   .spec.version	s11.5.8.0	The Db2u version that the operator supports. The value in the left column is the latest release.
   .spec.storage	[]	An array of storage configurations. This is the required storage configuration for meta and data (or shared).

8. Check the status of your Db2uCluster: 

   oc get db2ucluster -n ${NAMESPACE} ${DB2U_CLUSTER}

   DB2U_CLUSTER is the name value set in the metadata section of the YAML code. For example, 

   name: db2oltp-test

   NOTE: You can define an alternate value for name by using the db2ucluster custom resource. 
9. When the STATE value returned is Ready, the instance is deployed successfully. 

   oc -n ${NAMESPACE} get db2ucluster ${DB2U_CLUSTER} 
   NAME                      STATE   MAINTENANCESTATE          AGE 
   db2-001234567890          Ready         None               6h8m 

10. Log on to the database engine pod as db2inst1: 

    oc -n ${NAMESPACE} exec -it $(oc get pods -n ${NAMESPACE} | grep ${DB2U_CLUSTER}-db2u-0 | awk '{print $1}') -- su - db2inst1 

11. Connect to the database bludb on your Azure cluster: 

    db2 connect to bludb

    NOTE: While we are using the database name bludb for this tutorial, you can change this name by using the db2ucluster custom resource. 

cat <<EOF | oc apply -f - 
apiVersion: v1 
kind: Service 
metadata: 
  name: ${LOAD_BALANCER_SVC} 
  namespace: ${NAMESPACE} 
spec: 
  ports: 
  - port: 50000 
    protocol: TCP 
    targetPort: 50000 
  selector: 
    app: ${DB2U_CLUSTER} 
    component: db2wh 
    formation_id: ${DB2U_CLUSTER} 
    role: db 
    type: engine 
  externalTrafficPolicy: Local 
  type: LoadBalancer 
EOF 

oc get svc -n ${NAMESPACE} | grep ${LOAD_BALANCER_SVC} 
lb-db2-demo-eastus-001               LoadBalancer   10.0.247.179
20.127.178.10
50000:30856/TCP
     14d d 

curl -kv 20.127.178.10:50000 
*   Trying 20.127.178.10:50000... 
* Connected to 20.127.178.10 (20.127.178.10) port 50000 (#0) 
> GET / HTTP/1.1 
> Host: 20.127.178.10:50000 
> User-Agent: curl/7.79.1 
> Accept: */*