Installing Planning Analytics

An instance administrator can install Planning Analytics on IBM Cloud Pak® for Data Version 4.7.

Who needs to complete this task?

Instance administrator To install Planning Analytics, 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.

The tethered projects for the instance

After you install Planning Analytics, you can deploy Planning Analytics service instances to the operands project or to projects that are tethered 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 Planning Analytics when you installed the Cloud Pak for Data control plane, complete this task to add Planning Analytics 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 Planning Analytics on the cluster.

Information you need to complete this task

Review the following information before you install Planning Analytics:

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 Planning Analytics 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

Planning Analytics 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

Storage requirements

You don't need to specify storage information when you install Planning Analytics.

Storage	Notes	Storage classes
OpenShift Data Foundation	Use `ocs-storagecluster-cephfs` for TM1® storage. Use either `ocs-storagecluster-cephfs` or `ocs-storagecluster-ceph-rbd` for Workspace storage.	File storage: `ocs-storagecluster-cephfs` Block storage: `ocs-storagecluster-ceph-rbd`
IBM® Storage Fusion Data Foundation	Use `ocs-storagecluster-cephfs` for TM1 storage. Use either `ocs-storagecluster-cephfs` or `ocs-storagecluster-ceph-rbd` for Workspace storage.	File storage: `ocs-storagecluster-cephfs` Block storage: `ocs-storagecluster-ceph-rbd`
IBM Storage Fusion Global Data Platform	Use `ibm-spectrum-scale-sc` for TM1 and Workspace storage.	File storage: `ibm-spectrum-scale-sc` Block storage: `ibm-spectrum-scale-sc`
IBM Storage Scale Container Native	Use `ibm-spectrum-scale-sc` for TM1 and Workspace storage.	File storage: `ibm-spectrum-scale-sc` Block storage: `ibm-spectrum-scale-sc`
Portworx	Use `portworx-rwx-gp3-sc` for TM1 storage. Use `portworx-rwx-gp3-sc`, `portworx-shared-gp3`, or `portworx-db-gp3-sc` for Workspace storage.	File storage: `portworx-rwx-gp3-sc` (Equivalent to `portworx-shared-gp3` in older installations) Block storage: `portworx-db-gp3-sc`
NFS	Use `managed-nfs-storage` for TM1 and Workspace storage.	File storage: `managed-nfs-storage` Block storage: `managed-nfs-storage`
Amazon Elastic storage	Use `efs-nfs-client` for TM1 storage. Use `efs-nfs-client`, `gp2-csi`, `gp3-csi` for Workspace 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	Use `ontap-nas` for TM1 and Workspace 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 Planning Analytics.	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 an instance of Cloud Pak for Data.
For environments that use a private container registry, such as air-gapped environments, the Planning Analytics 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.

Procedure

Complete the following tasks to install Planning Analytics:

Installing the service
Validating the installation
What to do next

Installing the service

To install Planning Analytics:

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 Planning Analytics in the operators project for the instance:
```
cpd-cli manage apply-olm \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--components=planning_analytics
```
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 the custom resource for Planning Analytics.

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

Validating the installation

Planning Analytics is installed when the 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=planning_analytics

What to do next

The service is ready to use. You can now provision an instance of the Planning Analytics service. For more information, see Provisioning the Planning Analytics service.