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

SEE ALSO

290       kubectl(1), kubectl-top-node(1), kubectl-top-pod(1),
291
292
293

HISTORY

295       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
296       com) based on the kubernetes source material, but hopefully  they  have
297       been automatically generated since!
298
299
300
301Eric Paris                  kubernetes User Manuals              KUBERNETES(1)
Impressum