Installing OpenPages

A project administrator can install OpenPages 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 OpenPages 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 OpenPages, you must be an administrator of the project where you will install OpenPages. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.

When do you need to complete this task?: If you didn't install OpenPages when you installed the platform, you can complete this task to add OpenPages 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 OpenPages:

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: OpenPages uses a custom security context constraint (SCC). For details, see Creating the custom SCC for OpenPages.

Installation location: OpenPages is 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.
After you install OpenPages, you can optionally deploy instances of OpenPages to tethered projects.

Storage requirements: You don't need to specify storage when you install OpenPages; however you will need to specify storage when you provision an instance of OpenPages.

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 OpenPages.	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 OpenPages software images are mirrored to the private container registry.	If this task is not complete, see Mirroring images to a private container registry.
The custom security context constraint (SCC) required to run OpenPages exists.	If this task is not complete, see Creating the custom SCC for OpenPages.
The node settings are adjusted for OpenPages.	If this task is not complete, see Changing required node settings.

Procedure

Complete the following tasks to install OpenPages:

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 OpenPages operator simplifies the process of managing the OpenPages service on Red Hat® OpenShift Container Platform.

To install OpenPages, you must install the OpenPages 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 OpenPages 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 OpenPages:
```
cpd-cli manage apply-olm \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_OPS} \
--components=openpages
```
- 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 OpenPages service.

Installing the service

After the OpenPages operator is installed, you can install OpenPages.

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

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

To install the service:

Create the custom resource for OpenPages.

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

Validating the installation

OpenPages 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=openpages

What to do next

You must complete the Post-installation setup for OpenPages before users can access OpenPages.