Installing the IBM Cloud Pak for Data command-line interface

To install IBM Cloud Pak for Data software on your Red Hat® OpenShift® Container Platform cluster, you must install the Cloud Pak for Data command-line interface (cpd-cli) on the workstation from which you are running the installation commands.

Installation phase

Setting up a client workstation

Collecting required information

Preparing your cluster

Installing the Cloud Pak for Data platform and services

Who needs to complete this task?

User	Purpose
Cluster administrators	Required to create catalog sources and operator subscriptions. Required to change node settings
Project administrators	Required to install IBM Cloud Pak for Data Required to integrate with the IAM Service (if applicable)
Private container registry administrators	Required to mirror images to the private container registry.

When do you need to complete this task?

You must complete this task on any workstation from which you plan to run installation commands.

You can also complete this task if you need to use the cpd-cli to complete other tasks, such as backing up and restoring your installation or managing users.

Before you begin

Ensure that the workstation meets the requirements in Setting up a client workstation.

About this task

Install the cpd-cli on a client workstation that can connect to your cluster.

Procedure

Download Version 11.3.0 of the cpd-cli from the IBM/cpd-cli repository on GitHub.

Ensure that you download the correct package based on the Cloud Pak for Data license that you purchased and the operating system on the client workstation:

Workstation operating system	Enterprise Edition	Standard Edition
Linux®	`cpd-cli-linux-EE-11.3.0.tgz`	`cpd-cli-linux-SE-11.3.0.tgz`
Mac OS	`cpd-cli-darwin-EE-11.3.0.tgz`	`cpd-cli-darwin-SE-11.3.0.tgz`
Windows	You must download the Linux package and run it in Windows Subsystem for Linux: `cpd-cli-linux-EE-11.3.0.tgz`	You must download the Linux package and run it in Windows Subsystem for Linux: `cpd-cli-linux-SE-11.3.0.tgz`

Restriction: Do not download the Power® (ppc64le) or IBM Z® (s390x) packages if you plan to use the client to run an installation or upgrade. The

cpd-cli
manage

commands cannot be run on these operating systems.

Extract the contents of the package to the directory where you want to run the cpd-cli.
On Mac OS, you must trust the following components of the cpd-cli:
- cpd-cli
- plugins/lib/darwin/config
- plugins/lib/darwin/cpdbr
- plugins/lib/darwin/cpdbr-oadp
- plugins/lib/darwin/cpdtool
- plugins/lib/darwin/manage
- plugins/lib/darwin/migrate
- plugins/lib/darwin/platform-diag
- plugins/lib/darwin/platform-mgmt
For each component:
1. Right-click the component and select Open.
  You will see a message with the following format:
```
macOS cannot verify the developer of component-name. Are you sure you want to open it?
```
2. Click Open.

Best practice Make the cpd-cli executable from any directory.

By default, you must either change to the directory where the cpd-cli is located or specify the fully qualified path of the cpd-cli to run the commands.

However, you can make the cpd-cli executable from any directory so that you only need to type cpd-cli command-name to run the commands.

Workstation operating system	Details
Linux	Add the following line to your ~/.bashrc file: `export PATH=<fully-qualified-path-to-the-cpd-cli>:$PATH`
Mac OS	Add the following line to your ~/.bash_profile file: `export PATH=<fully-qualified-path-to-the-cpd-cli>:$PATH`
Windows	From the Windows Subsystem for Linux, add the following line to your ~/.bashrc file: `export PATH=<fully-qualified-path-to-the-cpd-cli>:$PATH`

Run the following command to ensure that the cpd-cli is installed and running and that the cpd-cli manage plug-in has the latest version of the olm-utils image.
```
cpd-cli manage restart-container
```

Results

When you run

cpd-cli
manage

commands, the cpd-cli-workspace directory is automatically created. The location of the directory depends on several factors:

If you made the cpd-cli executable from any directory, the directory is created in the directory where you run the cpd-cli commands.
Important: In this scenario, ensure that you run the cpd-cli from the same directory every time to ensure that all of the data is in the same directory.
If you did not make the cpd-cli executable from any directory, the directory is created in the directory where the cpd-cli is installed.

The cpd-cli-workspace directory includes the following sub-directories:

Directory	What is stored in the directory?
`olm-utils-workspace/work`	The `components.csv` file, which is generated when you run the `list-components` command. Log files generated by the `mirror-images` command.
`olm-utils-workspace/work/offline`	The contents of this directory are organized by release. For example, if you download the CASE packages for Version 4.5.3, the packages are stored in the `4.5.3` directory. In addition, the output of commands such as the `list-images` command are stored in the version-specific directories.