Page cover

persistentvolumeclaim

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

Usage

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

  2. To view the resource name, refer to the corresponding get persistentvolumeclaim 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 PVC will appear in your terminal. The output includes metadata, requested storage, and current binding status.

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

Column
Description

spec.accessModes

The desired access mode for the PVC.

spec.resources.requests.storage

The requested storage size for the volume.

spec.storageClassName

The name of the StorageClass that provisions the Persistent Volume for this claim.

spec.volumeName

The name of the Persistent Volume bound to this claim, if any.

spec.volumeMode

The mode in which the volume is exposed to the Pod.

status.phase

Indicates the current state of the claim.

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

Last updated