Page cover

pod

The describe pod command retrieves detailed information about a specific Pod in the Kubernetes cluster. This includes metadata, container configuration, environment details, resource requests and limits, as well as status and event information.

Usage

cldkctl describe pod [name] [flags]

Steps

Follow the steps below to run and view the result of this command:

  1. Run the following command in your terminal:

./cldkctl describe pod [name]
  1. Replace [name] with the Pod name you want to inspect.

  2. To view the resource name, refer to the corresponding get pod section.

  3. If the resource is located in a non-default namespace, include the -n or --namespace flag followed by the namespace name.

./cldkctl describe [resource] [name] -n [namespace]
  1. Once completed successfully, the detailed information about the specified Pod will appear in your terminal. The output includes metadata, container details, network information, and pod conditions.

The following table describes the additional fields specific to the Pod resource

Column
Description

spec.containers

A list of containers defined in the Pod, including names, images, ports, and mount paths.

spec.volumes

The storage volumes attached to the Pod.

spec.restartPolicy

Defines the restart behavior for containers.

spec.nodeName

The name of the node where the Pod is scheduled to run.

spec.serviceAccountName

The ServiceAccount associated with the Pod for API authentication.

status.phase

The current phase of the Pod lifecycle.

status.conditions

A list of condition objects indicating readiness and initialization states.

status.hostIP

The IP address of the node hosting the Pod.

status.podIP

The Pod’s internal IP address within the cluster network.

status.containerStatuses

Detailed information about each container’s current and previous states.

status.containerStatuses.state.waiting.reason

Explains why a container is not running.

status.containerStatuses.restartCount

The number of times the container has restarted.

status.qosClass

The Quality of Service (QoS) classification of the Pod, based on resource requests and limits.

Flags

  1. This command supports global flags. Refer to the Global Flags section for details.

  2. For common metadata fields, refer to the Common Output Fields table at the beginning of this section.

Flag
Description

-h, --help

Help for describe pod command.

Last updated