Installing OpenPages

An instance administrator can install OpenPages on IBM® Software Hub Version 5.2.

Who needs to complete this task?

Instance administrator To install OpenPages, 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 OpenPages 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 OpenPages 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 OpenPages, you can deploy OpenPages 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 multiple services at the same time, follow the process in Running a batch installation of solutions and services instead.
If you didn't install OpenPages as part of a batch installation, complete this task to add OpenPages 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 OpenPages on the cluster.

Information you need to complete this task

Review the following information before you install OpenPages:

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.2.2, you must install OpenPages at Version 5.2.2.

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

Storage requirements: You don't need to specify storage information when you install OpenPages. However, you do need to specify storage when you provision an instance of OpenPages.

Before you begin

This task assumes that the following prerequisites are met:

System requirements

This task assumes that the cluster meets the minimum requirements for OpenPages.

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

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:

The OpenPages 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.
The cpd-cli is configured to pull the olm-utils-v3 image from the private container registry.
Where to find more information

If this task is not complete, see Pulling the olm-utils-v3 image from the private container registry.

Custom SCC

Where to find more information
If this task is not complete, see Mirroring images to a private container registry.

Where to find more information
If this task is not complete, see Pulling the olm-utils-v3 image from the private container registry.

This task assumes that the custom security context constraint (SCC) for OpenPages exists.

Where to find more information
If this task is not complete, see Creating the custom SCC for OpenPages.

Load balancer

The load balancer timeout settings are adjusted for OpenPages.

Where to find more information
If this task is not complete, see Changing load balancer settings.

Kernel parameters

The kernel parameter settings are adjusted for OpenPages.

Where to find more information
If this task is not complete, see Changing kernel parameter settings.

Procedure

Complete the following tasks to install OpenPages:

Installing the service
Validating the installation
What to do next

Installing the service

To install OpenPages:

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.
Run the following command to create the required OLM objects for OpenPages in the operators project for the instance:
```
cpd-cli manage apply-olm \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--components=openpages
```
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 OpenPages.

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

Validating the installation

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

What to do next

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