From 760ad89f1f5abb730710162c25590e22726c59c6 Mon Sep 17 00:00:00 2001 From: Priya Wadhwa Date: Fri, 6 Nov 2020 13:43:54 -0800 Subject: [PATCH] Update docs to include --help flag --- site/content/en/docs/commands/addons.md | 39 ++++--------------- site/content/en/docs/commands/cache.md | 37 +++--------------- site/content/en/docs/commands/completion.md | 7 +--- site/content/en/docs/commands/config.md | 39 ++++--------------- site/content/en/docs/commands/dashboard.md | 4 +- site/content/en/docs/commands/delete.md | 2 +- site/content/en/docs/commands/docker-env.md | 2 +- site/content/en/docs/commands/help.md | 7 +--- site/content/en/docs/commands/ip.md | 7 +--- site/content/en/docs/commands/kubectl.md | 7 +--- site/content/en/docs/commands/logs.md | 2 +- site/content/en/docs/commands/mount.md | 2 +- site/content/en/docs/commands/node.md | 39 ++++--------------- site/content/en/docs/commands/pause.md | 2 +- site/content/en/docs/commands/podman-env.md | 2 +- site/content/en/docs/commands/profile.md | 16 ++------ site/content/en/docs/commands/service.md | 11 ++---- site/content/en/docs/commands/ssh-key.md | 7 +--- site/content/en/docs/commands/ssh.md | 2 +- site/content/en/docs/commands/start.md | 2 +- site/content/en/docs/commands/status.md | 2 +- site/content/en/docs/commands/stop.md | 2 +- site/content/en/docs/commands/tunnel.md | 2 +- site/content/en/docs/commands/unpause.md | 2 +- site/content/en/docs/commands/update-check.md | 7 +--- .../en/docs/commands/update-context.md | 7 +--- site/content/en/docs/commands/version.md | 2 +- 27 files changed, 55 insertions(+), 205 deletions(-) diff --git a/site/content/en/docs/commands/addons.md b/site/content/en/docs/commands/addons.md index d72137ec18..621179f56f 100644 --- a/site/content/en/docs/commands/addons.md +++ b/site/content/en/docs/commands/addons.md @@ -17,18 +17,13 @@ addons modifies minikube addons files using subcommands like "minikube addons en minikube addons SUBCOMMAND [flags] ``` -### Options - -``` - -h, --help help for addons -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -55,18 +50,13 @@ Configures the addon w/ADDON_NAME within minikube (example: minikube addons conf minikube addons configure ADDON_NAME [flags] ``` -### Options - -``` - -h, --help help for configure -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -93,18 +83,13 @@ Disables the addon w/ADDON_NAME within minikube (example: minikube addons disabl minikube addons disable ADDON_NAME [flags] ``` -### Options - -``` - -h, --help help for disable -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -131,18 +116,13 @@ Enables the addon w/ADDON_NAME within minikube (example: minikube addons enable minikube addons enable ADDON_NAME [flags] ``` -### Options - -``` - -h, --help help for enable -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -170,18 +150,13 @@ Simply type addons help [path to command] for full details. minikube addons help [command] [flags] ``` -### Options - -``` - -h, --help help for help -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -211,7 +186,6 @@ minikube addons list [flags] ### Options ``` - -h, --help help for list -o, --output string minikube addons list --output OUTPUT. json, list (default "list") ``` @@ -221,6 +195,7 @@ minikube addons list [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -251,7 +226,6 @@ minikube addons open ADDON_NAME [flags] ``` --format string Format to output addons URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}") - -h, --help help for open --https Open the addons URL with https instead of http --interval int The time interval for each check that wait performs in seconds (default 1) --url Display the Kubernetes addons URL in the CLI instead of opening it in the default browser @@ -264,6 +238,7 @@ minikube addons open ADDON_NAME [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/cache.md b/site/content/en/docs/commands/cache.md index 25e0e8cf30..3917b19b70 100644 --- a/site/content/en/docs/commands/cache.md +++ b/site/content/en/docs/commands/cache.md @@ -13,18 +13,13 @@ Add, delete, or push a local image into minikube Add, delete, or push a local image into minikube -### Options - -``` - -h, --help help for cache -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -51,18 +46,13 @@ Add an image to local cache. minikube cache add [flags] ``` -### Options - -``` - -h, --help help for add -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -89,18 +79,13 @@ Delete an image from the local cache. minikube cache delete [flags] ``` -### Options - -``` - -h, --help help for delete -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -128,18 +113,13 @@ Simply type cache help [path to command] for full details. minikube cache help [command] [flags] ``` -### Options - -``` - -h, --help help for help -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -171,7 +151,6 @@ minikube cache list [flags] ``` --format string Go template format string for the cache list output. The format for Go templates can be found here: https://golang.org/pkg/text/template/ For the list of accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd#CacheListTemplate (default "{{.CacheImage}}\n") - -h, --help help for list ``` ### Options inherited from parent commands @@ -180,6 +159,7 @@ minikube cache list [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -206,18 +186,13 @@ reloads images previously added using the 'cache add' subcommand minikube cache reload [flags] ``` -### Options - -``` - -h, --help help for reload -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/completion.md b/site/content/en/docs/commands/completion.md index 28912b6968..7738a2e216 100644 --- a/site/content/en/docs/commands/completion.md +++ b/site/content/en/docs/commands/completion.md @@ -38,18 +38,13 @@ Outputs minikube shell completion for the given shell (bash, zsh or fish) minikube completion SHELL [flags] ``` -### Options - -``` - -h, --help help for completion -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/config.md b/site/content/en/docs/commands/config.md index 7670320985..8e66d3f193 100644 --- a/site/content/en/docs/commands/config.md +++ b/site/content/en/docs/commands/config.md @@ -47,18 +47,13 @@ Configurable fields: minikube config SUBCOMMAND [flags] ``` -### Options - -``` - -h, --help help for config -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -91,7 +86,6 @@ minikube config defaults PROPERTY_NAME [flags] ### Options ``` - -h, --help help for defaults --output string Output format. Accepted values: [json] ``` @@ -101,6 +95,7 @@ minikube config defaults PROPERTY_NAME [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -127,18 +122,13 @@ Returns the value of PROPERTY_NAME from the minikube config file. Can be overwr minikube config get PROPERTY_NAME [flags] ``` -### Options - -``` - -h, --help help for get -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -166,18 +156,13 @@ Simply type config help [path to command] for full details. minikube config help [command] [flags] ``` -### Options - -``` - -h, --help help for help -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -205,18 +190,13 @@ Sets the PROPERTY_NAME config value to PROPERTY_VALUE minikube config set PROPERTY_NAME PROPERTY_VALUE [flags] ``` -### Options - -``` - -h, --help help for set -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -243,18 +223,13 @@ unsets PROPERTY_NAME from the minikube config file. Can be overwritten by flags minikube config unset PROPERTY_NAME [flags] ``` -### Options - -``` - -h, --help help for unset -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -286,7 +261,6 @@ minikube config view [flags] ``` --format string Go template format string for the config view output. The format for Go templates can be found here: https://golang.org/pkg/text/template/ For the list of accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd/config#ConfigViewTemplate (default "- {{.ConfigKey}}: {{.ConfigValue}}\n") - -h, --help help for view ``` ### Options inherited from parent commands @@ -295,6 +269,7 @@ minikube config view [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/dashboard.md b/site/content/en/docs/commands/dashboard.md index 8272beb8e0..8df23e2c93 100644 --- a/site/content/en/docs/commands/dashboard.md +++ b/site/content/en/docs/commands/dashboard.md @@ -20,8 +20,7 @@ minikube dashboard [flags] ### Options ``` - -h, --help help for dashboard - --url Display dashboard URL instead of opening a browser + --url Display dashboard URL instead of opening a browser ``` ### Options inherited from parent commands @@ -30,6 +29,7 @@ minikube dashboard [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/delete.md b/site/content/en/docs/commands/delete.md index 768c24de05..34cea14518 100644 --- a/site/content/en/docs/commands/delete.md +++ b/site/content/en/docs/commands/delete.md @@ -22,7 +22,6 @@ minikube delete [flags] ``` --all Set flag to delete all profiles - -h, --help help for delete --purge Set this flag to delete the '.minikube' folder from your user directory. ``` @@ -32,6 +31,7 @@ minikube delete [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/docker-env.md b/site/content/en/docs/commands/docker-env.md index 5b0e721869..7ce914a063 100644 --- a/site/content/en/docs/commands/docker-env.md +++ b/site/content/en/docs/commands/docker-env.md @@ -20,7 +20,6 @@ minikube docker-env [flags] ### Options ``` - -h, --help help for docker-env --no-proxy Add machine IP to NO_PROXY environment variable --shell string Force environment to be configured for a specified shell: [fish, cmd, powershell, tcsh, bash, zsh], default is auto-detect -u, --unset Unset variables instead of setting them @@ -32,6 +31,7 @@ minikube docker-env [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/help.md b/site/content/en/docs/commands/help.md index f0c808fcf3..6f25e68ca8 100644 --- a/site/content/en/docs/commands/help.md +++ b/site/content/en/docs/commands/help.md @@ -18,18 +18,13 @@ Simply type minikube help [path to command] for full details. minikube help [command] [flags] ``` -### Options - -``` - -h, --help help for help -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/ip.md b/site/content/en/docs/commands/ip.md index 559274c346..0a14345642 100644 --- a/site/content/en/docs/commands/ip.md +++ b/site/content/en/docs/commands/ip.md @@ -17,18 +17,13 @@ Retrieves the IP address of the running cluster, and writes it to STDOUT. minikube ip [flags] ``` -### Options - -``` - -h, --help help for ip -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/kubectl.md b/site/content/en/docs/commands/kubectl.md index f098a66e65..a787c52b5b 100644 --- a/site/content/en/docs/commands/kubectl.md +++ b/site/content/en/docs/commands/kubectl.md @@ -21,18 +21,13 @@ minikube kubectl -- get pods --namespace kube-system minikube kubectl [flags] ``` -### Options - -``` - -h, --help help for kubectl -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/logs.md b/site/content/en/docs/commands/logs.md index 148d186e5b..1734f8b7b9 100644 --- a/site/content/en/docs/commands/logs.md +++ b/site/content/en/docs/commands/logs.md @@ -21,7 +21,6 @@ minikube logs [flags] ``` -f, --follow Show only the most recent journal entries, and continuously print new entries as they are appended to the journal. - -h, --help help for logs -n, --length int Number of lines back to go within the log (default 60) --node string The node to get logs from. Defaults to the primary control plane. --problems Show only log entries which point to known problems @@ -33,6 +32,7 @@ minikube logs [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/mount.md b/site/content/en/docs/commands/mount.md index 33161f7a61..8d9decd590 100644 --- a/site/content/en/docs/commands/mount.md +++ b/site/content/en/docs/commands/mount.md @@ -22,7 +22,6 @@ minikube mount [flags] : ``` --9p-version string Specify the 9p version that the mount should use (default "9p2000.L") --gid string Default group id used for the mount (default "docker") - -h, --help help for mount --ip string Specify the ip that the mount should be setup on --kill Kill the mount process spawned by minikube start --mode uint File permissions used for the mount (default 493) @@ -38,6 +37,7 @@ minikube mount [flags] : --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/node.md b/site/content/en/docs/commands/node.md index 94b8fbf485..e7c22ec26c 100644 --- a/site/content/en/docs/commands/node.md +++ b/site/content/en/docs/commands/node.md @@ -17,18 +17,13 @@ Operations on nodes minikube node [flags] ``` -### Options - -``` - -h, --help help for node -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -60,7 +55,6 @@ minikube node add [flags] ``` --control-plane If true, the node added will also be a control plane in addition to a worker. --delete-on-failure If set, delete the current cluster if start fails and try again. Defaults to false. - -h, --help help for add --worker If true, the added node will be marked for work. Defaults to true. (default true) ``` @@ -70,6 +64,7 @@ minikube node add [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -96,18 +91,13 @@ Deletes a node from a cluster. minikube node delete [flags] ``` -### Options - -``` - -h, --help help for delete -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -135,18 +125,13 @@ Simply type node help [path to command] for full details. minikube node help [command] [flags] ``` -### Options - -``` - -h, --help help for help -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -173,18 +158,13 @@ List existing minikube nodes. minikube node list [flags] ``` -### Options - -``` - -h, --help help for list -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -215,7 +195,6 @@ minikube node start [flags] ``` --delete-on-failure If set, delete the current cluster if start fails and try again. Defaults to false. - -h, --help help for start ``` ### Options inherited from parent commands @@ -224,6 +203,7 @@ minikube node start [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -250,18 +230,13 @@ Stops a node in a cluster. minikube node stop [flags] ``` -### Options - -``` - -h, --help help for stop -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/pause.md b/site/content/en/docs/commands/pause.md index d1b2e04b5a..26938f43a2 100644 --- a/site/content/en/docs/commands/pause.md +++ b/site/content/en/docs/commands/pause.md @@ -22,7 +22,6 @@ minikube pause [flags] ``` -n, ----namespaces strings namespaces to pause (default [kube-system,kubernetes-dashboard,storage-gluster,istio-operator]) -A, --all-namespaces If set, pause all namespaces - -h, --help help for pause -o, --output string Format to print stdout in. Options include: [text,json] (default "text") ``` @@ -32,6 +31,7 @@ minikube pause [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/podman-env.md b/site/content/en/docs/commands/podman-env.md index bb71277a2d..ef94b796b3 100644 --- a/site/content/en/docs/commands/podman-env.md +++ b/site/content/en/docs/commands/podman-env.md @@ -20,7 +20,6 @@ minikube podman-env [flags] ### Options ``` - -h, --help help for podman-env --shell string Force environment to be configured for a specified shell: [fish, cmd, powershell, tcsh, bash, zsh], default is auto-detect -u, --unset Unset variables instead of setting them ``` @@ -31,6 +30,7 @@ minikube podman-env [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/profile.md b/site/content/en/docs/commands/profile.md index d7804d2b16..eb1ea697a3 100644 --- a/site/content/en/docs/commands/profile.md +++ b/site/content/en/docs/commands/profile.md @@ -17,18 +17,13 @@ profile sets the current minikube profile, or gets the current profile if no arg minikube profile [MINIKUBE_PROFILE_NAME]. You can return to the default minikube profile by running `minikube profile default` [flags] ``` -### Options - -``` - -h, --help help for profile -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -56,18 +51,13 @@ Simply type profile help [path to command] for full details. minikube profile help [command] [flags] ``` -### Options - -``` - -h, --help help for help -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -97,7 +87,6 @@ minikube profile list [flags] ### Options ``` - -h, --help help for list -o, --output string The output format. One of 'json', 'table' (default "table") ``` @@ -107,6 +96,7 @@ minikube profile list [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/service.md b/site/content/en/docs/commands/service.md index 3317399765..c387e9f637 100644 --- a/site/content/en/docs/commands/service.md +++ b/site/content/en/docs/commands/service.md @@ -21,7 +21,6 @@ minikube service [flags] SERVICE ``` --format string Format to output service URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}") - -h, --help help for service --https Open the service URL with https instead of http (defaults to "false") --interval int The initial time interval for each check that wait performs in seconds (default 1) -n, --namespace string The service namespace (default "default") @@ -35,6 +34,7 @@ minikube service [flags] SERVICE --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -62,12 +62,6 @@ Simply type service help [path to command] for full details. minikube service help [command] [flags] ``` -### Options - -``` - -h, --help help for help -``` - ### Options inherited from parent commands ``` @@ -75,6 +69,7 @@ minikube service help [command] [flags] --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") --format string Format to output service URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file @@ -104,7 +99,6 @@ minikube service list [flags] ### Options ``` - -h, --help help for list -n, --namespace string The services namespace ``` @@ -115,6 +109,7 @@ minikube service list [flags] --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") --format string Format to output service URL in. This format will be applied to each url individually and they will be printed one at a time. (default "http://{{.IP}}:{{.Port}}") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/ssh-key.md b/site/content/en/docs/commands/ssh-key.md index 7398280c21..89d84187f0 100644 --- a/site/content/en/docs/commands/ssh-key.md +++ b/site/content/en/docs/commands/ssh-key.md @@ -17,18 +17,13 @@ Retrieve the ssh identity key path of the specified cluster. minikube ssh-key [flags] ``` -### Options - -``` - -h, --help help for ssh-key -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/ssh.md b/site/content/en/docs/commands/ssh.md index 5953124b8c..3a00f98d1e 100644 --- a/site/content/en/docs/commands/ssh.md +++ b/site/content/en/docs/commands/ssh.md @@ -20,7 +20,6 @@ minikube ssh [flags] ### Options ``` - -h, --help help for ssh --native-ssh Use native Golang SSH client (default true). Set to 'false' to use the command line 'ssh' command when accessing the docker machine. Useful for the machine drivers when they will not start with 'Waiting for SSH'. (default true) -n, --node string The node to ssh into. Defaults to the primary control plane. ``` @@ -31,6 +30,7 @@ minikube ssh [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/start.md b/site/content/en/docs/commands/start.md index f828d83aa3..776faaf423 100644 --- a/site/content/en/docs/commands/start.md +++ b/site/content/en/docs/commands/start.md @@ -51,7 +51,6 @@ minikube start [flags] --feature-gates string A set of key=value pairs that describe feature gates for alpha/experimental features. --force Force minikube to perform possibly dangerous operations --force-systemd If set, force the container runtime to use sytemd as cgroup manager. Currently available for docker and crio. Defaults to false. - -h, --help help for start --host-dns-resolver Enable host resolver for NAT DNS requests (virtualbox driver only) (default true) --host-only-cidr string The CIDR to be used for the minikube VM (virtualbox driver only) (default "192.168.99.1/24") --host-only-nic-type string NIC Type used for host only network. One of Am79C970A, Am79C973, 82540EM, 82543GC, 82545EM, or virtio (virtualbox driver only) (default "virtio") @@ -101,6 +100,7 @@ minikube start [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/status.md b/site/content/en/docs/commands/status.md index a7197fa4c2..f8ca0b73e9 100644 --- a/site/content/en/docs/commands/status.md +++ b/site/content/en/docs/commands/status.md @@ -24,7 +24,6 @@ minikube status [flags] ``` -f, --format string Go template format string for the status output. The format for Go templates can be found here: https://golang.org/pkg/text/template/ For the list accessible variables for the template, see the struct values here: https://godoc.org/k8s.io/minikube/cmd/minikube/cmd#Status (default "{{.Name}}\ntype: Control Plane\nhost: {{.Host}}\nkubelet: {{.Kubelet}}\napiserver: {{.APIServer}}\nkubeconfig: {{.Kubeconfig}}\n\n") - -h, --help help for status -l, --layout string output layout (EXPERIMENTAL, JSON only): 'nodes' or 'cluster' (default "nodes") -n, --node string The node to check status for. Defaults to control plane. Leave blank with default format for status on all nodes. -o, --output string minikube status --output OUTPUT. json, text (default "text") @@ -36,6 +35,7 @@ minikube status [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/stop.md b/site/content/en/docs/commands/stop.md index e63da43f35..9f54204ab1 100644 --- a/site/content/en/docs/commands/stop.md +++ b/site/content/en/docs/commands/stop.md @@ -21,7 +21,6 @@ minikube stop [flags] ``` --all Set flag to stop all profiles (clusters) - -h, --help help for stop --keep-context-active keep the kube-context active after cluster is stopped. Defaults to false. -o, --output string Format to print stdout in. Options include: [text,json] (default "text") ``` @@ -32,6 +31,7 @@ minikube stop [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/tunnel.md b/site/content/en/docs/commands/tunnel.md index 3e85c936d4..370e8128dc 100644 --- a/site/content/en/docs/commands/tunnel.md +++ b/site/content/en/docs/commands/tunnel.md @@ -21,7 +21,6 @@ minikube tunnel [flags] ``` -c, --cleanup call with cleanup=true to remove old tunnels (default true) - -h, --help help for tunnel ``` ### Options inherited from parent commands @@ -30,6 +29,7 @@ minikube tunnel [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/unpause.md b/site/content/en/docs/commands/unpause.md index 5bdda4ac91..aabcedf80b 100644 --- a/site/content/en/docs/commands/unpause.md +++ b/site/content/en/docs/commands/unpause.md @@ -22,7 +22,6 @@ minikube unpause [flags] ``` -n, ----namespaces strings namespaces to unpause (default [kube-system,kubernetes-dashboard,storage-gluster,istio-operator]) -A, --all-namespaces If set, unpause all namespaces - -h, --help help for unpause -o, --output string Format to print stdout in. Options include: [text,json] (default "text") ``` @@ -32,6 +31,7 @@ minikube unpause [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/update-check.md b/site/content/en/docs/commands/update-check.md index cb51afd7f9..b3d98bb1bb 100644 --- a/site/content/en/docs/commands/update-check.md +++ b/site/content/en/docs/commands/update-check.md @@ -17,18 +17,13 @@ Print current and latest version number minikube update-check [flags] ``` -### Options - -``` - -h, --help help for update-check -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/update-context.md b/site/content/en/docs/commands/update-context.md index 7737bf279f..b981dbeba5 100644 --- a/site/content/en/docs/commands/update-context.md +++ b/site/content/en/docs/commands/update-context.md @@ -18,18 +18,13 @@ Retrieves the IP address of the running cluster, checks it minikube update-context [flags] ``` -### Options - -``` - -h, --help help for update-context -``` - ### Options inherited from parent commands ``` --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file diff --git a/site/content/en/docs/commands/version.md b/site/content/en/docs/commands/version.md index b63ac64550..d1fc7e06aa 100644 --- a/site/content/en/docs/commands/version.md +++ b/site/content/en/docs/commands/version.md @@ -20,7 +20,6 @@ minikube version [flags] ### Options ``` - -h, --help help for version -o, --output string One of 'yaml' or 'json'. --short Print just the version number. ``` @@ -31,6 +30,7 @@ minikube version [flags] --add_dir_header If true, adds the file directory to the header of the log messages --alsologtostderr log to standard error as well as files -b, --bootstrapper string The name of the cluster bootstrapper that will set up the Kubernetes cluster. (default "kubeadm") + -h, --help --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) --log_dir string If non-empty, write log files in this directory --log_file string If non-empty, use this log file