KUBERNETES(1)(kubernetes)

πŸ‘‘ KUBERNETES(1)(kubernetes) β€” the kubectl top node glow-up

okay bestie, sit down, we're doing the kubernetes manual, section 1, and it's literally about peeking at how hard your nodes are working πŸ’…


✨ NAME ✨

kubectl top node β€” display resource (CPU/memory) usage of nodes πŸ“


✨ SYNOPSIS ✨

kubectl top node [OPTIONS]

✨ DESCRIPTION ✨

Display resource (CPU/memory) usage of nodes.

The top-node command lets you see the resource consumption of nodes. that's it, that's the vibe β€” you wanna know which node is struggling and which one is thriving, and this is how you find out 🫢


✨ OPTIONS ✨

  • --no-headers=false β€” if you pass this, the output prints with no headers. just raw numbers, main character energy, no labels. πŸ™ˆ
  • -l, --selector="" β€” a selector (label query) to filter on, and it supports =, ==, !=, in, notin. (e.g. -l key1=value1,key2=value2,key3 in (value3)). matching objects have to satisfy all of the label constraints you specify β€” no half-committing, it's all or nothing fr fr.
  • --show-capacity=false β€” print node resources based on Capacity instead of Allocatable (which is the default) of the nodes. lowkey a whole different lens to look through. πŸ”₯
  • --show-swap=false β€” print node resources related to swap memory.
  • --sort-by="" β€” if it's non-empty, sort the nodes list using the specified field. the field can be either 'cpu' or 'memory'. pick your fighter ⭐
  • --use-protocol-buffers=true β€” enables using protocol-buffers to access the Metrics API. it's already true, she's on by default, iconic. ✨

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the family traits, bestie, passed down from the parent command and they're all so useful:

  • --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.
  • --as-user-extra=[] β€” user extras to impersonate for the operation. this flag can be repeated to specify multiple values for the same key.
  • --cache-dir="/home/username/.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. > heads up bestie, this will make your HTTPS connections insecure. it's giving "living dangerously" and not in the cute way 😭
  • --kubeconfig="" β€” path to the kubeconfig file to use for CLI requests.
  • --kuberc="" β€” path to the kuberc file to use for preferences. this can be disabled by exporting KUBECTL_KUBERC=false feature gate or turning off the feature KUBERC=off.
  • --match-server-version=false β€” require server version to match client version
  • -n, --namespace="" β€” if present, the namespace scope for this CLI request
  • --password="" β€” password for basic authentication to the API server
  • --profile="none" β€” name of profile to capture. one of (none|cpu|heap|goroutine|threadcreate|block|mutex|trace)
  • --profile-output="profile.pprof" β€” name of the file to write the profile to
  • --proxy-url="" β€” proxy URL to use for requests to the API server
  • --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. zero = no rules, just vibes πŸ¦‹
  • -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
  • --username="" β€” username for basic authentication to the API server
  • --version=false β€” --version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version
  • --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 nodes
kubectl top node

# Show metrics for a given node
kubectl top node NODE_NAME

πŸ’œ SEE ALSO πŸ’œ


πŸŽ€ HISTORY πŸŽ€

January 2015, originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! (not me reading 2015 lore, the way this manpage is a whole elder 🫢)


and that's the whole page, no cap β€” this was KUBERNETES(1)(kubernetes), from the Manuals collection, User section, dated Jan 2015, and written by Eric Paris. periodt. πŸ’…βœ¨

πŸ“¦ where this page comes from