Installing IBM Match 360
An instance administrator can install IBM Match 360 on IBM Cloud Pak® for Data Version 4.8.
- Who needs to complete this task?
-
Instance administrator To install IBM Match 360, 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 Cloud Pak for Data 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 Cloud Pak for Data control plane and the services for this instance of Cloud Pak for Data are installed in the operands project.
In the installation commands, the
${PROJECT_CPD_INST_OPERANDS}
environment variable refers to the operands project.
- 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 the Cloud Pak for Data control plane and one or more services at the same time, follow the process in Installing an instance of Cloud Pak for Data instead.
- If you didn't install IBM Match
360 when you installed the Cloud Pak for Data control plane, complete this task to add IBM Match
360 to your environment.
Repeat as needed If you are responsible for multiple instances of Cloud Pak for Data, you can repeat this task to install more instances of IBM Match 360 on the cluster.
Information you need to complete this task
Review the following information before you install IBM Match 360:
- Version requirements
-
All of the components that are associated with an instance of Cloud Pak for Data must be installed at the same release. For example, if the Cloud Pak for Data control plane is installed at Version 4.8.7, you must install IBM Match 360 at Version 4.8.7.
- 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
-
IBM Match 360 works with the default Red Hat® OpenShift® Container Platform security context constraint,
restricted-v2
.
- Common core services
-
IBM Match 360 requires the Cloud Pak for Data 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 IBM Match 360. The common core services installation increases the amount of time the installation takes to complete.
- Storage requirements
- You must specify storage classes when you install IBM Match 360. The following storage classes are recommended. However, if you don't use these storage classes on your cluster, ensure that you specify a storage class with an equivalent definition.
Before you begin
This task assumes that the following prerequisites are met:
Prerequisite | Where to find more information |
---|---|
The cluster meets the minimum requirements for installing IBM Match 360. | If this task is not complete, see System requirements. |
The workstation from which you will run the installation is set up as a client workstation
and includes the following command-line interfaces:
|
If this task is not complete, see Setting up a client workstation. |
The Cloud Pak for Data control plane is installed. | If this task is not complete, see Installing an instance of Cloud Pak for Data. |
For environments that use a private container registry, such as air-gapped environments, the IBM Match 360 software images are mirrored to the private container registry. | If this task is not complete, see Mirroring images to a private container registry. |
For environments that use a private container registry, such as air-gapped
environments, the cpd-cli is configured to pull the olm-utils-v2 image from the private container registry. |
If this task is not complete, see Pulling the olm-utils-v2 image from the private container registry. |
Prerequisite services
To enable the full capabilities of IBM Match 360, ensure that the following supplemental service is installed and running:
IBM Knowledge Catalog is not a strict installation prerequisite, but if it is not installed, key IBM Match 360 capabilities such as profiling, automapping, data quality workflows, and data governance will not work. Other features of the IBM Match 360 service will function normally.
Procedure
Complete the following tasks to install IBM Match 360:
Specifying installation options
If you plan to install IBM Match 360 with Watson™, you can
specify the following installation options in a file named install-options.yml
in the work
directory.
The parameters are optional. If you do not set these installation parameters, the default values are used. Uncomment the parameters that you want to override and update the values appropriately.
The sample YAML content uses the default values.
################################################################################
# IBM Match 360 with Watson parameters
################################################################################
#match360_scale_config: small
#match360_onboard_timeout: 300
#match360_ccs_http_timeout: 2000
Parameter | Description |
---|---|
match360_scale_config |
Specify the size of the service.
|
match360_onboard_timeout |
The length of time, in seconds, before the onboarding process times out. If your cluster is slow, increase this setting.
|
match360_ccs_http_timeout |
The length of time, in seconds, before the connection to the Cloud Pak for Data
common core services services times out. If your cluster is slow, increase this setting.
|
Installing the service
To install IBM Match 360:
-
Log the
cpd-cli
in to the Red Hat OpenShift Container Platform cluster:${CPDM_OC_LOGIN}
Remember:CPDM_OC_LOGIN
is an alias for thecpd-cli manage login-to-ocp
command. - Run the following command to create the required OLM objects for IBM Match
360 in the
operators project for the
instance:
cpd-cli manage apply-olm \ --release=${VERSION} \ --cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \ --components=match360
Wait for thecpd-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. - Create the custom resource for IBM Match
360.
The command that you run depends on the storage on your cluster.
Red Hat OpenShift Data Foundation storage
Run the appropriate command to create the custom resource.
- Default installation (without installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
- Custom installation (with installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --param-file=/tmp/work/install-options.yml \ --license_acceptance=true
IBM Storage Fusion Data Foundation storage
Run the appropriate command to create the custom resource.
- Default installation (without installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
- Custom installation (with installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --param-file=/tmp/work/install-options.yml \ --license_acceptance=true
IBM Storage Fusion Global Data Platform storage
Remember: When you use IBM Storage Fusion Global Data Platform storage, both${STG_CLASS_BLOCK}
and${STG_CLASS_FILE}
point to the same storage class, typicallyibm-spectrum-scale-sc
oribm-storage-fusion-cp-sc
.Run the appropriate command to create the custom resource.
- Default installation (without installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
- Custom installation (with installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --param-file=/tmp/work/install-options.yml \ --license_acceptance=true
IBM Storage Scale Container Native storage
Remember: When you use IBM Storage Scale Container Native storage, both${STG_CLASS_BLOCK}
and${STG_CLASS_FILE}
point to the same storage class, typicallyibm-spectrum-scale-sc
.Run the appropriate command to create the custom resource.
- Default installation (without installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
- Custom installation (with installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --param-file=/tmp/work/install-options.yml \ --license_acceptance=true
Portworx storage
Run the appropriate command to create the custom resource.
- Default installation (without installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --storage_vendor=portworx \ --license_acceptance=true
- Custom installation (with installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --storage_vendor=portworx \ --param-file=/tmp/work/install-options.yml \ --license_acceptance=true
NFS storage
Remember: When you use NFS storage, both${STG_CLASS_BLOCK}
and${STG_CLASS_FILE}
point to the same storage class, typicallymanaged-nfs-storage
.Run the appropriate command to create the custom resource.
- Default installation (without installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
- Custom installation (with installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --param-file=/tmp/work/install-options.yml \ --license_acceptance=true
AWS with EFS and EBS storage
Run the appropriate command to create the custom resource.
- Default installation (without installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
- Custom installation (with installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --param-file=/tmp/work/install-options.yml \ --license_acceptance=true
NetApp Trident
Remember: When you use NetApp Trident storage, both${STG_CLASS_BLOCK}
and${STG_CLASS_FILE}
point to the same storage class, typicallyontap-nas
.Run the appropriate command to create the custom resource.
- Default installation (without installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --license_acceptance=true
- Custom installation (with installation options)
-
cpd-cli manage apply-cr \ --components=match360 \ --release=${VERSION} \ --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \ --block_storage_class=${STG_CLASS_BLOCK} \ --file_storage_class=${STG_CLASS_FILE} \ --param-file=/tmp/work/install-options.yml \ --license_acceptance=true
Validating the installation
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=match360
What to do next
Complete the mandatory post-installation setup tasks to enable users to access IBM Match 360. For details, see Post-installation setup for IBM Match 360 with Watson.
Optionally, customize your IBM Match 360 deployment by changing configuration parameters in the custom resource. For details, see Modifying the CR to customize your IBM Match 360 with Watson installation.
Review the list of limitations and known issues. For details, see Known issues and limitations for IBM Match 360 with Watson.