kubectl-port-forward(1)

1KUBERNETES(1)(kubernetes)                            KUBERNETES(1)(kubernetes)
2
3
4
5Eric Paris Jan 2015
6
7

NAME

9       kubectl port-forward - Forward one or more local ports to a pod
10
11
12

SYNOPSIS

14       kubectl port-forward [OPTIONS]
15
16
17

DESCRIPTION

19       Forward one or more local ports to a pod.
20
21
22       Use resource type/name such as deployment/mydeployment to select a pod.
23       Resource type defaults to 'pod' if omitted.
24
25
26       If there are multiple pods matching the criteria, a  pod  will  be  se‐
27       lected automatically. The forwarding session ends when the selected pod
28       terminates, and a rerun of the command is needed to resume forwarding.
29
30
31

OPTIONS

33       --address=[localhost]      Addresses to listen  on  (comma  separated).
34       Only  accepts  IP  addresses or localhost as a value. When localhost is
35       supplied, kubectl will try to bind on both 127.0.0.1 and ::1  and  will
36       fail if neither of these addresses are available to bind.
37
38
39       --pod-running-timeout=1m0s      The length of time (like 5s, 2m, or 3h,
40       higher than zero) to wait until at least one pod is running
41
42
43

OPTIONS INHERITED FROM PARENT COMMANDS

45       --as=""      Username to impersonate for the operation. User could be a
46       regular user or a service account in a namespace.
47
48
49       --as-group=[]       Group  to  impersonate for the operation, this flag
50       can be repeated to specify multiple groups.
51
52
53       --as-uid=""      UID to impersonate for the operation.
54
55
56       --azure-container-registry-config=""      Path to the  file  containing
57       Azure container registry configuration information.
58
59
60       --cache-dir="/builddir/.kube/cache"      Default cache directory
61
62
63       --certificate-authority=""      Path to a cert file for the certificate
64       authority
65
66
67       --client-certificate=""      Path to a client certificate file for TLS
68
69
70       --client-key=""      Path to a client key file for TLS
71
72
73       --cluster=""      The name of the kubeconfig cluster to use
74
75
76       --context=""      The name of the kubeconfig context to use
77
78
79       --insecure-skip-tls-verify=false      If true, the server's certificate
80       will not be checked for validity. This will make your HTTPS connections
81       insecure
82
83
84       --kubeconfig=""      Path to the kubeconfig file to  use  for  CLI  re‐
85       quests.
86
87
88       --match-server-version=false        Require  server  version  to  match
89       client version
90
91
92       -n, --namespace=""      If present, the namespace scope  for  this  CLI
93       request
94
95
96       --password=""      Password for basic authentication to the API server
97
98
99       --profile="none"         Name   of   profile   to   capture.   One   of
100       (none|cpu|heap|goroutine|threadcreate|block|mutex)
101
102
103       --profile-output="profile.pprof"      Name of the  file  to  write  the
104       profile to
105
106
107       --request-timeout="0"       The length of time to wait before giving up
108       on a single server request. Non-zero values  should  contain  a  corre‐
109       sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
110       out requests.
111
112
113       -s, --server=""      The address and port of the Kubernetes API server
114
115
116       --tls-server-name=""      Server name to  use  for  server  certificate
117       validation.  If  it  is  not provided, the hostname used to contact the
118       server is used
119
120
121       --token=""      Bearer token for authentication to the API server
122
123
124       --user=""      The name of the kubeconfig user to use
125
126
127       --username=""      Username for basic authentication to the API server
128
129
130       --version=false      Print version information and quit
131
132
133       --warnings-as-errors=false      Treat warnings received from the server
134       as errors and exit with a non-zero exit code
135
136
137

EXAMPLE

139                # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in the pod
140                kubectl port-forward pod/mypod 5000 6000
141
142                # Listen on ports 5000 and 6000 locally, forwarding data to/from ports 5000 and 6000 in a pod selected by the deployment
143                kubectl port-forward deployment/mydeployment 5000 6000
144
145                # Listen on port 8443 locally, forwarding to the targetPort of the service's port named "https" in a pod selected by the service
146                kubectl port-forward service/myservice 8443:https
147
148                # Listen on port 8888 locally, forwarding to 5000 in the pod
149                kubectl port-forward pod/mypod 8888:5000
150
151                # Listen on port 8888 on all addresses, forwarding to 5000 in the pod
152                kubectl port-forward --address 0.0.0.0 pod/mypod 8888:5000
153
154                # Listen on port 8888 on localhost and selected IP, forwarding to 5000 in the pod
155                kubectl port-forward --address localhost,10.19.21.23 pod/mypod 8888:5000
156
157                # Listen on a random port locally, forwarding to 5000 in the pod
158                kubectl port-forward pod/mypod :5000
159
160
161
162

HISTORY

169       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
170       com) based on the kubernetes source material, but hopefully  they  have
171       been automatically generated since!
172
173
174
175Manuals                              User            KUBERNETES(1)(kubernetes)