1KUBERNETES(1)                      Jan 2015                      KUBERNETES(1)
2
3
4

NAME

6       kubectl top - Display Resource (CPU/Memory/Storage) usage.
7
8
9

SYNOPSIS

11       kubectl top [OPTIONS]
12
13
14

DESCRIPTION

16       Display Resource (CPU/Memory/Storage) usage.
17
18
19       The top command allows you to see the resource consumption for nodes or
20       pods.
21
22
23       This command requires Heapster to be correctly configured  and  working
24       on the server.
25
26
27

OPTIONS INHERITED FROM PARENT COMMANDS

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

SEE ALSO

314       kubectl(1), kubectl-top-node(1), kubectl-top-pod(1),
315
316
317

HISTORY

319       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
320       com) based on the kubernetes source material, but hopefully  they  have
321       been automatically generated since!
322
323
324
325Eric Paris                  kubernetes User Manuals              KUBERNETES(1)
Impressum