talos/docs/osctl/osctl_cluster.md
Andrey Smirnov 26f222e6db refactor: osctl code cleanup, no functional changes
Fixes #1666

1. Remove custom validation of Args, use cobra-provided validators.
2. Always use errors to stop the execution flow, don't rely on
`log.Fatal` and `panic` for normal flows. This makes sure `defer` always
has a chance to run, connection is shut down in a clean way.
3. Command `docs` is hidden, as it's not for users.
4. Global variable `globalCtx` is removed, `WithClient` is used to pass
context to the command.
5. `setupClientE` renamed to `WithClient`, `setupClient` removed.
6. Code from `cmd/root.go` moved to `pkg/helpers` when possible.

Signed-off-by: Andrey Smirnov <smirnov.andrey@gmail.com>
2019-12-20 00:32:26 +03:00

32 lines
996 B
Markdown

<!-- markdownlint-disable -->
## osctl cluster
A collection of commands for managing local docker-based clusters
### Synopsis
A collection of commands for managing local docker-based clusters
### Options
```
-h, --help help for cluster
--name string the name of the cluster (default "talos-default")
```
### Options inherited from parent commands
```
--context string Context to be used in command
-e, --endpoints strings override default endpoints in Talos configuration
-n, --nodes strings target the specified nodes
--talosconfig string The path to the Talos configuration file (default "/home/user/.talos/config")
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [osctl cluster create](osctl_cluster_create.md) - Creates a local docker-based kubernetes cluster
* [osctl cluster destroy](osctl_cluster_destroy.md) - Destroys a local docker-based kubernetes cluster