Last modified June 26, 2026
'kubectl gs get clusters' command reference
Like with all get commands in kubectl, this command can be used to get details on one item, a cluster in this case, or list several of them.
Usage
Get a list of clusters
Simply execute
kubectl gs get clusters
to list some information on all clusters available to you in the current installation. Use --all-namespace (if you have the permission to do so) or specify a namespace using the --namespace flag.
Here is some example output:
NAMESPACE NAME AGE PHASE RELEASE SERVICE PRIORITY ORGANIZATION DESCRIPTION
org-giantswarm-production operations 2y206d Provisioned 34.4.0 highest giantswarm-production Operations Cluster
org-giantswarm gazelle 2y232d Provisioned 34.0.0 highest giantswarm gazelle MC
Get specific cluster
When used with a cluster name as additional argument, the command will show details for a single cluster. Example:
kubectl gs get clusters ab12c
Note: As an alternative to get clusters, get cluster will also work.
Output
The standard tabular output format features these columns:
NAME: Unique identifier of the cluster.AGE: How long ago was the cluster created.PHASE: Current lifecycle phase of the cluster. Either of:Pending: The cluster is not yet being provisioned.Provisioning: The cluster is currently being created or updated.Provisioned: The cluster is running.Deleting: The cluster is being deleted.Failed: The cluster encountered an error.
RELEASE: Workload cluster release version of the cluster.SERVICE PRIORITY: Service priority level of the cluster.ORGANIZATION: Organization owning the cluster.DESCRIPTION: User-friendly description for the cluster.
Flags
Here we document the flags that have a particular meaning for the get clusters command. Use kubectl gs get clusters --help for a full list.
--output/-o
kubectl commonly allows to specify the output format for all get subcommands. kubectl gs get clusters is no different.
YAML output
To inspect a cluster’s main custom resource in YAML notation, add the --output yaml flag (or -o yaml in short) to the command.
The following example command would print the main resource for cluster ab12c. It would return the Cluster resource.
kubectl gs get clusters ab12c --output yaml
When applied without a cluster name argument, the output will be a list of resources. Example:
$ kubectl gs get clusters --output yaml
apiVersion: v1
kind: List
items:
- apiVersion: cluster.x-k8s.io/v1beta1
kind: Cluster
...
Related
kubectl gs login- Ensure an authenticated kubectl context.
Need help, got feedback?
We listen to your Slack support channel. You can also reach us at support@giantswarm.io. And of course, we welcome your pull requests!