IBM Cloud Docs
Installing the CLI

Installing the CLI

You can use the following tools to manage your Red Hat OpenShift on IBM Cloud clusters. While you can install a subset of the tools, all the following tools are recommended.

Virtual Private Cloud Classic infrastructure Satellite

Understanding the CLI tools

Table 1: CLI tools
CLI Description
ibmcloud You can use the ibmcloud CLI to login to your account, add users, manage your catalogs and more.
ks plug-in After installing the ibmcloud CLI, you can use the ks plug-in to create and manage Red Hat OpenShift on IBM Cloud clusters as well as Satellite hosts and Locations.
oc You can use the oc CLI to manage resources within your clusters like pods, deployments, and more.

Run the installation command

The latest version of the IBM Cloud CLI is installed when you run the command. As the CLI installs, keep an eye on the command line to authenticate as needed.

  • For MacOS, run the following command:

    curl -fsSL https://clis.cloud.ibm.com/install/osx | sh
    
  • For Linux™, run the following command:

    curl -fsSL https://clis.cloud.ibm.com/install/linux | sh
    
  • For Windows™, run the following command in PowerShell as an administrator:

    iex (New-Object Net.WebClient).DownloadString('https://clis.cloud.ibm.com/install/powershell')
    

    To open PowerShell, right-click the Windows™ PowerShell icon, and select Run as administrator.

  • For WSL2 on Windows™, run the following command:

    curl -fsSL https://clis.cloud.ibm.com/install/linux | sh
    

Verify the installation

To verify that the CLI was installed successfully, run the help command:

ibmcloud help

The output lists the usage instructions, the current version, and the supported commands.

Install CLI plug-ins and tools

To manually install the CLI plug-ins and tools, see Extending IBM Cloud CLI with plug-ins.

To install the container-service or ks plugin, run the following command.

ibmcloud plugin install ks

Install the Red Hat OpenShift CLI

You can use the oc CLI to deploy and manage resources in your Red Hat OpenShift on IBM Cloud cluster.

Red Hat OpenShift on IBM Cloud version 4.16 is now based on the RHEL 9.2 host operating system, which increases the micro-architecture requirements to x86-64-v2. As a result, host machines for IBM Cloud Satellite must support x86-64-v2 architecture for any location that contains a version 4.16 cluster. See Host system requirements for more information. In addition, client machines used to run oc client version 4.16 must also support x86-64-v2 architecture. Client machines, such as Ubuntu 20, that do not meet this micro-architecture requirement must use a RHEL 8 based oc version 4.16 client. Refer to the list of available oc version 4.16 clients.