diff --git a/cmd/talosctl/cmd/mgmt/config.go b/cmd/talosctl/cmd/mgmt/config.go index 20c5084c2..5de40fde9 100644 --- a/cmd/talosctl/cmd/mgmt/config.go +++ b/cmd/talosctl/cmd/mgmt/config.go @@ -35,10 +35,13 @@ var ( // genConfigCmd represents the gen config command. var genConfigCmd = &cobra.Command{ - Use: "config https://", + Use: "config ", 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]) diff --git a/cmd/talosctl/cmd/talos/logs.go b/cmd/talosctl/cmd/talos/logs.go index 3091b558a..2f7d35eb6 100644 --- a/cmd/talosctl/cmd/talos/logs.go +++ b/cmd/talosctl/cmd/talos/logs.go @@ -32,8 +32,8 @@ var ( // logsCmd represents the logs command var logsCmd = &cobra.Command{ - Use: "logs ", - Short: "Retrieve logs for a process or container", + Use: "logs ", + Short: "Retrieve logs for a service", Long: ``, Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/docs/talosctl/talosctl.md b/docs/talosctl/talosctl.md index e33da37aa..5bbf7f35a 100644 --- a/docs/talosctl/talosctl.md +++ b/docs/talosctl/talosctl.md @@ -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 diff --git a/docs/talosctl/talosctl_gen_config.md b/docs/talosctl/talosctl_gen_config.md index ad52b2e9d..a2cf59749 100644 --- a/docs/talosctl/talosctl_gen_config.md +++ b/docs/talosctl/talosctl_gen_config.md @@ -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 https:// [flags] +talosctl gen config [flags] ``` ### Options diff --git a/docs/talosctl/talosctl_logs.md b/docs/talosctl/talosctl_logs.md index b615c5609..931ce5274 100644 --- a/docs/talosctl/talosctl_logs.md +++ b/docs/talosctl/talosctl_logs.md @@ -1,14 +1,14 @@ ## 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 [flags] +talosctl logs [flags] ``` ### Options diff --git a/docs/website/content/v0.3/en/guides/cloud/aws.md b/docs/website/content/v0.3/en/guides/cloud/aws.md index be812ca66..a0075c8f8 100644 --- a/docs/website/content/v0.3/en/guides/cloud/aws.md +++ b/docs/website/content/v0.3/en/guides/cloud/aws.md @@ -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:// +$ osctl config generate talos-k8s-aws-tutorial https://: created init.yaml created controlplane.yaml created join.yaml diff --git a/docs/website/content/v0.3/en/guides/cloud/digitalocean.md b/docs/website/content/v0.3/en/guides/cloud/digitalocean.md index 975bcbd01..a3fcfa296 100644 --- a/docs/website/content/v0.3/en/guides/cloud/digitalocean.md +++ b/docs/website/content/v0.3/en/guides/cloud/digitalocean.md @@ -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:// +$ osctl config generate talos-k8s-digital-ocean-tutorial https://: created init.yaml created controlplane.yaml created join.yaml diff --git a/docs/website/content/v0.3/en/guides/cloud/vmware.md b/docs/website/content/v0.3/en/guides/cloud/vmware.md index f7e4a6b29..68b13169c 100644 --- a/docs/website/content/v0.3/en/guides/cloud/vmware.md +++ b/docs/website/content/v0.3/en/guides/cloud/vmware.md @@ -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:// +$ osctl config generate talos-k8s-vmware-tutorial https://: 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://:6443 +$ osctl config generate talos-k8s-vmware-tutorial https://: created init.yaml created controlplane.yaml created join.yaml diff --git a/docs/website/content/v0.3/en/guides/metal/matchbox.md b/docs/website/content/v0.3/en/guides/metal/matchbox.md index 3d0e832f2..b89f66ed6 100644 --- a/docs/website/content/v0.3/en/guides/metal/matchbox.md +++ b/docs/website/content/v0.3/en/guides/metal/matchbox.md @@ -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:// +$ osctl config generate talos-k8s-metal-tutorial https://: created init.yaml created controlplane.yaml created join.yaml diff --git a/docs/website/content/v0.4/en/guides/cloud/aws.md b/docs/website/content/v0.4/en/guides/cloud/aws.md index 5057f3896..63e13e170 100644 --- a/docs/website/content/v0.4/en/guides/cloud/aws.md +++ b/docs/website/content/v0.4/en/guides/cloud/aws.md @@ -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:// +$ talosctl gen config talos-k8s-aws-tutorial https://: created init.yaml created controlplane.yaml created join.yaml diff --git a/docs/website/content/v0.4/en/guides/cloud/digitalocean.md b/docs/website/content/v0.4/en/guides/cloud/digitalocean.md index baab9c182..afacf683b 100644 --- a/docs/website/content/v0.4/en/guides/cloud/digitalocean.md +++ b/docs/website/content/v0.4/en/guides/cloud/digitalocean.md @@ -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:// +$ talosctl gen config talos-k8s-digital-ocean-tutorial https://: created init.yaml created controlplane.yaml created join.yaml diff --git a/docs/website/content/v0.4/en/guides/cloud/vmware.md b/docs/website/content/v0.4/en/guides/cloud/vmware.md index e1ea50c0d..314f47890 100644 --- a/docs/website/content/v0.4/en/guides/cloud/vmware.md +++ b/docs/website/content/v0.4/en/guides/cloud/vmware.md @@ -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:// +$ talosctl gen config talos-k8s-vmware-tutorial https://: 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://:6443 created init.yaml diff --git a/docs/website/content/v0.4/en/guides/metal/matchbox.md b/docs/website/content/v0.4/en/guides/metal/matchbox.md index 47951cdba..89744ee3b 100644 --- a/docs/website/content/v0.4/en/guides/metal/matchbox.md +++ b/docs/website/content/v0.4/en/guides/metal/matchbox.md @@ -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:// +$ talosctl gen config talos-k8s-metal-tutorial https://: created init.yaml created controlplane.yaml created join.yaml