NAME¶

oc adm top pod - Display resource (CPU/memory) usage of pods

SYNOPSIS¶

oc adm top pod [OPTIONS]

DESCRIPTION¶

Display resource (CPU/memory) usage of pods.

The 'top pod' command allows you to see the resource consumption of pods.

Due to the metrics pipeline delay, they may be unavailable for a few minutes since pod creation.

OPTIONS¶

-A, --all-namespaces=false
If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.

--containers=false
If present, print usage of containers within a pod.

--field-selector=""
Selector (field query) to filter on, supports '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type.

--no-headers=false
If present, print output without headers.

-l, --selector=""
Selector (label query) to filter on, supports '=', '==', '!=', 'in', 'notin'.(e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints.

--sort-by=""
If non-empty, sort pods list using specified field. The field can be either 'cpu' or 'memory'.

--sum=false
Print the sum of the resource usage

--use-protocol-buffers=true
Enables using protocol-buffers to access Metrics API.

OPTIONS INHERITED FROM PARENT COMMANDS¶

--as=""
Username to impersonate for the operation. User could be a regular user or a service account in a namespace.

--as-group=[]
Group to impersonate for the operation, this flag can be repeated to specify multiple groups.

--as-uid=""
UID to impersonate for the operation.

--cache-dir="/home/abuild/.kube/cache"
Default cache directory

--certificate-authority=""
Path to a cert file for the certificate authority

--client-certificate=""
Path to a client certificate file for TLS

--client-key=""
Path to a client key file for TLS

--cluster=""
The name of the kubeconfig cluster to use

--context=""
The name of the kubeconfig context to use

--disable-compression=false
If true, opt-out of response compression for all requests to the server

--insecure-skip-tls-verify=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure

--kubeconfig=""
Path to the kubeconfig file to use for CLI requests.

--match-server-version=false
Require server version to match client version

-n, --namespace=""
If present, the namespace scope for this CLI request

--profile="none"
Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)

--profile-output="profile.pprof"
Name of the file to write the profile to

--request-timeout="0"
The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.

-s, --server=""
The address and port of the Kubernetes API server

--tls-server-name=""
Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used

--token=""
Bearer token for authentication to the API server

--user=""
The name of the kubeconfig user to use

--warnings-as-errors=false
Treat warnings received from the server as errors and exit with a non-zero exit code

EXAMPLE¶

  # Show metrics for all pods in the default namespace


  oc adm top pod


  


  # Show metrics for all pods in the given namespace


  oc adm top pod --namespace=NAMESPACE


  


  # Show metrics for a given pod and its containers


  oc adm top pod POD_NAME --containers


  


  # Show metrics for the pods defined by label name=myLabel


  oc adm top pod -l name=myLabel

SEE ALSO¶

oc-adm-top(1),

HISTORY¶

June 2016, Ported from the Kubernetes man-doc generator