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

NAME

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

SYNOPSIS

11       kubectl top node [OPTIONS]
12
13
14

DESCRIPTION

16       Display Resource (CPU/Memory/Storage) usage of nodes.
17
18
19       The top-node command allows you to see the resource consumption of
20       nodes.
21
22
23

OPTIONS

25       --heapster-namespace="kube-system"
26           Namespace Heapster service is located in
27
28
29       --heapster-port=""
30           Port name in service to use
31
32
33       --heapster-scheme="http"
34           Scheme (http or https) to connect to Heapster as
35
36
37       --heapster-service="heapster"
38           Name of Heapster service
39
40
41       --no-headers=false
42           If present, print output without headers
43
44
45       -l, --selector=""
46           Selector (label query) to filter on, supports '=', '==', and
47       '!='.(e.g. -l key1=value1,key2=value2)
48
49
50       --sort-by=""
51           If non-empty, sort nodes list using specified field. The field can
52       be either 'cpu' or 'memory'.
53
54
55

OPTIONS INHERITED FROM PARENT COMMANDS

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

EXAMPLE

359                # Show metrics for all nodes
360                kubectl top node
361
362                # Show metrics for a given node
363                kubectl top node NODE_NAME
364
365
366
367

SEE ALSO

369       kubectl-top(1),
370
371
372

HISTORY

374       January 2015, Originally compiled by Eric Paris (eparis at redhat dot
375       com) based on the kubernetes source material, but hopefully they have
376       been automatically generated since!
377
378
379
380Eric Paris                  kubernetes User Manuals              KUBERNETES(1)
Impressum