cmd/tailscale/cli: update docs and unhide configure

Also call out Alpha.

Updates #7220

Signed-off-by: Maisem Ali <maisem@tailscale.com>
pull/7548/head
Maisem Ali 2 years ago committed by Maisem Ali
parent 223713d4a1
commit 09aed46d44

@ -113,6 +113,7 @@ change in the future.
loginCmd, loginCmd,
logoutCmd, logoutCmd,
switchCmd, switchCmd,
configureCmd,
netcheckCmd, netcheckCmd,
ipCmd, ipCmd,
statusCmd, statusCmd,
@ -150,8 +151,6 @@ change in the future.
rootCmd.Subcommands = append(rootCmd.Subcommands, serveCmd) rootCmd.Subcommands = append(rootCmd.Subcommands, serveCmd)
case slices.Contains(args, "update"): case slices.Contains(args, "update"):
rootCmd.Subcommands = append(rootCmd.Subcommands, updateCmd) 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 { if runtime.GOOS == "linux" && distro.Get() == distro.Synology {
rootCmd.Subcommands = append(rootCmd.Subcommands, configureHostCmd) rootCmd.Subcommands = append(rootCmd.Subcommands, configureHostCmd)

@ -26,12 +26,14 @@ func init() {
var configureKubeconfigCmd = &ffcli.Command{ var configureKubeconfigCmd = &ffcli.Command{
Name: "kubeconfig", 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>", ShortUsage: "kubeconfig <hostname-or-fqdn>",
LongHelp: strings.TrimSpace(` 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. 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 { FlagSet: (func() *flag.FlagSet {
fs := newFlagSet("kubeconfig") fs := newFlagSet("kubeconfig")

@ -35,11 +35,11 @@ var configureHostCmd = &ffcli.Command{
var synologyConfigureCmd = &ffcli.Command{ var synologyConfigureCmd = &ffcli.Command{
Name: "synology", Name: "synology",
Exec: runConfigureSynology, Exec: runConfigureSynology,
ShortHelp: "Configure Synology to enable more Tailscale features", ShortHelp: "Configure Synology to enable outbound connections",
LongHelp: strings.TrimSpace(` LongHelp: strings.TrimSpace(`
The 'configure-host' command is intended to run at boot as root This command is intended to run at boot as root on a Synology device to
to create the /dev/net/tun device and give the tailscaled binary create the /dev/net/tun device and give the tailscaled binary permission
permission to use it. to use it.
See: https://tailscale.com/kb/1152/synology-outbound/ See: https://tailscale.com/kb/1152/synology-outbound/
`), `),

@ -15,10 +15,10 @@ import (
var configureCmd = &ffcli.Command{ var configureCmd = &ffcli.Command{
Name: "configure", Name: "configure",
ShortHelp: "Configure the host to enable more Tailscale features", ShortHelp: "[ALPHA] Configure the host to enable more Tailscale features",
LongHelp: strings.TrimSpace(` LongHelp: strings.TrimSpace(`
The 'configure' command is intended to provide a way to configure different The 'configure' set of commands are intended to provide a way to enable different
services on the host to enable more Tailscale features. services on the host to use Tailscale in more ways.
`), `),
FlagSet: (func() *flag.FlagSet { FlagSet: (func() *flag.FlagSet {
fs := newFlagSet("configure") fs := newFlagSet("configure")

Loading…
Cancel
Save