discovery

Documentation

Index

• Variables
• func NewNodeLister(client kubernetes.Interface, options ...informers.SharedInformerOption) (listersv1.NodeLister, chan<- struct{})
• func NewServicesLister(client kubernetes.Interface, options ...informers.SharedInformerOption) (listersv1.ServiceLister, chan<- struct{})
• type CachedNamespaceFilter
  • func NewCachedNamespaceFilter(filter NamespaceFilterer, cache NamespaceCache) *CachedNamespaceFilter
  • func (cm *CachedNamespaceFilter) IsAllowed(namespace string) bool
• type EndpointsDiscoverer
  • func NewEndpointsDiscoverer(config EndpointsDiscoveryConfig) (EndpointsDiscoverer, error)
• type EndpointsDiscovererWithTimeout
  • func (edt *EndpointsDiscovererWithTimeout) Discover() ([]string, error)
• type EndpointsDiscoveryConfig
• type MultiNamespacePodListerer
  • func NewNamespacePodListerer(config PodListererConfig) (*MultiNamespacePodListerer, chan<- struct{})
  • func (l MultiNamespacePodListerer) Lister(namespace string) (listersv1.PodNamespaceLister, bool)
• type MultiNamespaceSecretListerer
  • func NewNamespaceSecretListerer(config SecretListererConfig) (*MultiNamespaceSecretListerer, chan<- struct{})
  • func (l MultiNamespaceSecretListerer) Lister(namespace string) (listersv1.SecretNamespaceLister, bool)
• type NamespaceCache
• type NamespaceFilter
  • func NewNamespaceFilter(c *config.NamespaceSelector, client kubernetes.Interface, logger *log.Logger, ...) *NamespaceFilter
  • func (nf *NamespaceFilter) Close() error
  • func (nf *NamespaceFilter) IsAllowed(namespace string) bool
• type NamespaceFilterer
• type NamespaceInMemoryStore
  • func NewNamespaceInMemoryStore(logger *logrus.Logger) *NamespaceInMemoryStore
  • func (m *NamespaceInMemoryStore) Match(namespace string) (bool, bool)
  • func (m *NamespaceInMemoryStore) Put(namespace string, match bool)
  • func (m *NamespaceInMemoryStore) Vacuum()
• type PodListerer
• type PodListererConfig
• type SecretListerer
• type SecretListererConfig

Variables

var ErrDiscoveryTimeout = errors.New("timeout discovering endpoints")

ErrDiscoveryTimeout is returned by EndpointsDiscovererWithTimeout when discovery times out

Functions

func NewNodeLister

func NewNodeLister(client kubernetes.Interface, options ...informers.SharedInformerOption) (listersv1.NodeLister, chan<- struct{})

NewNodeLister returns a NodeGetter to get nodes with informers.

func NewServicesLister

func NewServicesLister(client kubernetes.Interface, options ...informers.SharedInformerOption) (listersv1.ServiceLister, chan<- struct{})

Types

type CachedNamespaceFilter

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

CachedNamespaceFilter holds a NamespaceCache around the NamespaceFilterer.

func NewCachedNamespaceFilter

func NewCachedNamespaceFilter(filter NamespaceFilterer, cache NamespaceCache) *CachedNamespaceFilter

NewCachedNamespaceFilter create a new CachedNamespaceFilter, wrapping the cache and the NamespaceFilterer.

func (*CachedNamespaceFilter) IsAllowed

func (cm *CachedNamespaceFilter) IsAllowed(namespace string) bool

IsAllowed looks for a match in the cache first, otherwise calls the filter.

type EndpointsDiscoverer

type EndpointsDiscoverer interface {
	Discover() ([]string, error)
}

func NewEndpointsDiscoverer

func NewEndpointsDiscoverer(config EndpointsDiscoveryConfig) (EndpointsDiscoverer, error)

type EndpointsDiscovererWithTimeout

type EndpointsDiscovererWithTimeout struct {
	EndpointsDiscoverer
	BackoffDelay time.Duration
	Timeout      time.Duration
}

EndpointsDiscovererWithTimeout implements EndpointsDiscoverer with a retry mechanism if no endpoints are found.

func (*EndpointsDiscovererWithTimeout) Discover

func (edt *EndpointsDiscovererWithTimeout) Discover() ([]string, error)

Discover will call poll the inner EndpointsDiscoverer every BackoffDelay seconds up to a max of Retries times until it returns an error, or a non-empty list of endpoints. If the max number of Retries is exceeded, it will return ErrDiscoveryTimeout.

type EndpointsDiscoveryConfig

type EndpointsDiscoveryConfig struct {
	// LabelSelector is the selector used to filter Endpoints.
	LabelSelector string
	// Namespace can be used to restric the search to a particular namespace.
	Namespace string
	// If set, Port will discard all endpoints discovered that do not use this specified port
	Port int

	// Client is the Kubernetes client.Interface used to build informers.
	Client kubernetes.Interface
}

type MultiNamespacePodListerer

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

MultiNamespacePodListerer implements PodListerer interface for a group of listers pre-build on initialization.

func NewNamespacePodListerer

func NewNamespacePodListerer(config PodListererConfig) (*MultiNamespacePodListerer, chan<- struct{})

NewNamespacePodListerer returns a MultiNamespacePodListerer with listers for all namespaces on config.Namespaces.

func (MultiNamespacePodListerer) Lister

func (l MultiNamespacePodListerer) Lister(namespace string) (listersv1.PodNamespaceLister, bool)

Lister returns the available lister based on the namespace if exists in the listerer.

type MultiNamespaceSecretListerer

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

MultiNamespaceSecretListerer implements SecretListerer interface for a group of listers pre-build on initialization.

func NewNamespaceSecretListerer

func NewNamespaceSecretListerer(config SecretListererConfig) (*MultiNamespaceSecretListerer, chan<- struct{})

NewNamespaceSecretListerer returns a MultiNamespaceSecretListerer with listers for all namespaces on config.Namespaces.

func (MultiNamespaceSecretListerer) Lister

func (l MultiNamespaceSecretListerer) Lister(namespace string) (listersv1.SecretNamespaceLister, bool)

Lister returns the available lister based on the namespace if exists in the listerer.

type NamespaceCache

type NamespaceCache interface {
	Put(namespace string, match bool)
	Match(namespace string) (bool, bool)
	Vacuum()
}

NamespaceCache provides an interface to add and retrieve namespaces from the cache.

type NamespaceFilter

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

NamespaceFilter is a struct holding pointers to the config and the namespace lister.

func NewNamespaceFilter

func NewNamespaceFilter(c *config.NamespaceSelector, client kubernetes.Interface, logger *log.Logger, options ...informers.SharedInformerOption) *NamespaceFilter

NewNamespaceFilter inits the namespace lister and returns a new NamespaceFilter.

func (*NamespaceFilter) Close

func (nf *NamespaceFilter) Close() error

Close closes the stop channel and implements the Closer interface.

func (*NamespaceFilter) IsAllowed

func (nf *NamespaceFilter) IsAllowed(namespace string) bool

IsAllowed checks if a namespace is allowed to be scraped given a certain match labels or expressions configuration.

type NamespaceFilterer

type NamespaceFilterer interface {
	IsAllowed(namespace string) bool
}

NamespaceFilterer provides an interface to filter from a given namespace.

type NamespaceInMemoryStore

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

func NewNamespaceInMemoryStore

func NewNamespaceInMemoryStore(logger *logrus.Logger) *NamespaceInMemoryStore

func (*NamespaceInMemoryStore) Match

func (m *NamespaceInMemoryStore) Match(namespace string) (bool, bool)

func (*NamespaceInMemoryStore) Put

func (m *NamespaceInMemoryStore) Put(namespace string, match bool)

func (*NamespaceInMemoryStore) Vacuum

func (m *NamespaceInMemoryStore) Vacuum()

Vacuum removes the cached data entries on each interval.

type PodListerer

type PodListerer interface {
	// Lister ruturns the pod lister for the specified namespaces
	// and true if the lister exist in the listerer.
	Lister(namespace string) (listersv1.PodNamespaceLister, bool)
}

PodListerer return namespaced pod listers.

type PodListererConfig

type PodListererConfig struct {
	// Namespaces supported by the listerer.
	Namespaces []string
	// Client is the Kubernetes client.Interface used to build informers.
	Client kubernetes.Interface
}

type SecretListerer

type SecretListerer interface {
	// Lister ruturns the secret lister for the specified namespaces
	// and true if the lister exist in the listerer.
	Lister(namespace string) (listersv1.SecretNamespaceLister, bool)
}

SecretListerer return namespaced secret listers.

type SecretListererConfig

type SecretListererConfig struct {
	// Namespaces supported by the listerer.
	Namespaces []string
	// Client is the Kubernetes client.Interface used to build informers.
	Client kubernetes.Interface
}