OC-ADM-TOP-NODE(1)

πŸ“¦
version 4.22.0 Β· 2 versions
, in nixpkgs unstable

πŸ’… oc adm top node β€” oc-adm-top-node(1) bestie edition ✨

Okay bestie, this is the OpenShift CLI manual page for oc adm top node. It’s giving β€œlet’s peek at node resource usage” energy, and honestly? Obsessed. 🫢


πŸ’– NAME πŸ’–

oc adm top node β€” display resource (CPU/memory) usage of nodes. That’s the assignment. Iconic. πŸ’…

🌸 SYNOPSIS 🌸

oc adm top node [OPTIONS]

πŸ¦‹ DESCRIPTION πŸ¦‹

Display resource (CPU/memory) usage of nodes. Full stop, bestie.

The top-node command lets you see the resource consumption of nodes. It is literally the main character of β€œwhat are my nodes eating?” energy. πŸ”₯

✨ OPTIONS ✨

  • --no-headers=false β€” if present, print output without headers. Bye-bye header row, we love a clean look. πŸ™ˆ
  • -l, --selector="" β€” selector (label query) to filter on. It supports '=', '==', '!=', 'in', 'notin' (e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints. Highkey precise. πŸŽ€
  • --show-capacity=false β€” print node resources based on Capacity instead of Allocatable(default) of the nodes. Choose your fighter. πŸ’…
  • --show-swap=false β€” print node resources related to swap memory. Swap girlies rise. πŸ“
  • --sort-by="" β€” if non-empty, sort the nodes list using the specified field. The field can be either 'cpu' or 'memory'. Sort responsibly. ⭐
  • --use-protocol-buffers=true β€” enables using protocol-buffers to access Metrics API. Techy slay. 🧚

🧬 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. Identity moment. πŸ‘‘
  • --as-group=[] β€” group to impersonate for the operation; this flag can be repeated to specify multiple groups. Repeat after me: groups. πŸ’œ
  • --as-uid="" β€” UID to impersonate for the operation. Numeric bestie behavior. πŸ”’
  • --as-user-extra=[] β€” user extras to impersonate for the operation; this flag can be repeated to specify multiple values for the same key. Extra, but make it authentication. πŸ’…
  • --cache-dir="/homeless-shelter/.kube/cache" β€” default cache directory. The path is the path. 🏠
  • --certificate-authority="" β€” path to a cert file for the certificate authority. Trust issues, but make it TLS. πŸŽ€
  • --client-certificate="" β€” path to a client certificate file for TLS. Client-certificate realness. πŸ¦‹
  • --client-key="" β€” path to a client key file for TLS. Keep it secret, keep it safe. πŸ”
  • --cluster="" β€” the name of the kubeconfig cluster to use. Cluster selection energy. 🌈
  • --context="" β€” the name of the kubeconfig context to use. Context is everything, literally. ✨
  • --disable-compression=false β€” if true, opt-out of response compression for all requests to the server. No squish. 🫢
  • --insecure-skip-tls-verify=false β€” if true, the server’s certificate will not be checked for validity. This will make your HTTPS connections insecure. 🚨 Bestie, that is the whole warning. Do not play. πŸ’€
  • --kubeconfig="" β€” path to the kubeconfig file to use for CLI requests. Point me to the config. πŸ“
  • --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. Preferences lore. 🧚
  • --match-server-version=false β€” require server version to match client version. Version check, but demanding. 😭
  • -n, --namespace="" β€” if present, the namespace scope for this CLI request. Namespace my beloved. πŸ’–
  • --profile="none" β€” name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex). Pick your profile. πŸ”₯
  • --profile-output="profile.pprof" β€” name of the file to write the profile to. File goes brrr. πŸ“
  • --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. Timeout boundaries, periodt. ⏳
  • -s, --server="" β€” the address and port of the Kubernetes API server. Server address unlocked. 🌐
  • --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. TLS name check, cute. πŸŽ€
  • --token="" β€” bearer token for authentication to the API server. Token moment. πŸ”‘
  • --user="" β€” the name of the kubeconfig user to use. User selection, slay. πŸ‘‘
  • --warnings-as-errors=false β€” treat warnings received from the server as errors and exit with a non-zero exit code. Warnings said β€œnot today.” πŸ’€

πŸŽ€ EXAMPLE πŸŽ€

# Show metrics for all nodes
oc adm top node

# Show metrics for a given node
oc adm top node NODE_NAME

πŸ”— SEE ALSO πŸ”—

Peep also: oc-adm-top(1), β€” cross-reference bestie, mwah. 🫢

πŸ“œ HISTORY πŸ“œ

June 2016 β€” Ported from the Kubernetes man-doc generator. That’s the origin story, no cap. 🧚


πŸ’– cute sign-off: Openshift β€” Openshift CLI User Manuals β€” OC ADM TOP(1) β€” June 2016. mwah, bestie 🫢

πŸ“¦ where this page comes from