Installing Product Master

A project administrator can install Product Master on IBM Cloud Pak® for Data.

What permissions do you need to complete this task?

The permissions that you need depend on which tasks you must complete:

To install the Product Master operators, you must have the appropriate permissions to create operators and you must be an administrator of the project where the Cloud Pak for Data operators are installed. This project is identified by the ${PROJECT_CPD_OPS} environment variable.
To install Product Master, you must be an administrator of the project where you will install Product Master. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.

When do you need to complete this task?: If you didn't install Product Master when you installed the platform, you can complete this task to add Product Master to your environment.
If you want to install all of the Cloud Pak for Data components at the same time, follow the process in Installing the platform and services instead.

Important: All of the Cloud Pak for Data components in a deployment must be installed at the same release.

Information you need to complete this task

Review the following information before you install Product Master:

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:
```
source ./cpd_vars.sh
```

Security context constraint requirements: Product Master uses the restricted security context constraint (SCC).

Installation location: Product Master must be installed in the same project (namespace) as the Cloud Pak for Data control plane. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.

Storage requirements

You must tell Product Master what storage to use. 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 install the service, specify file storage and block storage.	File storage: `ocs-storagecluster-cephfs` Block storage: `ocs-storagecluster-ceph-rbd`
IBM® Storage Fusion	When you install the service, 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 install the service, 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 install the service, the `--storage_vendor=portworx` option ensures that the service uses the correct storage classes.	File storage: `portworx-rwx-gp3-sc` (Equivalent to `portworx-shared-gp3` in older installations) Block storage: `portworx-db-gp3-sc`
NFS	Not supported.	Not applicable.
Amazon Elastic storage	When you install the service, 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`
IBM Cloud storage	When you install the service, specify file storage and block storage. File storage is provided by IBM Cloud File Storage. Block storage is provided by IBM Cloud Block Storage.	File storage: `ibmc-file-gold-gid` or `ibm-file-custom-gold-gid` Block storage: `ibmc-block-gold`
NetApp Trident	When you install the service, 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.
The node settings are adjusted for Product Master.	If this task is not complete, see Changing required node settings.

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:

Logging in to the cluster.
Installing the operator.
Installing the service.
Validating the installation.
What to do next.

Logging in to the cluster

To run cpd-cli manage commands, you must log in to the cluster.

To log in to the cluster:

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.

Installing the operator

The Product Master operator simplifies the process of managing the Product Master service on Red Hat® OpenShift Container Platform.

To install Product Master, you must install the Product Master operator and create the Operator Lifecycle Manager (OLM) objects, such as the catalog source and subscription, for the operator.

Who needs to complete this task?: You must be a cluster administrator (or a user with the appropriate permissions to install operators) to create the OLM objects.

When do you need to complete this task?: Complete this task if the Product Master operator and other OLM artifacts have not been created for the current release.
If you complete this task and the OLM artifacts already exist on the cluster, the cpd-cli detects that you already have the OLM objects for the components at the specified release, the cpd-cli does not attempt to create the OLM objects again.

To install the operator:

Create the OLM objects for Product Master:
```
cpd-cli manage apply-olm \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_OPS} \
--components=productmaster
```
- If the command succeeds, it returns [SUCCESS]... The apply-olm command ran successfully.
- If the command fails, it returns [ERROR] and includes information about the cause of the failure.

What to do next: Install the Product Master service.

Installing the service

After the Product Master operator is installed, you can install Product Master.

Who needs to complete this task?: You must be an administrator of the project where you will install Product Master.

When do you need to complete this task?: Complete this task if you want to add Product Master to your environment.

To install the service:

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 (depend 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>"
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.

Create the custom resource for Product Master.

cpd-cli manage apply-cr \
--components=productmaster \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--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_INSTANCE} \
--components=productmaster

What to do next

Complete the following tasks to use the service: