update docs using spf13/cobra generator

This commit is contained in:
Eric Paris
2015-04-12 15:04:39 -04:00
parent 263dc981db
commit faf60a3cab
30 changed files with 82 additions and 158 deletions

View File

@@ -1,52 +0,0 @@
## kubectl api-versions
Print available API versions.
### Synopsis
Print available API versions.
```
kubectl api-versions
```
### Options
```
-h, --help=false: help for api-versions
```
### Options inherrited from parent commands
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
--log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
--log_dir=: If non-empty, write log files in this directory
--log_flush_frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--password="": Password for basic authentication to the API server.
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
--username="": Username for basic authentication to the API server.
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kubectl](kubectl.md)

View File

@@ -1,52 +0,0 @@
## kubectl cluster-info
Display cluster info
### Synopsis
Display addresses of the master and services with label kubernetes.io/cluster-service=true
```
kubectl cluster-info
```
### Options
```
-h, --help=false: help for cluster-info
```
### Options inherrited from parent commands
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
--insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
--log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
--log_dir=: If non-empty, write log files in this directory
--log_flush_frequency=5s: Maximum number of seconds between log flushes
--logtostderr=true: log to standard error instead of files
--match-server-version=false: Require server version to match client version
--namespace="": If present, the namespace scope for this CLI request.
--password="": Password for basic authentication to the API server.
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
--username="": Username for basic authentication to the API server.
--v=0: log level for V logs
--validate=false: If true, use a schema to validate the input before sending it
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
* [kubectl](kubectl.md)

View File

@@ -45,24 +45,25 @@ kubectl
```
### SEE ALSO
* [kubectl-get](kubectl-get.md)
* [kubectl-describe](kubectl-describe.md)
* [kubectl-create](kubectl-create.md)
* [kubectl-update](kubectl-update.md)
* [kubectl-delete](kubectl-delete.md)
* [kubectl-namespace](kubectl-namespace.md)
* [kubectl-log](kubectl-log.md)
* [kubectl-rolling-update](kubectl-rolling-update.md)
* [kubectl-resize](kubectl-resize.md)
* [kubectl-exec](kubectl-exec.md)
* [kubectl-port-forward](kubectl-port-forward.md)
* [kubectl-proxy](kubectl-proxy.md)
* [kubectl-run-container](kubectl-run-container.md)
* [kubectl-stop](kubectl-stop.md)
* [kubectl-expose](kubectl-expose.md)
* [kubectl-label](kubectl-label.md)
* [kubectl-config](kubectl-config.md)
* [kubectl-cluster-info](kubectl-cluster-info.md)
* [kubectl-api-versions](kubectl-api-versions.md)
* [kubectl-version](kubectl-version.md)
* [kubectl api-versions](kubectl_api-versions.md) - Print available API versions.
* [kubectl cluster-info](kubectl_cluster-info.md) - Display cluster info
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files
* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin
* [kubectl delete](kubectl_delete.md) - Delete a resource by filename, stdin, resource and ID, or by resources and label selector.
* [kubectl describe](kubectl_describe.md) - Show details of a specific resource
* [kubectl exec](kubectl_exec.md) - Execute a command in a container.
* [kubectl expose](kubectl_expose.md) - Take a replicated application and expose it as Kubernetes Service
* [kubectl get](kubectl_get.md) - Display one or many resources
* [kubectl label](kubectl_label.md) - Update the labels on a resource
* [kubectl log](kubectl_log.md) - Print the logs for a container in a pod.
* [kubectl namespace](kubectl_namespace.md) - SUPERCEDED: Set and view the current Kubernetes namespace
* [kubectl port-forward](kubectl_port-forward.md) - Forward one or more local ports to a pod.
* [kubectl proxy](kubectl_proxy.md) - Run a proxy to the Kubernetes API server
* [kubectl resize](kubectl_resize.md) - Set a new size for a Replication Controller.
* [kubectl rolling-update](kubectl_rolling-update.md) - Perform a rolling update of the given ReplicationController.
* [kubectl run-container](kubectl_run-container.md) - Run a particular image on the cluster.
* [kubectl stop](kubectl_stop.md) - Gracefully shut down a resource by id or filename.
* [kubectl update](kubectl_update.md) - Update a resource by filename or stdin.
* [kubectl version](kubectl_version.md) - Print the client and server version information.
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.865844658 +0000 UTC

View File

@@ -48,5 +48,6 @@ kubectl api-versions
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.865438603 +0000 UTC

View File

@@ -48,5 +48,6 @@ kubectl cluster-info
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.865291243 +0000 UTC

View File

@@ -51,12 +51,13 @@ kubectl config SUBCOMMAND
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl-config-view](kubectl-config-view.md)
* [kubectl-config-set-cluster](kubectl-config-set-cluster.md)
* [kubectl-config-set-credentials](kubectl-config-set-credentials.md)
* [kubectl-config-set-context](kubectl-config-set-context.md)
* [kubectl-config-set](kubectl-config-set.md)
* [kubectl-config-unset](kubectl-config-unset.md)
* [kubectl-config-use-context](kubectl-config-use-context.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
* [kubectl config set](kubectl_config_set.md) - Sets an individual value in a kubeconfig file
* [kubectl config set-cluster](kubectl_config_set-cluster.md) - Sets a cluster entry in kubeconfig
* [kubectl config set-context](kubectl_config_set-context.md) - Sets a context entry in kubeconfig
* [kubectl config set-credentials](kubectl_config_set-credentials.md) - Sets a user entry in kubeconfig
* [kubectl config unset](kubectl_config_unset.md) - Unsets an individual value in a kubeconfig file
* [kubectl config use-context](kubectl_config_use-context.md) - Sets the current-context in a kubeconfig file
* [kubectl config view](kubectl_config_view.md) - displays merged kubeconfig settings or a specified kubeconfig file.
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.86513156 +0000 UTC

View File

@@ -66,5 +66,6 @@ $ kubectl config set-cluster e2e --insecure-skip-tls-verify=true
```
### SEE ALSO
* [kubectl-config](kubectl-config.md)
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.864096021 +0000 UTC

View File

@@ -59,5 +59,6 @@ $ kubectl config set-context gce --user=cluster-admin
```
### SEE ALSO
* [kubectl-config](kubectl-config.md)
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.86442717 +0000 UTC

View File

@@ -79,5 +79,6 @@ $ kubectl set-credentials cluster-admin --client-certificate=~/.kube/admin.crt -
```
### SEE ALSO
* [kubectl-config](kubectl-config.md)
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.864263862 +0000 UTC

View File

@@ -53,5 +53,6 @@ kubectl config set PROPERTY_NAME PROPERTY_VALUE
```
### SEE ALSO
* [kubectl-config](kubectl-config.md)
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.864594301 +0000 UTC

View File

@@ -52,5 +52,6 @@ kubectl config unset PROPERTY_NAME
```
### SEE ALSO
* [kubectl-config](kubectl-config.md)
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.864788809 +0000 UTC

View File

@@ -51,5 +51,6 @@ kubectl config use-context CONTEXT_NAME
```
### SEE ALSO
* [kubectl-config](kubectl-config.md)
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.864953658 +0000 UTC

View File

@@ -71,5 +71,6 @@ $ kubectl config view -o template --template='{{range .users}}{{ if eq .name "e2
```
### SEE ALSO
* [kubectl-config](kubectl-config.md)
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.863759642 +0000 UTC

View File

@@ -61,5 +61,6 @@ $ cat pod.json | kubectl create -f -
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.858089037 +0000 UTC

View File

@@ -79,5 +79,6 @@ $ kubectl delete pods --all
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.858739718 +0000 UTC

View File

@@ -51,5 +51,6 @@ kubectl describe RESOURCE ID
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.857744518 +0000 UTC

View File

@@ -62,5 +62,6 @@ $ kubectl exec -p 123456-7890 -c ruby-container -i -t -- bash -il
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.860311374 +0000 UTC

View File

@@ -80,5 +80,6 @@ $ kubectl expose streamer --port=4100 --protocol=udp --service-name=video-stream
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.863051668 +0000 UTC

View File

@@ -83,5 +83,6 @@ $ kubectl get rc/web service/frontend pods/web-pod-13je7
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.836684094 +0000 UTC

View File

@@ -79,5 +79,6 @@ $ kubectl label pods foo bar-
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.863412074 +0000 UTC

View File

@@ -60,5 +60,6 @@ $ kubectl log -f 123456-7890 ruby-container
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.859351191 +0000 UTC

View File

@@ -51,5 +51,6 @@ kubectl namespace [namespace]
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.859053402 +0000 UTC

View File

@@ -66,5 +66,6 @@ $ kubectl port-forward -p mypod 0:5000
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.860596821 +0000 UTC

View File

@@ -63,5 +63,6 @@ $ kubectl proxy --api-prefix=k8s-api
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.860912037 +0000 UTC

View File

@@ -66,5 +66,6 @@ $ kubectl resize --current-replicas=2 --replicas=3 replicationcontrollers foo
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.859972905 +0000 UTC

View File

@@ -66,5 +66,6 @@ $ cat frontend-v2.json | kubectl rolling-update frontend-v1 -f -
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.859654934 +0000 UTC

View File

@@ -76,5 +76,6 @@ $ kubectl run-container nginx --image=dockerfile/nginx --overrides='{ "apiVersio
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.861280128 +0000 UTC

View File

@@ -70,5 +70,6 @@ $ kubectl stop -f path/to/resources
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.862654585 +0000 UTC

View File

@@ -65,5 +65,6 @@ $ kubectl update pods my-pod --patch='{ "apiVersion": "v1beta1", "desiredState":
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.858390462 +0000 UTC

View File

@@ -49,5 +49,6 @@ kubectl version
```
### SEE ALSO
* [kubectl](kubectl.md)
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra at 2015-04-12 19:00:26.865600008 +0000 UTC