1OC(1)                              June 2016                             OC(1)
2
3
4

NAME

6       oc attach - Attach to a running container
7
8
9

SYNOPSIS

11       oc attach [OPTIONS]
12
13
14

DESCRIPTION

16       Attach to a running container
17
18
19       Attach  the  current  shell  to a remote container, returning output or
20       setting up a full terminal session. Can be used to debug containers and
21       invoke interactive commands.
22
23
24

OPTIONS

26       -c, --container=""
27           Container  name. If omitted, the first container in the pod will be
28       chosen
29
30
31       --pod-running-timeout=0
32           The length of time (like 5s, 2m, or 3h, higher than zero)  to  wait
33       until at least one pod is running
34
35
36       -i, --stdin=false
37           Pass stdin to the container
38
39
40       -t, --tty=false
41           Stdin is a TTY
42
43
44

OPTIONS INHERITED FROM PARENT COMMANDS

46       --allow_verification_with_non_compliant_keys=false
47           Allow  a  SignatureVerifier  to  use  keys  which  are  technically
48       non-compliant with RFC6962.
49
50
51       --alsologtostderr=false
52           log to standard error as well as files
53
54
55       --application_metrics_count_limit=100
56           Max number of application metrics to store (per container)
57
58
59       --as=""
60           Username to impersonate for the operation
61
62
63       --as-group=[]
64           Group to impersonate for the operation, this flag can  be  repeated
65       to specify multiple groups.
66
67
68       --azure-container-registry-config=""
69           Path  to the file containing Azure container registry configuration
70       information.
71
72
73       --boot_id_file="/proc/sys/kernel/random/boot_id"
74           Comma-separated list of files to check for boot-id. Use  the  first
75       one that exists.
76
77
78       --cache-dir="/builddir/.kube/http-cache"
79           Default HTTP cache directory
80
81
82       --certificate-authority=""
83           Path to a cert file for the certificate authority
84
85
86       --client-certificate=""
87           Path to a client certificate file for TLS
88
89
90       --client-key=""
91           Path to a client key file for TLS
92
93
94       --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
95           CIDRs opened in GCE firewall for LB traffic proxy  health checks
96
97
98       --cluster=""
99           The name of the kubeconfig cluster to use
100
101
102       --container_hints="/etc/cadvisor/container_hints.json"
103           location of the container hints file
104
105
106       --containerd="unix:///var/run/containerd.sock"
107           containerd endpoint
108
109
110       --context=""
111           The name of the kubeconfig context to use
112
113
114       --default-not-ready-toleration-seconds=300
115           Indicates   the   tolerationSeconds   of   the    toleration    for
116       notReady:NoExecute  that is added by default to every pod that does not
117       already have such a toleration.
118
119
120       --default-unreachable-toleration-seconds=300
121           Indicates the tolerationSeconds  of  the  toleration  for  unreach‐
122       able:NoExecute  that  is  added  by  default to every pod that does not
123       already have such a toleration.
124
125
126       --docker="unix:///var/run/docker.sock"
127           docker endpoint
128
129
130       --docker-tls=false
131           use TLS to connect to docker
132
133
134       --docker-tls-ca="ca.pem"
135           path to trusted CA
136
137
138       --docker-tls-cert="cert.pem"
139           path to client certificate
140
141
142       --docker-tls-key="key.pem"
143           path to private key
144
145
146       --docker_env_metadata_whitelist=""
147           a comma-separated list of environment variable keys that  needs  to
148       be collected for docker containers
149
150
151       --docker_only=false
152           Only report docker containers in addition to root stats
153
154
155       --docker_root="/var/lib/docker"
156           DEPRECATED:  docker  root is read from docker info (this is a fall‐
157       back, default: /var/lib/docker)
158
159
160       --enable_load_reader=false
161           Whether to enable cpu load reader
162
163
164       --event_storage_age_limit="default=24h"
165           Max length of time for which to store events (per type). Value is a
166       comma  separated  list  of  key  values, where the keys are event types
167       (e.g.: creation, oom) or "default" and the value is a duration. Default
168       is applied to all non-specified event types
169
170
171       --event_storage_event_limit="default=100000"
172           Max  number  of  events to store (per type). Value is a comma sepa‐
173       rated list of key values, where the keys are event  types  (e.g.:  cre‐
174       ation,  oom)  or  "default"  and  the  value  is an integer. Default is
175       applied to all non-specified event types
176
177
178       --global_housekeeping_interval=0
179           Interval between global housekeepings
180
181
182       --housekeeping_interval=0
183           Interval between container housekeepings
184
185
186       --insecure-skip-tls-verify=false
187           If true, the server's certificate will not be checked for validity.
188       This will make your HTTPS connections insecure
189
190
191       --kubeconfig=""
192           Path to the kubeconfig file to use for CLI requests.
193
194
195       --log-flush-frequency=0
196           Maximum number of seconds between log flushes
197
198
199       --log_backtrace_at=:0
200           when logging hits line file:N, emit a stack trace
201
202
203       --log_cadvisor_usage=false
204           Whether to log the usage of the cAdvisor container
205
206
207       --log_dir=""
208           If non-empty, write log files in this directory
209
210
211       --logtostderr=true
212           log to standard error instead of files
213
214
215       --machine_id_file="/etc/machine-id,/var/lib/dbus/machine-id"
216           Comma-separated  list  of  files  to  check for machine-id. Use the
217       first one that exists.
218
219
220       --match-server-version=false
221           Require server version to match client version
222
223
224       -n, --namespace=""
225           If present, the namespace scope for this CLI request
226
227
228       --request-timeout="0"
229           The length of time to wait before giving  up  on  a  single  server
230       request. Non-zero values should contain a corresponding time unit (e.g.
231       1s, 2m, 3h). A value of zero means don't timeout requests.
232
233
234       -s, --server=""
235           The address and port of the Kubernetes API server
236
237
238       --stderrthreshold=2
239           logs at or above this threshold go to stderr
240
241
242       --storage_driver_buffer_duration=0
243           Writes in the storage driver will be buffered  for  this  duration,
244       and committed to the non memory backends as a single transaction
245
246
247       --storage_driver_db="cadvisor"
248           database name
249
250
251       --storage_driver_host="localhost:8086"
252           database host:port
253
254
255       --storage_driver_password="root"
256           database password
257
258
259       --storage_driver_secure=false
260           use secure connection with database
261
262
263       --storage_driver_table="stats"
264           table name
265
266
267       --storage_driver_user="root"
268           database username
269
270
271       --token=""
272           Bearer token for authentication to the API server
273
274
275       --user=""
276           The name of the kubeconfig user to use
277
278
279       -v, --v=0
280           log level for V logs
281
282
283       --version=false
284           Print version information and quit
285
286
287       --vmodule=
288           comma-separated  list  of pattern=N settings for file-filtered log‐
289       ging
290
291
292

EXAMPLE

294                # Get output from running pod 123456-7890, using the first container by default
295                oc attach 123456-7890
296
297                # Get output from ruby-container from pod 123456-7890
298                oc attach 123456-7890 -c ruby-container
299
300                # Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod 123456-780
301                # and sends stdout/stderr from 'bash' back to the client
302                oc attach 123456-7890 -c ruby-container -i -t
303
304
305
306

SEE ALSO

308       oc(1),
309
310
311

HISTORY

313       June 2016, Ported from the Kubernetes man-doc generator
314
315
316
317Openshift                  Openshift CLI User Manuals                    OC(1)
Impressum