Last modified May 30, 2023
'gsctl show cluster' command reference
gsctl and the REST API are being phased out. We recommend to familiarize yourself with our Management API and the kubectl gs plugin as a future-proof replacement. We provide a migration page to help you with the transition.
gsctl show cluster command displays details of a cluster.
gsctl show cluster f0r14
You can also use the cluster’s name for identifying the cluster:
gsctl show cluster "Cluster name"
Example output for an AWS based cluster featuring node pools:
Cluster ID: ggf8v Name: Testing - Team upstate Created: 2020 May 04, 16:54 UTC Organization: acme Kubernetes API endpoint: https://api.ggf8v.REDACTED.aws.gigantic.io Release version: 11.2.1 Labels: usage=testing team=upstate locked=false Web UI: https://happa.ggf8v.REDACTED.aws.gigantic.io/organizations/acme/clusters/ggf8v Master availability zones: eu-central-1b Masters: 1 Masters ready: 1 Size: 3 nodes in 1 node pool CPUs in nodes: 12 RAM in nodes (GB): 48 This cluster has node pools. For details, use gsctl list nodepools ggf8v For details on a specific node pool, use gsctl show nodepool ggf8v/<nodepool-id>
Example output for a KVM based cluster:
ID: tjjm7 Name: Staging Cluster Created: 2018 Mar 06, 14:23 UTC Organization: acme Kubernetes API endpoint: https://api.tjjm7.REDACTED.kvm.gigantic.io Release version: 2.2.1 Worker node scaling: pinned to 2 Worker nodes running: 2 CPU cores in workers: 4 RAM in worker nodes (GB): 4 Storage in worker nodes (GB): 80 Ingress port for http: 30020 Ingress port for https: 30021
The output lines in detail:
- ID: unique cluster identifier
- Name: cluster name
- Created: date and time of cluster creation
- Organization: organization owning the cluster
- Kubernetes API endpoint: URL of the Kubernetes API for this cluster
- Masters: (only for AWS) Number of control plane nodes in the cluster
- Master availability zones: (only for AWS) Availability zone(s) of the control plane node(s)
- Release version: Version number of the workload cluster release used in this cluster
- Worker node scaling: Scaling limits. Shows either
autoscaling between <min> and <max>for an autoscaling cluster, or
pinned to <num>where autoscaling is disabled or where it’s not available.
- Desired worker node count: Only shown for autoscaling clusters. The number of worker nodes the autoscaler intends to have running.
- Worker nodes running: The current number of worker nodes running in this cluster.
- Worker EC2 instance type: (only on AWS) EC2 instance type used for worker nodes
- Worker VM size: (only on Azure) VM size used for worker nodes
- CPU cores in workers: total number of CPU cores in all worker nodes in this cluster
- RAM in worker nodes (GB): total amount of memory in all worker nodes in this cluster
- Storage in worker nodes (GB): (only for KVM) total amount of local storage in all worker nodes in this cluster
- Ingress port for <protocol>: (only for KVM) the port to forward traffic to from your data center’s load balancer(s) to this cluster’s ingress controller for that specific protocol
- AWS account: (only on AWS) If the cluster is running using non-default provider credentials, here we show the AWS account ID
- Azure subscription: (only on Azure) If the cluster is running using non-default provider credentials, here we show the subscription ID
- Azure tenant: (only on Azure) If the cluster is running using non-default provider credentials, here we show the tenant ID
- Labels (only on AWS) user defined labels. Only available for clusters with workload cluster release v10.0.0 and above for AWS
Note that some dynamic pieces of information, like the current number of workers, and the desired worker count, may take up to five minutes to be updated.
Need help, got feedback?
We listen to your Slack support channel. You can also reach us at firstname.lastname@example.org. And of course, we welcome your pull requests!