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

69 lines
2.9 KiB
Markdown
Raw Normal View History

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
-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
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.
--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.
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
* [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)
Make naming of kubectl subcommands consistent
2015-03-27 23:24:59 +00:00
* [kubectl-rolling-update](kubectl-rolling-update.md)
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-resize](kubectl-resize.md)
Add streaming command execution & port forwarding Add streaming command execution & port forwarding via HTTP connection upgrades (currently using SPDY).
2015-01-08 20:41:38 +00:00
* [kubectl-exec](kubectl-exec.md)
* [kubectl-port-forward](kubectl-port-forward.md)
Order the commands in kubectl by importance and function Move the client config commands towards the bottom, keep the primary verbs near the top. Version goes at the bottom.
2015-03-26 03:00:12 +00:00
* [kubectl-proxy](kubectl-proxy.md)
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-run-container](kubectl-run-container.md)
* [kubectl-stop](kubectl-stop.md)
* [kubectl-expose](kubectl-expose.md)
* [kubectl-label](kubectl-label.md)
Order the commands in kubectl by importance and function Move the client config commands towards the bottom, keep the primary verbs near the top. Version goes at the bottom.
2015-03-26 03:00:12 +00:00
* [kubectl-config](kubectl-config.md)
Make naming of kubectl subcommands consistent
2015-03-27 23:24:59 +00:00
* [kubectl-cluster-info](kubectl-cluster-info.md)
* [kubectl-api-versions](kubectl-api-versions.md)
Order the commands in kubectl by importance and function Move the client config commands towards the bottom, keep the primary verbs near the top. Version goes at the bottom.
2015-03-26 03:00:12 +00:00
* [kubectl-version](kubectl-version.md)
fix docs
2015-02-19 21:22:29 +00:00