mirrors/talos
1
0
Fork 0
mirror of https://github.com/siderolabs/talos.git synced 2025-10-03 03:31:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve CLI menu and metal docs

Browse Source 
This addresses a few common points of confusion for new users.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
This commit is contained in:
Andrew Rynhard 2020-04-15 20:08:27 -07:00
parent 3791fb5cbc
commit 0051a43aee
13 changed files with 26 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
cmd/talosctl/cmd/mgmt/config.go
View File

@ -35,10 +35,13 @@ var (
// genConfigCmd represents the gen config command.
var genConfigCmd = &cobra.Command{
Use: "config <cluster name> https://<load balancer IP or DNS name>",
Use: "config <cluster name> <cluster endpoint>",
Short: "Generates a set of configuration files for Talos cluster",
Long: ``,
Args: cobra.ExactArgs(2),
Long: `The cluster endpoint is the URL for the Kubernetes API. If you decide to use
a control plane node, common in a single node control plane setup, use port 6443 as
this is the port that the API server binds to on every control plane node. For an HA
setup, usually involving a load balancer, use the IP and port of the load balancer.`,
Args: cobra.ExactArgs(2),
RunE: func(cmd *cobra.Command, args []string) error {
// Validate url input to ensure it has https:// scheme before we attempt to gen
u, err := url.Parse(args[1])

4
cmd/talosctl/cmd/talos/logs.go
View File

@ -32,8 +32,8 @@ var (
// logsCmd represents the logs command
var logsCmd = &cobra.Command{
Use: "logs <id>",
Short: "Retrieve logs for a process or container",
Use: "logs <service name>",
Short: "Retrieve logs for a service",
Long: ``,
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {

2
docs/talosctl/talosctl.md
View File

@ -29,7 +29,7 @@ A CLI for out-of-band management of Kubernetes nodes created by Talos
* [talosctl interfaces](talosctl_interfaces.md) - List network interfaces
* [talosctl kubeconfig](talosctl_kubeconfig.md) - Download the admin kubeconfig from the node
* [talosctl list](talosctl_list.md) - Retrieve a directory listing
* [talosctl logs](talosctl_logs.md) - Retrieve logs for a process or container
* [talosctl logs](talosctl_logs.md) - Retrieve logs for a service
* [talosctl memory](talosctl_memory.md) - Show memory usage
* [talosctl mounts](talosctl_mounts.md) - List mounts
* [talosctl processes](talosctl_processes.md) - List running processes

7
docs/talosctl/talosctl_gen_config.md
View File

@ -5,10 +5,13 @@ Generates a set of configuration files for Talos cluster
### Synopsis
Generates a set of configuration files for Talos cluster
The cluster endpoint is the URL for the Kubernetes API. If you decide to use
a control plane node, common in a single node control plane setup, use port 6443 as
this is the port that the API server binds to on every control plane node. For an HA
setup, usually involving a load balancer, use the IP and port of the load balancer.
```
talosctl gen config <cluster name> https://<load balancer IP or DNS name> [flags]
talosctl gen config <cluster name> <cluster endpoint> [flags]
```
### Options

6
docs/talosctl/talosctl_logs.md
View File

@ -1,14 +1,14 @@
<!-- markdownlint-disable -->
## talosctl logs
Retrieve logs for a process or container
Retrieve logs for a service
### Synopsis
Retrieve logs for a process or container
Retrieve logs for a service
```
talosctl logs <id> [flags]
talosctl logs <service name> [flags]
```
### Options

2
docs/website/content/v0.3/en/guides/cloud/aws.md
View File

@ -140,7 +140,7 @@ We will need these soon.
Using the DNS name of the loadbalancer created earlier, generate the base configuration files for the Talos machines:
```bash
$ osctl config generate talos-k8s-aws-tutorial https://<load balancer IP or DNS>
$ osctl config generate talos-k8s-aws-tutorial https://<load balancer IP or DNS>:<port>
created init.yaml
created controlplane.yaml
created join.yaml

2
docs/website/content/v0.3/en/guides/cloud/digitalocean.md
View File

@ -53,7 +53,7 @@ Save it, as we will need it in the next step.
Using the DNS name of the loadbalancer created earlier, generate the base configuration files for the Talos machines:
```bash
$ osctl config generate talos-k8s-digital-ocean-tutorial https://<load balancer IP or DNS>
$ osctl config generate talos-k8s-digital-ocean-tutorial https://<load balancer IP or DNS>:<port>
created init.yaml
created controlplane.yaml
created join.yaml

6
docs/website/content/v0.3/en/guides/cloud/vmware.md
View File

@ -23,17 +23,15 @@ Prior to starting, it is important to have the following infrastructure in place
Using the DNS name or name of the loadbalancer used in the prereq steps, generate the base configuration files for the Talos machines:
```bash
$ osctl config generate talos-k8s-vmware-tutorial https://<load balancer IP or DNS>
$ osctl config generate talos-k8s-vmware-tutorial https://<load balancer IP or DNS>:<port>
created init.yaml
created controlplane.yaml
created join.yaml
created talosconfig
```
> Note: If you are using a DNS record, you will want to specify the port for the API Server (`tcp/6443`)
```bash
$ osctl config generate talos-k8s-vmware-tutorial https://<DNS name>:6443
$ osctl config generate talos-k8s-vmware-tutorial https://<load balancer IP or DNS>:<port>
created init.yaml
created controlplane.yaml
created join.yaml

2
docs/website/content/v0.3/en/guides/metal/matchbox.md
View File

@ -17,7 +17,7 @@ The setup and configuration of DHCP will not be covered.
Using the DNS name of the load balancer, generate the base configuration files for the Talos machines:
```bash
$ osctl config generate talos-k8s-metal-tutorial https://<load balancer IP or DNS>
$ osctl config generate talos-k8s-metal-tutorial https://<load balancer IP or DNS>:<port>
created init.yaml
created controlplane.yaml
created join.yaml

2
docs/website/content/v0.4/en/guides/cloud/aws.md
View File

@ -140,7 +140,7 @@ We will need these soon.
Using the DNS name of the loadbalancer created earlier, generate the base configuration files for the Talos machines:
```bash
$ talosctl gen config talos-k8s-aws-tutorial https://<load balancer IP or DNS>
$ talosctl gen config talos-k8s-aws-tutorial https://<load balancer IP or DNS>:<port>
created init.yaml
created controlplane.yaml
created join.yaml

2
docs/website/content/v0.4/en/guides/cloud/digitalocean.md
View File

@ -53,7 +53,7 @@ Save it, as we will need it in the next step.
Using the DNS name of the loadbalancer created earlier, generate the base configuration files for the Talos machines:
```bash
$ talosctl gen config talos-k8s-digital-ocean-tutorial https://<load balancer IP or DNS>
$ talosctl gen config talos-k8s-digital-ocean-tutorial https://<load balancer IP or DNS>:<port>
created init.yaml
created controlplane.yaml
created join.yaml

4
docs/website/content/v0.4/en/guides/cloud/vmware.md
View File

@ -23,15 +23,13 @@ Prior to starting, it is important to have the following infrastructure in place
Using the DNS name or name of the loadbalancer used in the prereq steps, generate the base configuration files for the Talos machines:
```bash
$ talosctl gen config talos-k8s-vmware-tutorial https://<load balancer IP or DNS>
$ talosctl gen config talos-k8s-vmware-tutorial https://<load balancer IP or DNS>:<port>
created init.yaml
created controlplane.yaml
created join.yaml
created talosconfig
```
> Note: If you are using a DNS record, you will want to specify the port for the API Server (`tcp/6443`)
```bash
$ talosctl gen config talos-k8s-vmware-tutorial https://<DNS name>:6443
created init.yaml

2
docs/website/content/v0.4/en/guides/metal/matchbox.md
View File

@ -17,7 +17,7 @@ The setup and configuration of DHCP will not be covered.
Using the DNS name of the load balancer, generate the base configuration files for the Talos machines:
```bash
$ talosctl gen config talos-k8s-metal-tutorial https://<load balancer IP or DNS>
$ talosctl gen config talos-k8s-metal-tutorial https://<load balancer IP or DNS>:<port>
created init.yaml
created controlplane.yaml
created join.yaml