OC-ADM-INSPECT(1)

OC ADM(1) (oc adm inspect) 💅

Okay bestie, so this page is from the OC ADM manual, and it's literally all about oc adm inspect. Let's get into it! 🫶

✨ NAME ✨

oc adm inspect: collect debugging data for a given resource. That's the whole vibe. 💖

🛠️ SYNOPSIS 🛠️

oc adm inspect [OPTIONS]

That's the whole command line, no cap.

🌸 DESCRIPTION 🌸

So like, this command gathers debugging information for a resource.

It downloads the specified resource and any related resources, all for the purpose of gathering debugging information. It's giving detective energy, honestly. 🔍

✨ OPTIONS ✨

• -A, --all-namespaces=false — if you include this, it lists the requested object(s) across all namespaces. The namespace in the current context is ignored even if you specify it with --namespace. So like, it's the "all the namespaces" button, periodt. 💅
• --as="" — username to impersonate for the operation. The user could be a regular user or a service account in a namespace. Like, you're cosplaying as someone else, lowkey. 🎭
• --as-group=[] — group to impersonate for the operation. This flag can be repeated to specify multiple groups. So you can stack 'em up, bestie. 🎀
• --as-uid="" — UID to impersonate for the operation. It's giving "who am I really" energy. 🙈
• --as-user-extra=[] — user extras to impersonate for the operation. This flag can be repeated to specify multiple values for the same key. So like, you can add all the extra bits, periodt. 💅
• --cache-dir="/homeless-shelter/.kube/cache" — default cache directory. Like, it's where stuff gets cached, you know? 😭
• --certificate-authority="" — path to a cert file for the certificate authority. So like, the CA cert goes here. 📜
• --client-certificate="" — path to a client certificate file for TLS. For when you need to prove who you are. 🪪
• --client-key="" — path to a client key file for TLS. The secret sauce to your client certificate. 🔑
• --cluster="" — the name of the kubeconfig cluster to use. So like, which cluster are we talking to? 🌐
• --context="" — the name of the kubeconfig context to use. It's the vibe of your kubeconfig, honestly. 🎯
• --dest-dir="" — root directory used for storing all gathered cluster operator data. It defaults to $(PWD)/inspect.local.<rand>. So like, if you don't specify, it makes a random folder in your current directory. 🎀
• --disable-compression=false — if true, opt-out of response compression for all requests to the server. So like, no compression, no problem? 💁
• --events-file="" — a path to an events.json file to create a HTML page from. So like, you give it a JSON file and it makes a little HTML page. Cute! 🎨
• --insecure-skip-tls-verify=false — if true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. So like, only do this if you're feeling risky, bestie. 💀

This will make your HTTPS connections insecure, so like, be careful! 🔥

• --kubeconfig="" — path to the kubeconfig file to use for CLI requests. So like, where's your kubeconfig at? 📁
• -n, --namespace="" — if present, the namespace scope for this CLI request. So like, which namespace are we poking around in? 🕵️
• --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. So like, zero means wait forever, which is giving patient queen energy. 👑
• -s, --server="" — the address and port of the Kubernetes API server. So like, where's the server at? 🌐
• --since=0 — only return logs newer than a relative duration like 5s, 2m, or 3h. It defaults to all logs. Only one of since-time / since may be used. So like, it's a time filter for logs. ⏰
• --since-time="" — only return logs after a specific date (RFC3339). It defaults to all logs. Only one of since-time / since may be used. So like, you can specify an exact date, but you can't use both. 🗓️
• --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. So like, it's the name on the certificate. 📛
• --token="" — bearer token for authentication to the API server. It's like your VIP pass. 🎟️
• --user="" — the name of the kubeconfig user to use. So like, which user are we? 👤

👑 OPTIONS INHERITED FROM PARENT COMMANDS 👑

• --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. So like, it's a preferences file, but you can turn it off if you want. 💅
• --match-server-version=false — require server version to match client version. So like, if you want them to be exactly the same, this is your flag. 🎯
• --profile="none" — name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex). So like, you can profile all the things. 📊
• --profile-output="profile.pprof" — name of the file to write the profile to. So like, where does the profile go? 📁
• --warnings-as-errors=false — treat warnings received from the server as errors and exit with a non-zero exit code. So like, warnings become errors, periodt. 💀

🦋 EXAMPLE 🦋

Here are some iconic examples, bestie:

# Collect debugging data for the "openshift-apiserver" clusteroperator
oc adm inspect clusteroperator/openshift-apiserver

# Collect debugging data for the "openshift-apiserver" and "kube-apiserver" clusteroperators
oc adm inspect clusteroperator/openshift-apiserver clusteroperator/kube-apiserver

# Collect debugging data for all clusteroperators
oc adm inspect clusteroperator

# Collect debugging data for all clusteroperators and clusterversions
oc adm inspect clusteroperators,clusterversions

🌈 SEE ALSO 🌈

oc-adm(1), that's the parent command, so go check it out if you want the full picture. 💖

💜 HISTORY 💜

June 2016, ported from the Kubernetes man-doc generator. So like, this page has been around for a minute, but it's still iconic. 👑

---

This page is from the Openshift CLI User Manuals, part of the OC ADM(1) family, and it was last updated in June 2016. Stay slay, bestie! 💖✨