Updating the IBM Software Hub command-line interface (Upgrading from Version 5.2 to Version 5.4)

Before you upgrade IBM Software Hub, you must ensure that the workstation has the correct version of the cpd-cli and the olm-utils-v4 image.

Upgrade phase
  • You are here icon. Updating your client workstation
  • You are not here. Collecting required information
  • You are not here. Preparing to run an upgrade in a restricted network
  • You are not here. Preparing to run an upgrade from a private container registry
  • You are not here. Upgrading prerequisite software
  • You are not here. Upgrading shared cluster components
  • You are not here. Preparing to upgrade an instance
  • You are not here. Upgrading an instance
  • You are not here. Setting up IBM Software Hub
Who needs to complete this task?

All administrators Any user who is involved in upgrading IBM Software Hub must have access to a client workstation with the correct version of the cpd-cli and the olm-utils-v4 image.

When do you need to complete this task?

Repeat as needed You must have at least one client workstation. You can repeat the tasks in this section as many times as needed to update multiple client workstations.

About this task

The olm-utils-v4 image is required to run the cpd-cli manage commands.

At a minimum, you must make the correct version of the cpd-cli and the olm-utils-v4 image available on the workstation from which you plan to run the upgrade.

Procedure

To update a client workstation:

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

    Ensure that you download the correct package based on the operating system on the client workstation:

    Workstation operating system Enterprise Edition Standard Edition
    Linux® The package that you download depends on your hardware:
    x86_64
    cpd-cli-linux-EE-14.4.0.tgz
    ppc64le
    cpd-cli-ppc64le-EE-14.4.0.tgz
    s390x
    cpd-cli-s390x-EE-14.4.0.tgz
    The package that you download depends on your hardware:
    x86_64
    cpd-cli-linux-SE-14.4.0.tgz
    ppc64le
    cpd-cli-ppc64le-SE-14.4.0.tgz
    s390x
    cpd-cli-s390x-SE-14.4.0.tgz
    Mac OS cpd-cli-darwin-EE-14.4.0.tgz cpd-cli-darwin-SE-14.4.0.tgz
    Windows

    You must download the Linux package and run it in Windows Subsystem for Linux:

    cpd-cli-linux-EE-14.4.0.tgz

    You must download the Linux package and run it in Windows Subsystem for Linux:

    cpd-cli-linux-SE-14.4.0.tgz
  2. Extract the contents of the package to the directory where you want to run the cpd-cli.
  3. Copy the cpd-cli-workspace directory from your old cpd-cli installation to your new cpd-cli Version 14.4.0 installation.
    Important: Ensure that you place the cpd-cli-workspace directory in the same directory as the cpd-cli executable file.
    In addition, ensure that all users have read, write, and execute permissions on the work subdirectory. To check the permissions on the work directory, change to the directory that contains the work directory and run:
    ls -l
    • If the command returns drwxrwxrwx, no action is required.
    • If the command returns a different value, run the following command to set read, write, and execute permissions for all users:
      chmod 0777 ./work
  4. Delete your old cpd-cli installation.
  5. 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/cpdctl
    • plugins/lib/darwin/cpdtool
    • plugins/lib/darwin/health
    • plugins/lib/darwin/manage
    • 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.
  6. 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 or ~/.zshrc 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
  7. Run the following command to ensure that the cpd-cli is installed and running and that the cpd-cli manage plug-in has the correct version of the olm-utils-v4 image.
    cpd-cli manage restart-container

What to do next

Now that you've updated your client workstation, you're ready to complete Updating the OpenShift command-line interface (Upgrading from Version 5.2 to Version 5.4).