kubernetes

Documentation

Overview

Package kubernetes contains an observer that watches the Kubernetes API for pods that are running on the same node as the agent. It uses the streaming watch API in K8s so that updates are seen immediately without any polling interval.

Index

• type AnnotationConfig
• type AnnotationConfigs
  • func (ac AnnotationConfigs) FilterByPortOrPortName(port int32, portName string) (out AnnotationConfigs)
• type Config
  • func (c *Config) Validate() error
• type Observer
  • func (o *Observer) Configure(config *Config) error
  • func (o *Observer) Shutdown()

Types

type AnnotationConfig

type AnnotationConfig struct {
	AnnotationKey string
	// The type of annotation
	Type string
	// Either the port number or name must be specified
	Port     int32
	PortName string
	// The config key that this will result in when configuring a monitor
	ConfigKey string
	Value     string
}

AnnotationConfig is a generic struct that can describe any of the annotation config values we support.

type AnnotationConfigs

type AnnotationConfigs []*AnnotationConfig

AnnotationConfigs is a slice of AnnotationConfig with some helper methods for filtering.

func (AnnotationConfigs) FilterByPortOrPortName

func (ac AnnotationConfigs) FilterByPortOrPortName(port int32, portName string) (out AnnotationConfigs)

FilterByPortOrPortName returns all AnnotationConfig instances that match either the port number or port name.

type Config

type Config struct {
	config.ObserverConfig
	// If specified, only pods within the given namespace on the same node as
	// the agent will be discovered. If blank, all pods on the same node as the
	// agent will be discovered.
	Namespace string `yaml:"namespace"`
	// Configuration for the K8s API client
	KubernetesAPI *kubernetes.APIConfig `yaml:"kubernetesAPI" default:"{}"`
}

Config for Kubernetes API observer

func (*Config) Validate

func (c *Config) Validate() error

Validate the observer-specific config

type Observer

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

Observer that watches the Kubernetes API for new pods pertaining to this node

func (*Observer) Configure

func (o *Observer) Configure(config *Config) error

Configure configures and starts watching for endpoints

func (*Observer) Shutdown

func (o *Observer) Shutdown()

Shutdown the service differ routine