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

NAME

6       oc adm top pod - Display Resource (CPU/Memory/Storage) usage of pods
7
8
9

SYNOPSIS

11       oc adm top pod [OPTIONS]
12
13
14

DESCRIPTION

16       Display Resource (CPU/Memory/Storage) usage of pods.
17
18
19       The  'top  pod'  command  allows you to see the resource consumption of
20       pods.
21
22
23       Due to the metrics pipeline delay, they may be unavailable  for  a  few
24       minutes since pod creation.
25
26
27

OPTIONS

29       --all-namespaces=false
30           If  present,  list  the  requested object(s) across all namespaces.
31       Namespace in current context is ignored even if specified with --names‐
32       pace.
33
34
35       --containers=false
36           If present, print usage of containers within a pod.
37
38
39       --heapster-namespace="openshift-infra"
40           Namespace Heapster service is located in
41
42
43       --heapster-port=""
44           Port name in service to use
45
46
47       --heapster-scheme="https"
48           Scheme (http or https) to connect to Heapster as
49
50
51       --heapster-service="heapster"
52           Name of Heapster service
53
54
55       -l, --selector=""
56           Selector  (label  query)  to  filter  on,  supports  '=', '==', and
57       '!='.(e.g. -l key1=value1,key2=value2)
58
59
60

OPTIONS INHERITED FROM PARENT COMMANDS

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

EXAMPLE

310                # Show metrics for all pods in the default namespace
311                kubectl top pod
312
313                # Show metrics for all pods in the given namespace
314                kubectl top pod --namespace=NAMESPACE
315
316                # Show metrics for a given pod and its containers
317                kubectl top pod POD_NAME --containers
318
319                # Show metrics for the pods defined by label name=myLabel
320                kubectl top pod -l name=myLabel
321
322
323
324

SEE ALSO

326       oc-adm-top(1),
327
328
329

HISTORY

331       June 2016, Ported from the Kubernetes man-doc generator
332
333
334
335Openshift                  Openshift CLI User Manuals            OC ADM TOP(1)
Impressum