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

SEE ALSO

157       kubectl(1),
158
159
160

HISTORY

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