NAME¶

oc port-forward - Forward one or more local ports to a pod

SYNOPSIS¶

oc port-forward [OPTIONS]

DESCRIPTION¶

Forward one or more local ports to a pod.

Use resource type/name such as deployment/mydeployment to select a pod. Resource type defaults to 'pod' if omitted.

If there are multiple pods matching the criteria, a pod will be selected automatically. The forwarding session ends when the selected pod terminates, and a rerun of the command is needed to resume forwarding.

OPTIONS¶

--address=[localhost]
Addresses to listen on (comma separated). Only accepts IP addresses or localhost as a value. When localhost is supplied, kubectl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these addresses are available to bind.

--pod-running-timeout=0
The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running

OPTIONS INHERITED FROM PARENT COMMANDS¶

--as=""
Username to impersonate for the operation. User could be a regular user or a service account in a namespace.

--as-group=[]
Group to impersonate for the operation, this flag can be repeated to specify multiple groups.

--as-uid=""
UID to impersonate for the operation.

--cache-dir="/home/abuild/.kube/cache"
Default cache directory

--certificate-authority=""
Path to a cert file for the certificate authority

--client-certificate=""
Path to a client certificate file for TLS

--client-key=""
Path to a client key file for TLS

--cluster=""
The name of the kubeconfig cluster to use

--context=""
The name of the kubeconfig context to use

--disable-compression=false
If true, opt-out of response compression for all requests to the server

--insecure-skip-tls-verify=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure

--kubeconfig=""
Path to the kubeconfig file to use for CLI requests.

--match-server-version=false
Require server version to match client version

-n, --namespace=""
If present, the namespace scope for this CLI request

--profile="none"
Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)

--profile-output="profile.pprof"
Name of the file to write the profile to

--request-timeout="0"
The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.

-s, --server=""
The address and port of the Kubernetes API server

--tls-server-name=""
Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used

--token=""
Bearer token for authentication to the API server

--user=""
The name of the kubeconfig user to use

--warnings-as-errors=false
Treat warnings received from the server as errors and exit with a non-zero exit code

EXAMPLE¶

  # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod


  oc port-forward pod/mypod 5000 6000


  


  # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the deployment


  oc port-forward deployment/mydeployment 5000 6000


  


  # Listen on port 8443 locally, forwarding to the targetPort of the service's port named "https" in a pod selected by the service


  oc port-forward service/myservice 8443:https


  


  # Listen on port 8888 locally, forwarding to 5000 in the pod


  oc port-forward pod/mypod 8888:5000


  


  # Listen on port 8888 on all addresses, forwarding to 5000 in the pod


  oc port-forward --address 0.0.0.0 pod/mypod 8888:5000


  


  # Listen on port 8888 on localhost and selected IP, forwarding to 5000 in the pod


  oc port-forward --address localhost,10.19.21.23 pod/mypod 8888:5000


  


  # Listen on a random port locally, forwarding to 5000 in the pod


  oc port-forward pod/mypod :5000

SEE ALSO¶

oc(1),

HISTORY¶

June 2016, Ported from the Kubernetes man-doc generator