1KUBERNETES(1) Jan 2015 KUBERNETES(1)
2
6 kubectl top pod - Display Resource (CPU/Memory/Storage) usage of pods
7
11 kubectl top pod [OPTIONS]
12
16 Display Resource (CPU/Memory/Storage) usage of pods.
17 The 'top pod' command allows you to see the resource consumption of
20 pods.
21 Due to the metrics pipeline delay, they may be unavailable for a few
24 minutes since pod creation.
25
29 --all-namespaces=false
30 If present, list the requested object(s) across all namespaces.
31 Namespace in current context is ignored even if specified with --names‐
32 pace.
33 --containers=false
36 If present, print usage of containers within a pod.
37 --heapster-namespace="kube-system"
40 Namespace Heapster service is located in
41 --heapster-port=""
44 Port name in service to use
45 --heapster-scheme="http"
48 Scheme (http or https) to connect to Heapster as
49 --heapster-service="heapster"
52 Name of Heapster service
53 --no-headers=false
56 If present, print output without headers.
57 -l, --selector=""
60 Selector (label query) to filter on, supports '=', '==', and
61 '!='.(e.g. -l key1=value1,key2=value2)
62
66 --alsologtostderr=false
67 log to standard error as well as files
68 --application-metrics-count-limit=100
71 Max number of application metrics to store (per container)
72 --as=""
75 Username to impersonate for the operation
76 --as-group=[]
79 Group to impersonate for the operation, this flag can be repeated
80 to specify multiple groups.
81 --azure-container-registry-config=""
84 Path to the file containing Azure container registry configuration
85 information.
86 --boot-id-file="/proc/sys/kernel/random/boot_id"
89 Comma-separated list of files to check for boot-id. Use the first
90 one that exists.
91 --cache-dir="/builddir/.kube/http-cache"
94 Default HTTP cache directory
95 --certificate-authority=""
98 Path to a cert file for the certificate authority
99 --client-certificate=""
102 Path to a client certificate file for TLS
103 --client-key=""
106 Path to a client key file for TLS
107 --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
110 CIDRs opened in GCE firewall for LB traffic proxy health checks
111 --cluster=""
114 The name of the kubeconfig cluster to use
115 --container-hints="/etc/cadvisor/container_hints.json"
118 location of the container hints file
119 --containerd="unix:///var/run/containerd.sock"
122 containerd endpoint
123 --context=""
126 The name of the kubeconfig context to use
127 --default-not-ready-toleration-seconds=300
130 Indicates the tolerationSeconds of the toleration for
131 notReady:NoExecute that is added by default to every pod that does not
132 already have such a toleration.
133 --default-unreachable-toleration-seconds=300
136 Indicates the tolerationSeconds of the toleration for unreach‐
137 able:NoExecute that is added by default to every pod that does not
138 already have such a toleration.
139 --docker="unix:///var/run/docker.sock"
142 docker endpoint
143 --docker-env-metadata-whitelist=""
146 a comma-separated list of environment variable keys that needs to
147 be collected for docker containers
148 --docker-only=false
151 Only report docker containers in addition to root stats
152 --docker-root="/var/lib/docker"
155 DEPRECATED: docker root is read from docker info (this is a fall‐
156 back, default: /var/lib/docker)
157 --docker-tls=false
160 use TLS to connect to docker
161 --docker-tls-ca="ca.pem"
164 path to trusted CA
165 --docker-tls-cert="cert.pem"
168 path to client certificate
169 --docker-tls-key="key.pem"
172 path to private key
173 --enable-load-reader=false
176 Whether to enable cpu load reader
177 --event-storage-age-limit="default=0"
180 Max length of time for which to store events (per type). Value is a
181 comma separated list of key values, where the keys are event types
182 (e.g.: creation, oom) or "default" and the value is a duration. Default
183 is applied to all non-specified event types
184 --event-storage-event-limit="default=0"
187 Max number of events to store (per type). Value is a comma sepa‐
188 rated list of key values, where the keys are event types (e.g.: cre‐
189 ation, oom) or "default" and the value is an integer. Default is
190 applied to all non-specified event types
191 --global-housekeeping-interval=1m0s
194 Interval between global housekeepings
195 --housekeeping-interval=10s
198 Interval between container housekeepings
199 --insecure-skip-tls-verify=false
202 If true, the server's certificate will not be checked for validity.
203 This will make your HTTPS connections insecure
204 --kubeconfig=""
207 Path to the kubeconfig file to use for CLI requests.
208 --log-backtrace-at=:0
211 when logging hits line file:N, emit a stack trace
212 --log-cadvisor-usage=false
215 Whether to log the usage of the cAdvisor container
216 --log-dir=""
219 If non-empty, write log files in this directory
220 --log-file=""
223 If non-empty, use this log file
224 --log-flush-frequency=5s
227 Maximum number of seconds between log flushes
228 --logtostderr=true
231 log to standard error instead of files
232 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
235 Comma-separated list of files to check for machine-id. Use the
236 first one that exists.
237 --match-server-version=false
240 Require server version to match client version
241 --mesos-agent="127.0.0.1:5051"
244 Mesos agent address
245 --mesos-agent-timeout=10s
248 Mesos agent timeout
249 -n, --namespace=""
252 If present, the namespace scope for this CLI request
253 --password=""
256 Password for basic authentication to the API server
257 --profile="none"
260 Name of profile to capture. One of (none|cpu|heap|goroutine|thread‐
261 create|block|mutex)
262 --profile-output="profile.pprof"
265 Name of the file to write the profile to
266 --request-timeout="0"
269 The length of time to wait before giving up on a single server
270 request. Non-zero values should contain a corresponding time unit (e.g.
271 1s, 2m, 3h). A value of zero means don't timeout requests.
272 -s, --server=""
275 The address and port of the Kubernetes API server
276 --skip-headers=false
279 If true, avoid header prefixes in the log messages
280 --stderrthreshold=2
283 logs at or above this threshold go to stderr
284 --storage-driver-buffer-duration=1m0s
287 Writes in the storage driver will be buffered for this duration,
288 and committed to the non memory backends as a single transaction
289 --storage-driver-db="cadvisor"
292 database name
293 --storage-driver-host="localhost:8086"
296 database host:port
297 --storage-driver-password="root"
300 database password
301 --storage-driver-secure=false
304 use secure connection with database
305 --storage-driver-table="stats"
308 table name
309 --storage-driver-user="root"
312 database username
313 --token=""
316 Bearer token for authentication to the API server
317 --user=""
320 The name of the kubeconfig user to use
321 --username=""
324 Username for basic authentication to the API server
325 -v, --v=0
328 log level for V logs
329 --version=false
332 Print version information and quit
333 --vmodule=
336 comma-separated list of pattern=N settings for file-filtered log‐
337 ging
338
342 # Show metrics for all pods in the default namespace
343 kubectl top pod
344 # Show metrics for all pods in the given namespace
346 kubectl top pod --namespace=NAMESPACE
347 # Show metrics for a given pod and its containers
349 kubectl top pod POD_NAME --containers
350 # Show metrics for the pods defined by label name=myLabel
352 kubectl top pod -l name=myLabel
353
358 kubectl-top(1),
359
363 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
364 com) based on the kubernetes source material, but hopefully they have
365 been automatically generated since!
366Eric Paris kubernetes User Manuals KUBERNETES(1)