airshipctl/airshipctl_cluster_list.md at 622d45f3bddc98e96abac49497909444ae666ea4

Sirisha Gopigiri 21f015b502 Updating cmd files for documentation

This PS updates cmd related to root, completion, document and
version subcommands. It also updates minor details in other
subcommands.

The description and examples are updated for the airshipctl
commands, which will be inturn used for generating documentation.
Please ignore the .md file changes in this PS. They are added for zuul
gates to pass. Here is the PS with generated documention
files https://review.opendev.org/c/airship/airshipctl/+/789250

Relates-To: #280
Change-Id: I562c15c0d25b2e9731c0eb03854d1d348eb435f2

2021-06-09 09:56:21 +00:00

983 B

Raw Blame History

airshipctl cluster list

Airshipctl command to get and list defined clusters

Synopsis

Retrieve and list the defined clusters in table form or display just the cluster names. The contents of the table would include cluster name, kubeconfig context and parent cluster name.

airshipctl cluster list [flags]

Examples


Retrieve list of clusters
# airshipctl cluster list --airshipconf /tmp/airconfig
# airshipctl cluster list -o table
# airshipctl cluster list -o name

Options

  -h, --help            help for list
  -o, --output string   output formats. Supported options are 'table' and 'name' (default "name")

Options inherited from parent commands

      --airshipconf string   path to the airshipctl configuration file. Defaults to "$HOME/.airship/config"
      --debug                enable verbose output

983 B Raw Blame History