Table: kubernetes_role - Query Kubernetes Roles using SQL

A Role in Kubernetes is a set of permissions that can be assigned to resources within a namespace. Roles dictate what actions are permitted and which resources those actions can be performed on. It is an integral part of Kubernetes' Role-Based Access Control (RBAC) system used to manage permissions and access to the Kubernetes API.

Table Usage Guide

The kubernetes_role table provides insights into Roles within Kubernetes RBAC. As a DevOps engineer, explore role-specific details through this table, including permissions, associated resources, and the namespaces they belong to. Utilize it to uncover information about roles, such as their access privileges, the resources they can interact with, and the namespaces they are active in.

Examples

Basic Info

Explore the roles within your Kubernetes environment, including their creation time and associated rules, to gain insights into your system's configuration and organization. This can help you understand how roles are distributed and manage them effectively.

select
  name,
  namespace,
  creation_timestamp,
  rules
from
  kubernetes_role
order by
  name;

select
  name,
  namespace,
  creation_timestamp,
  rules
from
  kubernetes_role
order by
  name;

List rules and verbs for roles

Explore which roles have specific permissions in your Kubernetes environment. This query helps in understanding the distribution of access rights, assisting in access control and security management.

select
  name as role_name,
  rule ->> 'apiGroups' as api_groups,
  rule ->> 'resources' as resources,
  rule ->> 'nonResourceURLs' as non_resource_urls,
  rule ->> 'verbs' as verbs,
  rule ->> 'resourceNames' as resource_names
from
  kubernetes_role,
  jsonb_array_elements(rules) as rule
order by
  role_name,
  api_groups;

select
  name as role_name,
  json_extract(rule.value, '$.apiGroups') as api_groups,
  json_extract(rule.value, '$.resources') as resources,
  json_extract(rule.value, '$.nonResourceURLs') as non_resource_urls,
  json_extract(rule.value, '$.verbs') as verbs,
  json_extract(rule.value, '$.resourceNames') as resource_names
from
  kubernetes_role,
  json_each(rules) as rule
order by
  role_name,
  api_groups;

List manifest resources

Explore which Kubernetes roles have a defined path to better organize and manage your resources. This can help in identifying instances where roles may be improperly configured or misplaced.

select
  name,
  namespace,
  rules,
  path
from
  kubernetes_role
where
  path is not null
order by
  name;

select
  name,
  namespace,
  rules,
  path
from
  kubernetes_role
where
  path is not null
order by
  name;

Query examples

Control examples

Schema for kubernetes_role

Name	Type	Description
_ctx	jsonb	Steampipe context in JSON form, e.g. connection_name.
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.
rules	jsonb	List of the PolicyRules for this Role.
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.
start_line	bigint	The path to the manifest file.
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_role