fix(docs): update cli reference

Signed-off-by: Ilya Lesikov <ilya@lesikov.com>
werf · Mar 22, 2022 · 7f65ca2 · 7f65ca2
1 parent a2d523e
commit 7f65ca2
Show file tree

Hide file tree

Showing 106 changed files with 394 additions and 303 deletions.
diff --git a/docs/_includes/reference/cli/werf_kubectl.md b/docs/_includes/reference/cli/werf_kubectl.md
@@ -35,12 +35,13 @@ werf kubectl [flags] [options]
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_alpha.md b/docs/_includes/reference/cli/werf_kubectl_alpha.md
@@ -27,12 +27,13 @@ These commands correspond to alpha features that are not enabled in Kubernetes c
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_alpha_events.md b/docs/_includes/reference/cli/werf_kubectl_alpha_events.md
@@ -63,12 +63,13 @@ werf kubectl alpha events [--for TYPE/NAME] [--watch] [options]
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_annotate.md b/docs/_includes/reference/cli/werf_kubectl_annotate.md
@@ -114,12 +114,13 @@ werf kubectl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KE
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_api_resources.md b/docs/_includes/reference/cli/werf_kubectl_api_resources.md
@@ -77,12 +77,13 @@ werf kubectl api-resources [flags] [options]
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_api_versions.md b/docs/_includes/reference/cli/werf_kubectl_api_versions.md
@@ -40,12 +40,13 @@ werf kubectl api-versions
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_apply.md b/docs/_includes/reference/cli/werf_kubectl_apply.md
@@ -126,12 +126,13 @@ werf kubectl apply (-f FILENAME | -k DIRECTORY) [options]
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_apply_edit_last_applied.md b/docs/_includes/reference/cli/werf_kubectl_apply_edit_last_applied.md
@@ -79,12 +79,13 @@ werf kubectl apply edit-last-applied (RESOURCE/NAME | -f FILENAME) [options]
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_apply_set_last_applied.md b/docs/_includes/reference/cli/werf_kubectl_apply_set_last_applied.md
@@ -72,12 +72,13 @@ werf kubectl apply set-last-applied -f FILENAME [options]
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_apply_view_last_applied.md b/docs/_includes/reference/cli/werf_kubectl_apply_view_last_applied.md
@@ -65,12 +65,13 @@ werf kubectl apply view-last-applied (TYPE [NAME | -l label] | TYPE/NAME | -f FI
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_attach.md b/docs/_includes/reference/cli/werf_kubectl_attach.md
@@ -69,12 +69,13 @@ werf kubectl attach (POD | TYPE/NAME) -c CONTAINER [options]
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_auth.md b/docs/_includes/reference/cli/werf_kubectl_auth.md
@@ -33,12 +33,13 @@ werf kubectl auth
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_auth_can_i.md b/docs/_includes/reference/cli/werf_kubectl_auth_can_i.md
@@ -75,12 +75,13 @@ werf kubectl auth can-i VERB [TYPE | TYPE/NAME | NONRESOURCEURL] [options]
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_auth_reconcile.md b/docs/_includes/reference/cli/werf_kubectl_auth_reconcile.md
@@ -80,12 +80,13 @@ werf kubectl auth reconcile -f FILENAME [options]
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_autoscale.md b/docs/_includes/reference/cli/werf_kubectl_autoscale.md
@@ -90,12 +90,13 @@ werf kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --m
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_certificate.md b/docs/_includes/reference/cli/werf_kubectl_certificate.md
@@ -33,12 +33,13 @@ werf kubectl certificate SUBCOMMAND
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_certificate_approve.md b/docs/_includes/reference/cli/werf_kubectl_certificate_approve.md
@@ -70,12 +70,13 @@ werf kubectl certificate approve (-f FILENAME | NAME) [options]
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_certificate_deny.md b/docs/_includes/reference/cli/werf_kubectl_certificate_deny.md
@@ -68,12 +68,13 @@ werf kubectl certificate deny (-f FILENAME | NAME) [options]
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_cluster_info.md b/docs/_includes/reference/cli/werf_kubectl_cluster_info.md
@@ -40,12 +40,13 @@ werf kubectl cluster-info
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_cluster_info_dump.md b/docs/_includes/reference/cli/werf_kubectl_cluster_info_dump.md
@@ -78,12 +78,13 @@ werf kubectl cluster-info dump [flags] [options]
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_completion.md b/docs/_includes/reference/cli/werf_kubectl_completion.md
@@ -97,12 +97,13 @@ werf kubectl completion SHELL
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''

diff --git a/docs/_includes/reference/cli/werf_kubectl_config.md b/docs/_includes/reference/cli/werf_kubectl_config.md
@@ -39,12 +39,13 @@ werf kubectl config SUBCOMMAND
       --cluster=''
             The name of the kubeconfig cluster to use
       --context=''
-            The name of the kubeconfig context to use
+            The name of the kubeconfig context to use (default $WERF_KUBE_CONTEXT)
       --insecure-skip-tls-verify=false
             If true, the server`s certificate will not be checked for validity. This will make your 
-            HTTPS connections insecure
+            HTTPS connections insecure (default $WERF_SKIP_TLS_VERIFY_REGISTRY)
       --kubeconfig=''
-            Path to the kubeconfig file to use for CLI requests.
+            Path to the kubeconfig file to use for CLI requests (default $WERF_KUBE_CONFIG, or      
+            $WERF_KUBECONFIG, or $KUBECONFIG)
       --match-server-version=false
             Require server version to match client version
   -n, --namespace=''