Table: kubernetes_endpoint - Query Kubernetes Endpoints using SQL

Kubernetes Endpoints are a part of the Kubernetes Service concept that represents a real or virtual IP address and a port number that Kubernetes pods use to access services. Endpoints can be defined as a network endpoint that can receive traffic. They are a fundamental part of the Kubernetes networking model, allowing pods to communicate with each other and with services outside the Kubernetes cluster.

Table Usage Guide

The kubernetes_endpoint table provides insights into endpoints within Kubernetes. As a DevOps engineer, you can explore details about each endpoint through this table, including its associated services, IP addresses, and ports. Use this table to understand the communication paths within your Kubernetes cluster, track the status of endpoints, and identify any potential networking issues.

Examples

Basic Info

Explore which Kubernetes endpoints are currently active in your system. This can help you understand the communication points within your clusters and troubleshoot any networking issues.

select
  name,
  namespace,
  subsets
from
  kubernetes_endpoint;

select
  name,
  namespace,
  subsets
from
  kubernetes_endpoint;

Endpoint IP Info

Determine the areas in which endpoint IP information, such as address, readiness status and protocol, is used in your Kubernetes environment. This can aid in network troubleshooting and enhancing security measures.

select
  name,
  namespace,
  addr ->> 'ip' as address,
  nr_addr ->> 'ip' as not_ready_address,
  port -> 'port' as port,
  port ->> 'protocol' as protocol
from
  kubernetes_endpoint,
  jsonb_array_elements(subsets) as subset
  left join jsonb_array_elements(subset -> 'addresses') as addr on true
  left join jsonb_array_elements(subset -> 'notReadyAddresses') as nr_addr on true
  left join jsonb_array_elements(subset -> 'ports') as port on true;

select
  kubernetes_endpoint.name,
  kubernetes_endpoint.namespace,
  json_extract(addr.value, '$.ip') as address,
  json_extract(nr_addr.value, '$.ip') as not_ready_address,
  json_extract(port.value, '$.port') as port,
  json_extract(port.value, '$.protocol') as protocol
from
  kubernetes_endpoint,
  json_each(kubernetes_endpoint.subsets) as subset,
  json_each(json_extract(subset.value, '$.addresses')) as addr,
  json_each(json_extract(subset.value, '$.notReadyAddresses')) as nr_addr,
  json_each(json_extract(subset.value, '$.ports')) as port;

List manifest resources

Explore which Kubernetes endpoints have a specified path. This is useful to understand the distribution of resources within your Kubernetes environment.

select
  name,
  namespace,
  subsets,
  path
from
  kubernetes_endpoint
where
  path is not null;

select
  name,
  namespace,
  subsets,
  path
from
  kubernetes_endpoint
where
  path is not null;

Query examples

endpoints_for_node

Control examples

Kubernetes API should serve on secure port

Schema for kubernetes_endpoint

Name	Type	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.
start_line	bigint	The path to the manifest file.
subsets	jsonb	List of addresses and ports that comprise a service.
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_endpoint