OC(1)

💅 NAME 💅

okay so welcome to OC(1), bestie — this is the manual page for oc describe, and it's here to show details of a specific resource or group of resources. lowkey iconic. 🫶

✨ SYNOPSIS ✨

oc describe [OPTIONS]

🌸 DESCRIPTION 🌸

Show details of a specific resource or group of resources. 💖

It prints a detailed description of the selected resources, including related resources such as events or controllers. You may select a single object by name, all objects of that type, provide a name prefix, or label selector. For example:

           $ oc describe TYPE NAME_PREFIX

will first check for an exact match on TYPE and NAME_PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME_PREFIX.

Use oc api-resources for a complete list of supported resources. 🗂️

🎀 OPTIONS 🎀

• -A, --all-namespaces=false — if present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. 💫
• --chunk-size=500 — return large lists in chunks rather than all at once. Pass 0 to disable. 🍓
• -f, --filename=[] — filename, directory, or URL to files containing the resource to describe. 📁
• -k, --kustomize="" — process the kustomization directory. Heads up: this flag can't be used together with -f or -R. 🚫
• -R, --recursive=false — process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. 🌀
• -l, --selector="" — selector (label query) to filter on, supports '=', '==', '!=', 'in', 'notin'. (e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints. 🔎
• --show-events=true — if true, display events related to the described object. 🎪

🦋 OPTIONS INHERITED FROM PARENT COMMANDS 🦋

these are the inherited flags, coming straight from the parent commands, iykyk 👑

• --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, that one's serious — it literally makes 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 🌈

okay these are the moments, bestie — copy-paste energy only ✨

                # Describe a node
                oc describe nodes kubernetes-node-emt8.c.myproject.internal

                # Describe a pod
                oc describe pods/nginx

                # Describe a pod identified by type and name in "pod.json"
                oc describe -f pod.json

                # Describe all pods
                oc describe pods

                # Describe pods by label name=myLabel
                oc describe pods -l name=myLabel

                # Describe all pods managed by the 'frontend' replication controller
                # (rc-created pods get the name of the rc as a prefix in the pod name)
                oc describe pods frontend

💜 SEE ALSO 💜

oc(1) — that's the whole see-also section, periodt. 💅

👑 HISTORY 👑

the origin story: June 2016, Ported from the Kubernetes man-doc generator. 🧚

---

xoxo, Openshift — Openshift CLI User Manuals, June 2016, OC(1) edition 💖🫶