Table: kubernetes_resource_quota - Query Kubernetes Resource Quotas using SQL
A Resource Quota in Kubernetes is a tool that administrators use to manage resources within a namespace. It sets hard limits on the amount of compute resources that can be used by a namespace in a Kubernetes cluster. This includes CPU and memory resources, the number of pods, services, volumes, and more.
Table Usage Guide
The kubernetes_resource_quota
table provides insights into resource quotas within Kubernetes. As a Kubernetes administrator, you can use this table to explore quota-specific details, including resource usage and restrictions within a namespace. Utilize it to uncover information about resource quotas, such as those nearing their limit, and effectively manage resources within your Kubernetes cluster.
Examples
Basic Info
Explore the basic information of your Kubernetes resource quotas to understand their allocation. This can help in managing and optimizing resource usage within your Kubernetes environment.
select name, namespace, resource_version, creation_timestamp, jsonb_pretty(spec_hard) as spec_hardfrom kubernetes_resource_quotaorder by name;
select name, namespace, resource_version, creation_timestamp, spec_hardfrom kubernetes_resource_quotaorder by name;
Get used pod details of namespaces
Discover the segments that are consuming resources in your Kubernetes environment by identifying how many pods and services are currently being used within each namespace. This is beneficial for managing resource allocation and identifying potential areas of overuse or inefficiency.
select name, namespace, status_used -> 'pods' as used_pods, status_used -> 'services' as used_servicesfrom kubernetes_resource_quota;
select name, namespace, json_extract(status_used, '$.pods') as used_pods, json_extract(status_used, '$.services') as used_servicesfrom kubernetes_resource_quota;
List manifest resources
Analyze the configuration of Kubernetes to identify resource quotas with specific paths. This is beneficial in managing resources efficiently by understanding their allocation and usage within your Kubernetes environment.
select name, namespace, resource_version, jsonb_pretty(spec_hard) as spec_hard, pathfrom kubernetes_resource_quotawhere path is not nullorder by name;
select name, namespace, resource_version, spec_hard, pathfrom kubernetes_resource_quotawhere path is not nullorder by name;
Control examples
Schema for kubernetes_resource_quota
Name | Type | Operators | Description |
---|---|---|---|
_ctx | jsonb | Steampipe context in JSON form. | |
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. | |
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. | |
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. | |
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. | |
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. | |
spec_hard | jsonb | Spec hard is the set of desired hard limits for each named resource. | |
spec_scope_selector | jsonb | A collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. | |
spec_scopes | jsonb | A collection of filters that must match each object tracked by a quota. | |
start_line | bigint | The path to the manifest file. | |
status_hard | jsonb | Status hard is the set of enforced hard limits for each named resource. | |
status_used | jsonb | Indicates current observed total usage of the resource in the namespace. | |
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. |
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_resource_quota