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.
17 Use resource type/name such as deployment/mydeployment to select a pod.
20 Resource type defaults to 'pod' if omitted.
21 If there are multiple pods matching the criteria, a pod will be
24 selected automatically. The forwarding session ends when the selected
25 pod terminates, and rerun of the command is needed to resume forward‐
26 ing.
27
31 --pod-running-timeout=1m0s
32 The length of time (like 5s, 2m, or 3h, higher than zero) to wait
33 until at least one pod is running
34
38 --allow-verification-with-non-compliant-keys=false
39 Allow a SignatureVerifier to use keys which are technically
40 non-compliant with RFC6962.
41 --alsologtostderr=false
44 log to standard error as well as files
45 --application-metrics-count-limit=100
48 Max number of application metrics to store (per container)
49 --as=""
52 Username to impersonate for the operation
53 --as-group=[]
56 Group to impersonate for the operation, this flag can be repeated
57 to specify multiple groups.
58 --azure-container-registry-config=""
61 Path to the file containing Azure container registry configuration
62 information.
63 --boot-id-file="/proc/sys/kernel/random/boot_id"
66 Comma-separated list of files to check for boot-id. Use the first
67 one that exists.
68 --cache-dir="/builddir/.kube/http-cache"
71 Default HTTP cache directory
72 --certificate-authority=""
75 Path to a cert file for the certificate authority
76 --client-certificate=""
79 Path to a client certificate file for TLS
80 --client-key=""
83 Path to a client key file for TLS
84 --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
87 CIDRs opened in GCE firewall for LB traffic proxy health checks
88 --cluster=""
91 The name of the kubeconfig cluster to use
92 --container-hints="/etc/cadvisor/container_hints.json"
95 location of the container hints file
96 --containerd="unix:///var/run/containerd.sock"
99 containerd endpoint
100 --context=""
103 The name of the kubeconfig context to use
104 --default-not-ready-toleration-seconds=300
107 Indicates the tolerationSeconds of the toleration for
108 notReady:NoExecute that is added by default to every pod that does not
109 already have such a toleration.
110 --default-unreachable-toleration-seconds=300
113 Indicates the tolerationSeconds of the toleration for unreach‐
114 able:NoExecute that is added by default to every pod that does not
115 already have such a toleration.
116 --docker="unix:///var/run/docker.sock"
119 docker endpoint
120 --docker-env-metadata-whitelist=""
123 a comma-separated list of environment variable keys that needs to
124 be collected for docker containers
125 --docker-only=false
128 Only report docker containers in addition to root stats
129 --docker-root="/var/lib/docker"
132 DEPRECATED: docker root is read from docker info (this is a fall‐
133 back, default: /var/lib/docker)
134 --docker-tls=false
137 use TLS to connect to docker
138 --docker-tls-ca="ca.pem"
141 path to trusted CA
142 --docker-tls-cert="cert.pem"
145 path to client certificate
146 --docker-tls-key="key.pem"
149 path to private key
150 --enable-load-reader=false
153 Whether to enable cpu load reader
154 --event-storage-age-limit="default=0"
157 Max length of time for which to store events (per type). Value is a
158 comma separated list of key values, where the keys are event types
159 (e.g.: creation, oom) or "default" and the value is a duration. Default
160 is applied to all non-specified event types
161 --event-storage-event-limit="default=0"
164 Max number of events to store (per type). Value is a comma sepa‐
165 rated list of key values, where the keys are event types (e.g.: cre‐
166 ation, oom) or "default" and the value is an integer. Default is
167 applied to all non-specified event types
168 --global-housekeeping-interval=1m0s
171 Interval between global housekeepings
172 --google-json-key=""
175 The Google Cloud Platform Service Account JSON Key to use for
176 authentication.
177 --housekeeping-interval=10s
180 Interval between container housekeepings
181 --insecure-skip-tls-verify=false
184 If true, the server's certificate will not be checked for validity.
185 This will make your HTTPS connections insecure
186 --kubeconfig=""
189 Path to the kubeconfig file to use for CLI requests.
190 --log-backtrace-at=:0
193 when logging hits line file:N, emit a stack trace
194 --log-cadvisor-usage=false
197 Whether to log the usage of the cAdvisor container
198 --log-dir=""
201 If non-empty, write log files in this directory
202 --log-flush-frequency=5s
205 Maximum number of seconds between log flushes
206 --logtostderr=true
209 log to standard error instead of files
210 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
213 Comma-separated list of files to check for machine-id. Use the
214 first one that exists.
215 --match-server-version=false
218 Require server version to match client version
219 --mesos-agent="127.0.0.1:5051"
222 Mesos agent address
223 --mesos-agent-timeout=10s
226 Mesos agent timeout
227 -n, --namespace=""
230 If present, the namespace scope for this CLI request
231 --request-timeout="0"
234 The length of time to wait before giving up on a single server
235 request. Non-zero values should contain a corresponding time unit (e.g.
236 1s, 2m, 3h). A value of zero means don't timeout requests.
237 -s, --server=""
240 The address and port of the Kubernetes API server
241 --stderrthreshold=2
244 logs at or above this threshold go to stderr
245 --storage-driver-buffer-duration=1m0s
248 Writes in the storage driver will be buffered for this duration,
249 and committed to the non memory backends as a single transaction
250 --storage-driver-db="cadvisor"
253 database name
254 --storage-driver-host="localhost:8086"
257 database host:port
258 --storage-driver-password="root"
261 database password
262 --storage-driver-secure=false
265 use secure connection with database
266 --storage-driver-table="stats"
269 table name
270 --storage-driver-user="root"
273 database username
274 --token=""
277 Bearer token for authentication to the API server
278 --user=""
281 The name of the kubeconfig user to use
282 -v, --v=0
285 log level for V logs
286 --version=false
289 Print version information and quit
290 --vmodule=
293 comma-separated list of pattern=N settings for file-filtered log‐
294 ging
295
299 # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod
300 kubectl port-forward pod/mypod 5000 6000
301 # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the deployment
303 kubectl port-forward deployment/mydeployment 5000 6000
304 # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the service
306 kubectl port-forward service/myservice 5000 6000
307 # Listen on port 8888 locally, forwarding to 5000 in the pod
309 kubectl port-forward pod/mypod 8888:5000
310 # Listen on a random port locally, forwarding to 5000 in the pod
312 kubectl port-forward pod/mypod :5000
313
318 kubectl(1),
319
323 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
324 com) based on the kubernetes source material, but hopefully they have
325 been automatically generated since!
326Eric Paris kubernetes User Manuals KUBERNETES(1)