turbot/kubernetes
steampipe plugin install kubernetes

Table: kubernetes_replicaset - Query Kubernetes ReplicaSets using SQL

A ReplicaSet in Kubernetes is a resource that ensures that a specified number of pod replicas are running at any given time. It is often used to guarantee the availability of a specified number of identical pods. A ReplicaSet creates new pods when needed and removes old pods when too many are running.

Table Usage Guide

The kubernetes_replicaset table provides insights into the ReplicaSets within a Kubernetes cluster. As a DevOps engineer or Kubernetes administrator, you can use this table to monitor the status and health of your ReplicaSets, including the current and desired number of replicas, as well as the labels and selectors used to identify its pods. This can be particularly useful for maintaining high availability and for troubleshooting issues with your applications running on Kubernetes.

Examples

Basic Info

Explore the status and configuration of your Kubernetes replica sets to understand their readiness, availability, and age. This can be useful to assess the health and stability of your application deployments.

select
name,
namespace,
replicas as desired,
ready_replicas as ready,
available_replicas as available,
selector,
fully_labeled_replicas,
age(current_timestamp, creation_timestamp)
from
kubernetes_replicaset;
select
name,
namespace,
replicas as desired,
ready_replicas as ready,
available_replicas as available,
selector,
fully_labeled_replicas,
strftime('%s', 'now') - strftime('%s', creation_timestamp) as age
from
kubernetes_replicaset;

Get container and image used in the replicaset

Gain insights into the relationship between containers and their corresponding images within a replicaset, helping to manage and track the utilization of resources in a Kubernetes environment. This query is particularly useful for administrators looking to optimize their deployments.

select
name,
namespace,
c ->> 'name' as container_name,
c ->> 'image' as image
from
kubernetes_replicaset,
jsonb_array_elements(template -> 'spec' -> 'containers') as c
order by
namespace,
name;
select
name,
namespace,
json_extract(c.value, '$.name') as container_name,
json_extract(c.value, '$.image') as image
from
kubernetes_replicaset,
json_each(json_extract(template, '$.spec.containers')) as c
order by
namespace,
name;

List pods for a replicaset (by name)

Discover the details of pods associated with a specific replicaset in a Kubernetes environment. This is useful in monitoring and managing the pods that belong to a particular replicaset, ensuring the replicaset is functioning as expected.

select
pod.namespace,
rs.name as replicaset_name,
pod.name as pod_name,
pod.phase,
age(current_timestamp, pod.creation_timestamp),
pod.pod_ip,
pod.node_name
from
kubernetes_pod as pod,
jsonb_array_elements(pod.owner_references) as pod_owner,
kubernetes_replicaset as rs
where
pod_owner ->> 'kind' = 'ReplicaSet'
and rs.uid = pod_owner ->> 'uid'
and rs.name = 'frontend-56fc5b6b47'
order by
pod.namespace,
rs.name,
pod.name;
select
pod.namespace,
rs.name as replicaset_name,
pod.name as pod_name,
pod.phase,
strftime('%s', 'now') - strftime('%s', pod.creation_timestamp) as age,
pod.pod_ip,
pod.node_name
from
kubernetes_pod as pod,
json_each(pod.owner_references) as pod_owner,
kubernetes_replicaset as rs
where
json_extract(pod_owner.value, '$.kind') = 'ReplicaSet'
and rs.uid = json_extract(pod_owner.value, '$.uid')
and rs.name = 'frontend-56fc5b6b47'
order by
pod.namespace,
rs.name,
pod.name;

List manifest resources

Analyze the status of replica sets in your Kubernetes environment to understand their readiness and availability. This can help in assessing the health and performance of your applications running on Kubernetes.

select
name,
namespace,
replicas as desired,
ready_replicas as ready,
available_replicas as available,
selector,
fully_labeled_replicas,
path
from
kubernetes_replicaset
where
path is not null;
select
name,
namespace,
replicas as desired,
ready_replicas as ready,
available_replicas as available,
selector,
fully_labeled_replicas,
path
from
kubernetes_replicaset
where
path is not null;

Control examples

Schema for kubernetes_replicaset

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form.
annotationsjsonbAnnotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
available_replicasbigintThe number of available replicas (ready for at least minReadySeconds) for this replica set.
conditionsjsonbRepresents the latest available observations of a replica set's current state.
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.
fully_labeled_replicasbigintThe number of pods that have labels matching the labels of the pod template of the replicaset.
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.
min_ready_secondsbigintMinimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0
nametextName of the object. Name must be unique within a namespace.
namespacetextNamespace defines the space within which each name must be unique.
observed_generationbigintObservedGeneration reflects the generation of the most recently observed ReplicaSet.
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.
ready_replicasbigintThe number of ready replicas for this replica set.
replicasbigintReplicas is the number of desired replicas. Defaults to 1.
resource_versiontextAn opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed.
selectorjsonbSelector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set.
selector_querytextA query string representation of the selector.
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.
status_replicasbigintThe most recently oberved number of replicas.
tagsjsonbA map of tags for the resource. This includes both labels and annotations.
templatejsonbTemplate is the object that describes the pod that will be created if insufficient replicas are detected.
titletextTitle of the resource.
uidtextUID 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_replicaset