ibmcloud-ks
manages IBM Cloud Kubernetes Service clusters
TLDR
SYNOPSIS
ibmcloud ks command [subcommand] [options]
DESCRIPTION
ibmcloud ks is the IBM Cloud Kubernetes Service plugin for the IBM Cloud CLI. It drives the full lifecycle of managed Kubernetes and Red Hat OpenShift clusters: creating them on classic, VPC, or Satellite infrastructure, adding and resizing worker pools, upgrading versions, and wiring up ingress, storage, and key management.Install it with `ibmcloud plugin install ks`, then log in and target an account and resource group before use. The plugin manages infrastructure only; workloads inside a cluster are handled by `kubectl`, whose configuration is fetched with ibmcloud ks cluster config.Most subcommands follow a `noun verb` shape (`cluster ls`, `worker get`, `worker-pool resize`) and accept --output json for scripting. Cluster-scoped commands take -c/--cluster with a cluster name or ID.
PARAMETERS
cluster ls [-l LOCATION] [--provider PROVIDER] [--output json]
List clusters, optionally filtered by location or infrastructure provider (`classic`, `vpc-classic`, `vpc-gen2`, `satellite`).cluster get --cluster CLUSTER [--show-resources] [--output json]
Show the details of a cluster.cluster config --cluster CLUSTER [--admin] [--endpoint ENDPOINT] [--network] [--skip-rbac]
Download the Kubernetes configuration and certificates for `kubectl`. --admin retrieves administrator certificates and keys.cluster create classic --name NAME --zone ZONE --flavor FLAVOR
Create a cluster on classic infrastructure. Common extras are --workers, --version, --hardware, --private-vlan, and --public-service-endpoint.cluster create vpc-gen2 --name NAME --zone ZONE --flavor FLAVOR --vpc-id ID --subnet-id ID
Create a cluster on VPC infrastructure.cluster rm --cluster CLUSTER [--delete-storage] [-f]
Delete a cluster. Worker nodes, apps, and containers are removed permanently.worker ls --cluster CLUSTER [--worker-pool POOL] [--output json]
List the worker nodes of a cluster.worker reload --worker WORKER
Reimage a worker node and reinstall Kubernetes at the latest patch version.worker-pool create, worker-pool ls, worker-pool rm
Manage worker pools, the groups that define flavor and size per zone.worker-pool resize --cluster CLUSTER --worker-pool POOL --size-per-zone SIZE
Change the number of workers per zone in a pool.zone add, zone ls, zone rm
Manage the zones a worker pool spans in a multizone cluster.versions
List the available Kubernetes and OpenShift versions.locations, flavor ls, vpc ls, vlan ls
List supported locations, worker node flavors, VPCs, and VLANs.ingress alb ls, nlb-dns ls
Manage Ingress ALBs and network load balancer DNS records.api-key reset
Reset the IAM API key that the cluster uses to access account infrastructure.-q
Suppress the message of the day and update reminders.
CAVEATS
cluster create needs --flavor, --name, and --zone at minimum, plus --vpc-id and --subnet-id for VPC clusters. Run ibmcloud ks locations, ibmcloud ks zone ls, and ibmcloud ks flavor ls --zone ZONE to find valid values.Clusters bill for their worker nodes, load balancers, and attached storage for as long as they exist. cluster rm is irreversible and does not delete persistent volumes unless --delete-storage is given.Older releases used flat command names such as `ibmcloud ks clusters` and `ibmcloud ks workers`. These aliases still resolve but the documented form is the `cluster ls` / `worker ls` style used above.
HISTORY
ibmcloud ks started as the `container-service` plugin for the Bluemix CLI. It was renamed `ks` and reorganized into `noun verb` subcommands as IBM Cloud Kubernetes Service matured, and later gained Red Hat OpenShift support alongside the sibling `ibmcloud oc` alias.
SEE ALSO
ibmcloud(1), kubectl(1), oc(1), ibmcloud-cr(1), ibmcloud-iam(1), ibmcloud-target(1)
