Installing Product Master

An instance administrator can install Product Master on IBM Cloud Pak® for Data Version 4.7.

Who needs to complete this task?

Instance administrator To install Product Master, 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 the platform and services instead.
If you didn't install Product Master when you installed the Cloud Pak for Data control plane, complete this task to add Product Master 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 Product Master on the cluster.

Information you need to complete this task

Review the following information before you install Product Master:

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.7.4, you must install Product Master at Version 4.7.4.

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

Product Master works with the default Red Hat® OpenShift® Container Platform security context constraint:

On Version 4.10, the default SCC is restricted.
On Version 4.12, the default SCC is restricted-v2

Product Master requires a custom security context constraint (SCC). For more information, see Creating the custom SCC for Product Master.

Storage requirements

You must specify storage classes when you install Product Master. 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.

Storage	Notes	Storage classes
OpenShift Data Foundation	When you create the service instance, specify file storage and block storage.	File storage: `ocs-storagecluster-cephfs` Block storage: `ocs-storagecluster-ceph-rbd`
IBM® Storage Fusion Data Foundation	When you create the service instance, specify file storage and block storage.	File storage: `ocs-storagecluster-cephfs` Block storage: `ocs-storagecluster-ceph-rbd`
IBM Storage Fusion Global Data Platform	When you create the service instance, specify the same storage class for both file storage and block storage.	File storage: `ibm-spectrum-scale-sc` Block storage: `ibm-spectrum-scale-sc`
IBM Storage Scale Container Native	When you create the service instance, specify the same storage class for both file storage and block storage.	File storage: `ibm-spectrum-scale-sc` Block storage: `ibm-spectrum-scale-sc`
Portworx	When you create the service instance, specify file storage and block storage.	File storage: `portworx-rwx-gp3-sc` (Equivalent to `portworx-shared-gp3` in older installations) Block storage: `portworx-gp3-sc`
NFS	Not supported.	Not applicable.
Amazon Elastic storage	When you create the service instance, specify file storage and block storage. File storage is provided by Amazon Elastic File System. Block storage is provided by Amazon Elastic Block Store.	File storage: `efs-nfs-client` Block storage: `gp2-csi` or `gp3-csi`
NetApp Trident	When you create the service instance, specify the same storage class for both file storage and block storage.	File storage: `ontap-nas` Block storage: `ontap-nas`

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 Product Master.	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: Cloud Pak for Data CLI: `cpd-cli` OpenShift CLI: `oc`	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 the platform and services.
For environments that use a private container registry, such as air-gapped environments, the Product Master 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.
The custom security context constraint (SCC) for Product Master exists.	If this task is not complete, see Creating the custom SCC for Product Master.
The node settings are adjusted for Product Master.	If this task is not complete, see Changing required node settings.
You have installed OpenSearch.	If this task is not complete, see Installing OpenSearch on the Red Hat OpenShift Container Platform.

Prerequisite services

Before you install Product Master, ensure that the following services are installed and running:

Product Master supports Db2® service, IBM Db2 Version 11.5, or Oracle Database Version 19c database.

These database services are not installed with Product Master and hence you need to complete the tasks listed in the Preparing to install the Product Master service topic before you start the Product Master installation.

Procedure

Complete the following tasks to install Product Master:

Installing the service.
Validating the installation.
What to do next.

Installing the service

To install Product Master:

Run the cpd-cli manage login-to-ocp command to log in to the cluster as a user with sufficient permissions to complete this task. For example:
```
cpd-cli manage login-to-ocp \
--username=${OCP_USERNAME} \
--password=${OCP_PASSWORD} \
--server=${OCP_URL}
```
Tip: The login-to-ocp command takes the same input as the oc login command. Run oc login --help for details.
Run the following command to create the required OLM objects for Product Master in the operators project for the instance:
```
cpd-cli manage apply-olm \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--components=productmaster
```
Wait for the cpd-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 app-secret file with the following entries to securely store sensitive data.

cat <<EOF |oc apply -f -
apiVersion: v1
kind: Secret
metadata:
  name: app-secret
  labels:
    app.kubernetes.io/instance: ibm-cpd-productmaster-operator
    app.kubernetes.io/managed-by: ibm-cpd-productmaster-operator
    app.kubernetes.io/name: ibm-cpd-productmaster-operator
#Namespace where the IBM Cloud Pak® for Data is installed, default value is cpd-instance
  namespace: ${PROJECT_CPD_INSTANCE}    
type: Opaque 
stringData: 
#Database details (depends on your database type)  
  db_type: "<db2 / oracle>"
  db_name: "<DB name>"
  db_host: "<IP  or DB service name>"
  db_user: "<DB username>"
  db_pass: "<DB password>"
  db_port: "<DB server port>"
#OpenSearch details
  opensearch_host: "https://<OpenSearch hostname>"
  opensearch_user: "<OpenSearch username>"
  opensearch_pass: "<OpenSearch password>"
  opensearch_port: "<OpenSearch port>"
  opensearch_ssl_crt: |
     <OpenSearch admin.pem certificate>
EOF

Optional: To connect to an existing IBM Watson® Knowledge Catalog service, add the following to the app-secret file.


  cpd_host_url: "<CPD host URL>"
  cpd_user_name: "<CPD User name>"
  wkc_auth_api_key: "<WKC API Key>"
  wkc_catalog_name: "<WKC Catalog name>"

Optional: To use an existing Simple Mail Transfer Protocol (SMTP) service, add the following to the app-secret file.


  smtp_address: "<SMTP server hostname>"
  from_address: "<From email address>"
  smtp_port: "<SMTP server port>"
  smtp_user: "<SMTP username or API key>"
  smtp_pass: "<SMTP password>"
  smtp_additional_props: "<SMTP additional properties>"

Optional: To use an existing Security Assertion Markup Language (SAML) Single sign-on (SSO), add the following to the app-secret file.


  sso_company: "<company code>"
  sso_config_adminui: "<AdminUI SAML WebSSO configuration for IBM WebSphere® Liberty, in the <samlWebSso20>..</samlWebSso20>> format"
  sso_config_personaui: "<PersonaUI SAML WebSSO configuration for IBM WebSphere® Liberty Liberty, in the format <samlWebSso20>..</samlWebSso20>>"
  sso_idp_metadata: "<Identity provider metadata file content>"

For more information on generating authentication keys for the wkc_auth_api_key property, see Platform API key.

Optional: To connect to a Magento connector, add the following to the app-secret file.


  magento_user: "<Magento service username>"
  magento_pass: "<Magento service password>"
  magento_host: "<Magento IP  or hostname>"
  magento_port: "<Magento connector port>"
  magento_ipm_user: "<application username>"
  magento_ipm_pass: "<application password>"
  magento_ipm_company: "<application Magento company name>"

Create the custom resource for Product Master.

cpd-cli manage apply-cr \
--components=productmaster \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--license_acceptance=true

Validating the installation

Product Master is installed when the apply-cr command returns [SUCCESS]... The apply-cr command ran successfully.

However, you can optionally run the

cpd-cli
manage
get-cr-status

command if you want to confirm that the custom resource status is Completed:

cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--components=productmaster

What to do next

Complete the following tasks to use the service: