Installing IBM Cloud Pak® CLI (cloudctl)
You can use IBM Cloud Pak® CLI (cloudctl) to view information about your cluster, manage your cluster, install Helm charts and workloads, and more.
After you install IBM Cloud Pak® CLI (cloudctl), you can install another supported CLI on Windows, Linux®, or macOS.
To set up the IBM Cloud Pak® CLI, complete the following steps:
From the console, select the user icon , then click Configure client.
Click Install CLI tools. Tip: You can also install the IBM Cloud Pak® CLI without the console by entering the curl commands in this procedure at the command prompt, or in a Terminal window.
Note: To download the installation file by using curl commands, see Downloading the installation file by using curl commands. After you download the file, you can continue from step 3 to set up cloudctl.
Expand Install IBM Cloud Pak CLI (cloudctl). Read the text, then copy and run the curl command for your operating system. Continue the installation procedure in the product documentation.
Choose the curl command for the applicable operating system to download the required files. For example, you can run the following command for macOS:
curl -kLo <install_file> https://<Cluster Master Host>:<Cluster Master API Port>/api/cli/cloudctl-darwin-amd64
Run the following example command to download the required files on the Linux operating system, replacing the variables with information for your environment:
curl -kLo <install_file> https://<Cluster Master Host>:<Cluster Master API Port>/api/cli/cloudctl-linux-amd64
After you run the curl command for your operating system, continue to install the IBM Cloud Pak® CLI.
To install the IBM Cloud Pak® CLI, run the command that matches your client computer operating system, where
<path_to_installer>is the path to the directory where you downloaded the cloudctl file, and
<install_file>is the downloaded file name.
For example, for Linux and macOS, run the following commands to change and move the file. Remember that the curl command for your cluster is located in the console:
chmod 755 <path_to_installer>/<install_file>
sudo mv <path_to_installer>/<install_file> /usr/local/bin/cloudctl
For Windows, rename the downloaded file to
cloudctland place the file on the PATH environment variable.
Confirm that cloudctl is installed:
The cloudctl usage is displayed.
Set up the
kubectlCLI. See Installing the Kubernetes CLI (kubectl) for installation instructions.
Log in to your cluster with the following command, where
<Cluster Master Host>is the external host name or IP address for your master or leading master node. See the Master endpoint section of the Endpoints documentation.
cloudctl login -a https://<Cluster Master Host>:<Cluster Master API Port> --skip-ssl-validation
You can now use cloudctl to view information about your cluster and manage your clusters.
Downloading the installation file by using curl commands
You can complete the following steps to download the installation file:
Get the service hostnames. Use the
management-ingressservice hostname in the command to download the installation file.
oc get route -n kube-system
Following is a sample output:
NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD icp-console icp-console.apps.an.os.example.abc.com management-ingress <all> passthrough/Redirect None icp-proxy icp-proxy.apps.an.os.example.abc.com nginx-ingress https passthrough/Redirect None
Download the installation file.
For macOS, run the following command:
curl -kLo cloudctl-darwin-amd64-v3.2.4-1675 https://icp-console.apps.an.os.example.abc.com:443/api/cli/cloudctl-darwin-amd64
For Linux® x86_64, run the following command:
curl -kLo cloudctl-linux-amd64-v3.2.4-1675 https://icp-console.apps.an.os.example.abc.com:443/api/cli/cloudctl-linux-amd64
For Linux on Power (ppc64le), run the following command:
curl -kLo cloudctl-linux-ppc64le-v3.2.4-1675 https://icp-console.apps.an.os.example.abc.com:443/api/cli/cloudctl-linux-ppc64le
For Windows (64-bit), run the following command:
curl -kLo cloudctl-win-amd64-v3.2.4-1675.exe https://icp-console.apps.an.os.example.abc.com:443/api/cli/cloudctl-win-amd64.exe
For Linux on IBM Z and LinuxONE, run the following command:
curl -kLo cloudctl-linux-s390x-v3.2.4-1675 https://icp-console.apps.an.os.example.abc.com:443/api/cli/cloudctl-linux-s390x