KUBERNETES(1)(kubernetes)

💖 KUBERNETES(1)(kubernetes) 💖

okay bestie, so this is kubectl cluster-info dump, part of the kubernetes manual — and honestly? it's giving "emergency room for your cluster" and I'm obsessed. written by Eric Paris back in Jan 2015, still serving looks. let's get into it 🩺✨

---

✨ NAME ✨

kubectl cluster-info dump — dump relevant info for debugging and diagnosis. like a little detective kit for when your cluster is acting up 🕵️♀️

---

🌸 SYNOPSIS 🌸

kubectl cluster-info dump [OPTIONS]

---

🦋 DESCRIPTION 🦋

So what it does is: it dumps cluster information out, in a way that's suitable for debugging and diagnosing cluster problems. it's literally the "tell me everything" button 💅

By default, it dumps everything to stdout. (yes, straight to your terminal, no cap.)

You can optionally specify a directory with --output-directory. If you specify a directory, Kubernetes will build a set of files in that directory. cute, organized, iconic 📁

By default, it only dumps things in the current namespace and the 'kube-system' namespace — but you can switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all the namespaces. main character energy: dump everything 🌈

The command also dumps the logs of all of the pods in the cluster; these logs are dumped into different directories based on namespace and pod name. so yes, every pod's little diary gets filed away by name and namespace 🫶

---

💅 OPTIONS 💅

• -A, --all-namespaces=false — If true, dump all namespaces. If true, --namespaces is ignored. (she doesn't share the spotlight 💀)
• --allow-missing-template-keys=true — If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. no drama over missing keys ✨
• --namespaces=[] — A comma separated list of namespaces to dump.
• -o, --output="json" — Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). pick your aesthetic 🎀
• --output-directory="" — Where to output the files. If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory.
• --pod-running-timeout=20s — The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running. patience, bestie ⏳
• --show-managed-fields=false — If true, keep the managedFields when printing objects in JSON or YAML format.
• --template="" — Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].

---

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

these are the heirlooms she inherited, and honestly they're lowkey the most powerful part 🧚

• --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. This will make your HTTPS connections insecure.

⚠️ bestie, note the insecure in the name — this makes your HTTPS connections insecure, so do not just leave it on like it's a cute accessory. 🚨

• --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.
• -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 🌈

go off, bestie, here's how it's done:

# Dump current cluster state to stdout
kubectl cluster-info dump

# Dump current cluster state to /path/to/cluster-state
kubectl cluster-info dump --output-directory=/path/to/cluster-state

# Dump all namespaces to stdout
kubectl cluster-info dump --all-namespaces

# Dump a set of namespaces to /path/to/cluster-state
kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state

---

🎀 SEE ALSO 🎀

• kubectl-cluster-info(1)

---

📜 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! fr fr 🙈

---

and that's the whole vibe check, bestie 💖 this page comes from the Manuals / User corner of the world, for version KUBERNETES(1)(kubernetes), dated back to Jan 2015 by Eric Paris. slay, go debug something, ily 🦋✨💅