Installing

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

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

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: AI Factsheets uses the restricted security context constraint (SCC).

Installation location: AI Factsheets 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.

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 AI Factsheets.	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 AI Factsheets 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` image from the private container registry.	If this task is not complete, see Pulling the olm-utils-v2 image from the private container registry.

Prerequisite services

Before you install AI Factsheets, ensure that one of the following services are installed and running:

Procedure

Complete the following tasks to install AI Factsheets:

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

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

Installing the service

After the AI Factsheets operator is installed, you can install AI Factsheets.

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

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

To install the service:

Create the custom resource for AI Factsheets.

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

Validating the installation

AI Factsheets 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=factsheet

What to do next

AI Factsheets is ready to use. To get started with AI Factsheets, see AI Factsheets.
You can give users administer access to AI Factsheets. For details, see Administering AI Factsheets.