From 15e422d79ba8397318a29e02e5353f524861a80d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anders=20F=20Bj=C3=B6rklund?= Date: Thu, 18 Mar 2021 07:20:33 +0100 Subject: [PATCH] Generate docs for commands to make test happy --- site/content/en/docs/commands/kubectl.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/site/content/en/docs/commands/kubectl.md b/site/content/en/docs/commands/kubectl.md index b4c4b91379..34e7975402 100644 --- a/site/content/en/docs/commands/kubectl.md +++ b/site/content/en/docs/commands/kubectl.md @@ -13,18 +13,28 @@ Run a kubectl binary matching the cluster version Run the Kubernetes client, download it if necessary. Remember -- after kubectl! -Examples: -minikube kubectl -- --help -minikube kubectl -- get pods --namespace kube-system +This will run the Kubernetes client (kubectl) with the same version as the cluster + +Normally it will download a binary matching the host operating system and architecture, +but optionally you can also run it directly on the control plane over the ssh connection. +This can be useful if you cannot run kubectl locally for some reason, like unsupported +host. Please be aware that when using --ssh all paths will apply to the remote machine. ```shell minikube kubectl [flags] ``` +### Examples + +``` +minikube kubectl -- --help +minikube kubectl -- get pods --namespace kube-system +``` + ### Options ``` - --ssh Use SSH for running kubernetes client + --ssh Use SSH for running kubernetes client on the node ``` ### Options inherited from parent commands