github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/docs/user-guide/kubectl/kubectl.md

97 lines
4.9 KiB
Markdown
Raw Normal View History

Run gendocs and munges
2015-07-12 04:04:52 +00:00
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
<!-- BEGIN STRIP_FOR_RELEASE -->
Run gendocs
2015-07-13 22:15:35 +00:00
![WARNING](http://releases.k8s.io/HEAD/docs/warning.png)
![WARNING](http://releases.k8s.io/HEAD/docs/warning.png)
![WARNING](http://releases.k8s.io/HEAD/docs/warning.png)
<h1>PLEASE NOTE: This document applies to the HEAD of the source
Run gendocs and munges
2015-07-12 04:04:52 +00:00
tree only. If you are using a released version of Kubernetes, you almost
certainly want the docs that go with that version.</h1>
<strong>Documentation for specific releases can be found at
[releases.k8s.io](http://releases.k8s.io).</strong>
Run gendocs
2015-07-13 22:15:35 +00:00
![WARNING](http://releases.k8s.io/HEAD/docs/warning.png)
![WARNING](http://releases.k8s.io/HEAD/docs/warning.png)
![WARNING](http://releases.k8s.io/HEAD/docs/warning.png)
Run gendocs and munges
2015-07-12 04:04:52 +00:00
<!-- END STRIP_FOR_RELEASE -->
<!-- END MUNGE: UNVERSIONED_WARNING -->
Autogenerate markdown docs for kubectl Add test to verify generated docs are up to date.
2015-01-14 05:02:22 +00:00
## kubectl
kubectl controls the Kubernetes cluster manager
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
### Synopsis
Autogenerate markdown docs for kubectl Add test to verify generated docs are up to date.
2015-01-14 05:02:22 +00:00
Fix md generation for kubectl docs Display usage string, not long help, as code, remove angle brackets from output (.md interprets as tags and hides).
2015-03-11 17:22:08 +00:00
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
kubectl controls the Kubernetes cluster manager.
Autogenerate markdown docs for kubectl Add test to verify generated docs are up to date.
2015-01-14 05:02:22 +00:00
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
Find more information at https://github.com/GoogleCloudPlatform/kubernetes.
Updating docs with new CLI flag output.
2015-02-11 23:25:45 +00:00
Fix md generation for kubectl docs Display usage string, not long help, as code, remove angle brackets from output (.md interprets as tags and hides).
2015-03-11 17:22:08 +00:00
```
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
kubectl
Fix md generation for kubectl docs Display usage string, not long help, as code, remove angle brackets from output (.md interprets as tags and hides).
2015-03-11 17:22:08 +00:00
```
Updating docs with new CLI flag output.
2015-02-11 23:25:45 +00:00
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
### Options
Add a label command.
2015-02-07 00:33:42 +00:00
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
--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
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
-h, --help=false: help for kubectl
Add a label command.
2015-02-07 00:33:42 +00:00
--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.
Warn for every _ flag user or cmd defined also renames all global _ flags to -
2015-05-16 16:44:42 +00:00
--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
Add a label command.
2015-02-07 00:33:42 +00:00
--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.
fix docs
2015-02-19 21:22:29 +00:00
--password="": Password for basic authentication to the API server.
Minor clarification of --server flag. Fixes #3425.
2015-02-12 00:23:44 +00:00
-s, --server="": The address and port of the Kubernetes API server
Add a label command.
2015-02-07 00:33:42 +00:00
--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
fix docs
2015-02-19 21:22:29 +00:00
--username="": Username for basic authentication to the API server.
Add a label command.
2015-02-07 00:33:42 +00:00
--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
```
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
### SEE ALSO
update docs using spf13/cobra generator
2015-04-12 19:04:39 +00:00
* [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
Using NAME to replace ID in help string
2015-07-01 02:43:02 +00:00
* [kubectl delete](kubectl_delete.md) - Delete a resource by filename, stdin, resource and name, or by resources and label selector.
Update kubectl describe help to document prefix matching behavior
2015-07-07 23:57:37 +00:00
* [kubectl describe](kubectl_describe.md) - Show details of a specific resource or group of resources
update docs using spf13/cobra generator
2015-04-12 19:04:39 +00:00
* [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
Rename 'kubectl log' to 'kubectl logs'
2015-05-21 20:14:32 +00:00
* [kubectl logs](kubectl_logs.md) - Print the logs for a container in a pod.
update docs using spf13/cobra generator
2015-04-12 19:04:39 +00:00
* [kubectl namespace](kubectl_namespace.md) - SUPERCEDED: Set and view the current Kubernetes namespace
add "kubectl patch". It will replace "kubectl udpate --patch" in the future
2015-06-25 22:56:30 +00:00
* [kubectl patch](kubectl_patch.md) - Update field(s) of a resource by stdin.
update docs using spf13/cobra generator
2015-04-12 19:04:39 +00:00
* [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
Add command "kubectl replace". "kubectl update" is still supported as an alias. "kubectl replace --patch" is NOT supported. It's moved to "kubectl patch" as a separate command in another commit.
2015-06-27 04:25:08 +00:00
* [kubectl replace](kubectl_replace.md) - Replace a resource by filename or stdin.
update docs using spf13/cobra generator
2015-04-12 19:04:39 +00:00
* [kubectl rolling-update](kubectl_rolling-update.md) - Perform a rolling update of the given ReplicationController.
rename run-container to run in kubectl
2015-05-21 20:53:10 +00:00
* [kubectl run](kubectl_run.md) - Run a particular image on the cluster.
rename resize to scale
2015-05-21 21:10:25 +00:00
* [kubectl scale](kubectl_scale.md) - Set a new size for a Replication Controller.
Using NAME to replace ID in help string
2015-07-01 02:43:02 +00:00
* [kubectl stop](kubectl_stop.md) - Gracefully shut down a resource by name or filename.
update docs using spf13/cobra generator
2015-04-12 19:04:39 +00:00
* [kubectl version](kubectl_version.md) - Print the client and server version information.
fix docs
2015-02-19 21:22:29 +00:00
Apply mungedocs changes
2015-07-14 00:13:09 +00:00
###### Auto generated by spf13/cobra at 2015-07-14 00:11:42.96000791 +0000 UTC
Add ga-beacon analytics to gendocs scripts hack/run-gendocs.sh puts ga-beacon analytics link into all md files, hack/verify-gendocs.sh verifies presence of link.
2015-05-14 22:12:45 +00:00
Apply mungedocs changes
2015-07-14 00:13:09 +00:00
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
move kubectl docs to docs/user-guide/kubectl
2015-07-13 17:19:25 +00:00
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl.md?pixel)]()
Apply mungedocs changes
2015-07-14 00:13:09 +00:00
<!-- END MUNGE: GENERATED_ANALYTICS -->