.nh
.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
Creates a proxy server or application-level gateway between localhost and the Kubernetes API server. It also allows serving static content over specified HTTP path. All incoming data enters through one port and gets forwarded to the remote Kubernetes API server port, except for the path matching the static content path.


.SH OPTIONS
.PP
\fB--accept-hosts\fP="^localhost$,^127\\\&.0\\\&.0\\\&.1$,^\\[::1\\]$"
	Regular expression for hosts that the proxy should accept.

.PP
\fB--accept-paths\fP="^.*"
	Regular expression for paths that the proxy should accept.

.PP
\fB--address\fP="127.0.0.1"
	The IP address on which to serve on.

.PP
\fB--api-prefix\fP="/"
	Prefix to serve the proxied API under.

.PP
\fB--append-server-path\fP=false
	If true, enables automatic path appending of the kube context server path to each request.

.PP
\fB--disable-filter\fP=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.

.PP
\fB--keepalive\fP=0s
	keepalive specifies the keep-alive period for an active network connection. Set to 0 to disable keepalive.

.PP
\fB-p\fP, \fB--port\fP=8001
	The port on which to run the proxy. Set to 0 to pick a random port.

.PP
\fB--reject-methods\fP="^$"
	Regular expression for HTTP methods that the proxy should reject (example --reject-methods='POST,PUT,PATCH').

.PP
\fB--reject-paths\fP="^/api/.\fI/pods/.\fP/exec,^/api/.\fI/pods/.\fP/attach"
	Regular expression for paths that the proxy should reject. Paths specified here will be rejected even accepted by --accept-paths.

.PP
\fB-u\fP, \fB--unix-socket\fP=""
	Unix socket on which to run the proxy.

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


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--as\fP=""
	Username to impersonate for the operation. User could be a regular user or a service account in a namespace.

.PP
\fB--as-group\fP=[]
	Group to impersonate for the operation, this flag can be repeated to specify multiple groups.

.PP
\fB--as-uid\fP=""
	UID to impersonate for the operation.

.PP
\fB--cache-dir\fP="/home/username/.kube/cache"
	Default cache directory

.PP
\fB--certificate-authority\fP=""
	Path to a cert file for the certificate authority

.PP
\fB--client-certificate\fP=""
	Path to a client certificate file for TLS

.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--disable-compression\fP=false
	If true, opt-out of response compression for all requests to the server

.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
\fB--match-server-version\fP=false
	Require server version to match client version

.PP
\fB-n\fP, \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--profile\fP="none"
	Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)

.PP
\fB--profile-output\fP="profile.pprof"
	Name of the file to write the profile to

.PP
\fB--request-timeout\fP="0"
	The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.

.PP
\fB-s\fP, \fB--server\fP=""
	The address and port of the Kubernetes API server

.PP
\fB--tls-server-name\fP=""
	Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used

.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--version\fP=false
	--version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version

.PP
\fB--warnings-as-errors\fP=false
	Treat warnings received from the server as errors and exit with a non-zero exit code


.SH EXAMPLE
.EX
  # To proxy all of the Kubernetes API and nothing else
  kubectl proxy --api-prefix=/
  
  # To proxy only part of the Kubernetes API and also some static files
  # You can get pods info with 'curl localhost:8001/api/v1/pods'
  kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/
  
  # To proxy the entire Kubernetes API at a different root
  # You can get pods info with 'curl localhost:8001/custom/api/v1/pods'
  kubectl proxy --api-prefix=/custom/
  
  # Run a proxy to the Kubernetes API server on port 8011, serving static content from ./local/www/
  kubectl proxy --port=8011 --www=./local/www/
  
  # Run a proxy to the Kubernetes API server on an arbitrary local port
  # The chosen port for the server will be output to stdout
  kubectl proxy --port=0
  
  # Run a proxy to the Kubernetes API server, changing the API prefix to k8s-api
  # This makes e.g. the pods API available at localhost:8001/k8s-api/v1/pods/
  kubectl proxy --api-prefix=/k8s-api
.EE


.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!