summaryrefslogtreecommitdiffhomepage
path: root/cmd
diff options
context:
space:
mode:
authorMaisem Ali <maisem@tailscale.com>2023-03-09 17:22:06 -0800
committerMaisem Ali <maisem@gmail.com>2023-03-13 11:36:08 -0700
commit09aed46d44bcee265e8aae0e48ab85d91d5fa677 (patch)
tree4f2852c1e3b5b9c1fc8add4601546bbf491be889 /cmd
parent223713d4a1fc79a5c4f61d3655b173f7cb1e2409 (diff)
downloadtailscale-09aed46d44bcee265e8aae0e48ab85d91d5fa677.tar.xz
tailscale-09aed46d44bcee265e8aae0e48ab85d91d5fa677.zip
cmd/tailscale/cli: update docs and unhide configure
Also call out Alpha. Updates #7220 Signed-off-by: Maisem Ali <maisem@tailscale.com>
Diffstat (limited to 'cmd')
-rw-r--r--cmd/tailscale/cli/cli.go3
-rw-r--r--cmd/tailscale/cli/configure-kube.go6
-rw-r--r--cmd/tailscale/cli/configure-synology.go8
-rw-r--r--cmd/tailscale/cli/configure.go6
4 files changed, 12 insertions, 11 deletions
diff --git a/cmd/tailscale/cli/cli.go b/cmd/tailscale/cli/cli.go
index c0b43e052..714a1f995 100644
--- a/cmd/tailscale/cli/cli.go
+++ b/cmd/tailscale/cli/cli.go
@@ -113,6 +113,7 @@ change in the future.
loginCmd,
logoutCmd,
switchCmd,
+ configureCmd,
netcheckCmd,
ipCmd,
statusCmd,
@@ -150,8 +151,6 @@ change in the future.
rootCmd.Subcommands = append(rootCmd.Subcommands, serveCmd)
case slices.Contains(args, "update"):
rootCmd.Subcommands = append(rootCmd.Subcommands, updateCmd)
- case slices.Contains(args, "configure"):
- rootCmd.Subcommands = append(rootCmd.Subcommands, configureCmd)
}
if runtime.GOOS == "linux" && distro.Get() == distro.Synology {
rootCmd.Subcommands = append(rootCmd.Subcommands, configureHostCmd)
diff --git a/cmd/tailscale/cli/configure-kube.go b/cmd/tailscale/cli/configure-kube.go
index 4e45a19bb..0c7371927 100644
--- a/cmd/tailscale/cli/configure-kube.go
+++ b/cmd/tailscale/cli/configure-kube.go
@@ -26,12 +26,14 @@ func init() {
var configureKubeconfigCmd = &ffcli.Command{
Name: "kubeconfig",
- ShortHelp: "Configure kubeconfig to use Tailscale",
+ ShortHelp: "[ALPHA] Connect to a Kubernetes cluster using a Tailscale Auth Proxy",
ShortUsage: "kubeconfig <hostname-or-fqdn>",
LongHelp: strings.TrimSpace(`
-Run this command to configure your kubeconfig to use Tailscale for authentication to a Kubernetes cluster.
+Run this command to configure kubectl to connect to a Kubernetes cluster over Tailscale.
The hostname argument should be set to the Tailscale hostname of the peer running as an auth proxy in the cluster.
+
+See: https://tailscale.com/s/k8s-auth-proxy
`),
FlagSet: (func() *flag.FlagSet {
fs := newFlagSet("kubeconfig")
diff --git a/cmd/tailscale/cli/configure-synology.go b/cmd/tailscale/cli/configure-synology.go
index 86c739f2e..717d63161 100644
--- a/cmd/tailscale/cli/configure-synology.go
+++ b/cmd/tailscale/cli/configure-synology.go
@@ -35,11 +35,11 @@ var configureHostCmd = &ffcli.Command{
var synologyConfigureCmd = &ffcli.Command{
Name: "synology",
Exec: runConfigureSynology,
- ShortHelp: "Configure Synology to enable more Tailscale features",
+ ShortHelp: "Configure Synology to enable outbound connections",
LongHelp: strings.TrimSpace(`
-The 'configure-host' command is intended to run at boot as root
-to create the /dev/net/tun device and give the tailscaled binary
-permission to use it.
+This command is intended to run at boot as root on a Synology device to
+create the /dev/net/tun device and give the tailscaled binary permission
+to use it.
See: https://tailscale.com/kb/1152/synology-outbound/
`),
diff --git a/cmd/tailscale/cli/configure.go b/cmd/tailscale/cli/configure.go
index a40039081..2ebed0503 100644
--- a/cmd/tailscale/cli/configure.go
+++ b/cmd/tailscale/cli/configure.go
@@ -15,10 +15,10 @@ import (
var configureCmd = &ffcli.Command{
Name: "configure",
- ShortHelp: "Configure the host to enable more Tailscale features",
+ ShortHelp: "[ALPHA] Configure the host to enable more Tailscale features",
LongHelp: strings.TrimSpace(`
-The 'configure' command is intended to provide a way to configure different
-services on the host to enable more Tailscale features.
+The 'configure' set of commands are intended to provide a way to enable different
+services on the host to use Tailscale in more ways.
`),
FlagSet: (func() *flag.FlagSet {
fs := newFlagSet("configure")