k8s

Documentation

Overview

Package k8s provides datagatherers for different parts of the Kubernetes API.

Index

• Variables
• func NewDiscoveryClient(kubeconfigPath string) (discovery.DiscoveryClient, error)
• func NewDynamicClient(kubeconfigPath string) (dynamic.Interface, error)
• func Redact(fields []string, resource *unstructured.Unstructured) error
• func Select(fields []string, resource *unstructured.Unstructured) error
• type ConfigDiscovery
  • func (c *ConfigDiscovery) NewDataGatherer(ctx context.Context) (datagatherer.DataGatherer, error)
  • func (c *ConfigDiscovery) UnmarshalYAML(unmarshal func(interface{}) error) error
• type ConfigDynamic
  • func (c *ConfigDynamic) NewDataGatherer(ctx context.Context) (datagatherer.DataGatherer, error)
  • func (c *ConfigDynamic) UnmarshalYAML(unmarshal func(interface{}) error) error
• type DataGathererDiscovery
  • func (g *DataGathererDiscovery) Delete() error
  • func (g *DataGathererDiscovery) Fetch() (interface{}, error)
  • func (g *DataGathererDiscovery) Run(stopCh <-chan struct{}) error
  • func (g *DataGathererDiscovery) WaitForCacheSync(stopCh <-chan struct{}) error
• type DataGathererDynamic
  • func (g *DataGathererDynamic) Delete() error
  • func (g *DataGathererDynamic) Fetch() (interface{}, error)
  • func (g *DataGathererDynamic) Run(stopCh <-chan struct{}) error
  • func (g *DataGathererDynamic) WaitForCacheSync(stopCh <-chan struct{}) error

Variables

var RedactFields = []string{
	"metadata.managedFields",
	"/metadata/annotations/kubectl.kubernetes.io~1last-applied-configuration",
}

RedactFields are removed from all objects

var SecretSelectedFields = []string{
	"kind",
	"apiVersion",
	"metadata.name",
	"metadata.namespace",
	"metadata.ownerReferences",
	"metadata.selfLink",
	"metadata.uid",
	"type",
	"/data/tls.crt",
	"/data/ca.crt",
}

SecretSelectedFields is the list of fields sent from Secret objects to the backend

Functions

func NewDiscoveryClient

func NewDiscoveryClient(kubeconfigPath string) (discovery.DiscoveryClient, error)

NewDiscoveryClient creates a new 'discovery' client using the provided kubeconfig. If kubeconfigPath is not set/empty, it will attempt to load configuration using the default loading rules.

func NewDynamicClient

func NewDynamicClient(kubeconfigPath string) (dynamic.Interface, error)

NewDynamicClient creates a new 'dynamic' clientset using the provided kubeconfig. If kubeconfigPath is not set/empty, it will attempt to load configuration using the default loading rules.

func Redact

func Redact(fields []string, resource *unstructured.Unstructured) error

Redact removes the supplied fields from the resource

func Select

func Select(fields []string, resource *unstructured.Unstructured) error

Select removes all but the supplied fields from the resource

Types

type ConfigDiscovery

type ConfigDiscovery struct {
	// KubeConfigPath is the path to the kubeconfig file. If empty, will assume it runs in-cluster.
	KubeConfigPath string `yaml:"kubeconfig"`
}

ConfigDiscovery contains the configuration for the k8s-discovery data-gatherer

func (*ConfigDiscovery) NewDataGatherer

func (c *ConfigDiscovery) NewDataGatherer(ctx context.Context) (datagatherer.DataGatherer, error)

NewDataGatherer constructs a new instance of the generic K8s data-gatherer for the provided GroupVersionResource.

func (*ConfigDiscovery) UnmarshalYAML

func (c *ConfigDiscovery) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML unmarshals the Config resolving GroupVersionResource.

type ConfigDynamic

type ConfigDynamic struct {
	// KubeConfigPath is the path to the kubeconfig file. If empty, will assume it runs in-cluster.
	KubeConfigPath string `yaml:"kubeconfig"`
	// GroupVersionResource identifies the resource type to gather.
	GroupVersionResource schema.GroupVersionResource
	// ExcludeNamespaces is a list of namespaces to exclude.
	ExcludeNamespaces []string `yaml:"exclude-namespaces"`
	// IncludeNamespaces is a list of namespaces to include.
	IncludeNamespaces []string `yaml:"include-namespaces"`
}

ConfigDynamic contains the configuration for the data-gatherer.

func (*ConfigDynamic) NewDataGatherer

func (c *ConfigDynamic) NewDataGatherer(ctx context.Context) (datagatherer.DataGatherer, error)

NewDataGatherer constructs a new instance of the generic K8s data-gatherer for the provided GroupVersionResource.

func (*ConfigDynamic) UnmarshalYAML

func (c *ConfigDynamic) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML unmarshals the ConfigDynamic resolving GroupVersionResource.

type DataGathererDiscovery

type DataGathererDiscovery struct {
	// contains filtered or unexported fields
}

DataGathererDiscovery stores the config for a k8s-discovery datagatherer

func (*DataGathererDiscovery) Delete

func (g *DataGathererDiscovery) Delete() error

func (*DataGathererDiscovery) Fetch

func (g *DataGathererDiscovery) Fetch() (interface{}, error)

Fetch will fetch discovery data from the apiserver, or return an error

func (*DataGathererDiscovery) Run

func (g *DataGathererDiscovery) Run(stopCh <-chan struct{}) error

func (*DataGathererDiscovery) WaitForCacheSync

func (g *DataGathererDiscovery) WaitForCacheSync(stopCh <-chan struct{}) error

type DataGathererDynamic

type DataGathererDynamic struct {
	// contains filtered or unexported fields
}

DataGathererDynamic is a generic gatherer for Kubernetes. It knows how to request a list of generic resources from the Kubernetes apiserver. It does not deserialize the objects into structured data, instead utilising the Kubernetes `Unstructured` type for data handling. This is to allow us to support arbitrary CRDs and resources that Preflight does not have registered as part of its `runtime.Scheme`.

func (*DataGathererDynamic) Delete

func (g *DataGathererDynamic) Delete() error

Delete will flush the cache being used to stored resources gathered by the informer

func (*DataGathererDynamic) Fetch

func (g *DataGathererDynamic) Fetch() (interface{}, error)

Fetch will fetch the requested data from the apiserver, or return an error if fetching the data fails.

func (*DataGathererDynamic) Run

func (g *DataGathererDynamic) Run(stopCh <-chan struct{}) error

Run starts the dynamic data gatherer's informers for resource collection. Returns error if the data gatherer informer wasn't initialized

func (*DataGathererDynamic) WaitForCacheSync

func (g *DataGathererDynamic) WaitForCacheSync(stopCh <-chan struct{}) error

WaitForCacheSync waits for the data gatherer's informers cache to sync before collecting the resources.