function

Documentation

Index

• type Effects
• type GetDetails
• type ObjectToQuery
• type Query

Types

type Effects

type Effects struct {
	// Persists lists objects to persist: create or update.
	//
	// If an object is being updated, its UID field is recommended to be set (otherwise, the update costs an extra GET
	// request).
	//
	// OwnerReferences of persisted objects should have UID field set. The only exception is when an OwnerReference is to
	// an object being persisted in the same Persists list (and its UID is, obviously, not yet known). In such cases, the
	// owner object should come earlier in the Persists list, as it is processed sequentially.
	Persists []client.Object

	// Deletes lists objects to delete. Deletes are handled after Persists to allow for necessary preparation, like
	// removing finalizers. It is also processed sequentially.
	Deletes []client.Object
}

Effects specify the changes intended as results of the reconciler function.

type GetDetails

type GetDetails func(query Query) runtime.Object

GetDetails function is provided to the reconciler function. In tests, it's provided by the test. The returned result is either a client.Object or client.ObjectList

type ObjectToQuery

type ObjectToQuery func(obj client.Object) Query

type Query

type Query struct {
	Type      runtime.Object
	Namespace string
	Name      string
	Selector  labels.Selector
	Options   []client.ListOption
}

Query is a generalized API query - for either Get or List. The Type field is required, and MUST be an empty instance of a client.Object (if Name is non-empty) or client.ObjectList (Selector is an optional filter for the list). Options field is an optional list of []client.ListOption. Namespace and Selector values override those set by Options.