Table: kubernetes_persistent_volume_claim - Query Kubernetes Persistent Volume Claims using SQL
A Kubernetes Persistent Volume Claim (PVC) is a request for storage by a user. It is similar to a pod in Kubernetes. PVCs can request specific size and access modes like read and write for a Persistent Volume (PV).
Table Usage Guide
The kubernetes_persistent_volume_claim
table provides insights into the Persistent Volume Claims within a Kubernetes cluster. As a DevOps engineer, you can use this table to explore details about each claim, including its current status, requested storage capacity, and access modes. This table is beneficial when you need to manage storage resources or troubleshoot storage-related issues in your Kubernetes environment.
Examples
Basic Info
Explore the status and capacity of persistent storage volumes in a Kubernetes environment. This can help you manage resources effectively and ensure optimal allocation and usage.
select name, namespace, volume_name as volume, volume_mode, access_modes, phase as status, capacity ->> 'storage' as capacity, creation_timestamp, data_source, selector, resources, age(current_timestamp, creation_timestamp)from kubernetes_persistent_volume_claim;
select name, namespace, volume_name as volume, volume_mode, access_modes, phase as status, json_extract(capacity, '$.storage') as capacity, creation_timestamp, data_source, selector, resources, (julianday('now') - julianday(creation_timestamp)) * 24 * 60 * 60 as agefrom kubernetes_persistent_volume_claim;
List manifest resources
Explore the various resources within a manifest by identifying their names, namespaces, and statuses. This is useful for understanding the capacity and configuration of your persistent storage volumes, particularly when you need to assess the availability and allocation of resources.
select name, namespace, volume_name as volume, volume_mode, access_modes, phase as status, capacity ->> 'storage' as capacity, data_source, selector, resources, pathfrom kubernetes_persistent_volume_claimwhere path is not null;
select name, namespace, volume_name as volume, volume_mode, access_modes, phase as status, json_extract(capacity, '$.storage') as capacity, data_source, selector, resources, pathfrom kubernetes_persistent_volume_claimwhere path is not null;
Schema for kubernetes_persistent_volume_claim
Name | Type | Operators | Description |
---|---|---|---|
_ctx | jsonb | Steampipe context in JSON form. | |
access_modes | jsonb | List of ways the volume can be mounted. | |
annotations | jsonb | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. | |
capacity | jsonb | The actual resources of the underlying volume. | |
conditions | jsonb | The Condition of persistent volume claim. | |
context_name | text | Kubectl config context name. | |
creation_timestamp | timestamp with time zone | CreationTimestamp is a timestamp representing the server time when this object was created. | |
data_source | jsonb | The source of the volume. This can be used to specify either: an existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot), an existing PVC (PersistentVolumeClaim) or an existing custom resource that implements data population (Alpha). | |
deletion_grace_period_seconds | bigint | Number 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_timestamp | timestamp with time zone | DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. | |
end_line | bigint | The path to the manifest file. | |
finalizers | jsonb | Must 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_name | text | GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. | |
generation | bigint | A sequence number representing a specific generation of the desired state. | |
labels | jsonb | Map 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. | |
name | text | Name of the object. Name must be unique within a namespace. | |
namespace | text | Namespace defines the space within which each name must be unique. | |
owner_references | jsonb | List 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. | |
path | text | The path to the manifest file. | |
phase | text | Phase indicates the current phase of PersistentVolumeClaim. | |
resource_version | text | An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. | |
resources | jsonb | Represents the minimum resources the volume should have. | |
selector | jsonb | The actual volume backing the persistent volume. | |
source_type | text | The 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_name | text | Steampipe connection name. | |
sp_ctx | jsonb | Steampipe context in JSON form. | |
start_line | bigint | The path to the manifest file. | |
status_access_modes | jsonb | The actual access modes the volume backing the PVC has. | |
storage_class | text | Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. | |
tags | jsonb | A map of tags for the resource. This includes both labels and annotations. | |
title | text | Title of the resource. | |
uid | text | UID is the unique in time and space value for this object. | |
volume_mode | text | Defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. | |
volume_name | text | The binding reference to the PersistentVolume backing this claim. |
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_claim