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

208 lines
4.6 KiB
Groff
Raw Normal View History

automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
.TH "KUBERNETES" "1" " kubernetes User Manuals" "Eric Paris" "Jan 2015" ""
.SH NAME
.PP
kubectl proxy \- Run a proxy to the Kubernetes API server
.SH SYNOPSIS
.PP
\fBkubectl proxy\fP [OPTIONS]
.SH DESCRIPTION
.PP
gendocs
2015-06-04 01:34:37 +00:00
To proxy all of the kubernetes api and nothing else, use:
.PP
kubectl proxy \-\-api\-prefix=/
.PP
To proxy only part of the kubernetes api and also some static files:
.PP
kubectl proxy \-\-www=/my/files \-\-www\-prefix=/static/ \-\-api\-prefix=/api/
.PP
The above lets you 'curl localhost:8001/api/v1/pods'.
.PP
To proxy the entire kubernetes api at a different root, use:
.PP
kubectl proxy \-\-api\-prefix=/custom/
.PP
The above lets you 'curl localhost:8001/custom/api/v1/pods'
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
.SH OPTIONS
Add some XSRF protection to kubectl proxy.
2015-06-04 23:21:11 +00:00
.PP
\fB\-\-accept\-hosts\fP="^localhost$,^127\\.0\\.0\\.1$,^\\[::1\\]$"
Regular expression for hosts that the proxy should accept.
.PP
Make UI work through kubectl proxy (again) Fixes #10115.
2015-06-22 23:54:37 +00:00
\fB\-\-accept\-paths\fP="^/.*"
Add some XSRF protection to kubectl proxy.
2015-06-04 23:21:11 +00:00
Regular expression for paths that the proxy should accept.
Update docs
2015-09-30 11:27:07 +00:00
.PP
\fB\-\-address\fP="127.0.0.1"
The IP address on which to serve on.
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
.PP
Change kubectl proxy --api-prefix default to allow /apis/
2015-10-09 19:02:16 +00:00
\fB\-\-api\-prefix\fP="/"
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
Prefix to serve the proxied API under.
Add some XSRF protection to kubectl proxy.
2015-06-04 23:21:11 +00:00
.PP
\fB\-\-disable\-filter\fP=false
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
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.
Add some XSRF protection to kubectl proxy.
2015-06-04 23:21:11 +00:00
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
.PP
\fB\-p\fP, \fB\-\-port\fP=8001
Make `kubectl proxy` support picking a random port
2015-07-07 05:04:39 +00:00
The port on which to run the proxy. Set to 0 to pick a random port.
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
Add some XSRF protection to kubectl proxy.
2015-06-04 23:21:11 +00:00
.PP
\fB\-\-reject\-methods\fP="POST,PUT,PATCH"
Regular expression for HTTP methods that the proxy should reject.
.PP
Prevent attach from being served by default via the proxy
2015-10-06 18:26:29 +00:00
\fB\-\-reject\-paths\fP="^/api/.\fI/exec,^/api/.\fP/run,^/api/.*/attach"
Add some XSRF protection to kubectl proxy.
2015-06-04 23:21:11 +00:00
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
.PP
\fB\-u\fP, \fB\-\-unix\-socket\fP=""
Unix socket on which to run the proxy.
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
.PP
\fB\-w\fP, \fB\-\-www\fP=""
Also serve static files from the given directory under the specified prefix.
.PP
\fB\-P\fP, \fB\-\-www\-prefix\fP="/static/"
Prefix to serve static files under, if static file directory is specified.
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-alsologtostderr\fP=false
log to standard error as well as files
.PP
\fB\-\-api\-version\fP=""
The API version to use when talking to the server
.PP
\fB\-\-certificate\-authority\fP=""
Path to a cert. file for the certificate authority.
.PP
\fB\-\-client\-certificate\fP=""
Fix description errro for client-certificate option From "client key file" to "client certificate file".
2015-11-24 01:33:35 +00:00
Path to a client certificate file for TLS.
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
.PP
\fB\-\-client\-key\fP=""
Path to a client key file for TLS.
.PP
\fB\-\-cluster\fP=""
The name of the kubeconfig cluster to use
.PP
\fB\-\-context\fP=""
The name of the kubeconfig context to use
.PP
\fB\-\-insecure\-skip\-tls\-verify\fP=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
.PP
\fB\-\-kubeconfig\fP=""
Path to the kubeconfig file to use for CLI requests.
.PP
Warn for every _ flag user or cmd defined also renames all global _ flags to -
2015-05-16 16:44:42 +00:00
\fB\-\-log\-backtrace\-at\fP=:0
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
when logging hits line file:N, emit a stack trace
.PP
Warn for every _ flag user or cmd defined also renames all global _ flags to -
2015-05-16 16:44:42 +00:00
\fB\-\-log\-dir\fP=""
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
If non\-empty, write log files in this directory
.PP
Warn for every _ flag user or cmd defined also renames all global _ flags to -
2015-05-16 16:44:42 +00:00
\fB\-\-log\-flush\-frequency\fP=5s
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
Maximum number of seconds between log flushes
.PP
\fB\-\-logtostderr\fP=true
log to standard error instead of files
.PP
\fB\-\-match\-server\-version\fP=false
Require server version to match client version
.PP
\fB\-\-namespace\fP=""
If present, the namespace scope for this CLI request.
.PP
\fB\-\-password\fP=""
Password for basic authentication to the API server.
.PP
\fB\-s\fP, \fB\-\-server\fP=""
The address and port of the Kubernetes API server
.PP
\fB\-\-stderrthreshold\fP=2
logs at or above this threshold go to stderr
.PP
\fB\-\-token\fP=""
Bearer token for authentication to the API server.
.PP
\fB\-\-user\fP=""
The name of the kubeconfig user to use
.PP
\fB\-\-username\fP=""
Username for basic authentication to the API server.
.PP
\fB\-\-v\fP=0
log level for V logs
.PP
\fB\-\-vmodule\fP=
comma\-separated list of pattern=N settings for file\-filtered logging
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
.SH EXAMPLE
.PP
.RS
.nf
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/
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
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
.fi
.RE
automatically generate man pages for kubectl generate man pages for kubectl using the cobra.Command information. This will directly create files in (by default) docs/man/man1/ called kubectl*.1. Each child verb/cobra command will gets its own man page.
2015-02-06 03:02:44 +00:00
.SH SEE ALSO
.PP
\fBkubectl(1)\fP,
.SH HISTORY
.PP
January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!