cache

Documentation

Overview

Package cache provides object caches that act as caching client.Reader instances and help drive Kubernetes-object-based event handlers.

Index

• func New(config *rest.Config, opts cache.Options) (cache.Cache, error)
• type ErrCacheNotStarted
  • func (*ErrCacheNotStarted) Error() string
• type NewCacheFunc
  • func MultiNamespacedCacheBuilder(namespaces []string) NewCacheFunc

Functions

func New

func New(config *rest.Config, opts cache.Options) (cache.Cache, error)

New initializes and returns a new Cache.

Types

type ErrCacheNotStarted

type ErrCacheNotStarted struct{}

ErrCacheNotStarted is returned when trying to read from the cache that wasn't started.

func (*ErrCacheNotStarted) Error

func (*ErrCacheNotStarted) Error() string

type NewCacheFunc

type NewCacheFunc func(config *rest.Config, opts k8s_cache.Options) (k8s_cache.Cache, error)

NewCacheFunc - Function for creating a new cache from the options and a rest config

func MultiNamespacedCacheBuilder

func MultiNamespacedCacheBuilder(namespaces []string) NewCacheFunc

MultiNamespacedCacheBuilder - Builder function to create a new multi-namespaced cache. This will scope the cache to a list of namespaces. Listing for all namespaces will list for all the namespaces that this knows about. Note that this is not intended to be used for excluding namespaces, this is better done via a Predicate. Also note that you may face performance issues when using this with a high number of namespaces.