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_proxy.md

131 lines
5.3 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 -->
Better scary message
2015-07-16 17:02:26 +00:00
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<h2>PLEASE NOTE: This document applies to the HEAD of the source tree</h2>
If you are using a released version of Kubernetes, you should
refer to the docs that go with that version.
run hack/update-generated-docs.sh
2015-12-14 18:37:38 +00:00
<!-- TAG RELEASE_LINK, added by the munger automatically -->
Better scary message
2015-07-16 17:02:26 +00:00
<strong>
Run update-gendocs
2015-11-03 18:17:57 +00:00
The latest release of this document can be found
[here](http://releases.k8s.io/release-1.1/docs/user-guide/kubectl/kubectl_proxy.md).
Better scary message
2015-07-16 17:02:26 +00:00
Documentation for other releases can be found at
[releases.k8s.io](http://releases.k8s.io).
</strong>
--
Run gendocs
2015-07-13 22:15:35 +00:00
Run gendocs and munges
2015-07-12 04:04:52 +00:00
<!-- END STRIP_FOR_RELEASE -->
<!-- END MUNGE: UNVERSIONED_WARNING -->
Run gendocs
2015-07-17 22:35:41 +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 proxy
Run a proxy to the Kubernetes API server
### Synopsis
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
gendocs
2015-06-04 01:34:37 +00:00
To proxy all of the kubernetes api and nothing else, use:
kubectl proxy --api-prefix=/
To proxy only part of the kubernetes api and also some static files:
kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/
The above lets you 'curl localhost:8001/api/v1/pods'.
To proxy the entire kubernetes api at a different root, use:
kubectl proxy --api-prefix=/custom/
The above lets you 'curl localhost:8001/custom/api/v1/pods'
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
```
kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix]
Generate new docs with the new changes
2015-02-20 21:29:23 +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
### Examples
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
```
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-12 16:50:09 +00:00
# Run a proxy to kubernetes apiserver on port 8011, serving static content from ./local/www/
update commented examples just remove $
2016-02-29 14:41:09 +00:00
kubectl proxy --port=8011 --www=./local/www/
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
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-12 16:50:09 +00:00
# Run a proxy to kubernetes apiserver on an arbitrary local port.
# The chosen port for the server will be output to stdout.
update commented examples just remove $
2016-02-29 14:41:09 +00:00
kubectl proxy --port=0
Make `kubectl proxy` support picking a random port
2015-07-07 05:04:39 +00:00
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-12 16:50:09 +00:00
# Run a proxy to kubernetes apiserver, changing the api prefix to k8s-api
# This makes e.g. the pods api available at localhost:8011/k8s-api/v1/pods/
update commented examples just remove $
2016-02-29 14:41:09 +00:00
kubectl proxy --api-prefix=/k8s-api
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
### Options
```
Add some XSRF protection to kubectl proxy.
2015-06-04 23:21:11 +00:00
--accept-hosts="^localhost$,^127\\.0\\.0\\.1$,^\\[::1\\]$": Regular expression for hosts that the proxy should accept.
Make UI work through kubectl proxy (again) Fixes #10115.
2015-06-22 23:54:37 +00:00
--accept-paths="^/.*": Regular expression for paths that the proxy should accept.
Update docs
2015-09-30 11:27:07 +00:00
--address="127.0.0.1": The IP address on which to serve on.
Change kubectl proxy --api-prefix default to allow /apis/
2015-10-09 19:02:16 +00:00
--api-prefix="/": Prefix to serve the proxied API under.
Regen docs with new pflags This basically just shows in the docs that the =false portion of booleans are optional.
2015-08-05 14:23:28 +00:00
--disable-filter[=false]: If true, disable request filtering in the proxy. This is dangerous, and can leave you vulnerable to XSRF attacks, when used with an accessible port.
Make `kubectl proxy` support picking a random port
2015-07-07 05:04:39 +00:00
-p, --port=8001: The port on which to run the proxy. Set to 0 to pick a random port.
Add some XSRF protection to kubectl proxy.
2015-06-04 23:21:11 +00:00
--reject-methods="POST,PUT,PATCH": Regular expression for HTTP methods that the proxy should reject.
Prevent attach from being served by default via the proxy
2015-10-06 18:26:29 +00:00
--reject-paths="^/api/.*/exec,^/api/.*/run,^/api/.*/attach": Regular expression for paths that the proxy should reject.
kubectl: Add proxy --unix-socket=/file/path option Proxies on a TCP port are accessible outside the current security context (eg: uid). Add support for having the proxy listen on a unix socket, which has permissions applied to it. We make sure the socket starts its life only accessible by the current user using Umask. This is useful for applications like Cockpit and other tools which want the help of kubectl to handle authentication, configuration and transport security, but also want to not make that accessible to all users on a multi-user system.
2015-07-01 08:17:53 +00:00
-u, --unix-socket="": Unix socket on which to run the proxy.
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
-w, --www="": Also serve static files from the given directory under the specified prefix.
-P, --www-prefix="/static/": Prefix to serve static files under, if static file directory is specified.
```
Update docs after cobra update (spellling mistake)
2015-04-29 15:26:55 +00:00
### Options inherited from parent commands
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
```
Update docs
2015-08-17 18:06:16 +00:00
--alsologtostderr[=false]: log to standard error as well as files
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
--api-version="": The API version to use when talking to the server
--certificate-authority="": Path to a cert. file for the certificate authority.
Fix description errro for client-certificate option From "client key file" to "client certificate file".
2015-11-24 01:33:35 +00:00
--client-certificate="": Path to a client certificate file for TLS.
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
--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
Regen docs with new pflags This basically just shows in the docs that the =false portion of booleans are optional.
2015-08-05 14:23:28 +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.
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
--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
Update docs
2015-08-17 18:06:16 +00:00
--log-dir="": If non-empty, write log files in this directory
Warn for every _ flag user or cmd defined also renames all global _ flags to -
2015-05-16 16:44:42 +00:00
--log-flush-frequency=5s: Maximum number of seconds between log flushes
Update docs
2015-08-17 18:06:16 +00:00
--logtostderr[=true]: log to standard error instead of files
Regen docs with new pflags This basically just shows in the docs that the =false portion of booleans are optional.
2015-08-05 14:23:28 +00:00
--match-server-version[=false]: Require server version to match client version
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
--namespace="": If present, the namespace scope for this CLI request.
Merge branch 'kubectl-man' of https://github.com/eparis/kubernetes into eparis-kubectl-man Conflicts: docs/kubectl.md COMMIT_BLOCKED_ON_GENDOCS
2015-02-19 19:51:38 +00:00
--password="": Password for basic authentication to the API server.
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
-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
Merge branch 'kubectl-man' of https://github.com/eparis/kubernetes into eparis-kubectl-man Conflicts: docs/kubectl.md COMMIT_BLOCKED_ON_GENDOCS
2015-02-19 19:51:38 +00:00
--username="": Username for basic authentication to the API server.
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
--v=0: log level for V logs
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
Run gendocs
2015-07-17 22:35:41 +00:00
update docs using spf13/cobra generator
2015-04-12 19:04:39 +00:00
* [kubectl](kubectl.md) - 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
update commented examples just remove $
2016-02-29 14:41:09 +00:00
###### Auto generated by spf13/cobra on 29-Feb-2016
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_proxy.md?pixel)]()
Apply mungedocs changes
2015-07-14 00:13:09 +00:00
<!-- END MUNGE: GENERATED_ANALYTICS -->