OC-ADM-NODE-LOGS(1)

📦
version 4.22.0 · 2 versions
, in nixpkgs unstable

💅 oc adm node-logs — the OC ADM(1) manual, but make it make sense 🎀

okay so bestie, welcome to oc adm node-logs from the OC ADM(1) manual — the glow-up edition. Grab a strawberry drink 🍓 and let's get into it, because this one is literally about peeking at what your nodes are saying behind your back. 👀

✨ NAME ✨

oc adm node-logs — display and filter node logs, periodt. 💅

🦋 SYNOPSIS 🦋

oc adm node-logs [OPTIONS]

🌸 DESCRIPTION 🌸

Display and filter node logs. That's the whole vibe. 🫶

This command retrieves logs for the node. The default mode is to query the systemd journal on supported operating systems, which allows searching, time based filtering, and unit based filtering. You may also use the --path argument to see a list of log files available under /var/log/ and view those contents directly. Two whole ways to snoop, iconique. ✨

⚠️ bestie, real talk: node logs may contain sensitive output and so are limited to privileged node administrators. The system:node-admins role grants this permission by default. No cap, don't go handing this out like candy. 🙈

You check who has that permission via:

oc adm policy who-can --all-namespaces get nodes/log

💖 OPTIONS 💖

  • --boot=0 — show messages from a specific boot. Use negative numbers, allowed [-100, 0], passing invalid boot offset will fail retrieving logs. Only applies to node service logs. 🥾
  • --case-sensitive=true — filters are case sensitive by default. Pass --case-sensitive=false to do a case insensitive filter. your uppercase era 💀
  • -g, --grep="" — filter log entries by the provided regex pattern. Only applies to node service logs. regex girlies rise 🧚
  • -o, --output="" — display service logs in an alternate format (short, cat, json, short-unix). Only applies to node service logs. pick your aesthetic ✨
  • --path="journal" — retrieve the specified path within the node's /var/log/ folder. The 'journal' value will allow querying the services on supported operating systems. 📁
  • --raw=false — perform no transformation of the returned data. raw and unfiltered, main character energy 🔥
  • --role="" — set a label selector by node role. 👑
  • -l, --selector="" — selector (label query) to filter on. 🎯
  • --since="" — return logs after a specific ISO timestamp or relative date. Only applies to node service logs. ⏰
  • --tail=0 — return up to this many lines (not more than 100k) from the end of the log. Only applies to node service logs. not me reading the last 100k lines like a novel 😭
  • --unify=false — interleave logs by sorting the output. Defaults on when viewing node service logs. 🌀
  • -u, --unit=[] — return log entries from the specified services(s) Only applies to node service logs. (yes, "service(s)" — that's their typo, not mine, i'm just the messenger 🎀)
  • --until="" — return logs before a specific ISO timestamp or relative date. Only applies to node service logs. ⏳

🎀 OPTIONS INHERITED FROM PARENT COMMANDS 🎀

these are the family heirlooms, passed down from the parent command. lowkey iconic. 💜

  • --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="/homeless-shelter/.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. 🚨 bestie this is a jump-scare, do not casually enable it. 🙈
  • --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. 📍
  • --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 🌈

here's the part where it all clicks, fr fr:

# Show kubelet logs from all control plane nodes
oc adm node-logs --role master -u kubelet

# See what logs are available in control plane nodes in /var/log
oc adm node-logs --role master --path=/

# Display cron log file from all control plane nodes
oc adm node-logs --role master --path=cron

three examples, all ate, no crumbs. 🔥

⭐ SEE ALSO ⭐

  • oc-adm(1) — go say hi to the parent. 👋

🦋 HISTORY 🦋

June 2016, ported from the Kubernetes man-doc generator. a true vintage moment, we love a throwback. 🕰️

and that's the page, bestie! 🫶 this whole thing comes to you courtesy of the Openshift CLI User Manuals, June 2016 vintage, from the lovely people at Openshift — go forth and read your logs responsibly. 💜✨🎀

📦 where this page comes from