indexer

Documentation

Index

• func ListOwnedBy(ctx context.Context, client ctrlclient.Client, list ctrlclient.ObjectList, ...) error
• func StartSourceForTesting(ctx context.Context, s source.Source, reconciler reconcile.Reconciler, ...)
• type Indexer
  • func NewIndexer(scheme *runtime.Scheme, keyFuncs ...KeyFunc) *Indexer
  • func (m *Indexer) AddKeyFunc(fn KeyFunc)
  • func (m *Indexer) Enqueue(ctx context.Context, obj client.Object) []reconcile.Request
  • func (m *Indexer) EnqueueKey(key Key) []reconcile.Request
  • func (m *Indexer) OnReconcile(name types.NamespacedName, obj client.Object)
• type Key
• type KeyFunc
• type RequeueForTestResult
• type Requeuer
  • func NewRequeuer() *Requeuer
  • func (s *Requeuer) Add(nn types.NamespacedName)
  • func (s *Requeuer) Start(ctx context.Context, q workqueue.TypedRateLimitingInterface[reconcile.Request]) error

Functions

func ListOwnedBy

func ListOwnedBy(ctx context.Context, client ctrlclient.Client, list ctrlclient.ObjectList, nn types.NamespacedName, ownerType metav1.TypeMeta) error

List all the objects owned by the given object type.

This allows us to use owner-based indexing in tests without incurring the overhead of caching.

See discussion here: https://github.com/tilt-dev/tilt/issues/4719

func StartSourceForTesting

func StartSourceForTesting(
	ctx context.Context,
	s source.Source,
	reconciler reconcile.Reconciler,
	resultChan chan RequeueForTestResult,
)

Types

type Indexer

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

Helper struct to help reconcilers determine when to start their objects when a dependency triggers.

func NewIndexer

func NewIndexer(scheme *runtime.Scheme, keyFuncs ...KeyFunc) *Indexer

func (*Indexer) AddKeyFunc

func (m *Indexer) AddKeyFunc(fn KeyFunc)

AddKeyFunc registers a new indexer function.

In practice, all KeyFunc indexer functions should be added before or during controller initialization to avoid missed updates.

func (*Indexer) Enqueue

func (m *Indexer) Enqueue(ctx context.Context, obj client.Object) []reconcile.Request

Given an update of a watched object, return the names of objects watching it that we need to reconcile.

func (*Indexer) EnqueueKey

func (m *Indexer) EnqueueKey(key Key) []reconcile.Request

EnqueueKey() when we don't have the full object, only the name and kind.

func (*Indexer) OnReconcile

func (m *Indexer) OnReconcile(name types.NamespacedName, obj client.Object)

Register the watched object for the given primary object.

type Key

type Key struct {
	Name types.NamespacedName
	GVK  schema.GroupVersionKind
}

A key to help index objects we watch.

type KeyFunc

type KeyFunc func(obj client.Object) []Key

type RequeueForTestResult

type RequeueForTestResult struct {
	ObjName types.NamespacedName
	Error   error
	Result  reconcile.Result
}

type Requeuer

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

Small helper class for triggering a Reconcile() from a goroutine.

func NewRequeuer

func NewRequeuer() *Requeuer

func (*Requeuer) Add

func (s *Requeuer) Add(nn types.NamespacedName)

func (*Requeuer) Start

func (s *Requeuer) Start(ctx context.Context, q workqueue.TypedRateLimitingInterface[reconcile.Request]) error