HiveBrain v1.2.0
Get Started
← Back to all entries
snippetbashTip

kubectl proxy — Create a proxy server or application-level gateway between localhost and the Kubernetes API server.

Submitted by: @import:tldr-pages··
0
Viewed 0 times
servercreatecommandproxylevelclikubectl proxyapplication

Problem

How to use the kubectl proxy command: Create a proxy server or application-level gateway between localhost and the Kubernetes API server. More information: <https://kubernetes.io/docs/reference/kubectl/generated/kubectl_proxy/>.

Solution

kubectl proxy — Create a proxy server or application-level gateway between localhost and the Kubernetes API server. More information: <https://kubernetes.io/docs/reference/kubectl/generated/kubectl_proxy/>.

Run a proxy using the default settings on port 8001 and listen on localhost:
kubectl proxy


Proxy part of the Kubernetes API while serving static files from a local directory:
kubectl proxy {{[-w|--www]}} {{path/to/static_dir}} {{[-P|--www-prefix]}} {{/static_prefix/}} --api-prefix {{/api_subset/}}


Proxy the entire Kubernetes API under a custom prefix:
kubectl proxy --api-prefix {{/custom_prefix/}}


Serve the Kubernetes API on a specific port while also serving static content:
kubectl proxy {{[-p|--port]}} {{port}} {{[-w|--www]}} {{path/to/static_dir}}


Run a proxy on a random local port, printing the chosen port to stdout:
kubectl proxy {{[-p|--port]}} 0


Run the proxy on a Unix domain socket instead of a TCP port:
kubectl proxy {{[-u|--unix-socket]}} {{path/to/socket}}


Accept connections from remote hosts by listening on all interfaces (use caution when exposing the proxy publicly):
kubectl proxy --address 0.0.0.0 --accept-hosts '.*'


Allow only selected API paths while rejecting sensitive endpoints:
kubectl proxy --accept-paths '^/api/v1/namespaces/default/.*' --reject-paths '^/api/.*/pods/.*/exec'

Code Snippets

Run a proxy using the default settings on port 8001 and listen on localhost

kubectl proxy

Proxy part of the Kubernetes API while serving static files from a local directory

kubectl proxy {{[-w|--www]}} {{path/to/static_dir}} {{[-P|--www-prefix]}} {{/static_prefix/}} --api-prefix {{/api_subset/}}

Proxy the entire Kubernetes API under a custom prefix

kubectl proxy --api-prefix {{/custom_prefix/}}

Serve the Kubernetes API on a specific port while also serving static content

kubectl proxy {{[-p|--port]}} {{port}} {{[-w|--www]}} {{path/to/static_dir}}

Run a proxy on a random local port, printing the chosen port to `stdout`

kubectl proxy {{[-p|--port]}} 0

Context

tldr-pages: common/kubectl proxy

Revisions (0)

No revisions yet.