kubernetes

Documentation

Overview

package kubernetes implements a steampipe plugin for kubernetes.

This plugin provides data that Steampipe uses to present foreign tables that represent kubernetes resources.

Index

• Constants
• func GetConfig(connection *plugin.Connection) kubernetesConfig
• func GetNewClientCRD(ctx context.Context, d *plugin.QueryData) (*apiextension.Clientset, error)
• func GetNewClientCRDRaw(ctx context.Context, cc *connection.ConnectionCache, c *plugin.Connection) (*apiextension.Clientset, error)
• func GetNewClientDynamic(ctx context.Context, d *plugin.QueryData) (dynamic.Interface, error)
• func GetNewClientset(ctx context.Context, d *plugin.QueryData) (*kubernetes.Clientset, error)
• func Plugin(ctx context.Context) *plugin.Plugin
• type CRDResourceInfo
• type ClusterRole
• type ClusterRoleBinding
• type ConfigMap
• type CronJob
• type CustomResourceDefinition
• type DaemonSet
• type Deployment
• type EndpointSlice
• type Endpoints
• type Event
• type HelmChartInfo
• type HelmRenderedTemplate
• type HorizontalPodAutoscaler
• type Ingress
• type Job
• type LimitRange
• type LineInfo
• type Namespace
• type NetworkPolicy
• type Node
• type PersistentVolume
• type PersistentVolumeClaim
• type Pod
• type PodDisruptionBudget
• type PodSecurityPolicy
• type PodTemplate
• type ReplicaSet
• type ReplicationController
• type ResourceQuota
• type Role
• type RoleBinding
• type Row
• type Rows
• type Secret
• type Service
• type ServiceAccount
• type SourceType
  • func (sourceType SourceType) IsValid() error
  • func (sourceType SourceType) String() string
  • func (sourceType SourceType) ToSourceTypes() []string
• type StatefulSet
• type StorageClass

Constants

const (
	ColumnDescriptionTitle = "Title of the resource."
	ColumnDescriptionAkas  = "Array of globally unique identifier strings (also known as) for the resource."
	ColumnDescriptionTags  = "A map of tags for the resource. This includes both labels and annotations."
)

Functions

func GetConfig

func GetConfig(connection *plugin.Connection) kubernetesConfig

GetConfig :: retrieve and cast connection config from query data

func GetNewClientCRD

func GetNewClientCRD(ctx context.Context, d *plugin.QueryData) (*apiextension.Clientset, error)

GetNewClientCRD :: gets client for querying k8s apis for CustomResourceDefinition

func GetNewClientCRDRaw

func GetNewClientCRDRaw(ctx context.Context, cc *connection.ConnectionCache, c *plugin.Connection) (*apiextension.Clientset, error)

GetNewClientCRDRaw :: gets client for querying k8s apis for CustomResourceDefinition

func GetNewClientDynamic

func GetNewClientDynamic(ctx context.Context, d *plugin.QueryData) (dynamic.Interface, error)

GetNewClientDynamic :: gets client for querying k8s apis for Dynamic Interface

func GetNewClientset

func GetNewClientset(ctx context.Context, d *plugin.QueryData) (*kubernetes.Clientset, error)

GetNewClientset :: gets client for querying k8s apis for the provided context

func Plugin

func Plugin(ctx context.Context) *plugin.Plugin

Plugin creates this (k8s) plugin

Types

type CRDResourceInfo

type CRDResourceInfo struct {
	Name              interface{}
	UID               interface{}
	CreationTimestamp interface{}
	Kind              interface{}
	APIVersion        interface{}
	Namespace         interface{}
	Annotations       interface{}
	Spec              interface{}
	Labels            interface{}
	Status            interface{}
	Path              string
	StartLine         int
	EndLine           int
	SourceType        string
	ContextName       string
}

type ClusterRole

type ClusterRole struct {
	v1.ClusterRole
	// contains filtered or unexported fields
}

type ClusterRoleBinding

type ClusterRoleBinding struct {
	v1.ClusterRoleBinding
	// contains filtered or unexported fields
}

type ConfigMap

type ConfigMap struct {
	v1.ConfigMap
	// contains filtered or unexported fields
}

type CronJob

type CronJob struct {
	v1.CronJob
	// contains filtered or unexported fields
}

type CustomResourceDefinition

type CustomResourceDefinition struct {
	v1.CustomResourceDefinition
	// contains filtered or unexported fields
}

type DaemonSet

type DaemonSet struct {
	v1.DaemonSet
	// contains filtered or unexported fields
}

type Deployment

type Deployment struct {
	v1.Deployment
	// contains filtered or unexported fields
}

type EndpointSlice

type EndpointSlice struct {
	v1.EndpointSlice
	// contains filtered or unexported fields
}

type Endpoints

type Endpoints struct {
	v1.Endpoints
	// contains filtered or unexported fields
}

type Event

type Event struct {
	v1.Event
	// contains filtered or unexported fields
}

type HelmChartInfo

type HelmChartInfo struct {
	chart.Metadata
	ChartPath string
}

type HelmRenderedTemplate

type HelmRenderedTemplate struct {
	Data      string
	Chart     *chart.Chart
	Path      string
	ConfigKey string
}

type HorizontalPodAutoscaler

type HorizontalPodAutoscaler struct {
	v2.HorizontalPodAutoscaler
	// contains filtered or unexported fields
}

type Ingress

type Ingress struct {
	v1.Ingress
	// contains filtered or unexported fields
}

type Job

type Job struct {
	v1.Job
	// contains filtered or unexported fields
}

type LimitRange

type LimitRange struct {
	v1.LimitRange
	// contains filtered or unexported fields
}

type LineInfo

type LineInfo struct {
	StartLine int
	EndLine   int
}

type Namespace

type Namespace struct {
	v1.Namespace
	// contains filtered or unexported fields
}

type NetworkPolicy

type NetworkPolicy struct {
	v1.NetworkPolicy
	// contains filtered or unexported fields
}

type Node

type Node struct {
	v1.Node
	// contains filtered or unexported fields
}

type PersistentVolume

type PersistentVolume struct {
	v1.PersistentVolume
	// contains filtered or unexported fields
}

type PersistentVolumeClaim

type PersistentVolumeClaim struct {
	v1.PersistentVolumeClaim
	// contains filtered or unexported fields
}

type Pod

type Pod struct {
	v1.Pod
	// contains filtered or unexported fields
}

type PodDisruptionBudget

type PodDisruptionBudget struct {
	v1.PodDisruptionBudget
	// contains filtered or unexported fields
}

type PodSecurityPolicy

type PodSecurityPolicy struct {
	v1beta1.PodSecurityPolicy
	// contains filtered or unexported fields
}

type PodTemplate

type PodTemplate struct {
	v1.PodTemplate
	// contains filtered or unexported fields
}

type ReplicaSet

type ReplicaSet struct {
	v1.ReplicaSet
	// contains filtered or unexported fields
}

type ReplicationController

type ReplicationController struct {
	v1.ReplicationController
	// contains filtered or unexported fields
}

type ResourceQuota

type ResourceQuota struct {
	v1.ResourceQuota
	// contains filtered or unexported fields
}

type Role

type Role struct {
	v1.Role
	// contains filtered or unexported fields
}

type RoleBinding

type RoleBinding struct {
	v1.RoleBinding
	// contains filtered or unexported fields
}

type Row

type Row struct {
	Path        string
	Key         []string
	Value       interface{}
	Tag         *string
	PreComments []string
	HeadComment string
	LineComment string
	FootComment string
	StartLine   int
	StartColumn int
}

type Rows

type Rows []Row

type Secret

type Secret struct {
	v1.Secret
	// contains filtered or unexported fields
}

type Service

type Service struct {
	v1.Service
	// contains filtered or unexported fields
}

type ServiceAccount

type ServiceAccount struct {
	v1.ServiceAccount
	// contains filtered or unexported fields
}

type SourceType

type SourceType string

const (
	Deployed SourceType = "deployed"
	Helm     SourceType = "helm"
	Manifest SourceType = "manifest"
	All      SourceType = "all"
)

func (SourceType) IsValid

func (sourceType SourceType) IsValid() error

Validate the source type.

func (SourceType) String

func (sourceType SourceType) String() string

Convert the source type to its string equivalent

func (SourceType) ToSourceTypes

func (sourceType SourceType) ToSourceTypes() []string

ToSourceTypes is used to convert SourceType to []string

type StatefulSet

type StatefulSet struct {
	v1.StatefulSet
	// contains filtered or unexported fields
}

type StorageClass

type StorageClass struct {
	v1.StorageClass
	// contains filtered or unexported fields
}