OC-CLUSTER-INFO-DUMP(1)

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

✨ NAME ✨

Okay bestie, this is the manual page for oc cluster-info dump (section 1, from the OpenShift CLI User Manuals, June 2016). It literally dumps all the relevant information for debugging and diagnosis. No cap. πŸ’…

✨ SYNOPSIS ✨

oc cluster-info dump [OPTIONS]

That's it. That's the whole vibe. πŸŽ€

✨ DESCRIPTION ✨

Okay so here's the tea β˜•: this command dumps cluster information out, and it's suitable for debugging and diagnosing cluster problems. By default, it dumps everything to stdout. You can optionally specify a directory with --output-directory. If you specify a directory, Kubernetes will build a set of files in that directory. 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 namespaces.

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 like, it's organized fr fr. 🫢

✨ OPTIONS ✨

Here are the options, bestie. Slay. πŸ”₯

  • -A, --all-namespaces=false β€” If true, dump all namespaces. If true, --namespaces is ignored. Periodt.
  • --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. It's giving forgiving energy.
  • --namespaces=[] β€” A comma separated list of namespaces to dump. Cute.
  • -o, --output="json" β€” Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). So many choices, you're gonna eat.
  • --output-directory="" β€” Where to output the files. If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory. Iconic.
  • --pod-running-timeout=0 β€” The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running. Lowkey useful.
  • --show-managed-fields=false β€” If true, keep the managedFields when printing objects in JSON or YAML format. Iykyk.
  • --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⟩]. Obsessed with templates.

✨ OPTIONS INHERITED FROM PARENT COMMANDS ✨

These are the flags you get from the parent command, bestie. They're iconic. πŸ‘‘

  • --as="" β€” Username to impersonate for the operation. User could be a regular user or a service account in a namespace. Main character energy.
  • --as-group=[] β€” Group to impersonate for the operation, this flag can be repeated to specify multiple groups. Slay.
  • --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. That path is giving homeless shelter vibes but okay. πŸ™ˆ
  • --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. ⚠️ Careful bestie, this is literally insecure. Don't do it unless you know what you're doing.
  • --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. No cap, warnings become errors. πŸ’€

✨ EXAMPLE ✨

Okay here are some examples, bestie. You're gonna eat these up. πŸ“

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

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

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

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

✨ SEE ALSO ✨

✨ HISTORY ✨

June 2016, Ported from the Kubernetes man-doc generator. So like, it's vintage but still slaying. πŸ’–


And that's a wrap, bestie! This page is from the Openshift CLI User Manuals, June 2016, version OC CLUSTER-INFO(1). Stay iconic. πŸ’–βœ¨πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from