kubectl proxy

Synopsis

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.

  1. kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix]

Examples

  1.   # To proxy all of the Kubernetes API and nothing else
  2.   kubectl proxy --api-prefix=/
  4.   # To proxy only part of the Kubernetes API and also some static files
  5.   # You can get pods info with 'curl localhost:8001/api/v1/pods'
  6.   kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/
  8.   # To proxy the entire Kubernetes API at a different root
  9.   # You can get pods info with 'curl localhost:8001/custom/api/v1/pods'
  10.   kubectl proxy --api-prefix=/custom/
  12.   # Run a proxy to the Kubernetes API server on port 8011, serving static content from ./local/www/
  13.   kubectl proxy --port=8011 --www=./local/www/
  15.   # Run a proxy to the Kubernetes API server on an arbitrary local port
  16.   # The chosen port for the server will be output to stdout
  17.   kubectl proxy --port=0
  19.   # Run a proxy to the Kubernetes API server, changing the API prefix to k8s-api
  20.   # This makes e.g. the pods API available at localhost:8001/k8s-api/v1/pods/
  21.   kubectl proxy --api-prefix=/k8s-api

Options

—accept-hosts string     Default: “^localhost$,^127.0.0.1$,^[::1]$”

Regular expression for hosts that the proxy should accept.

—accept-paths string     Default: “^.“

Regular expression for paths that the proxy should accept.

—address string     Default: “127.0.0.1”

The IP address on which to serve on.

—api-prefix string     Default: “/“

Prefix to serve the proxied API under.

—append-server-path

If true, enables automatic path appending of the kube context server path to each request.

—disable-filter

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.

-h, —help

help for proxy

—keepalive duration

keepalive specifies the keep-alive period for an active network connection. Set to 0 to disable keepalive.

-p, —port int     Default: 8001

The port on which to run the proxy. Set to 0 to pick a random port.

—reject-methods string     Default: “^$”

Regular expression for HTTP methods that the proxy should reject (example —reject-methods=’POST,PUT,PATCH’).

—reject-paths string     Default: “^/api/./pods/./exec,
^/api/./pods/.*/attach”

Regular expression for paths that the proxy should reject. Paths specified here will be rejected even accepted by —accept-paths.

-u, —unix-socket string

Unix socket on which to run the proxy.

-w, —www string

Also serve static files from the given directory under the specified prefix.

-P, —www-prefix string     Default: “/static/“

Prefix to serve static files under, if static file directory is specified.

—as string

Username to impersonate for the operation. User could be a regular user or a service account in a namespace.

—as-group strings

Group to impersonate for the operation, this flag can be repeated to specify multiple groups.

—as-uid string

UID to impersonate for the operation.

—cache-dir string     Default: “$HOME/.kube/cache”

Default cache directory

—certificate-authority string

Path to a cert file for the certificate authority

—client-certificate string

Path to a client certificate file for TLS

—client-key string

Path to a client key file for TLS

—cluster string

The name of the kubeconfig cluster to use

—context string

The name of the kubeconfig context to use

—default-not-ready-toleration-seconds int     Default: 300

Indicates the tolerationSeconds of the toleration for notReady:NoExecute that is added by default to every pod that does not already have such a toleration.

—default-unreachable-toleration-seconds int     Default: 300

Indicates the tolerationSeconds of the toleration for unreachable:NoExecute that is added by default to every pod that does not already have such a toleration.

—disable-compression

If true, opt-out of response compression for all requests to the server

—insecure-skip-tls-verify

If true, the server’s certificate will not be checked for validity. This will make your HTTPS connections insecure

—kubeconfig string

Path to the kubeconfig file to use for CLI requests.

—match-server-version

Require server version to match client version

-n, —namespace string

If present, the namespace scope for this CLI request

—password string

Password for basic authentication to the API server

—profile string     Default: “none”

Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)

—profile-output string     Default: “profile.pprof”

Name of the file to write the profile to

—request-timeout string     Default: “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.

-s, —server string

The address and port of the Kubernetes API server

—storage-driver-buffer-duration duration     Default: 1m0s

Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction

—storage-driver-db string     Default: “cadvisor”

database name

—storage-driver-host string     Default: “localhost:8086”

database host:port

—storage-driver-password string     Default: “root”

database password

—storage-driver-secure

use secure connection with database

—storage-driver-table string     Default: “stats”

table name

—storage-driver-user string     Default: “root”

database username

—tls-server-name string

Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used

—token string

Bearer token for authentication to the API server

—user string

The name of the kubeconfig user to use

—username string

Username for basic authentication to the API server

—version version[=true]

—version, —version=raw prints version information and quits; —version=vX.Y.Z… sets the reported version

—warnings-as-errors

Treat warnings received from the server as errors and exit with a non-zero exit code

See Also

  • kubectl - kubectl controls the Kubernetes cluster manager