internal

Documentation

Index

• func FieldIndexName(field string) string
• func KeyToNamespacedKey(ns string, baseKey string) string
• type Cache
• type CacheReader
  • func (c *CacheReader) Get(_ context.Context, key client.ObjectKey, out client.Object, ...) error
  • func (c *CacheReader) List(_ context.Context, out client.ObjectList, opts ...client.ListOption) error
• type Informers
  • func NewInformers(config *rest.Config, options *InformersOpts) *Informers
  • func (ip *Informers) Get(ctx context.Context, gvk schema.GroupVersionKind, obj runtime.Object) (bool, *Cache, error)
  • func (ip *Informers) Start(ctx context.Context) error
  • func (ip *Informers) WaitForCacheSync(ctx context.Context) bool
• type InformersOpts
• type InformersOptsByGVK
• type Selector
  • func (s Selector) ApplyToList(listOpts *metav1.ListOptions)
• type TransformFuncByGVK
  • func TransformFuncByGVKFromMap(in map[schema.GroupVersionKind]cache.TransformFunc) TransformFuncByGVK

Functions

func FieldIndexName

func FieldIndexName(field string) string

FieldIndexName constructs the name of the index over the given field, for use with an indexer.

func KeyToNamespacedKey

func KeyToNamespacedKey(ns string, baseKey string) string

KeyToNamespacedKey prefixes the given index key with a namespace for use in field selector indexes.

Types

type Cache

type Cache struct {
	// Informer is the cached informer
	Informer cache.SharedIndexInformer

	// CacheReader wraps Informer and implements the CacheReader interface for a single type
	Reader CacheReader
}

Cache contains the cached data for an Cache.

type CacheReader

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

CacheReader wraps a cache.Index to implement the client.CacheReader interface for a single type.

func (*CacheReader) Get

func (c *CacheReader) Get(_ context.Context, key client.ObjectKey, out client.Object, opts ...client.GetOption) error

Get checks the indexer for the object and writes a copy of it if found.

func (*CacheReader) List

func (c *CacheReader) List(_ context.Context, out client.ObjectList, opts ...client.ListOption) error

List lists items out of the indexer and writes them to out.

type Informers

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

Informers create and caches Informers for (runtime.Object, schema.GroupVersionKind) pairs. It uses a standard parameter codec constructed based on the given generated Scheme.

func NewInformers

func NewInformers(config *rest.Config, options *InformersOpts) *Informers

NewInformers creates a new InformersMap that can create informers under the hood.

func (*Informers) Get

func (ip *Informers) Get(ctx context.Context, gvk schema.GroupVersionKind, obj runtime.Object) (bool, *Cache, error)

Get will create a new Informer and add it to the map of specificInformersMap if none exists. Returns the Informer from the map.

func (*Informers) Start

func (ip *Informers) Start(ctx context.Context) error

Start calls Run on each of the informers and sets started to true. Blocks on the context. It doesn't return start because it can't return an error, and it's not a runnable directly.

func (*Informers) WaitForCacheSync

func (ip *Informers) WaitForCacheSync(ctx context.Context) bool

WaitForCacheSync waits until all the caches have been started and synced.

type InformersOpts

type InformersOpts struct {
	HTTPClient   *http.Client
	Scheme       *runtime.Scheme
	Mapper       meta.RESTMapper
	ResyncPeriod time.Duration
	Namespace    string
	ByGVK        map[schema.GroupVersionKind]InformersOptsByGVK
}

InformersOpts configures an InformerMap.

type InformersOptsByGVK

type InformersOptsByGVK struct {
	Selector              Selector
	Transform             cache.TransformFunc
	UnsafeDisableDeepCopy *bool
}

InformersOptsByGVK configured additional by group version kind (or object) in an InformerMap.

type Selector

type Selector struct {
	Label labels.Selector
	Field fields.Selector
}

Selector specify the label/field selector to fill in ListOptions.

func (Selector) ApplyToList

func (s Selector) ApplyToList(listOpts *metav1.ListOptions)

ApplyToList fill in ListOptions LabelSelector and FieldSelector if needed.

type TransformFuncByGVK

type TransformFuncByGVK interface {
	Set(runtime.Object, *runtime.Scheme, cache.TransformFunc) error
	Get(schema.GroupVersionKind) cache.TransformFunc
	SetDefault(transformer cache.TransformFunc)
}

TransformFuncByGVK provides access to the correct transform function for any given GVK.

func TransformFuncByGVKFromMap

func TransformFuncByGVKFromMap(in map[schema.GroupVersionKind]cache.TransformFunc) TransformFuncByGVK

TransformFuncByGVKFromMap creates a TransformFuncByGVK from a map that maps GVKs to TransformFuncs.