1OC(1) June 2016 OC(1)
2
6 oc port-forward - Forward one or more local ports to a pod
7
11 oc port-forward [OPTIONS]
12
16 Forward 1 or more local ports to a pod
17
21 --pod-running-timeout=0
22 The length of time (like 5s, 2m, or 3h, higher than zero) to wait
23 until at least one pod is running
24
28 --allow_verification_with_non_compliant_keys=false
29 Allow a SignatureVerifier to use keys which are technically
30 non-compliant with RFC6962.
31 --alsologtostderr=false
34 log to standard error as well as files
35 --application_metrics_count_limit=100
38 Max number of application metrics to store (per container)
39 --as=""
42 Username to impersonate for the operation
43 --as-group=[]
46 Group to impersonate for the operation, this flag can be repeated
47 to specify multiple groups.
48 --azure-container-registry-config=""
51 Path to the file containing Azure container registry configuration
52 information.
53 --boot_id_file="/proc/sys/kernel/random/boot_id"
56 Comma-separated list of files to check for boot-id. Use the first
57 one that exists.
58 --cache-dir="/builddir/.kube/http-cache"
61 Default HTTP cache directory
62 --certificate-authority=""
65 Path to a cert file for the certificate authority
66 --client-certificate=""
69 Path to a client certificate file for TLS
70 --client-key=""
73 Path to a client key file for TLS
74 --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
77 CIDRs opened in GCE firewall for LB traffic proxy health checks
78 --cluster=""
81 The name of the kubeconfig cluster to use
82 --container_hints="/etc/cadvisor/container_hints.json"
85 location of the container hints file
86 --containerd="unix:///var/run/containerd.sock"
89 containerd endpoint
90 --context=""
93 The name of the kubeconfig context to use
94 --default-not-ready-toleration-seconds=300
97 Indicates the tolerationSeconds of the toleration for
98 notReady:NoExecute that is added by default to every pod that does not
99 already have such a toleration.
100 --default-unreachable-toleration-seconds=300
103 Indicates the tolerationSeconds of the toleration for unreach‐
104 able:NoExecute that is added by default to every pod that does not
105 already have such a toleration.
106 --docker="unix:///var/run/docker.sock"
109 docker endpoint
110 --docker-tls=false
113 use TLS to connect to docker
114 --docker-tls-ca="ca.pem"
117 path to trusted CA
118 --docker-tls-cert="cert.pem"
121 path to client certificate
122 --docker-tls-key="key.pem"
125 path to private key
126 --docker_env_metadata_whitelist=""
129 a comma-separated list of environment variable keys that needs to
130 be collected for docker containers
131 --docker_only=false
134 Only report docker containers in addition to root stats
135 --docker_root="/var/lib/docker"
138 DEPRECATED: docker root is read from docker info (this is a fall‐
139 back, default: /var/lib/docker)
140 --enable_load_reader=false
143 Whether to enable cpu load reader
144 --event_storage_age_limit="default=24h"
147 Max length of time for which to store events (per type). Value is a
148 comma separated list of key values, where the keys are event types
149 (e.g.: creation, oom) or "default" and the value is a duration. Default
150 is applied to all non-specified event types
151 --event_storage_event_limit="default=100000"
154 Max number of events to store (per type). Value is a comma sepa‐
155 rated list of key values, where the keys are event types (e.g.: cre‐
156 ation, oom) or "default" and the value is an integer. Default is
157 applied to all non-specified event types
158 --global_housekeeping_interval=0
161 Interval between global housekeepings
162 --housekeeping_interval=0
165 Interval between container housekeepings
166 --httptest.serve=""
169 if non-empty, httptest.NewServer serves on this address and blocks
170 --insecure-skip-tls-verify=false
173 If true, the server's certificate will not be checked for validity.
174 This will make your HTTPS connections insecure
175 --kubeconfig=""
178 Path to the kubeconfig file to use for CLI requests.
179 --log-flush-frequency=0
182 Maximum number of seconds between log flushes
183 --log_backtrace_at=:0
186 when logging hits line file:N, emit a stack trace
187 --log_cadvisor_usage=false
190 Whether to log the usage of the cAdvisor container
191 --log_dir=""
194 If non-empty, write log files in this directory
195 --logtostderr=true
198 log to standard error instead of files
199 --machine_id_file="/etc/machine-id,/var/lib/dbus/machine-id"
202 Comma-separated list of files to check for machine-id. Use the
203 first one that exists.
204 --match-server-version=false
207 Require server version to match client version
208 -n, --namespace=""
211 If present, the namespace scope for this CLI request
212 --request-timeout="0"
215 The length of time to wait before giving up on a single server
216 request. Non-zero values should contain a corresponding time unit (e.g.
217 1s, 2m, 3h). A value of zero means don't timeout requests.
218 -s, --server=""
221 The address and port of the Kubernetes API server
222 --stderrthreshold=2
225 logs at or above this threshold go to stderr
226 --storage_driver_buffer_duration=0
229 Writes in the storage driver will be buffered for this duration,
230 and committed to the non memory backends as a single transaction
231 --storage_driver_db="cadvisor"
234 database name
235 --storage_driver_host="localhost:8086"
238 database host:port
239 --storage_driver_password="root"
242 database password
243 --storage_driver_secure=false
246 use secure connection with database
247 --storage_driver_table="stats"
250 table name
251 --storage_driver_user="root"
254 database username
255 --token=""
258 Bearer token for authentication to the API server
259 --user=""
262 The name of the kubeconfig user to use
263 -v, --v=0
266 log level for V logs
267 --version=false
270 Print version information and quit
271 --vmodule=
274 comma-separated list of pattern=N settings for file-filtered log‐
275 ging
276
280 # Listens on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod
281 oc port-forward mypod 5000 6000
282 # Listens on port 8888 locally, forwarding to 5000 in the pod
284 oc port-forward mypod 8888:5000
285 # Listens on a random port locally, forwarding to 5000 in the pod
287 oc port-forward mypod :5000
288 # Listens on a random port locally, forwarding to 5000 in the pod
290 oc port-forward mypod 0:5000
291
296 oc(1),
297
301 June 2016, Ported from the Kubernetes man-doc generator
302Openshift Openshift CLI User Manuals OC(1)