k8s

Documentation

Overview

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

Index

• Variables
• func NewClientSet(kubeconfigPath string) (kubernetes.Interface, error)
• func NewDiscoveryClient(kubeconfigPath string) (*discovery.DiscoveryClient, error)
• func NewDynamicClient(kubeconfigPath string) (dynamic.Interface, error)
• func Redact(fields []FieldPath, resource *unstructured.Unstructured) error
• func RemoveTypedKeys(excludeAnnotKeys []*regexp.Regexp, m map[string]string)
• func RemoveUnstructuredKeys(excludeKeys []*regexp.Regexp, obj *unstructured.Unstructured, path ...string)
• func Select(fields []FieldPath, 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{}, int, 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{}, int, error)
  • func (g *DataGathererDynamic) Run(stopCh <-chan struct{}) error
  • func (g *DataGathererDynamic) WaitForCacheSync(stopCh <-chan struct{}) error
• type FieldPath

Variables

var ErrCacheSyncTimeout = fmt.Errorf("timed out waiting for Kubernetes cache to sync")

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

RedactFields are removed from all objects

var RouteSelectedFields = []FieldPath{
	{"kind"},
	{"apiVersion"},
	{"metadata", "annotations"},
	{"metadata", "name"},
	{"metadata", "namespace"},
	{"metadata", "ownerReferences"},
	{"metadata", "selfLink"},
	{"metadata", "uid"},

	{"spec", "host"},
	{"spec", "to", "kind"},
	{"spec", "to", "name"},
	{"spec", "to", "weight"},
	{"spec", "tls", "termination"},
	{"spec", "tls", "certificate"},
	{"spec", "tls", "caCertificate"},
	{"spec", "tls", "destinationCACertificate"},
	{"spec", "tls", "insecureEdgeTerminationPolicy"},
	{"spec", "wildcardPolicy"},
	{"status"},
}

RouteSelectedFields is the list of fields sent from OpenShift Route objects to the backend

var SecretSelectedFields = []FieldPath{
	{"kind"},
	{"apiVersion"},
	{"metadata", "annotations"},
	{"metadata", "labels"},
	{"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 NewClientSet

func NewClientSet(kubeconfigPath string) (kubernetes.Interface, error)

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

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 []FieldPath, resource *unstructured.Unstructured) error

Redact removes the supplied fields from the resource

func RemoveTypedKeys

func RemoveTypedKeys(excludeAnnotKeys []*regexp.Regexp, m map[string]string)

Meant for typed clientset objects.

func RemoveUnstructuredKeys

func RemoveUnstructuredKeys(excludeKeys []*regexp.Regexp, obj *unstructured.Unstructured, path ...string)

Meant for unstructured clientset objects. Removes the keys from the field given as input. For example, let's say we have the following object:

{
  "metadata": {
    "annotations": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Then, the following call:

RemoveUnstructuredKeys("^key1$", obj, "metadata", "annotations")

Will result in:

{
  "metadata": {
    "annotations": {"key2": "value2"}
  }
}

If the given path doesn't exist or leads to a non-map object, nothing happens. The leaf object must either be a map[string]interface{} (that's what's returned by the unstructured clientset) or a map[string]string (that's what's returned by the typed clientset).

func Select

func Select(fields []FieldPath, 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"`
	// FieldSelectors is a list of field selectors to use when listing this resource
	FieldSelectors []string `yaml:"field-selectors"`
}

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

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{}, int, 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 {
	ExcludeAnnotKeys []*regexp.Regexp
	ExcludeLabelKeys []*regexp.Regexp
	// 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{}, int, 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, Run blocks until the stopCh is closed.

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. Use errors.Is(err, ErrCacheSyncTimeout) to check if the cache sync failed.

type FieldPath

type FieldPath []string