Installing IBM Match 360 with Watson

A project administrator can install IBM Match 360 with Watson 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 IBM Match 360 with Watson.

Information you need to complete this task

IBM Match 360 with Watson needs only the restricted security context constraint (SCC).
IBM Match 360 with Watson must be installed in the same project as Cloud Pak for Data.
IBM Match 360 with Watson 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 IBM Match 360 with Watson, the common core services will be automatically installed when you install IBM Match 360 with Watson, which will increase the amount of time the installation takes to complete.
IBM Match 360 with Watson 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:
  - For foundation data: ocs-storagecluster-ceph-rbd
  - For shared volumes: ocs-storagecluster-cephfs
- IBM Spectrum®: ibm-spectrum-scale-sc
- NFS: managed-nfs-storage
- Portworx:
  - portworx-shared-gp3
  - portworx-elastic-sc
- IBM Cloud File Storage: ibmc-file-gold-gid
Important: If you use OpenShift Container Storage, the persistence.storage_class must support block storage. Because block storage only supports read-write once (RWO) permissions, you must additionally define a storage class for shared volumes (shared_persistence.storage_class) that supports read-write-execute (RWX) permissions such as ocs-storagecluster-cephfs.

Tip: Your storage class names can differ from those listed here. Determine an appropriate storage class name based on the information provided in Storage requirements.
To deploy multiple instances of IBM Match 360 with Watson on a single cluster, ensure that the following conditions are met:
- Each IBM Match 360 instance must have its own full stack of dependencies, including the Cloud Pak for Data platform, core common services or IBM Watson™ Knowledge Catalog, and all other service dependencies.
- Each IBM Match 360 custom resource must define a unique value for the spec.aspera.port property. By default, this port is set to 31000, but if you have multiple service instances installed in the cluster, you cannot use the default value for more than one instance.

Before you begin

Ensure that the cluster meets the minimum requirements for installing IBM Match 360 with Watson. 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:

Cloud Pak for Data is installed. For details, see Installing Cloud Pak for Data.
For environments that use a private container registry, such as air-gapped environments, the IBM Match 360 with Watson software images are mirrored to the private container registry. For details, see Mirroring images to your container registry.
The cluster is configured to pull the IBM Match 360 with Watson software images. For details, see Configuring your cluster to pull images.
Services are enabled to use namespace scoping with third-party operators. For details, see Enabling services to use namespace scoping with third-party operators.
The IBM Match 360 with Watson catalog source exists. For details, see Creating catalog sources.
The IBM Match 360 with Watson operator subscription exists. For details, see Creating operator subscriptions.

If these tasks are not complete, the IBM Match 360 with Watson installation will fail.

Prerequisite services

Before you install IBM Match 360 with Watson, ensure that the following services are installed and running:

To enable the profiling and automapping features of IBM Match 360 with Watson, you must install IBM Watson Knowledge Catalog. If Watson Knowledge Catalog is not installed, profiling and automapping will not work.

Procedure

Complete the following tasks to install IBM Match 360 with Watson:

Installing the service
Verifying the installation
Choosing a service upgrade plan
What to do next

Installing the service

To install IBM Match 360 with Watson:

Log in to Red Hat® OpenShift Container Platform as a user with sufficient permissions to complete the task:
```
oc login OpenShift_URL:port
```
Create a MasterDataManagement custom resource to install IBM Match 360 with Watson.
Important: By creating a MasterDataManagement custom resource with spec.license.accept: true, you are accepting the license terms for IBM Match 360 with Watson. You can find links to the relevant licenses in IBM Cloud Pak for Data License Information.

Tip: For additional properties that you can specify in the custom resource, see Additional installation options.

The cluster uses custom storage class names

Important: Use a storage class with attributes similar to the storage class described in the Service persistent storage requirements section of Storage requirements.

Create a custom resource with the following format.
```
cat <<EOF |oc apply -f -
apiVersion: mdm.cpd.ibm.com/v1
kind: MasterDataManagement
metadata:
  name: mdm-cr     # This is the recommended name, but you can change it
  namespace: project-name     # Replace with the project where you will install IBM Match 360 with Watson
spec:
  license:
    accept: true
    license: Enterprise | Standard     # Specify the license you purchased
  version: 1.1.278
  persistence:
    storage_class: storage-class-name     # See the guidance in "Information you need to complete this task"
    storage_vendor: storage-vendor-name     # Specify the storage vendor (ocs | portworx). Include this only for OCS or Portworx
  common_core_services:
    enabled: true
EOF
```
Important: If you are using OCS storage or if the persistence.storage_class does not support RWX permissions, you must additionally include the following lines in the spec section to define a storage class for shared volumes that supports RWX, such as ocs-storagecluster-cephfs.
```
  shared_persistence:     # Include this if persistence.storage_class does not support RWX
    storage_class: storage-class-name-rwx     # Include this if persistence.storage_class does not support RWX
```
For more information, see the guidance in Information you need to complete this task at the beginning of this topic.

Additional installation options

IBM Match 360 with Watson provides several configuration options in the custom resource (CR) spec to enable you to tune and customize your IBM Match 360 with Watson deployment. For information about the configuration options in the CR, see Specifying a custom resource for IBM Match 360 with Watson.

IBM Match 360 with Watson provides t-shirt sizing to enable you to scale the service installation up or down. For information about scaling IBM Match 360 and other services, see Scaling services.

Verifying the installation

When you create the custom resource, the IBM Match 360 with Watson operator processes the contents of the custom resource and starts up the microservices that comprise IBM Match 360 with Watson, including MasterDataManagement. (The MasterDataManagement microservice is defined by the mdm-cr custom resource.) IBM Match 360 with Watson is installed when the MasterDataManagement status is Completed.

To check the status of the installation:

Change to the project where you installed IBM Match 360 with Watson:
```
oc project project-name
```
Get the status of IBM Match 360 with Watson (mdm-cr):
```
oc get MasterDataManagement mdm-cr -o jsonpath='{.status.mdmStatus} {"\n"}'
```
IBM Match 360 with Watson is ready when the command returns Completed

Choosing a service upgrade plan

You can choose how IBM Match 360 with Watson is upgraded when you install a newer version of the IBM Match 360 with Watson operator on the cluster.

Automatic upgrade (recommended)

If you want IBM Match 360 with Watson to be automatically upgraded when you install a newer version of the IBM Match 360 with Watson operator on the cluster, remove the version entry from the MasterDataManagement custom resource.

To remove the version entry, run the following command. You must update the command with the appropriate project name before you run the command.

oc patch MasterDataManagement mdm-cr \
--namespace project-name \
--type=json \
--patch '[{ "op": "remove", "path": "/spec/version" }]'

Manual upgrade

If you want to manually upgrade IBM Match 360 with Watson after you install a newer version of the IBM Match 360 with Watson operator, you can pin the installation at a specific version in the MasterDataManagement custom resource.

By default, when you create the MasterDataManagement custom resource, it includes the version entry, so no additional action is required.

If you removed the version entry from the MasterDataManagement custom resource, run the following command to pin the installation at Version 1.1.278. You must update the command with the appropriate project name before you run the command.

oc patch MasterDataManagement mdm-cr \
--namespace project-name \
--type=merge \
--patch '{"spec": {"version":"1.1.278"}}'

For a list of operand versions supported by the IBM Match 360 with Watson operator, see Operator and operand versions.

What to do next

Before accessing the service, review the known issues. For details, see Limitations and known issues in IBM Match 360 with Watson.

The service must be configured before users can access the service:

An administrator must assign the proper service instance role to themselves and other users who require access to IBM Match 360. For details, see Giving users access to IBM Match 360. Service users that do not have the appropriate user role cannot access the IBM Match 360 service or the master data configuration asset.
A data engineer user must create a master data configuration asset and set up your IBM Match 360 service instance. For details, see Creating a master data configuration asset. To complete this task, you must have a Data Engineer service instance role.

After completing these steps, the service is ready to use. For details, see Managing master data.

Note: If you have a cartridge license that entitles you to both IBM Match 360 and IBM InfoSphere® Master Data Management Standard or Advanced Edition (InfoSphere), install and configure your InfoSphere MDM deployment. Be sure to also install the MDM Publisher functionality so that you can publish master data from InfoSphere MDM into IBM Match 360. See IBM Documentation for information about: