airshipctl/docs/source/cli/airshipctl_cluster.md
Ian Howell eecc417495 Implement airshipctl cluster status
This change introduces the subcommand `status` to the `airshipctl
cluster` command. The `status` command will iterate over all defined
custom resources in the target path, check their status against the
resources currently in the cluster, and then report results on stdout.

Change-Id: Ieaff6b91fd9055f995c5ba8ce79959356a2a8a02
Relates-To: #73
2020-06-10 10:14:12 -05:00

32 lines
1.0 KiB
Markdown

## airshipctl cluster
Manage Kubernetes clusters
### Synopsis
This command provides capabilities for interacting with a Kubernetes cluster,
such as getting status and deploying initial infrastructure.
### Options
```
-h, --help help for cluster
```
### Options inherited from parent commands
```
--airshipconf string Path to file for airshipctl configuration. (default "$HOME/.airship/config")
--debug enable verbose output
--kubeconfig string Path to kubeconfig associated with airshipctl configuration. (default "$HOME/.airship/kubeconfig")
```
### SEE ALSO
* [airshipctl](airshipctl.md) - A unified entrypoint to various airship components
* [airshipctl cluster init](airshipctl_cluster_init.md) - Deploy cluster-api provider components
* [airshipctl cluster move](airshipctl_cluster_move.md) - Move Cluster API objects, provider specific objects and all dependencies to the target cluster
* [airshipctl cluster status](airshipctl_cluster_status.md) - Retrieve statuses of deployed cluster components