docs: add docs command to osctl

This allows osctl to generate documentation for itself.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
This commit is contained in:
Andrew Rynhard 2019-11-13 22:23:56 +00:00
parent 83d5f4c721
commit 127fa54a76
40 changed files with 1306 additions and 0 deletions

46
cmd/osctl/cmd/docs.go Normal file
View File

@ -0,0 +1,46 @@
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
package cmd
import (
"os"
"github.com/spf13/cobra"
"github.com/spf13/cobra/doc"
"github.com/talos-systems/talos/cmd/osctl/pkg/helpers"
)
func filePrepender(filename string) string {
return "<!-- markdownlint-disable -->\n"
}
func linkHandler(s string) string { return s }
// docsCmd represents the docs command
var docsCmd = &cobra.Command{
Use: "docs <output>",
Short: "Generate documentation for the CLI",
Long: ``,
Run: func(cmd *cobra.Command, args []string) {
if len(args) != 1 {
helpers.Fatalf("an output path is required")
}
out := args[0]
if err := os.MkdirAll(out, 0777); err != nil {
helpers.Fatalf("failed to create output directory %q", out)
}
if err := doc.GenMarkdownTreeCustom(rootCmd, out, filePrepender, linkHandler); err != nil {
helpers.Fatalf("failed to generate docs: %v", err)
}
},
}
func init() {
rootCmd.AddCommand(docsCmd)
}

47
docs/osctl/osctl.md Normal file
View File

@ -0,0 +1,47 @@
<!-- markdownlint-disable -->
## osctl
A CLI for out-of-band management of Kubernetes nodes created by Talos
### Synopsis
A CLI for out-of-band management of Kubernetes nodes created by Talos
### Options
```
-h, --help help for osctl
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl cluster](osctl_cluster.md) - A collection of commands for managing local docker-based clusters
* [osctl config](osctl_config.md) - Manage the client configuration
* [osctl containers](osctl_containers.md) - List containers
* [osctl cp](osctl_cp.md) - Copy data out from the node
* [osctl dmesg](osctl_dmesg.md) - Retrieve kernel logs
* [osctl docs](osctl_docs.md) - Generate documentation for the CLI
* [osctl gen](osctl_gen.md) - Generate CAs, certificates, and private keys
* [osctl install](osctl_install.md) - Install Talos to a specified disk
* [osctl interfaces](osctl_interfaces.md) - List network interfaces
* [osctl kubeconfig](osctl_kubeconfig.md) - Download the admin kubeconfig from the node
* [osctl logs](osctl_logs.md) - Retrieve logs for a process or container
* [osctl ls](osctl_ls.md) - Retrieve a directory listing
* [osctl memory](osctl_memory.md) - Show memory usage
* [osctl mounts](osctl_mounts.md) - List mounts
* [osctl processes](osctl_processes.md) - List running processes
* [osctl reboot](osctl_reboot.md) - Reboot a node
* [osctl reset](osctl_reset.md) - Reset a node
* [osctl restart](osctl_restart.md) - Restart a process
* [osctl routes](osctl_routes.md) - List network routes
* [osctl service](osctl_service.md) - Retrieve the state of a service (or all services), control service state
* [osctl shutdown](osctl_shutdown.md) - Shutdown a node
* [osctl stats](osctl_stats.md) - Get processes stats
* [osctl time](osctl_time.md) - Gets current server time
* [osctl upgrade](osctl_upgrade.md) - Upgrade Talos on the target node
* [osctl validate](osctl_validate.md) - Validate config
* [osctl version](osctl_version.md) - Prints the version
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,30 @@
<!-- 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
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### 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
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,39 @@
<!-- markdownlint-disable -->
## osctl cluster create
Creates a local docker-based kubernetes cluster
### Synopsis
Creates a local docker-based kubernetes cluster
```
osctl cluster create [flags]
```
### Options
```
--cpus string the share of CPUs as fraction (each container) (default "1.5")
-h, --help help for create
--image string the image to use (default "docker.io/autonomy/talos:v0.3.0-alpha.7-9-g1e9a09e6-dirty")
--kubernetes-version string desired kubernetes version to run (default "1.16.2")
--masters int the number of masters to create (default 1)
--memory int the limit on memory usage in MB (each container) (default 1024)
--mtu string MTU of the docker bridge network (default "1500")
--workers int the number of workers to create (default 1)
```
### Options inherited from parent commands
```
--name string the name of the cluster (default "talos_default")
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl cluster](osctl_cluster.md) - A collection of commands for managing local docker-based clusters
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,32 @@
<!-- markdownlint-disable -->
## osctl cluster destroy
Destroys a local docker-based kubernetes cluster
### Synopsis
Destroys a local docker-based kubernetes cluster
```
osctl cluster destroy [flags]
```
### Options
```
-h, --help help for destroy
```
### Options inherited from parent commands
```
--name string the name of the cluster (default "talos_default")
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl cluster](osctl_cluster.md) - A collection of commands for managing local docker-based clusters
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,31 @@
<!-- markdownlint-disable -->
## osctl config
Manage the client configuration
### Synopsis
Manage the client configuration
### Options
```
-h, --help help for config
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [osctl config add](osctl_config_add.md) - Add a new context
* [osctl config context](osctl_config_context.md) - Set the current context
* [osctl config generate](osctl_config_generate.md) - Generate a set of configuration files
* [osctl config target](osctl_config_target.md) - Set the target for the current context
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,34 @@
<!-- markdownlint-disable -->
## osctl config add
Add a new context
### Synopsis
Add a new context
```
osctl config add <context> [flags]
```
### Options
```
--ca string the path to the CA certificate
--crt string the path to the certificate
-h, --help help for add
--key string the path to the key
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl config](osctl_config.md) - Manage the client configuration
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,31 @@
<!-- markdownlint-disable -->
## osctl config context
Set the current context
### Synopsis
Set the current context
```
osctl config context <context> [flags]
```
### Options
```
-h, --help help for context
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl config](osctl_config.md) - Manage the client configuration
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,36 @@
<!-- markdownlint-disable -->
## osctl config generate
Generate a set of configuration files
### Synopsis
Generate a set of configuration files
```
osctl config generate <cluster name> <load balancer IP or DNS name> [flags]
```
### Options
```
--additional-sans strings additional Subject-Alt-Names for the APIServer certificate
-h, --help help for generate
--install-disk string the disk to install to (default "/dev/sda")
--install-image string the image used to perform an installation (default "docker.io/autonomy/installer:v0.3.0-alpha.7-9-g1e9a09e6-dirty")
--kubernetes-version string desired kubernetes version to run (default "1.16.2")
--version string the desired machine config version to generate (default "v1alpha1")
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl config](osctl_config.md) - Manage the client configuration
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,31 @@
<!-- markdownlint-disable -->
## osctl config target
Set the target for the current context
### Synopsis
Set the target for the current context
```
osctl config target <target> [flags]
```
### Options
```
-h, --help help for target
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl config](osctl_config.md) - Manage the client configuration
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,33 @@
<!-- markdownlint-disable -->
## osctl containers
List containers
### Synopsis
List containers
```
osctl containers [flags]
```
### Options
```
-h, --help help for containers
-k, --kubernetes use the k8s.io containerd namespace
-c, --use-cri use the CRI driver
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

38
docs/osctl/osctl_cp.md Normal file
View File

@ -0,0 +1,38 @@
<!-- markdownlint-disable -->
## osctl cp
Copy data out from the node
### Synopsis
Creates an .tar.gz archive at the node starting at <src-path> and
streams it back to the client.
If '-' is given for <local-path>, archive is written to stdout.
Otherwise archive is extracted to <local-path> which should be an empty directory or
osctl creates a directory if <local-path> doesn't exist. Command doesn't preserve
ownership and access mode for the files in extract mode, while streamed .tar archive
captures ownership and permission bits.
```
osctl cp <src-path> -|<local-path> [flags]
```
### Options
```
-h, --help help for cp
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

31
docs/osctl/osctl_dmesg.md Normal file
View File

@ -0,0 +1,31 @@
<!-- markdownlint-disable -->
## osctl dmesg
Retrieve kernel logs
### Synopsis
Retrieve kernel logs
```
osctl dmesg [flags]
```
### Options
```
-h, --help help for dmesg
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

31
docs/osctl/osctl_docs.md Normal file
View File

@ -0,0 +1,31 @@
<!-- markdownlint-disable -->
## osctl docs
Generate documentation for the CLI
### Synopsis
Generate documentation for the CLI
```
osctl docs <output> [flags]
```
### Options
```
-h, --help help for docs
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

32
docs/osctl/osctl_gen.md Normal file
View File

@ -0,0 +1,32 @@
<!-- markdownlint-disable -->
## osctl gen
Generate CAs, certificates, and private keys
### Synopsis
Generate CAs, certificates, and private keys
### Options
```
-h, --help help for gen
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
* [osctl gen ca](osctl_gen_ca.md) - Generates a self-signed X.509 certificate authority
* [osctl gen crt](osctl_gen_crt.md) - Generates an X.509 Ed25519 certificate
* [osctl gen csr](osctl_gen_csr.md) - Generates a CSR using an Ed25519 private key
* [osctl gen key](osctl_gen_key.md) - Generates an Ed25519 private key
* [osctl gen keypair](osctl_gen_keypair.md) - Generates an X.509 Ed25519 key pair
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,34 @@
<!-- markdownlint-disable -->
## osctl gen ca
Generates a self-signed X.509 certificate authority
### Synopsis
Generates a self-signed X.509 certificate authority
```
osctl gen ca [flags]
```
### Options
```
-h, --help help for ca
--hours int the hours from now on which the certificate validity period ends (default 87600)
--organization string X.509 distinguished name for the Organization
--rsa generate in RSA format
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl gen](osctl_gen.md) - Generate CAs, certificates, and private keys
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,35 @@
<!-- markdownlint-disable -->
## osctl gen crt
Generates an X.509 Ed25519 certificate
### Synopsis
Generates an X.509 Ed25519 certificate
```
osctl gen crt [flags]
```
### Options
```
--ca string path to the PEM encoded CERTIFICATE
--csr string path to the PEM encoded CERTIFICATE REQUEST
-h, --help help for crt
--hours int the hours from now on which the certificate validity period ends (default 24)
--name string the basename of the generated file
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl gen](osctl_gen.md) - Generate CAs, certificates, and private keys
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,33 @@
<!-- markdownlint-disable -->
## osctl gen csr
Generates a CSR using an Ed25519 private key
### Synopsis
Generates a CSR using an Ed25519 private key
```
osctl gen csr [flags]
```
### Options
```
-h, --help help for csr
--ip string generate the certificate for this IP address
--key string path to the PEM encoded EC or RSA PRIVATE KEY
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl gen](osctl_gen.md) - Generate CAs, certificates, and private keys
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,32 @@
<!-- markdownlint-disable -->
## osctl gen key
Generates an Ed25519 private key
### Synopsis
Generates an Ed25519 private key
```
osctl gen key [flags]
```
### Options
```
-h, --help help for key
--name string the basename of the generated file
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl gen](osctl_gen.md) - Generate CAs, certificates, and private keys
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,33 @@
<!-- markdownlint-disable -->
## osctl gen keypair
Generates an X.509 Ed25519 key pair
### Synopsis
Generates an X.509 Ed25519 key pair
```
osctl gen keypair [flags]
```
### Options
```
--ca string path to the PEM encoded CERTIFICATE
-h, --help help for keypair
--ip string generate the certificate for this IP address
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl gen](osctl_gen.md) - Generate CAs, certificates, and private keys
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,37 @@
<!-- markdownlint-disable -->
## osctl install
Install Talos to a specified disk
### Synopsis
Install Talos to a specified disk
```
osctl install [flags]
```
### Options
```
--bootloader Install a booloader to the specified disk (default true)
--config string The value of talos.config
--disk string The path to the disk to install to
--extra-kernel-arg stringArray Extra argument to pass to the kernel
-h, --help help for install
--platform string The value of talos.platform
--upgrade Indicates that the install is being performed by an upgrade
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,31 @@
<!-- markdownlint-disable -->
## osctl interfaces
List network interfaces
### Synopsis
List network interfaces
```
osctl interfaces [flags]
```
### Options
```
-h, --help help for interfaces
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,32 @@
<!-- markdownlint-disable -->
## osctl kubeconfig
Download the admin kubeconfig from the node
### Synopsis
Download the admin kubeconfig from the node.
Kubeconfig will be written to PWD/kubeconfig or [local-path]/kubeconfig if specified.
```
osctl kubeconfig [local-path] [flags]
```
### Options
```
-h, --help help for kubeconfig
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

33
docs/osctl/osctl_logs.md Normal file
View File

@ -0,0 +1,33 @@
<!-- markdownlint-disable -->
## osctl logs
Retrieve logs for a process or container
### Synopsis
Retrieve logs for a process or container
```
osctl logs <id> [flags]
```
### Options
```
-h, --help help for logs
-k, --kubernetes use the k8s.io containerd namespace
-c, --use-cri use the CRI driver
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

34
docs/osctl/osctl_ls.md Normal file
View File

@ -0,0 +1,34 @@
<!-- markdownlint-disable -->
## osctl ls
Retrieve a directory listing
### Synopsis
Retrieve a directory listing
```
osctl ls [path] [flags]
```
### Options
```
-d, --depth int32 maximum recursion depth
-h, --help help for ls
-l, --long display additional file details
-r, --recurse recurse into subdirectories
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,32 @@
<!-- markdownlint-disable -->
## osctl memory
Show memory usage
### Synopsis
Show memory usage
```
osctl memory [flags]
```
### Options
```
-h, --help help for memory
-v, --verbose display extended memory statistics
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,31 @@
<!-- markdownlint-disable -->
## osctl mounts
List mounts
### Synopsis
List mounts
```
osctl mounts [flags]
```
### Options
```
-h, --help help for mounts
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,33 @@
<!-- markdownlint-disable -->
## osctl processes
List running processes
### Synopsis
List running processes
```
osctl processes [flags]
```
### Options
```
-h, --help help for processes
-s, --sort string Column to sort output by. [rss|cpu] (default "rss")
-w, --watch Stream running processes
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,31 @@
<!-- markdownlint-disable -->
## osctl reboot
Reboot a node
### Synopsis
Reboot a node
```
osctl reboot [flags]
```
### Options
```
-h, --help help for reboot
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

31
docs/osctl/osctl_reset.md Normal file
View File

@ -0,0 +1,31 @@
<!-- markdownlint-disable -->
## osctl reset
Reset a node
### Synopsis
Reset a node
```
osctl reset [flags]
```
### Options
```
-h, --help help for reset
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,33 @@
<!-- markdownlint-disable -->
## osctl restart
Restart a process
### Synopsis
Restart a process
```
osctl restart [flags]
```
### Options
```
-h, --help help for restart
-k, --kubernetes use the k8s.io containerd namespace
-c, --use-cri use the CRI driver
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,31 @@
<!-- markdownlint-disable -->
## osctl routes
List network routes
### Synopsis
List network routes
```
osctl routes [flags]
```
### Options
```
-h, --help help for routes
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,33 @@
<!-- markdownlint-disable -->
## osctl service
Retrieve the state of a service (or all services), control service state
### Synopsis
Service control command. If run without arguments, lists all the services and their state.
If service ID is specified, default action 'status' is executed which shows status of a single list service.
With actions 'start', 'stop', 'restart', service state is updated respectively.
```
osctl service [<id> [start|stop|restart|status]] [flags]
```
### Options
```
-h, --help help for service
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,31 @@
<!-- markdownlint-disable -->
## osctl shutdown
Shutdown a node
### Synopsis
Shutdown a node
```
osctl shutdown [flags]
```
### Options
```
-h, --help help for shutdown
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

33
docs/osctl/osctl_stats.md Normal file
View File

@ -0,0 +1,33 @@
<!-- markdownlint-disable -->
## osctl stats
Get processes stats
### Synopsis
Get processes stats
```
osctl stats [flags]
```
### Options
```
-h, --help help for stats
-k, --kubernetes use the k8s.io containerd namespace
-c, --use-cri use the CRI driver
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

32
docs/osctl/osctl_time.md Normal file
View File

@ -0,0 +1,32 @@
<!-- markdownlint-disable -->
## osctl time
Gets current server time
### Synopsis
Gets current server time
```
osctl time [--check server] [flags]
```
### Options
```
-c, --check string checks server time against specified ntp server (default "pool.ntp.org")
-h, --help help for time
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,32 @@
<!-- markdownlint-disable -->
## osctl upgrade
Upgrade Talos on the target node
### Synopsis
Upgrade Talos on the target node
```
osctl upgrade [flags]
```
### Options
```
-h, --help help for upgrade
-u, --image string the container image to use for performing the install
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,33 @@
<!-- markdownlint-disable -->
## osctl validate
Validate config
### Synopsis
Validate config
```
osctl validate [flags]
```
### Options
```
-c, --config string the path of the config file
-h, --help help for validate
-m, --mode string the mode to validate the config for
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

View File

@ -0,0 +1,32 @@
<!-- markdownlint-disable -->
## osctl version
Prints the version
### Synopsis
Prints the version
```
osctl version [flags]
```
### Options
```
-h, --help help for version
--short Print the short version
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019

2
go.sum
View File

@ -63,6 +63,7 @@ github.com/coreos/go-systemd v0.0.0-20190719114852-fd7a80b32e1f h1:JOrtw2xFKzlg+
github.com/coreos/go-systemd v0.0.0-20190719114852-fd7a80b32e1f/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4=
github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f h1:lBNOc5arjvs8E5mO2tbpBpLoyyu8B6e44T7hJy6potg=
github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA=
github.com/cpuguy83/go-md2man v1.0.10 h1:BSKMNlYxDvnunlTymqtgONjNnaRV1sTpcovwwjF22jk=
github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE=
github.com/davecgh/go-spew v0.0.0-20151105211317-5215b55f46b2/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@ -293,6 +294,7 @@ github.com/prometheus/procfs v0.0.3/go.mod h1:4A/X28fw3Fc593LaREMrKMqOKvUAntwMDa
github.com/prometheus/procfs v0.0.6 h1:0qbH+Yqu/cj1ViVLvEWCP6qMQ4efWUj6bQqOEA0V0U4=
github.com/prometheus/procfs v0.0.6/go.mod h1:7Qr8sr6344vo1JqZ6HhLceV9o3AJ1Ff+GxbHq6oeK9A=
github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg=
github.com/russross/blackfriday v1.5.2 h1:HyvC0ARfnZBqnXwABFeSZHpKvJHJJfPz81GNueLj0oo=
github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
github.com/ryanuber/columnize v2.1.0+incompatible h1:j1Wcmh8OrK4Q7GXY+V7SVSY8nUWQxHW5TkBe7YUl+2s=
github.com/ryanuber/columnize v2.1.0+incompatible/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts=