indexer

package

v0.33.13 Latest Latest Go to latest Published: Apr 26, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

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.

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

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(scheme *runtime.Scheme, keyFuncs ...KeyFunc) *Indexer

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 (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 (m *Indexer) EnqueueKey(key Key) []reconcile.Request

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

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

Register the watched object for the given primary object.

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

A key to help index objects we watch.

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

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

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

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

func NewRequeuer() *Requeuer

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

func (s *Requeuer) Start(ctx context.Context, q workqueue.RateLimitingInterface) error