From 0a42b0ab34ef24ba9dc12f251bb406d6e93ed46e Mon Sep 17 00:00:00 2001 From: Steven Smith Date: Mon, 19 Jan 2026 09:28:58 -0500 Subject: [PATCH] Adds oc describe instructions to viewing pods page --- modules/troubleshooting-general-describe-pod.adoc | 13 +++++-------- nodes/pods/nodes-pods-viewing.adoc | 7 +++++++ 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/modules/troubleshooting-general-describe-pod.adoc b/modules/troubleshooting-general-describe-pod.adoc index b9734fcefa..78a10606e1 100644 --- a/modules/troubleshooting-general-describe-pod.adoc +++ b/modules/troubleshooting-general-describe-pod.adoc @@ -1,24 +1,24 @@ // Module included in the following assemblies: // +// * nodes/pods/nodes-pods-viewing.adoc // * edge_computing/day_2_core_cnf_clusters/troubleshooting/troubleshooting-general-troubleshooting.adoc :_mod-docs-content-type: PROCEDURE [id="troubleshooting-general-describe-pod_{context}"] = Describing a pod -Describing a pod gives you information about that pod to help with troubleshooting. -The `Events` section provides detailed information about the pod and the containers inside of it. +[role="_abstract"] +To troubleshoot pod issues and view detailed information about a pod in {product-title}, you can describe a pod using the `oc describe pod` command. The *Events* section in the output provides detailed information about the pod and the containers inside of it. .Procedure * Describe a pod by running the following command: + --- [source,terminal] ---- $ oc describe pod -n busybox-1 ---- - ++ .Example output [source,terminal] ---- @@ -38,7 +38,4 @@ Events: Normal Pulled 41m (x170 over 7d1h) kubelet Container image "quay.io/quay/busybox:latest" already present on machine Normal Created 41m (x170 over 7d1h) kubelet Created container busybox Normal Started 41m (x170 over 7d1h) kubelet Started container busybox ----- --- - -For more information, see "oc describe". \ No newline at end of file +---- \ No newline at end of file diff --git a/nodes/pods/nodes-pods-viewing.adoc b/nodes/pods/nodes-pods-viewing.adoc index f3e21b5e45..488960459f 100644 --- a/nodes/pods/nodes-pods-viewing.adoc +++ b/nodes/pods/nodes-pods-viewing.adoc @@ -10,6 +10,13 @@ As an administrator, you can view cluster pods, check their health, and evaluate include::modules/nodes-pods-viewing-project.adoc[leveloffset=+1] +include::modules/troubleshooting-general-describe-pod.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources + +* xref:../../cli_reference/openshift_cli/developer-cli-commands.adoc#oc-describe[oc describe] + include::modules/nodes-pods-viewing-usage.adoc[leveloffset=+1] include::modules/viewing-resource-logs-cli-console.adoc[leveloffset=+1]