turbot/kubernetes
steampipe plugin install kubernetes

Table: kubernetes_cronjob - Query Kubernetes CronJobs using SQL

A Kubernetes CronJob creates Jobs on a repeating schedule, similar to the job scheduling in Unix-like systems. It is a way to run automated tasks at regular, predetermined times. CronJobs use the Cron format to schedule tasks.

Table Usage Guide

The kubernetes_cronjob table provides insights into CronJobs within Kubernetes. As a DevOps engineer, explore CronJob-specific details through this table, including schedules, job histories, and associated metadata. Utilize it to monitor and manage your automated tasks, and ensure they are running as expected.

Examples

Basic Info

Explore which scheduled tasks within your Kubernetes environment have failed. This allows for proactive troubleshooting and understanding of task scheduling and execution patterns.

select
name,
namespace,
uid,
failed_jobs_history_limit,
schedule,
suspend
from
kubernetes_cronjob;
select
name,
namespace,
uid,
failed_jobs_history_limit,
schedule,
suspend
from
kubernetes_cronjob;

Get list of container and images for cronJobs

Explore which cronJobs are running in your Kubernetes environment and identify the containers and images they are using. This is useful to understand the dependencies and configurations of your scheduled tasks, and can help in troubleshooting or optimizing resource usage.

select
name,
namespace,
jsonb_agg(elems.value -> 'name') as containers,
jsonb_agg(elems.value -> 'image') as images
from
kubernetes_cronjob,
jsonb_array_elements(
job_template -> 'spec' -> 'template' -> 'spec' -> 'containers'
) as elems
group by
name,
namespace;
select
name,
namespace,
json_group_array(json_extract(elems.value, '$.name')) as containers,
json_group_array(json_extract(elems.value, '$.image')) as images
from
kubernetes_cronjob,
json_each(job_template, '$.spec.template.spec.containers') as elems
group by
name,
namespace;

List manifest resources

Explore which scheduled tasks within your Kubernetes environment have a specified path. This can be useful to identify tasks that may be associated with certain applications or services, helping you to manage and monitor your resources more effectively.

select
name,
namespace,
uid,
failed_jobs_history_limit,
schedule,
suspend,
path
from
kubernetes_cronjob
where
path is not null;
select
name,
namespace,
uid,
failed_jobs_history_limit,
schedule,
suspend,
path
from
kubernetes_cronjob
where
path is not null;

Control examples

Schema for kubernetes_cronjob

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form.
activejsonbA list of pointers to currently running jobs.
annotationsjsonbAnnotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.
concurrency_policyjsonbSpecifies how to treat concurrent executions of a Job.
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.
failed_jobs_history_limitbigintThe number of failed finished jobs to retain. Value must be non-negative integer.
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.
job_templatejsonbSpecifies the job that will be created when executing a CronJob.
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.
last_schedule_timetimestamp with time zoneInformation when was the last time the job was successfully scheduled.
last_successful_timetimestamp with time zoneInformation when was the last time the job successfully completed.
nametextName of the object. Name must be unique within a namespace.
namespacetextNamespace defines the space within which each name must be unique.
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.
resource_versiontextAn opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed.
scheduletextThe schedule in Cron format.
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.
starting_deadline_secondsbigintOptional deadline in seconds for starting the job if it misses scheduledtime for any reason.
successful_jobs_history_limitbigintThe number of successful finished jobs to retain. Value must be non-negative integer.
suspendbooleanThis flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
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.

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_cronjob