OC-ADM-MUST-GATHER(1)

💅 oc adm must-gather 💅

okay bestie, this is the OC-ADM-MUST-GATHER(1) manual page and it’s literally the “launch a pod and grab all the debug info” page. no cap, very useful. 🫶

🌸 NAME 🌸

oc adm must-gather — Launch a new instance of a pod for gathering debug information. it’s giving “debug-info collection era” ✨

✨ SYNOPSIS ✨

oc adm must-gather [OPTIONS]

🦋 DESCRIPTION 🦋

Launch a pod to gather debugging information.

This command will launch a pod in a temporary namespace on your cluster that gathers debugging information and then downloads the gathered information. yes bestie, it gathers it and then downloads it — iconic behavior honestly 💖

🎀 OPTIONS 🎀

• --all-images=false — Collect must-gather using the default image for all Operators on the cluster annotated with operators.openshift.io/must-gather-image
• --dest-dir="" — Set a specific directory on the local machine to write gathered data to.
• --host-network=false — Run must-gather pods as hostNetwork: true — relevant if a specific command and image needs to capture host-level data
• --image=[] — Specify a must-gather plugin image to run. If not specified, OpenShift's default must-gather image will be used.
• --image-stream=[] — Specify an image stream (namespace/name:tag) containing a must-gather plugin image to run.
• --node-name="" — Set a specific node to use — by default a random master will be used
• --node-selector="" — Set a specific node selector to use — only relevant when specifying a command and image which needs to capture data on a set of cluster nodes simultaneously
• --run-namespace="" — An existing privileged namespace where must-gather pods should run. If not specified a temporary namespace will be generated.
• --since=0 — Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Plugins are encouraged but not required to support this. Only one of since-time / since may be used.
• --since-time="" — Only return logs after a specific date (RFC3339). Defaults to all logs. Plugins are encouraged but not required to support this. Only one of since-time / since may be used. This may not be applied to all commands in must-gather image (e.g. not every command complies with RFC3339, the use might be limited, etc.).
• --source-dir="/must-gather/" — Set the specific directory on the pod copy the gathered data from.
• --timeout="10m" — The length of time to wait for data gathering to complete, like 5s, 2m, or 3h, higher than zero. Defaults to 10 minutes. NOTE: This timeout only applies to the data gathering phase. After gathering completes, copying to the local destination will continue until finished.
• --volume-percentage=70 — Specify maximum percentage of must-gather pod's allocated volume that can be used. If this limit is exceeded, must-gather will stop gathering, but still copy gathered data.

⚠️ bestie, read the --timeout note: the timeout only applies to the data gathering phase. after gathering completes, copying to the local destination will continue until finished. don’t panic when the copy keeps going 💀

🫶 OPTIONS INHERITED FROM PARENT COMMANDS 🫶

these flags come along for the ride from the parent commands, bestie 🚗✨

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

# Gather information using the default plug-in image and command, writing into ./must-gather.local.<rand>
oc adm must-gather

# Gather information with a specific local folder to copy to
oc adm must-gather --dest-dir=/local/directory

# Gather audit information
oc adm must-gather -- /usr/bin/gather_audit_logs

# Gather information using multiple plug-in images
oc adm must-gather --image=quay.io/kubevirt/must-gather --image=quay.io/openshift/origin-must-gather

# Gather information using a specific image stream plug-in
oc adm must-gather --image-stream=openshift/must-gather:latest

# Gather information using a specific image, command, and pod directory
oc adm must-gather --image=my/image:tag --source-dir=/pod/directory -- myspecial-command.sh

⭐ SEE ALSO ⭐

• oc-adm(1),

💜 HISTORY 💜

June 2016, Ported from the Kubernetes man-doc generator

---

okay that’s the whole page, bestie! 🫶 source/version cuties: Openshift and Openshift CLI User Manuals; date: June 2016; manual: OC ADM(1). mwah 💋