Client workstation requirements

You can use a client workstation, such as a laptop, to run the IBM Cloud Pak® for Data command-line interface (cpd-cli).

The cpd-cli is comprised of several plug-ins. Some of the plug-ins have different hardware requirements, container runtime requirements, and internet access requirements. Use the information in the following table to determine which plug-ins you will need to run based on your role in installing and administering Cloud Pak for Data:

Plug-in	How is this plug-in used?	Related documentation
`config`	Create a local user configuration and profile to enable you to run the following `cpd-cli` commands against an existing Cloud Pak for Data instance: `cpd-cli diag` `cpd-cli export-import` `cpd-cli service-instance` `cpd-cli user-mgmt`	`config` command reference Creating a profile to use the `cpd-cli` management commands
`cpdbr`	Backup and restore Cloud Pak for Data volumes.	`backup-restore` command reference Offline volume backup and restore
`cpdbr-oadp`	Backup and restore Cloud Pak for Data deployments, including volumes.	`oadp` command reference Cloud Pak for Data online backup and restore Cloud Pak for Data offline backup and restore
`cpdtool`	Export and import platform and service data, including metadata.	`export-import` command reference Migrating Cloud Pak for Data metadata and clusters
`manage`	Install and upgrade Cloud Pak for Data	`manage` command reference Installing IBM Cloud Pak for Data Upgrading IBM Cloud Pak for Data
`migrate`	This plug-in is deprecated and cannot be used with Cloud Pak for Data Version 4.7.	Not applicable.
`platform-diag`	Gather diagnostic information about a Cloud Pak for Data deployment.	`diag` command reference Gathering diagnostics from Cloud Pak for Data services
`platform-mgmt`	Manage the service instances and users associated with a Cloud Pak for Data deployment.	Service instances `service-instance` command reference Managing Cloud Pak for Data service instances by command line Users `user-mgmt` command reference Managing Cloud Pak for Data users by command line

Hardware requirements for client workstations

Some of the cpd-cli plug-ins support a subset of the hardware that Cloud Pak for Data supports.

Note: The hardware on the client workstation does not need to be the same as the hardware on the cluster. For example, if your cluster is running s390x hardware, you can run the cpd-cli on an x86-64 client workstation.

Use the following table to determine whether you have the appropriate operating system to run the plug-ins that you plan to use:

Plug-in	x86-64	ppc64le	s390x
`config`	✓	✓	✓
`cpdbr`	✓	✓
`cpdbr-oadp`	✓	✓
`cpdtool`	✓	✓
`manage`	✓		✓
`platform-diag`	✓	✓	✓
`platform-mgmt`	✓	✓	✓

Operating system requirements for client workstations

The hardware that you are running determines which operating system the client workstation can run.

Operating system	x86-64	ppc64le	s390x	Notes
Linux®	✓	✓	✓
Mac OS	✓
Windows	✓			To run on Windows, you must install Windows Subsystem for Linux.

Container runtime requirements for client workstations

Some of the cpd-cli plug-ins require a container runtime, such as Docker or Podman.

It is strongly recommended that you use the latest version of the container runtime that is compatible with your operating system.

The minimum recommended versions are:

Docker
Choose the Docker offering that is compatible with your operating system:
- Docker Desktop Version 4.2.0 or later
  For information on installing Docker Desktop, see https://docs.docker.com/desktop/.
- Docker Engine Version 20.0.0 or later
  For information on installing Docker Engine, see https://docs.docker.com/engine/.
Podman Version 4.0.0 or later
For information on installing Podman, see https://podman.io/getting-started/installation.

Plug-in	Runtime required	Runtimes supported
`config`
`cpdbr`	✓	Docker
`cpdbr-oadp`	✓	Docker
`cpdtool`	✓	Docker
`manage`	✓	Docker Podman
`platform-diag`
`platform-mgmt`

Windows users: If you are running the cpd-cli on the Windows operating system, you must set up the container runtime inside Windows Subsystem for Linux.

Internet access requirements for client workstations

The cpd-cli plug-ins have various internet access requirements. At a minimum, the workstation must be able to access the cluster network. However, some of the plug-ins require public internet access to complete a subset of tasks, such as downloading files and containerized software images. Use the following table to determine whether the plug-ins that you plan to use require internet access:

Plug-in	Requires public internet connection?
`config`	No.
`cpdbr`	Required to obtain the following images: `cpdbr` (x86_64 or ppc64le) image. Also required if your S3 storage is not in your cluster network.
`cpdbr-oadp`	Required to obtain the following images: `ubi-minimal` (x86_64 or ppc64le) `cpdbr-velero-plugin` (x86_64 or ppc64le) `cpdbr-oadp` (x86_64 or ppc64le) `cpdbr-api` (x86_64 or ppc64le) Also required if your object storage is not in your cluster network.
`cpdtool`	Required to obtain following images: `cpdtool` (x86_64 or ppc64le)
`manage`	Required to obtain the following images: `olm-utils-v2` (x86_64 or s390x) `zen-rsi-adm-controller` (x86_64, ppc64le, or s390x) Also required to: Download the required CASE packages Mirror images to a private container registry or to an intermediary container registry on the workstation.
`platform-diag`	No.
`platform-mgmt`	No.

Additional guidance for clusters in a restricted network

The following images are automatically mirrored when you mirror the Cloud Pak for Data (cpd_platform) images:

cpdbr
cpdbr-velero-plugin
cpdbr-oadp
cpdbr-api
cpdtool
olm-utils-v2
zen-rsi-adm-controller

You must obtain the ubi-minimal image before you move the client workstation behind the cluster firewall. For more information, see Moving images for the backup and restore utilities to the private container registry.