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 -A, --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 --sort-by=""
65 If non-empty, sort pods list using specified field. The field can
66 be either 'cpu' or 'memory'.
67
71 --alsologtostderr=false
72 log to standard error as well as files
73 --application-metrics-count-limit=100
76 Max number of application metrics to store (per container)
77 --as=""
80 Username to impersonate for the operation
81 --as-group=[]
84 Group to impersonate for the operation, this flag can be repeated
85 to specify multiple groups.
86 --azure-container-registry-config=""
89 Path to the file containing Azure container registry configuration
90 information.
91 --boot-id-file="/proc/sys/kernel/random/boot_id"
94 Comma-separated list of files to check for boot-id. Use the first
95 one that exists.
96 --cache-dir="/builddir/.kube/http-cache"
99 Default HTTP cache directory
100 --certificate-authority=""
103 Path to a cert file for the certificate authority
104 --client-certificate=""
107 Path to a client certificate file for TLS
108 --client-key=""
111 Path to a client key file for TLS
112 --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
115 CIDRs opened in GCE firewall for LB traffic proxy health checks
116 --cluster=""
119 The name of the kubeconfig cluster to use
120 --container-hints="/etc/cadvisor/container_hints.json"
123 location of the container hints file
124 --containerd="/run/containerd/containerd.sock"
127 containerd endpoint
128 --containerd-namespace="k8s.io"
131 containerd namespace
132 --context=""
135 The name of the kubeconfig context to use
136 --default-not-ready-toleration-seconds=300
139 Indicates the tolerationSeconds of the toleration for
140 notReady:NoExecute that is added by default to every pod that does not
141 already have such a toleration.
142 --default-unreachable-toleration-seconds=300
145 Indicates the tolerationSeconds of the toleration for unreach‐
146 able:NoExecute that is added by default to every pod that does not
147 already have such a toleration.
148 --docker="unix:///var/run/docker.sock"
151 docker endpoint
152 --docker-env-metadata-whitelist=""
155 a comma-separated list of environment variable keys that needs to
156 be collected for docker containers
157 --docker-only=false
160 Only report docker containers in addition to root stats
161 --docker-root="/var/lib/docker"
164 DEPRECATED: docker root is read from docker info (this is a fall‐
165 back, default: /var/lib/docker)
166 --docker-tls=false
169 use TLS to connect to docker
170 --docker-tls-ca="ca.pem"
173 path to trusted CA
174 --docker-tls-cert="cert.pem"
177 path to client certificate
178 --docker-tls-key="key.pem"
181 path to private key
182 --enable-load-reader=false
185 Whether to enable cpu load reader
186 --event-storage-age-limit="default=0"
189 Max length of time for which to store events (per type). Value is a
190 comma separated list of key values, where the keys are event types
191 (e.g.: creation, oom) or "default" and the value is a duration. Default
192 is applied to all non-specified event types
193 --event-storage-event-limit="default=0"
196 Max number of events to store (per type). Value is a comma sepa‐
197 rated list of key values, where the keys are event types (e.g.: cre‐
198 ation, oom) or "default" and the value is an integer. Default is
199 applied to all non-specified event types
200 --global-housekeeping-interval=1m0s
203 Interval between global housekeepings
204 --housekeeping-interval=10s
207 Interval between container housekeepings
208 --insecure-skip-tls-verify=false
211 If true, the server's certificate will not be checked for validity.
212 This will make your HTTPS connections insecure
213 --kubeconfig=""
216 Path to the kubeconfig file to use for CLI requests.
217 --log-backtrace-at=:0
220 when logging hits line file:N, emit a stack trace
221 --log-cadvisor-usage=false
224 Whether to log the usage of the cAdvisor container
225 --log-dir=""
228 If non-empty, write log files in this directory
229 --log-file=""
232 If non-empty, use this log file
233 --log-file-max-size=1800
236 Defines the maximum size a log file can grow to. Unit is megabytes.
237 If the value is 0, the maximum file size is unlimited.
238 --log-flush-frequency=5s
241 Maximum number of seconds between log flushes
242 --logtostderr=true
245 log to standard error instead of files
246 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
249 Comma-separated list of files to check for machine-id. Use the
250 first one that exists.
251 --match-server-version=false
254 Require server version to match client version
255 -n, --namespace=""
258 If present, the namespace scope for this CLI request
259 --password=""
262 Password for basic authentication to the API server
263 --profile="none"
266 Name of profile to capture. One of (none|cpu|heap|goroutine|thread‐
267 create|block|mutex)
268 --profile-output="profile.pprof"
271 Name of the file to write the profile to
272 --request-timeout="0"
275 The length of time to wait before giving up on a single server
276 request. Non-zero values should contain a corresponding time unit (e.g.
277 1s, 2m, 3h). A value of zero means don't timeout requests.
278 -s, --server=""
281 The address and port of the Kubernetes API server
282 --skip-headers=false
285 If true, avoid header prefixes in the log messages
286 --skip-log-headers=false
289 If true, avoid headers when opening log files
290 --stderrthreshold=2
293 logs at or above this threshold go to stderr
294 --storage-driver-buffer-duration=1m0s
297 Writes in the storage driver will be buffered for this duration,
298 and committed to the non memory backends as a single transaction
299 --storage-driver-db="cadvisor"
302 database name
303 --storage-driver-host="localhost:8086"
306 database host:port
307 --storage-driver-password="root"
310 database password
311 --storage-driver-secure=false
314 use secure connection with database
315 --storage-driver-table="stats"
318 table name
319 --storage-driver-user="root"
322 database username
323 --token=""
326 Bearer token for authentication to the API server
327 --update-machine-info-interval=5m0s
330 Interval between machine info updates.
331 --user=""
334 The name of the kubeconfig user to use
335 --username=""
338 Username for basic authentication to the API server
339 -v, --v=0
342 number for the log level verbosity
343 --version=false
346 Print version information and quit
347 --vmodule=
350 comma-separated list of pattern=N settings for file-filtered log‐
351 ging
352
356 # Show metrics for all pods in the default namespace
357 kubectl top pod
358 # Show metrics for all pods in the given namespace
360 kubectl top pod --namespace=NAMESPACE
361 # Show metrics for a given pod and its containers
363 kubectl top pod POD_NAME --containers
364 # Show metrics for the pods defined by label name=myLabel
366 kubectl top pod -l name=myLabel
367
372 kubectl-top(1),
373
377 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
378 com) based on the kubernetes source material, but hopefully they have
379 been automatically generated since!
380Eric Paris kubernetes User Manuals KUBERNETES(1)