What's new and changed in the Cloud Pak for Data command-line interface

The Cloud Pak for Data command-line interface (cpd-cli) release and subsequent refreshes can include new features, bug fixes, and security updates. Refreshes appear in reverse chronological order, and only the refreshes that contain updates for the command-line interface are shown.

You can see a list of the new features for the platform and all of the services at What's new in IBM Cloud Pak for Data?.

Installing or upgrading the Cloud Pak for Data command-line interface

Ready to install or upgrade the Cloud Pak for Data command-line interface? Download the latest version from the cpd-cli repository on GitHub.

For information on editing the repo.yaml file that is included with the cpd-cli, see Obtaining the installation files.

Refresh 13 of Cloud Pak for Data Version 3.5

A new version of the cpd-cli was released in April 2022.

Version: 3.5.10

This release includes the following changes:

Security fixes: Version 3.5.10 of the Cloud Pak for Data command-line interface includes various fixes.

Refresh 12 of Cloud Pak for Data Version 3.5

A new version of the cpd-cli was released in March 2022.

Version: 3.5.9

This release includes the following changes:

Security fixes: Version 3.5.9 of the Cloud Pak for Data command-line interface includes various fixes.

Refresh 10 of Cloud Pak for Data Version 3.5

A new version of the cpd-cli was released in January 2022.

Version: 3.5.8

This release includes the following changes:

Security fixes: Version 3.5.8 of the Cloud Pak for Data command-line interface includes various security fixes.

Refresh 9 of Cloud Pak for Data Version 3.5

A new version of the cpd-cli was released in October 2021.

Version: 3.5.7

This release includes the following changes:

Security fixes: Version 3.5.7 of the Cloud Pak for Data command-line interface includes various security fixes.

Refresh 7 of Cloud Pak for Data Version 3.5

A new version of the cpd-cli was released in July 2021.

Version: 3.5.6

This release includes the following changes:

New features

The 3.5.6 release of the Cloud Pak for Data command-line interface includes the following features and updates:

Refreshing the Cloud Pak for Data Operator: You can now refresh the Cloud Pak for Data Operator so that you can use newer versions of the cpd-cli to patch and scale Cloud Pak for Data. Previously, if you encountered an error because of an incompatibility between the cpd-cli and the operator, you needed to upgrade Cloud Pak for Data. For details, see Cannot use the cpd-cli to patch or scale.

Refresh 5 of Cloud Pak for Data Version 3.5

A new version of the cpd-cli was released in April 2021.

Version: 3.5.4

This release includes the following changes:

New features

The 3.5.4 release of the Cloud Pak for Data command-line interface includes the following features and updates:

Support for a different temporary download directory

When you download files for air-gapped environments, the cpd-cli uses /var/tmp for temporary storage. However, if you don't have sufficient space in your /var/tmp directory, the download can fail.

In the latest release of the cpd-cli, you can specify a different temporary directory with more space. For details, see:

Bug fixes

Version 3.5.4 of the Cloud Pak for Data command-line interface includes minor bug fixes.

Important: The cpd-install-operator version must match the cpd-cli version. When you run the cpd-cli, you might see the following message:

There is an incompatibility between cpd-install-operator and cpd-cli versions. Upgrade the lite assembly prior to retrying this operation.

If you encounter this message you can resolve the problem by running the Cloud Pak for Data control plane upgrade. Choose the appropriate option for your environment:

If you are already running the latest version of the Cloud Pak for Data control plane, re-run the command to upgrade the control plane.
For details, see: Upgrading the control plane.
If you are running an older version of the Cloud Pak for Data control plane but do not want to install a newer version of the control plane, re-run the command to upgrade the control plane:
- On an air-gapped cluster, the command will use the version of the version of the control plane assembly that is already on the registry server.
  For details, see: Upgrading control plane the on air-gapped clusters.
- On a connected cluster, ensure that you specify the --version flag and remove the --latest-dependency flag.
  For details, see Upgrading the control plane on clusters connected to the internet.
If you are running an older version of the Cloud Pak for Data control plane and are willing to upgrade to the latest version of the control plane, run the command to upgrade the control plane:
- On an air-gapped cluster, you must download the latest version of the control plane assembly before you can run the upgrade.
  For details, see Preparing for air-gapped upgrades.
- On a connected cluster, the latest version of the software is installed by default. For details, see Upgrading the control plane on clusters connected to the internet.

Refresh 4 of Cloud Pak for Data Version 3.5

A new version of the cpd-cli was released in March 2021.

Version: 3.5.3

This release includes the following changes:

Bug fixes

Issue: When you run the status command, the command returns information about patches for the latest release, regardless of the release that is installed.
Resolution: The status command now returns information about available patches for the release that is installed
Issue: In some cases, when you install the Cloud Pak for Data control plane, the installation times out before the route to the platform created and annotated.
Resolution: The installation waits until the route is annotated.
Issue: When you run the cpd-cli delta-images command, unexpected versions of some assemblies are downloaded.
Resolution: If you want a specific version of an assembly, you must specify it in the download.yaml file. The documentation for downloading a specific version of the software has been enhanced to provide additional guidance. For details, see Preparing for air-gapped upgrades.

Refresh 2 of Cloud Pak for Data Version 3.5

A new version of the cpd-cli was released in January 2021.

Version: 3.5.2

This release includes the following changes:

New features

You must install Version 3.5.2 of the cpd-cli to install Cloud Pak for Data on Red Hat® OpenShift® 4.6.

In addition this release also includes the following features and updates:

New flag for air-gapped environments

When you run the cpd-cli preload-images command, you can optionally specify the --include-patches flag, which downloads the latest patch, if one is available. This reduces the number of commands that you must run to get the latest version of the software installed on your cluster.

For installations, see Preparing for air-gapped installations.

For upgrades, see Preparing for air-gapped upgrades.

No need to specify the --storageclass flag during upgrade

When you upgrade a service using cpd-cli, you don't need to specify the --storageclass flag. The upgrade command uses the storage class that was specified when you installed the service. If you specify the --storageclass flag during an upgrade, the value is ignored and the value from the existing installation is used.

Initial release of Cloud Pak for Data Version 3.5

A new version of the Cloud Pak for Data command-line interface (cpd-cli) was released as part of Cloud Pak for Data Version 3.5.

Version: 3.5.1

This release includes the following changes:

Red Hat OpenShift support

You can deploy Cloud Pak for Data Version 3.5 on the following versions of Red Hat OpenShift:

Version 3.11
Version 4.5

zLinux support

You can deploy the following Cloud Pak for Data software on zLinux (s390x):

The Cloud Pak for Data control plane
Db2®
Db2 Warehouse
Db2 for z/OS® Connector
Db2 Data Gate

New service account required

The Cloud Pak for Data control plane requires an additional service account: cpd-norbac-sa, which is bound to a restricted security context constraint (SCC).

This security account is specified in the cpd-cli adm command for the control plane.

For details, see:

New upgrade step required

Before you can upgrade to Cloud Pak for Data Version 3.5, you must upgrade the Cloud Pak for Data metadata by running the

cpd-cli
operator-upgrade

command.

For details, see Preparing to upgrade the Watson Machine Learning Accelerator.

New features

Simplified and updated installation commands

The Cloud Pak for Data command-line interface uses a simplified syntax. The cpd-Operating_System command is replaced by the cpd-cli command.

When you download the installation files, you must select the appropriate package for the operating system where you will run the commands. For details, see Obtaining the installation files.

Many of the cpd-cli commands have different syntax. Review the installation documentation carefully to ensure that you use the correct syntax.

For example:

On air-gapped clusters, the cpd-Operating_System preloadImages command is now cpd-cli preload-images.
When you run the install or upgrade commands, you specify the --latest-depenency flag to ensure that the latest prerequisite components are installed.

Simplified storage overrides

If an assembly requires an override for Portworx or OpenShift Container Storage, the assembly includes predefined override files. The instructions for the assembly will include information on how to install the service with the appropriate override file for your environment.

Rolling back patches

Whether a patch succeeded or failed, you can now revert a service to the state before the patch was applied by running the cpd-cli patch rollback command.

For details, see Applying patches.

New cpd-cli commands

You can use the Cloud Pak for Data command line interface to:

Manage service instances
Back up and restore the project where Cloud Pak for Data is deployed
Export and import Cloud Pak for Data metadata