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="unix:///var/run/containerd.sock"
85           containerd endpoint
86
87
88       --context=""
89           The name of the kubeconfig context to use
90
91
92       --default-not-ready-toleration-seconds=300
93           Indicates    the    tolerationSeconds   of   the   toleration   for
94       notReady:NoExecute that is added by default to every pod that does  not
95       already have such a toleration.
96
97
98       --default-unreachable-toleration-seconds=300
99           Indicates  the  tolerationSeconds  of  the  toleration for unreach‐
100       able:NoExecute that is added by default to  every  pod  that  does  not
101       already have such a toleration.
102
103
104       --docker="unix:///var/run/docker.sock"
105           docker endpoint
106
107
108       --docker-env-metadata-whitelist=""
109           a  comma-separated  list of environment variable keys that needs to
110       be collected for docker containers
111
112
113       --docker-only=false
114           Only report docker containers in addition to root stats
115
116
117       --docker-root="/var/lib/docker"
118           DEPRECATED: docker root is read from docker info (this is  a  fall‐
119       back, default: /var/lib/docker)
120
121
122       --docker-tls=false
123           use TLS to connect to docker
124
125
126       --docker-tls-ca="ca.pem"
127           path to trusted CA
128
129
130       --docker-tls-cert="cert.pem"
131           path to client certificate
132
133
134       --docker-tls-key="key.pem"
135           path to private key
136
137
138       --enable-load-reader=false
139           Whether to enable cpu load reader
140
141
142       --event-storage-age-limit="default=0"
143           Max length of time for which to store events (per type). Value is a
144       comma separated list of key values, where  the  keys  are  event  types
145       (e.g.: creation, oom) or "default" and the value is a duration. Default
146       is applied to all non-specified event types
147
148
149       --event-storage-event-limit="default=0"
150           Max number of events to store (per type). Value is  a  comma  sepa‐
151       rated  list  of  key values, where the keys are event types (e.g.: cre‐
152       ation, oom) or "default" and  the  value  is  an  integer.  Default  is
153       applied to all non-specified event types
154
155
156       --global-housekeeping-interval=1m0s
157           Interval between global housekeepings
158
159
160       --housekeeping-interval=10s
161           Interval between container housekeepings
162
163
164       --insecure-skip-tls-verify=false
165           If true, the server's certificate will not be checked for validity.
166       This will make your HTTPS connections insecure
167
168
169       --kubeconfig=""
170           Path to the kubeconfig file to use for CLI requests.
171
172
173       --log-backtrace-at=:0
174           when logging hits line file:N, emit a stack trace
175
176
177       --log-cadvisor-usage=false
178           Whether to log the usage of the cAdvisor container
179
180
181       --log-dir=""
182           If non-empty, write log files in this directory
183
184
185       --log-file=""
186           If non-empty, use this log file
187
188
189       --log-flush-frequency=5s
190           Maximum number of seconds between log flushes
191
192
193       --logtostderr=true
194           log to standard error instead of files
195
196
197       --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
198           Comma-separated list of files to  check  for  machine-id.  Use  the
199       first one that exists.
200
201
202       --match-server-version=false
203           Require server version to match client version
204
205
206       --mesos-agent="127.0.0.1:5051"
207           Mesos agent address
208
209
210       --mesos-agent-timeout=10s
211           Mesos agent timeout
212
213
214       -n, --namespace=""
215           If present, the namespace scope for this CLI request
216
217
218       --password=""
219           Password for basic authentication to the API server
220
221
222       --profile="none"
223           Name of profile to capture. One of (none|cpu|heap|goroutine|thread‐
224       create|block|mutex)
225
226
227       --profile-output="profile.pprof"
228           Name of the file to write the profile to
229
230
231       --request-timeout="0"
232           The length of time to wait before giving  up  on  a  single  server
233       request. Non-zero values should contain a corresponding time unit (e.g.
234       1s, 2m, 3h). A value of zero means don't timeout requests.
235
236
237       -s, --server=""
238           The address and port of the Kubernetes API server
239
240
241       --skip-headers=false
242           If true, avoid header prefixes in the log messages
243
244
245       --stderrthreshold=2
246           logs at or above this threshold go to stderr
247
248
249       --storage-driver-buffer-duration=1m0s
250           Writes in the storage driver will be buffered  for  this  duration,
251       and committed to the non memory backends as a single transaction
252
253
254       --storage-driver-db="cadvisor"
255           database name
256
257
258       --storage-driver-host="localhost:8086"
259           database host:port
260
261
262       --storage-driver-password="root"
263           database password
264
265
266       --storage-driver-secure=false
267           use secure connection with database
268
269
270       --storage-driver-table="stats"
271           table name
272
273
274       --storage-driver-user="root"
275           database username
276
277
278       --token=""
279           Bearer token for authentication to the API server
280
281
282       --user=""
283           The name of the kubeconfig user to use
284
285
286       --username=""
287           Username for basic authentication to the API server
288
289
290       -v, --v=0
291           log level for V logs
292
293
294       --version=false
295           Print version information and quit
296
297
298       --vmodule=
299           comma-separated  list  of pattern=N settings for file-filtered log‐
300       ging
301
302
303

SEE ALSO

305       kubectl(1), kubectl-top-node(1), kubectl-top-pod(1),
306
307
308

HISTORY

310       January 2015, Originally compiled by Eric Paris (eparis at  redhat  dot
311       com)  based  on the kubernetes source material, but hopefully they have
312       been automatically generated since!
313
314
315
316Eric Paris                  kubernetes User Manuals              KUBERNETES(1)
Impressum