1KUBERNETES(1) Jan 2015 KUBERNETES(1)
2
6 kubectl proxy - Run a proxy to the Kubernetes API server
7
11 kubectl proxy [OPTIONS]
12
16 Creates a proxy server or application-level gateway between localhost
17 and the Kubernetes API Server. It also allows serving static content
18 over specified HTTP path. All incoming data enters through one port and
19 gets forwarded to the remote kubernetes API Server port, except for the
20 path matching the static content path.
21
25 --accept-hosts="^localhost$,^127\.0\.0\.1$,^\[::1\]$"
26 Regular expression for hosts that the proxy should accept.
27 --accept-paths="^.*"
30 Regular expression for paths that the proxy should accept.
31 --address="127.0.0.1"
34 The IP address on which to serve on.
35 --api-prefix="/"
38 Prefix to serve the proxied API under.
39 --disable-filter=false
42 If true, disable request filtering in the proxy. This is dangerous,
43 and can leave you vulnerable to XSRF attacks, when used with an acces‐
44 sible port.
45 --keepalive=0s
48 keepalive specifies the keep-alive period for an active network
49 connection. Set to 0 to disable keepalive.
50 -p, --port=8001
53 The port on which to run the proxy. Set to 0 to pick a random port.
54 --reject-methods="^$"
57 Regular expression for HTTP methods that the proxy should reject
58 (example --reject-methods='POST,PUT,PATCH').
59 --reject-paths="^/api/./pods/./exec,^/api/./pods/./attach"
62 Regular expression for paths that the proxy should reject. Paths
63 specified here will be rejected even accepted by --accept-paths.
64 -u, --unix-socket=""
67 Unix socket on which to run the proxy.
68 -w, --www=""
71 Also serve static files from the given directory under the speci‐
72 fied prefix.
73 -P, --www-prefix="/static/"
76 Prefix to serve static files under, if static file directory is
77 specified.
78
82 --alsologtostderr=false
83 log to standard error as well as files
84 --application-metrics-count-limit=100
87 Max number of application metrics to store (per container)
88 --as=""
91 Username to impersonate for the operation
92 --as-group=[]
95 Group to impersonate for the operation, this flag can be repeated
96 to specify multiple groups.
97 --azure-container-registry-config=""
100 Path to the file containing Azure container registry configuration
101 information.
102 --boot-id-file="/proc/sys/kernel/random/boot_id"
105 Comma-separated list of files to check for boot-id. Use the first
106 one that exists.
107 --cache-dir="/builddir/.kube/http-cache"
110 Default HTTP cache directory
111 --certificate-authority=""
114 Path to a cert file for the certificate authority
115 --client-certificate=""
118 Path to a client certificate file for TLS
119 --client-key=""
122 Path to a client key file for TLS
123 --cloud-provider-gce-lb-src-cidrs=130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16
126 CIDRs opened in GCE firewall for LB traffic proxy health checks
127 --cluster=""
130 The name of the kubeconfig cluster to use
131 --container-hints="/etc/cadvisor/container_hints.json"
134 location of the container hints file
135 --containerd="unix:///var/run/containerd.sock"
138 containerd endpoint
139 --context=""
142 The name of the kubeconfig context to use
143 --default-not-ready-toleration-seconds=300
146 Indicates the tolerationSeconds of the toleration for
147 notReady:NoExecute that is added by default to every pod that does not
148 already have such a toleration.
149 --default-unreachable-toleration-seconds=300
152 Indicates the tolerationSeconds of the toleration for unreach‐
153 able:NoExecute that is added by default to every pod that does not
154 already have such a toleration.
155 --docker="unix:///var/run/docker.sock"
158 docker endpoint
159 --docker-env-metadata-whitelist=""
162 a comma-separated list of environment variable keys that needs to
163 be collected for docker containers
164 --docker-only=false
167 Only report docker containers in addition to root stats
168 --docker-root="/var/lib/docker"
171 DEPRECATED: docker root is read from docker info (this is a fall‐
172 back, default: /var/lib/docker)
173 --docker-tls=false
176 use TLS to connect to docker
177 --docker-tls-ca="ca.pem"
180 path to trusted CA
181 --docker-tls-cert="cert.pem"
184 path to client certificate
185 --docker-tls-key="key.pem"
188 path to private key
189 --enable-load-reader=false
192 Whether to enable cpu load reader
193 --event-storage-age-limit="default=0"
196 Max length of time for which to store events (per type). Value is a
197 comma separated list of key values, where the keys are event types
198 (e.g.: creation, oom) or "default" and the value is a duration. Default
199 is applied to all non-specified event types
200 --event-storage-event-limit="default=0"
203 Max number of events to store (per type). Value is a comma sepa‐
204 rated list of key values, where the keys are event types (e.g.: cre‐
205 ation, oom) or "default" and the value is an integer. Default is
206 applied to all non-specified event types
207 --global-housekeeping-interval=1m0s
210 Interval between global housekeepings
211 --housekeeping-interval=10s
214 Interval between container housekeepings
215 --insecure-skip-tls-verify=false
218 If true, the server's certificate will not be checked for validity.
219 This will make your HTTPS connections insecure
220 --kubeconfig=""
223 Path to the kubeconfig file to use for CLI requests.
224 --log-backtrace-at=:0
227 when logging hits line file:N, emit a stack trace
228 --log-cadvisor-usage=false
231 Whether to log the usage of the cAdvisor container
232 --log-dir=""
235 If non-empty, write log files in this directory
236 --log-file=""
239 If non-empty, use this log file
240 --log-flush-frequency=5s
243 Maximum number of seconds between log flushes
244 --logtostderr=true
247 log to standard error instead of files
248 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
251 Comma-separated list of files to check for machine-id. Use the
252 first one that exists.
253 --match-server-version=false
256 Require server version to match client version
257 --mesos-agent="127.0.0.1:5051"
260 Mesos agent address
261 --mesos-agent-timeout=10s
264 Mesos agent timeout
265 -n, --namespace=""
268 If present, the namespace scope for this CLI request
269 --password=""
272 Password for basic authentication to the API server
273 --profile="none"
276 Name of profile to capture. One of (none|cpu|heap|goroutine|thread‐
277 create|block|mutex)
278 --profile-output="profile.pprof"
281 Name of the file to write the profile to
282 --request-timeout="0"
285 The length of time to wait before giving up on a single server
286 request. Non-zero values should contain a corresponding time unit (e.g.
287 1s, 2m, 3h). A value of zero means don't timeout requests.
288 -s, --server=""
291 The address and port of the Kubernetes API server
292 --skip-headers=false
295 If true, avoid header prefixes in the log messages
296 --stderrthreshold=2
299 logs at or above this threshold go to stderr
300 --storage-driver-buffer-duration=1m0s
303 Writes in the storage driver will be buffered for this duration,
304 and committed to the non memory backends as a single transaction
305 --storage-driver-db="cadvisor"
308 database name
309 --storage-driver-host="localhost:8086"
312 database host:port
313 --storage-driver-password="root"
316 database password
317 --storage-driver-secure=false
320 use secure connection with database
321 --storage-driver-table="stats"
324 table name
325 --storage-driver-user="root"
328 database username
329 --token=""
332 Bearer token for authentication to the API server
333 --user=""
336 The name of the kubeconfig user to use
337 --username=""
340 Username for basic authentication to the API server
341 -v, --v=0
344 log level for V logs
345 --version=false
348 Print version information and quit
349 --vmodule=
352 comma-separated list of pattern=N settings for file-filtered log‐
353 ging
354
358 # To proxy all of the kubernetes api and nothing else, use:
359 $ kubectl proxy --api-prefix=/
361 # To proxy only part of the kubernetes api and also some static files:
363 $ kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/
365 # The above lets you 'curl localhost:8001/api/v1/pods'.
367 # To proxy the entire kubernetes api at a different root, use:
369 $ kubectl proxy --api-prefix=/custom/
371 # The above lets you 'curl localhost:8001/custom/api/v1/pods'
373 # Run a proxy to kubernetes apiserver on port 8011, serving static content from ./local/www/
375 kubectl proxy --port=8011 --www=./local/www/
376 # Run a proxy to kubernetes apiserver on an arbitrary local port.
378 # The chosen port for the server will be output to stdout.
379 kubectl proxy --port=0
380 # Run a proxy to kubernetes apiserver, changing the api prefix to k8s-api
382 # This makes e.g. the pods api available at localhost:8001/k8s-api/v1/pods/
383 kubectl proxy --api-prefix=/k8s-api
384
389 kubectl(1),
390
394 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
395 com) based on the kubernetes source material, but hopefully they have
396 been automatically generated since!
397Eric Paris kubernetes User Manuals KUBERNETES(1)