1KUBERNETES(1) Jan 2015 KUBERNETES(1)
2
6 kubectl port-forward - Forward one or more local ports to a pod
7
11 kubectl port-forward [OPTIONS]
12
16 Forward one or more local ports to a pod. This command requires the
17 node to have 'socat' installed.
18 Use resource type/name such as deployment/mydeployment to select a pod.
21 Resource type defaults to 'pod' if omitted.
22 If there are multiple pods matching the criteria, a pod will be
25 selected automatically. The forwarding session ends when the selected
26 pod terminates, and rerun of the command is needed to resume
27 forwarding.
28
32 --address=[localhost]
33 Addresses to listen on (comma separated). Only accepts IP addresses
34 or localhost as a value. When localhost is supplied, kubectl will try
35 to bind on both 127.0.0.1 and ::1 and will fail if neither of these
36 addresses are available to bind.
37 --pod-running-timeout=1m0s
40 The length of time (like 5s, 2m, or 3h, higher than zero) to wait
41 until at least one pod is running
42
46 --add-dir-header=false
47 If true, adds the file directory to the header
48 --alsologtostderr=false
51 log to standard error as well as files
52 --application-metrics-count-limit=100
55 Max number of application metrics to store (per container)
56 --as=""
59 Username to impersonate for the operation
60 --as-group=[]
63 Group to impersonate for the operation, this flag can be repeated
64 to specify multiple groups.
65 --azure-container-registry-config=""
68 Path to the file containing Azure container registry configuration
69 information.
70 --boot-id-file="/proc/sys/kernel/random/boot_id"
73 Comma-separated list of files to check for boot-id. Use the first
74 one that exists.
75 --cache-dir="/builddir/.kube/http-cache"
78 Default HTTP cache directory
79 --certificate-authority=""
82 Path to a cert file for the certificate authority
83 --client-certificate=""
86 Path to a client certificate file for TLS
87 --client-key=""
90 Path to a client key file for TLS
91 --cloud-provider-gce-l7lb-src-cidrs=130.211.0.0/22,35.191.0.0/16
94 CIDRs opened in GCE firewall for L7 LB traffic proxy health checks
95 --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
98 CIDRs opened in GCE firewall for L4 LB traffic proxy health checks
99 --cluster=""
102 The name of the kubeconfig cluster to use
103 --container-hints="/etc/cadvisor/container_hints.json"
106 location of the container hints file
107 --containerd="/run/containerd/containerd.sock"
110 containerd endpoint
111 --containerd-namespace="k8s.io"
114 containerd namespace
115 --context=""
118 The name of the kubeconfig context to use
119 --default-not-ready-toleration-seconds=300
122 Indicates the tolerationSeconds of the toleration for
123 notReady:NoExecute that is added by default to every pod that does not
124 already have such a toleration.
125 --default-unreachable-toleration-seconds=300
128 Indicates the tolerationSeconds of the toleration for
129 unreachable:NoExecute that is added by default to every pod that does
130 not already have such a toleration.
131 --disable-root-cgroup-stats=false
134 Disable collecting root Cgroup stats
135 --docker="unix:///var/run/docker.sock"
138 docker endpoint
139 --docker-env-metadata-whitelist=""
142 a comma-separated list of environment variable keys that needs to
143 be collected for docker containers
144 --docker-only=false
147 Only report docker containers in addition to root stats
148 --docker-root="/var/lib/docker"
151 DEPRECATED: docker root is read from docker info (this is a
152 fallback, default: /var/lib/docker)
153 --docker-tls=false
156 use TLS to connect to docker
157 --docker-tls-ca="ca.pem"
160 path to trusted CA
161 --docker-tls-cert="cert.pem"
164 path to client certificate
165 --docker-tls-key="key.pem"
168 path to private key
169 --enable-load-reader=false
172 Whether to enable cpu load reader
173 --event-storage-age-limit="default=0"
176 Max length of time for which to store events (per type). Value is a
177 comma separated list of key values, where the keys are event types
178 (e.g.: creation, oom) or "default" and the value is a duration. Default
179 is applied to all non-specified event types
180 --event-storage-event-limit="default=0"
183 Max number of events to store (per type). Value is a comma
184 separated list of key values, where the keys are event types (e.g.:
185 creation, oom) or "default" and the value is an integer. Default is
186 applied to all non-specified event types
187 --global-housekeeping-interval=1m0s
190 Interval between global housekeepings
191 --housekeeping-interval=10s
194 Interval between container housekeepings
195 --insecure-skip-tls-verify=false
198 If true, the server's certificate will not be checked for validity.
199 This will make your HTTPS connections insecure
200 --kubeconfig=""
203 Path to the kubeconfig file to use for CLI requests.
204 --log-backtrace-at=:0
207 when logging hits line file:N, emit a stack trace
208 --log-cadvisor-usage=false
211 Whether to log the usage of the cAdvisor container
212 --log-dir=""
215 If non-empty, write log files in this directory
216 --log-file=""
219 If non-empty, use this log file
220 --log-file-max-size=1800
223 Defines the maximum size a log file can grow to. Unit is megabytes.
224 If the value is 0, the maximum file size is unlimited.
225 --log-flush-frequency=5s
228 Maximum number of seconds between log flushes
229 --logtostderr=true
232 log to standard error instead of files
233 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
236 Comma-separated list of files to check for machine-id. Use the
237 first one that exists.
238 --match-server-version=false
241 Require server version to match client version
242 -n, --namespace=""
245 If present, the namespace scope for this CLI request
246 --password=""
249 Password for basic authentication to the API server
250 --profile="none"
253 Name of profile to capture. One of
254 (none|cpu|heap|goroutine|threadcreate|block|mutex)
255 --profile-output="profile.pprof"
258 Name of the file to write the profile to
259 --request-timeout="0"
262 The length of time to wait before giving up on a single server
263 request. Non-zero values should contain a corresponding time unit (e.g.
264 1s, 2m, 3h). A value of zero means don't timeout requests.
265 -s, --server=""
268 The address and port of the Kubernetes API server
269 --skip-headers=false
272 If true, avoid header prefixes in the log messages
273 --skip-log-headers=false
276 If true, avoid headers when opening log files
277 --stderrthreshold=2
280 logs at or above this threshold go to stderr
281 --storage-driver-buffer-duration=1m0s
284 Writes in the storage driver will be buffered for this duration,
285 and committed to the non memory backends as a single transaction
286 --storage-driver-db="cadvisor"
289 database name
290 --storage-driver-host="localhost:8086"
293 database host:port
294 --storage-driver-password="root"
297 database password
298 --storage-driver-secure=false
301 use secure connection with database
302 --storage-driver-table="stats"
305 table name
306 --storage-driver-user="root"
309 database username
310 --tls-server-name=""
313 Server name to use for server certificate validation. If it is not
314 provided, the hostname used to contact the server is used
315 --token=""
318 Bearer token for authentication to the API server
319 --update-machine-info-interval=5m0s
322 Interval between machine info updates.
323 --user=""
326 The name of the kubeconfig user to use
327 --username=""
330 Username for basic authentication to the API server
331 -v, --v=0
334 number for the log level verbosity
335 --version=false
338 Print version information and quit
339 --vmodule=
342 comma-separated list of pattern=N settings for file-filtered
343 logging
344
348 # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod
349 kubectl port-forward pod/mypod 5000 6000
350 # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the deployment
352 kubectl port-forward deployment/mydeployment 5000 6000
353 # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the service
355 kubectl port-forward service/myservice 5000 6000
356 # Listen on port 8888 locally, forwarding to 5000 in the pod
358 kubectl port-forward pod/mypod 8888:5000
359 # Listen on port 8888 on all addresses, forwarding to 5000 in the pod
361 kubectl port-forward --address 0.0.0.0 pod/mypod 8888:5000
362 # Listen on port 8888 on localhost and selected IP, forwarding to 5000 in the pod
364 kubectl port-forward --address localhost,10.19.21.23 pod/mypod 8888:5000
365 # Listen on a random port locally, forwarding to 5000 in the pod
367 kubectl port-forward pod/mypod :5000
368
373 kubectl(1),
374
378 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
379 com) based on the kubernetes source material, but hopefully they have
380 been automatically generated since!
381Eric Paris kubernetes User Manuals KUBERNETES(1)