store

Documentation

Index

• type ConfigMapLister
  • func (cml *ConfigMapLister) ByKey(key string) (*apiv1.ConfigMap, error)
• type EndpointLister
  • func (s *EndpointLister) ByKey(key string) (*apiv1.Endpoints, error)
• type Event
• type EventType
• type Informer
  • func (i *Informer) Run(stopCh chan struct{})
• type IngressFilterFunc
• type IngressLister
  • func (il IngressLister) ByKey(key string) (*networking.Ingress, error)
• type IngressWithAnnotationsLister
  • func (il IngressWithAnnotationsLister) ByKey(key string) (*ingress.Ingress, error)
• type Lister
• type NotExistsError
  • func (e NotExistsError) Error() string
• type PodLister
• type ServiceLister
  • func (sl *ServiceLister) ByKey(key string) (*apiv1.Service, error)
• type Storer
  • func New(namespace string, client clientset.Interface, fs file.Filesystem, ...) Storer

Types

type ConfigMapLister

type ConfigMapLister struct {
	cache.Store
}

ConfigMapLister makes a Store that lists Configmaps.

func (*ConfigMapLister) ByKey

func (cml *ConfigMapLister) ByKey(key string) (*apiv1.ConfigMap, error)

ByKey returns the ConfigMap matching key in the local ConfigMap Store.

type EndpointLister

type EndpointLister struct {
	cache.Store
}

EndpointLister makes a Store that lists Endpoints.

func (*EndpointLister) ByKey

func (s *EndpointLister) ByKey(key string) (*apiv1.Endpoints, error)

ByKey returns the Endpoints of the Service matching key in the local Endpoint Store.

type Event

type Event struct {
	Type EventType
	Obj  interface{}
}

Event holds the context of an event.

type EventType

type EventType string

EventType type of event associated with an informer

const (
	// CreateEvent event associated with new objects in an informer
	CreateEvent EventType = "CREATE"
	// UpdateEvent event associated with an object update in an informer
	UpdateEvent EventType = "UPDATE"
	// DeleteEvent event associated when an object is removed from an informer
	DeleteEvent EventType = "DELETE"
)

type Informer

type Informer struct {
	Ingress  cache.SharedIndexInformer
	Endpoint cache.SharedIndexInformer
	Service  cache.SharedIndexInformer
	Pod      cache.SharedIndexInformer
}

Informer defines the required SharedIndexInformers that interact with the API server.

func (*Informer) Run

func (i *Informer) Run(stopCh chan struct{})

Run initiates the synchronization of the informers against the API server.

type IngressFilterFunc

type IngressFilterFunc func(*ingress.Ingress) bool

IngressFilterFunc decides if an Ingress should be omitted or not

type IngressLister

type IngressLister struct {
	cache.Store
}

IngressLister makes a Store that lists Ingress.

func (IngressLister) ByKey

func (il IngressLister) ByKey(key string) (*networking.Ingress, error)

ByKey returns the Ingress matching key in the local Ingress Store.

type IngressWithAnnotationsLister

type IngressWithAnnotationsLister struct {
	cache.Store
}

IngressWithAnnotationsLister makes a Store that lists Ingress rules with annotations already parsed

func (IngressWithAnnotationsLister) ByKey

func (il IngressWithAnnotationsLister) ByKey(key string) (*ingress.Ingress, error)

ByKey returns the Ingress with annotations matching key in the local store or an error

type Lister

type Lister struct {
	Ingress               IngressLister
	Service               ServiceLister
	Endpoint              EndpointLister
	IngressWithAnnotation IngressWithAnnotationsLister
	Pod                   PodLister
}

Lister contains object listers (stores).

type NotExistsError

type NotExistsError string

NotExistsError is returned when an object does not exist in a local store.

func (NotExistsError) Error

func (e NotExistsError) Error() string

Error implements the error interface.

type PodLister

type PodLister struct {
	cache.Store
}

PodLister makes a Store that lists Pods.

type ServiceLister

type ServiceLister struct {
	cache.Store
}

ServiceLister makes a Store that lists Services.

func (*ServiceLister) ByKey

func (sl *ServiceLister) ByKey(key string) (*apiv1.Service, error)

ByKey returns the Service matching key in the local Service Store.

type Storer

type Storer interface {
	// GetService returns the Service matching key.
	GetService(key string) (*corev1.Service, error)

	// GetServiceEndpoints returns the Endpoints of a Service matching key.
	GetServiceEndpoints(key string) (*corev1.Endpoints, error)

	// ListIngresses returns a list of all Ingresses in the store.
	ListIngresses(IngressFilterFunc) []*ingress.Ingress

	// GetRunningControllerPodsCount returns the number of Running ingress-nginx controller Pods.
	GetRunningControllerPodsCount() int

	// Run initiates the synchronization of the controllers
	Run(stopCh chan struct{})
}

Storer is the interface that wraps the required methods to gather information about ingresses, services, secrets and ingress annotations.

func New

func New(namespace string,
	client clientset.Interface,
	fs file.Filesystem,
	updateCh *channels.RingChannel,
	pod *k8s.PodInfo) Storer

New creates a new object store to be used in the ingress controller