Page cover

persistentvolume

The describe persistentvolume command retrieves detailed information about a specific Persistent Volume (PV) in the Kubernetes cluster. This includes metadata, storage capacity, access modes, reclaim policy, binding status, and the associated Persistent Volume Claim (PVC), if any.

Usage

cldkctl describe persistentvolume [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 persistentvolume [name]
  1. Replace [name] with the PV name you want to inspect.

  2. To view the resource name, refer to the corresponding get persistentvolume 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 Persistent Volume will appear in your terminal. The output includes metadata, storage details, and binding information.

The following table describes the additional fields specific to the PersistentVolume resource.

Column
Description

spec.capacity.storage

The total storage capacity allocated to this Persistent Volume.

spec.hostPath.path

The file system path on the host node where data is stored.

spec.accessModes

The supported access mode for this volume.

spec.persistentVolumeReclaimPolicy

Defines the behavior of the PV when its claim is released.

spec.storageClassName

The name of the StorageClass associated with this Persistent Volume.

spec.volumeMode

Indicates how the volume is exposed to the Pod.

status.phase

Displays the current state of the volume.

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 persistentvolume command.

Last updated