Installing Product Master

An instance administrator can install Product Master on IBM® Software Hub Version 5.4.

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 Product Master 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 custom resources for the control plane and Product Master 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 multiple services at the same time, follow the process in Running a batch installation of solutions and services instead.
  • If you didn't install Product Master as part of a batch installation, complete this task to add Product Master to your environment.

    Repeat as needed If you are responsible for multiple instances of IBM Software Hub, 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 IBM Software Hub must be installed at the same release. For example, if the IBM Software Hub control plane is installed at Version 5.4.0, you must install Product Master at Version 5.4.0.

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, restricted-v2.

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 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 Fusion Global Data Platform When you create the service instance, specify the same storage class for both file storage and block storage.
  • File storage:

    Either of the following storage classes:

    • ibm-spectrum-scale-sc
    • ibm-storage-fusion-cp-sc
  • Block storage:

    Either of the following storage classes:

    • ibm-spectrum-scale-sc
    • ibm-storage-fusion-cp-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:

    Either of the following storage classes:

    • gp2-csi
    • 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
Nutanix Not supported. Not applicable.

Before you begin

This task assumes that the following prerequisites are met:

System requirements
This task assumes that the cluster meets the minim requirements for Product Master.
Where to find more information
If this task is not complete, see System requirements.
Workstation
This task assumes that the workstation from which you will run the installation is set up as a client workstation and has the following command-line interfaces:
  • IBM Software Hub CLI: cpd-cli
  • OpenShift CLI: oc
  • Helm CLI: oc
Where to find more information
If this task is not complete, see Setting up a client workstation.
Control plane
This task assumes that the IBM Software Hub control plane is installed.
Where to find more information
If this task is not complete, see Installing an instance of IBM Software Hub.
Private container registry
If your environment uses a private container registry (for example, your cluster is air-gapped), this task assumes that the following tasks are complete:
  1. The Product Master software images are mirrored to the private container registry.
    Where to find more information
    If this task is not complete, see Mirroring images to a private container registry.
  2. The cpd-cli is configured to pull the olm-utils-v4 image from the private container registry.
    Where to find more information
    If this task is not complete, see Pulling the olm-utils-v4 image from the private container registry.
OpenSearch
This task assumes that OpenSearch is installed.
Where to find more information
If this task is not complete, see Installing OpenSearch on the Red Hat OpenShift Container Platform.
Cluster-scoped resources
This task assumes that the cluster-scoped resources, such as custom resource definitions, cluster roles, and cluster role bindings, exist.
Where to find more information
If this task is not complete, see Creating cluster-scoped resources for the IBM Software Hub platform and services.
Image pull secrets
This task assumes that the secrets that contain the image pull credentials for the instance exist.
Where to find more information
If this task is not complete, see Creating image pull secrets for an instance of IBM Software Hub.

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 that are 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:

  1. Installing the service.
  2. Validating the installation.
  3. What to do next.

Installing the service

To install Product Master:

  1. Log the cpd-cli in to the Red Hat OpenShift Container Platform cluster:
    ${CPDM_OC_LOGIN}
    Remember: CPDM_OC_LOGIN is an alias for the cpd-cli manage login-to-ocp command.
  2. Create a 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 entries 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 Security Assertion Markup Language (SAML) single sign-on (SSO), add the following entries 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>"
    Optional: To use LDAP single sign-on (SSO), add the following entries to the app-secret file.
    
enable_sso="true"
company_name="<user_defined>"
    Optional: To connect to a Magento connector, add the following entries 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>"
    Optional: To connect to an external MQ service, add the following entries to the app-secret file. If you have enabled GDS service, you need to do this. 
    
mq_host: "<MQ IP or hostname>"  
mq_port: "<MQ service port>"  
mq_app_user: "<MQ service  app username>"  
mq_app_pass: "<MQ service app password>"
  3. Install the operator and custom resource for Product Master.

    The command that you run depends on the storage on your cluster.

    Red Hat OpenShift Data Foundation storage 
    cpd-cli manage install-components \
--license_acceptance=true \
--components=productmaster \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
    IBM Fusion Data Foundation storage 
    cpd-cli manage install-components \
--license_acceptance=true \
--components=productmaster \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
    IBM Fusion Global Data Platform storage
    Remember: When you use IBM Fusion Global Data Platform storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically ibm-spectrum-scale-sc or ibm-storage-fusion-cp-sc.
    cpd-cli manage install-components \
--license_acceptance=true \
--components=productmaster \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
    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, typically ibm-spectrum-scale-sc.
    cpd-cli manage install-components \
--license_acceptance=true \
--components=productmaster \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
    Portworx storage 
    cpd-cli manage install-components \
--license_acceptance=true \
--components=productmaster \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--storage_vendor=portworx \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
    AWS with EFS and EBS storage 
    cpd-cli manage install-components \
--license_acceptance=true \
--components=productmaster \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}
    NetApp Trident
    Remember: When you use NetApp Trident storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically ontap-nas.
    cpd-cli manage install-components \
--license_acceptance=true \
--components=productmaster \
--release=${VERSION} \
--operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--image_pull_prefix=${IMAGE_PULL_PREFIX} \
--image_pull_secret=${IMAGE_PULL_SECRET}

Validating the installation

Product Master is installed when the install-components command returns:
[SUCCESS]... The install-components 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=productmaster

What to do next

Complete the following tasks to use the service:
  1. Create a service instance.
    Important: There is a known limitation where for a new database and new instance deployment, the Product Master instance pod may initially remain in the 0/1 state. You need to execute the create_schema script. For more information, see Create database schema.
  2. Create database schema.
  3. Get application URL.
  4. Enable additional features in the Product Master application.
  5. Customize the Product Master application.
  6. Administer the Product Master application.