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

NAME

9       kubectl attach - Attach to a running container
10
11
12

SYNOPSIS

14       kubectl attach [OPTIONS]
15
16
17

DESCRIPTION

19       Attach  to  a  process  that is already running inside an existing con‐
20       tainer.
21
22
23

OPTIONS

25       -c, --container=""      Container name. If omitted, use the kubectl.ku‐
26       bernetes.io/default-container annotation for selecting the container to
27       be attached or the first container in the pod will be chosen
28
29
30       --pod-running-timeout=1m0s      The length of time (like 5s, 2m, or 3h,
31       higher than zero) to wait until at least one pod is running
32
33
34       -q, --quiet=false      Only print output from the remote session
35
36
37       -i, --stdin=false      Pass stdin to the container
38
39
40       -t, --tty=false      Stdin is a TTY
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       --disable-compression=false       If true, opt-out of response compres‐
80       sion for all requests to the server
81
82
83       --insecure-skip-tls-verify=false      If true, the server's certificate
84       will not be checked for validity. This will make your HTTPS connections
85       insecure
86
87
88       --kubeconfig=""      Path to the kubeconfig file to  use  for  CLI  re‐
89       quests.
90
91
92       --match-server-version=false        Require  server  version  to  match
93       client version
94
95
96       -n, --namespace=""      If present, the namespace scope  for  this  CLI
97       request
98
99
100       --password=""      Password for basic authentication to the API server
101
102
103       --profile="none"         Name   of   profile   to   capture.   One   of
104       (none|cpu|heap|goroutine|threadcreate|block|mutex)
105
106
107       --profile-output="profile.pprof"      Name of the  file  to  write  the
108       profile to
109
110
111       --request-timeout="0"       The length of time to wait before giving up
112       on a single server request. Non-zero values  should  contain  a  corre‐
113       sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
114       out requests.
115
116
117       -s, --server=""      The address and port of the Kubernetes API server
118
119
120       --tls-server-name=""      Server name to  use  for  server  certificate
121       validation.  If  it  is  not provided, the hostname used to contact the
122       server is used
123
124
125       --token=""      Bearer token for authentication to the API server
126
127
128       --user=""      The name of the kubeconfig user to use
129
130
131       --username=""      Username for basic authentication to the API server
132
133
134       --version=false      Print version information and quit
135
136
137       --warnings-as-errors=false      Treat warnings received from the server
138       as errors and exit with a non-zero exit code
139
140
141

EXAMPLE

143                # Get output from running pod mypod; use the 'kubectl.kubernetes.io/default-container' annotation
144                # for selecting the container to be attached or the first container in the pod will be chosen
145                kubectl attach mypod
146
147                # Get output from ruby-container from pod mypod
148                kubectl attach mypod -c ruby-container
149
150                # Switch to raw terminal mode; sends stdin to 'bash' in ruby-container from pod mypod
151                # and sends stdout/stderr from 'bash' back to the client
152                kubectl attach mypod -c ruby-container -i -t
153
154                # Get output from the first pod of a replica set named nginx
155                kubectl attach rs/nginx
156
157
158
159

SEE ALSO

161       kubectl(1),
162
163
164

HISTORY

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