ibmcloud-ks

View the details of a cluster

$ ibmcloud ks cluster get [[-c|--cluster]] [cluster_id]

$ ibmcloud ks cluster ca status [[-c|--cluster]] [cluster_id]

$ ibmcloud ks worker-pool ls [[-c|--cluster]] [cluster_id]

$ ibmcloud ks worker replace [[-c|--cluster]] [cluster_id] [[-w|--worker]] [worker_id]

$ ibmcloud ks help

ibmcloud ks <main_command> [<subcommand>] [<options>]

Common <main_command> examples include: cluster, worker, ingress, vlan. Each <main_command> often has its own set of <subcommand> and <options>.

cluster
    Manages Kubernetes clusters, including creation, listing, getting details, resizing, and deletion.

worker
    Manages worker nodes within a Kubernetes cluster, covering listing, reloading, updating, and deleting worker nodes.

ingress
    Manages Ingress resources for exposing applications, including Ingress secrets and ALB (Application Load Balancer) configurations.

vpc-cluster
    Manages Kubernetes clusters provisioned in an IBM Cloud VPC (Virtual Private Cloud).

vlan
    Manages VLAN (Virtual Local Area Network) resources associated with classic infrastructure clusters.

zone
    Lists available zones where Kubernetes clusters can be provisioned.

flavor
    Lists available worker node flavors (CPU, RAM, storage configurations) for cluster creation.

api
    Manages the API endpoint for the Kubernetes Service plugin.

--help
    Displays help information for the ibmcloud-ks command or its subcommands.

The ibmcloud-ks command is a plugin for the IBM Cloud Command Line Interface (CLI) that enables users to manage their Kubernetes Service resources directly from the terminal. It provides a comprehensive set of functionalities for interacting with IBM Cloud Kubernetes clusters, including provisioning and deleting clusters, managing worker nodes, configuring network components like ingress and VLANs, and handling other cluster-related settings. This plugin is essential for developers, administrators, and DevOps professionals who need to automate or script their Kubernetes cluster operations on IBM Cloud, offering a powerful alternative to the graphical user interface. It integrates seamlessly with the broader IBM Cloud CLI ecosystem, allowing for consistent authentication and project management across various IBM Cloud services.

To use ibmcloud-ks, the IBM Cloud CLI must be installed and configured. Users must authenticate to their IBM Cloud account using ibmcloud login and have the necessary IAM permissions to manage Kubernetes Service resources. Operations are often sensitive to the currently targeted region and resource group, and many commands require specifying a cluster ID or name. Network connectivity to IBM Cloud endpoints is also essential.

The ibmcloud-ks plugin is installed via the main IBM Cloud CLI using the command:
ibmcloud plugin install kubernetes-service.
Before use, ensure you are logged into IBM Cloud:
ibmcloud login

Many commands require you to target a specific cluster. After logging in, you can set the Kubernetes context using:
ibmcloud ks cluster config --cluster <cluster_name_or_ID>.
This command also sets up your local kubectl configuration to interact directly with the cluster.

The ibmcloud-ks command emerged as the primary command-line interface for managing the IBM Cloud Kubernetes Service (formerly IBM Cloud Container Service), which was introduced to provide managed Kubernetes clusters. As Kubernetes gained widespread adoption, IBM Cloud developed this dedicated plugin to empower users with programmatic control over their container orchestration platform. It has continuously evolved with new features mirroring the advancements in Kubernetes and IBM Cloud infrastructure, including support for VPC-based clusters and enhanced security features, becoming an indispensable tool for automation and integration within CI/CD pipelines.

ibmcloud(1), kubectl(1), helm(1), docker(1)