1KUBERNETES(1)(kubernetes) KUBERNETES(1)(kubernetes)
2Eric Paris Jan 2015
6
9 kubectl top - Display Resource (CPU/Memory/Storage) usage.
10
14 kubectl top [OPTIONS]
15
19 Display Resource (CPU/Memory/Storage) usage.
20 The top command allows you to see the resource consumption for nodes or
23 pods.
24 This command requires Metrics Server to be correctly configured and
27 working on the server.
28
32 --add-dir-header=false If true, adds the file directory to the
33 header of the log messages
34 --alsologtostderr=false log to standard error as well as files
37 --application-metrics-count-limit=100 Max number of application
40 metrics to store (per container)
41 --as="" Username to impersonate for the operation
44 --as-group=[] Group to impersonate for the operation, this flag
47 can be repeated to specify multiple groups.
48 --azure-container-registry-config="" Path to the file containing
51 Azure container registry configuration information.
52 --boot-id-file="/proc/sys/kernel/random/boot_id" Comma-separated
55 list of files to check for boot-id. Use the first one that exists.
56 --cache-dir="/builddir/.kube/cache" Default cache directory
59 --certificate-authority="" Path to a cert file for the certificate
62 authority
63 --client-certificate="" Path to a client certificate file for TLS
66 --client-key="" Path to a client key file for TLS
69 --cloud-provider-gce-l7lb-src-cidrs=130.211.0.0/22,35.191.0.0/16
72 CIDRs opened in GCE firewall for L7 LB traffic proxy health
73 checks
74 --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
77 CIDRs opened in GCE firewall for L4 LB traffic proxy health
78 checks
79 --cluster="" The name of the kubeconfig cluster to use
82 --container-hints="/etc/cadvisor/container_hints.json" location of
85 the container hints file
86 --containerd="/run/containerd/containerd.sock" containerd endpoint
89 --containerd-namespace="k8s.io" containerd namespace
92 --context="" The name of the kubeconfig context to use
95 --default-not-ready-toleration-seconds=300 Indicates the tolera‐
98 tionSeconds of the toleration for notReady:NoExecute that is added by
99 default to every pod that does not already have such a toleration.
100 --default-unreachable-toleration-seconds=300 Indicates the tolera‐
103 tionSeconds of the toleration for unreachable:NoExecute that is added
104 by default to every pod that does not already have such a toleration.
105 --disable-root-cgroup-stats=false Disable collecting root Cgroup
108 stats
109 --docker="unix:///var/run/docker.sock" docker endpoint
112 --docker-env-metadata-whitelist="" a comma-separated list of envi‐
115 ronment variable keys matched with specified prefix that needs to be
116 collected for docker containers
117 --docker-only=false Only report docker containers in addition to
120 root stats
121 --docker-root="/var/lib/docker" DEPRECATED: docker root is read
124 from docker info (this is a fallback, default: /var/lib/docker)
125 --docker-tls=false use TLS to connect to docker
128 --docker-tls-ca="ca.pem" path to trusted CA
131 --docker-tls-cert="cert.pem" path to client certificate
134 --docker-tls-key="key.pem" path to private key
137 --enable-load-reader=false Whether to enable cpu load reader
140 --event-storage-age-limit="default=0" Max length of time for which
143 to store events (per type). Value is a comma separated list of key val‐
144 ues, where the keys are event types (e.g.: creation, oom) or "default"
145 and the value is a duration. Default is applied to all non-specified
146 event types
147 --event-storage-event-limit="default=0" Max number of events to
150 store (per type). Value is a comma separated list of key values, where
151 the keys are event types (e.g.: creation, oom) or "default" and the
152 value is an integer. Default is applied to all non-specified event
153 types
154 --global-housekeeping-interval=1m0s Interval between global house‐
157 keepings
158 --housekeeping-interval=10s Interval between container housekeep‐
161 ings
162 --insecure-skip-tls-verify=false If true, the server's certificate
165 will not be checked for validity. This will make your HTTPS connections
166 insecure
167 --kubeconfig="" Path to the kubeconfig file to use for CLI re‐
170 quests.
171 --log-backtrace-at=:0 when logging hits line file:N, emit a stack
174 trace
175 --log-cadvisor-usage=false Whether to log the usage of the cAdvi‐
178 sor container
179 --log-dir="" If non-empty, write log files in this directory
182 --log-file="" If non-empty, use this log file
185 --log-file-max-size=1800 Defines the maximum size a log file can
188 grow to. Unit is megabytes. If the value is 0, the maximum file size is
189 unlimited.
190 --log-flush-frequency=5s Maximum number of seconds between log
193 flushes
194 --logtostderr=true log to standard error instead of files
197 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
200 Comma-separated list of files to check for machine-id. Use the
201 first one that exists.
202 --match-server-version=false Require server version to match
205 client version
206 -n, --namespace="" If present, the namespace scope for this CLI
209 request
210 --one-output=false If true, only write logs to their native sever‐
213 ity level (vs also writing to each lower severity level
214 --password="" Password for basic authentication to the API server
217 --profile="none" Name of profile to capture. One of
220 (none|cpu|heap|goroutine|threadcreate|block|mutex)
221 --profile-output="profile.pprof" Name of the file to write the
224 profile to
225 --referenced-reset-interval=0 Reset interval for referenced bytes
228 (container_referenced_bytes metric), number of measurement cycles after
229 which referenced bytes are cleared, if set to 0 referenced bytes are
230 never cleared (default: 0)
231 --request-timeout="0" The length of time to wait before giving up
234 on a single server request. Non-zero values should contain a corre‐
235 sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
236 out requests.
237 -s, --server="" The address and port of the Kubernetes API server
240 --skip-headers=false If true, avoid header prefixes in the log
243 messages
244 --skip-log-headers=false If true, avoid headers when opening log
247 files
248 --stderrthreshold=2 logs at or above this threshold go to stderr
251 --storage-driver-buffer-duration=1m0s Writes in the storage driver
254 will be buffered for this duration, and committed to the non memory
255 backends as a single transaction
256 --storage-driver-db="cadvisor" database name
259 --storage-driver-host="localhost:8086" database host:port
262 --storage-driver-password="root" database password
265 --storage-driver-secure=false use secure connection with database
268 --storage-driver-table="stats" table name
271 --storage-driver-user="root" database username
274 --tls-server-name="" Server name to use for server certificate
277 validation. If it is not provided, the hostname used to contact the
278 server is used
279 --token="" Bearer token for authentication to the API server
282 --update-machine-info-interval=5m0s Interval between machine info
285 updates.
286 --user="" The name of the kubeconfig user to use
289 --username="" Username for basic authentication to the API server
292 -v, --v=0 number for the log level verbosity
295 --version=false Print version information and quit
298 --vmodule= comma-separated list of pattern=N settings for
301 file-filtered logging
302 --warnings-as-errors=false Treat warnings received from the server
305 as errors and exit with a non-zero exit code
306
310 kubectl(1), kubectl-top-node(1), kubectl-top-pod(1),
311
315 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
316 com) based on the kubernetes source material, but hopefully they have
317 been automatically generated since!
318Manuals User KUBERNETES(1)(kubernetes)