turbot/kubernetes
steampipe plugin install kubernetes

Table: kubernetes_persistent_volume - Query Kubernetes Persistent Volumes using SQL

A Kubernetes Persistent Volume (PV) is a piece of storage in the cluster that has been provisioned by an administrator or dynamically provisioned using Storage Classes. PVs are volume plugins like Volumes, but have a lifecycle independent of any individual Pod that uses the PV. These resources allow Pods to store data that can survive the lifecycle of a Pod.

Table Usage Guide

The kubernetes_persistent_volume table provides insights into persistent volumes within Kubernetes. As a DevOps engineer, explore volume-specific details through this table, including storage capacity, access modes, and associated metadata. Utilize it to uncover information about volumes, such as those with certain storage classes, the status of volumes, and the reclaim policy set for volumes.

Examples

Basic Info

Explore the status and capacity of your persistent storage volumes within your Kubernetes environment. This allows you to manage your storage resources effectively and plan for future capacity needs.

select
name,
access_modes,
storage_class,
capacity ->> 'storage' as storage_capacity,
creation_timestamp,
persistent_volume_reclaim_policy,
phase as status,
volume_mode,
age(current_timestamp, creation_timestamp)
from
kubernetes_persistent_volume;
select
name,
access_modes,
storage_class,
json_extract(capacity, '$.storage') as storage_capacity,
creation_timestamp,
persistent_volume_reclaim_policy,
phase as status,
volume_mode,
(julianday('now') - julianday(creation_timestamp)) * 24 * 60 * 60 as age
from
kubernetes_persistent_volume;

Get hostpath details for the volume

Explore the details of your persistent volume's hostpath in your Kubernetes setup. This can help in understanding the type and path associated with your volume, which is crucial for managing and troubleshooting your storage configuration.

select
name,
persistent_volume_source -> 'hostPath' ->> 'path' as path,
persistent_volume_source -> 'hostPath' ->> 'type' as type
from
kubernetes_persistent_volume;
select
name,
json_extract(persistent_volume_source, '$.hostPath.path') as path,
json_extract(persistent_volume_source, '$.hostPath.type') as type
from
kubernetes_persistent_volume;

List manifest resources

Explore the various resources within your Kubernetes persistent volumes, focusing on those that have a specified path. This allows you to assess storage capacities, access modes, and reclaim policies to better manage your Kubernetes environment.

select
name,
access_modes,
storage_class,
capacity ->> 'storage' as storage_capacity,
persistent_volume_reclaim_policy,
phase as status,
volume_mode,
path
from
kubernetes_persistent_volume
where
path is not null;
select
name,
access_modes,
storage_class,
json_extract(capacity, '$.storage') as storage_capacity,
persistent_volume_reclaim_policy,
phase as status,
volume_mode,
path
from
kubernetes_persistent_volume
where
path is not null;

Schema for kubernetes_persistent_volume

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form.
access_modesjsonbList of ways the volume can be mounted.
annotationsjsonbAnnotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
capacityjsonbA description of the persistent volume's resources and capacity.
claim_refjsonbClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound.
context_nametextKubectl config context name.
creation_timestamptimestamp with time zoneCreationTimestamp is a timestamp representing the server time when this object was created.
deletion_grace_period_secondsbigintNumber of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set.
deletion_timestamptimestamp with time zoneDeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.
end_linebigintThe path to the manifest file.
finalizersjsonbMust be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
generate_nametextGenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided.
generationbigintA sequence number representing a specific generation of the desired state.
labelsjsonbMap of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services.
messagetextA human-readable message indicating details about why the volume is in this state.
mount_optionsjsonbA list of mount options, e.g. ["ro", "soft"].
nametextName of the object. Name must be unique within a namespace.
node_affinityjsonbDefines constraints that limit what nodes this volume can be accessed from.
owner_referencesjsonbList of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
pathtextThe path to the manifest file.
persistent_volume_reclaim_policytextWhat happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume.
persistent_volume_sourcejsonbThe actual volume backing the persistent volume.
phasetextPhase indicates if a volume is available, bound to a claim, or released by a claim.
reasontextReason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.
resource_versiontextAn opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed.
source_typetextThe source of the resource. Possible values are: deployed and manifest. If the resource is fetched from the spec file the value will be manifest.
sp_connection_nametextSteampipe connection name.
sp_ctxjsonbSteampipe context in JSON form.
start_linebigintThe path to the manifest file.
storage_classtextName of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
tagsjsonbA map of tags for the resource. This includes both labels and annotations.
titletextTitle of the resource.
uidtextUID is the unique in time and space value for this object.
volume_modetextDefines if a volume is intended to be used with a formatted filesystem or to remain in raw block state.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- kubernetes

You can pass the configuration to the command with the --config argument:

steampipe_export_kubernetes --config '<your_config>' kubernetes_persistent_volume