reconcilers

Mar 11, 2024

Changes in this version

+ var IgnoreAllUnexported = cmp.FilterPath(func(p cmp.Path) bool { ... }, cmp.Ignore())

Dec 8, 2023

Changes in this version

+ func RetrieveKnownChildren[T client.Object](ctx context.Context) []T

Sep 12, 2023

Changes in this version

+ var ErrHaltSubReconcilers = fmt.Errorf("stop processing SubReconcilers, without returning an error: %w", ErrQuiet)

+ var ErrQuiet = fmt.Errorf("quiet errors are returned as errors, but not logged or recorded")

+ func RetrieveIteration(ctx context.Context) int

+ type ErrMaxIterations struct

+ Iterations int

+ func (err *ErrMaxIterations) Error() string

+ type IfThen struct

+ Else SubReconciler[Type]

+ If func(ctx context.Context, resource Type) bool

+ Name string

+ Setup func(ctx context.Context, mgr Manager, bldr *Builder) error

+ Then SubReconciler[Type]

+ func (r *IfThen[T]) Reconcile(ctx context.Context, resource T) (Result, error)

+ func (r *IfThen[T]) SetupWithManager(ctx context.Context, mgr ctrl.Manager, bldr *builder.Builder) error

+ type OverrideSetup struct

+ Name string

+ Reconciler SubReconciler[Type]

+ Setup func(ctx context.Context, mgr Manager, bldr *Builder) error

+ func (r *OverrideSetup[T]) Reconcile(ctx context.Context, resource T) (Result, error)

+ func (r *OverrideSetup[T]) SetupWithManager(ctx context.Context, mgr ctrl.Manager, bldr *builder.Builder) error

+ type TryCatch struct

+ Catch func(ctx context.Context, resource Type, result Result, err error) (Result, error)

+ Finally SubReconciler[Type]

+ Name string

+ Setup func(ctx context.Context, mgr Manager, bldr *Builder) error

+ Try SubReconciler[Type]

+ func (r *TryCatch[T]) Reconcile(ctx context.Context, resource T) (Result, error)

+ func (r *TryCatch[T]) SetupWithManager(ctx context.Context, mgr ctrl.Manager, bldr *builder.Builder) error

+ type While struct

+ Condition func(ctx context.Context, resource Type) bool

+ MaxIterations *int

+ Name string

+ Reconciler SubReconciler[Type]

+ Setup func(ctx context.Context, mgr Manager, bldr *Builder) error

+ func (r *While[T]) Reconcile(ctx context.Context, resource T) (Result, error)

+ func (r *While[T]) SetupWithManager(ctx context.Context, mgr ctrl.Manager, bldr *builder.Builder) error

Aug 7, 2023

Changes in this version

+ func ClearValue(ctx context.Context, key StashKey) interface

type ChildReconciler

+ func (r *ChildReconciler[T, CT, CLT]) SetResourceManager(rm *ResourceManager[CT])

+ type ChildSetPartialResult struct

+ Child T

+ Err error

+ Id string

+ type ChildSetReconciler struct

+ ChildListType ChildListType

+ ChildType ChildType

+ DesiredChildren func(ctx context.Context, resource Type) ([]ChildType, error)

+ Finalizer string

+ HarmonizeImmutableFields func(current, desired ChildType)

+ IdentifyChild func(child ChildType) string

+ ListOptions func(ctx context.Context, resource Type) []client.ListOption

+ MergeBeforeUpdate func(current, desired ChildType)

+ Name string

+ OurChild func(resource Type, child ChildType) bool

+ ReflectChildrenStatusOnParent func(ctx context.Context, parent Type, result ChildSetResult[ChildType])

+ Sanitize func(child ChildType) interface{}

+ Setup func(ctx context.Context, mgr ctrl.Manager, bldr *builder.Builder) error

+ SkipOwnerReference bool

+ func (r *ChildSetReconciler[T, CT, CLT]) Reconcile(ctx context.Context, resource T) (Result, error)

+ func (r *ChildSetReconciler[T, CT, CLT]) SetupWithManager(ctx context.Context, mgr ctrl.Manager, bldr *builder.Builder) error

+ type ChildSetResult struct

+ Children []ChildSetPartialResult[T]

+ func (r *ChildSetResult[T]) AggregateError() error

May 23, 2023

Changes in this version

type Config

+ func (c Config) TrackAndList(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error

+ type Request = reconcile.Request

type ResourceReconciler

+ SkipStatusUpdate bool

+ type Result = reconcile.Result

type SyncReconciler

+ FinalizeWithResult func(ctx context.Context, resource Type) (Result, error)

+ SyncWithResult func(ctx context.Context, resource Type) (Result, error)

Aug 23, 2022

Changes in this version

+ var HaltSubReconcilers = errors.New("stop processing SubReconcilers, without returning an error")

Jun 16, 2022

Changes in this version

+ func RetrieveAdditionalConfigs(ctx context.Context) map[string]Config

+ func RetrieveAdmissionRequest(ctx context.Context) admission.Request

+ func RetrieveAdmissionResponse(ctx context.Context) *admission.Response

+ func RetrieveHTTPRequest(ctx context.Context) *http.Request

+ func StashAdditionalConfigs(ctx context.Context, additionalConfigs map[string]Config) context.Context

+ func StashAdmissionRequest(ctx context.Context, req admission.Request) context.Context

+ func StashAdmissionResponse(ctx context.Context, resp *admission.Response) context.Context

+ func StashHTTPRequest(ctx context.Context, req *http.Request) context.Context

+ type AdmissionWebhookAdapter struct

+ Config Config

+ Name string

+ Reconciler SubReconciler

+ Type client.Object

+ func (r *AdmissionWebhookAdapter) Build() *admission.Webhook

+ func (r *AdmissionWebhookAdapter) Handle(ctx context.Context, req admission.Request) admission.Response

May 26, 2022

Changes in this version

+ func AddFinalizer(ctx context.Context, resource client.Object, finalizer string) error

+ func ClearFinalizer(ctx context.Context, resource client.Object, finalizer string) error

+ func RetrieveOriginalResourceType(ctx context.Context) client.Object

+ func RetrieveResourceType(ctx context.Context) client.Object

+ func StashOriginalConfig(ctx context.Context, resourceConfig Config) context.Context

+ func StashOriginalResourceType(ctx context.Context, resourceType client.Object) context.Context

+ func StashResourceType(ctx context.Context, currentType client.Object) context.Context

+ type AggregateReconciler struct

+ Config Config

+ DesiredResource interface{}

+ HarmonizeImmutableFields interface{}

+ MergeBeforeUpdate interface{}

+ Name string

+ Reconciler SubReconciler

+ Request ctrl.Request

+ Sanitize interface{}

+ SemanticEquals interface{}

+ Setup func(ctx context.Context, mgr ctrl.Manager, bldr *builder.Builder) error

+ Type client.Object

+ func (r *AggregateReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

+ func (r *AggregateReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error

+ func (r *AggregateReconciler) SetupWithManagerYieldingController(ctx context.Context, mgr ctrl.Manager) (controller.Controller, error)

+ type CastResource struct

+ Name string

+ Reconciler SubReconciler

+ Type client.Object

+ func (r *CastResource) Reconcile(ctx context.Context, resource client.Object) (ctrl.Result, error)

+ func (r *CastResource) SetupWithManager(ctx context.Context, mgr ctrl.Manager, bldr *builder.Builder) error

type Config

+ func RetrieveOriginalConfig(ctx context.Context) (Config, error)

+ func RetrieveOriginalConfigOrDie(ctx context.Context) Config

+ type ResourceManager struct

+ Finalizer string

+ HarmonizeImmutableFields interface{}

+ MergeBeforeUpdate interface{}

+ Name string

+ Sanitize interface{}

+ SemanticEquals interface{}

+ TrackDesired bool

+ Type client.Object

+ func (r *ResourceManager) Manage(ctx context.Context, resource, actual, desired client.Object) (client.Object, error)

+ func (r *ResourceManager) Setup(ctx context.Context) error

+ type ResourceReconciler struct

+ Config Config

+ Name string

+ Reconciler SubReconciler

+ Setup func(ctx context.Context, mgr ctrl.Manager, bldr *builder.Builder) error

+ Type client.Object

+ func (r *ResourceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

+ func (r *ResourceReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error

+ func (r *ResourceReconciler) SetupWithManagerYieldingController(ctx context.Context, mgr ctrl.Manager) (controller.Controller, error)

May 16, 2022

Changes in this version

+ func AddParentFinalizer(ctx context.Context, parent client.Object, finalizer string) error

+ func AggregateResults(results ...ctrl.Result) ctrl.Result

+ func ClearParentFinalizer(ctx context.Context, parent client.Object, finalizer string) error

+ func RetrieveRequest(ctx context.Context) ctrl.Request

+ func StashConfig(ctx context.Context, config Config) context.Context

+ func StashParentConfig(ctx context.Context, parentConfig Config) context.Context

+ func StashRequest(ctx context.Context, req ctrl.Request) context.Context

type CastParent

+ Name string

type ChildReconciler

+ Finalizer string

+ ListOptions interface{}

+ Name string

+ SkipOwnerReference bool

type Config

+ func RetrieveConfig(ctx context.Context) (Config, error)

+ func RetrieveConfigOrDie(ctx context.Context) Config

+ func RetrieveParentConfig(ctx context.Context) (Config, error)

+ func RetrieveParentConfigOrDie(ctx context.Context) Config

+ func (c Config) IsEmpty() bool

+ func (c Config) TrackAndGet(ctx context.Context, key types.NamespacedName, obj client.Object) error

+ func (c Config) WithCluster(cluster cluster.Cluster) Config

type ParentReconciler

+ Config Config

+ Name string

type SyncReconciler

+ Finalize interface{}

+ Name string

+ SyncDuringFinalization bool

+ type WithConfig struct

+ Config func(context.Context, Config) (Config, error)

+ Name string

+ Reconciler SubReconciler

+ func (r *WithConfig) Reconcile(ctx context.Context, parent client.Object) (ctrl.Result, error)

+ func (r *WithConfig) SetupWithManager(ctx context.Context, mgr ctrl.Manager, bldr *builder.Builder) error

+ type WithFinalizer struct

+ Finalizer string

+ Name string

+ Reconciler SubReconciler

+ func (r *WithFinalizer) Reconcile(ctx context.Context, parent client.Object) (ctrl.Result, error)

+ func (r *WithFinalizer) SetupWithManager(ctx context.Context, mgr ctrl.Manager, bldr *builder.Builder) error

May 5, 2021

Changes in this version

type ChildReconciler

+ OurChild interface{}

Dec 7, 2020

Changes in this version

+ var OnlyReconcileChildStatus = errors.New(...)

+ var PatchGenerationMismatch = errors.New("patch generation did not match target")

+ func RetrieveCastParentType(ctx context.Context) runtime.Object

+ func RetrieveParentType(ctx context.Context) runtime.Object

+ func StashCastParentType(ctx context.Context, currentType runtime.Object) context.Context

+ func StashParentType(ctx context.Context, parentType runtime.Object) context.Context

+ type CastParent struct

+ Reconciler SubReconciler

+ Type runtime.Object

+ func (r *CastParent) Reconcile(ctx context.Context, parent apis.Object) (ctrl.Result, error)

+ func (r *CastParent) SetupWithManager(ctx context.Context, mgr ctrl.Manager, bldr *builder.Builder) error

type Config

+ func NewConfig(mgr ctrl.Manager, apiType runtime.Object, syncPeriod time.Duration) Config

type ParentReconciler

+ Reconciler SubReconciler

+ type Patch struct

+ func NewPatch(base, update apis.Object) (*Patch, error)

+ func (p *Patch) Apply(rebase apis.Object) error

+ type Sequence []SubReconciler

+ func (r Sequence) Reconcile(ctx context.Context, parent apis.Object) (ctrl.Result, error)

+ func (r Sequence) SetupWithManager(ctx context.Context, mgr ctrl.Manager, bldr *builder.Builder) error

Jun 26, 2020

Changes in this version

+ func EnqueueTracked(by runtime.Object, t tracker.Tracker, s *runtime.Scheme) *handler.EnqueueRequestsFromMapFunc

+ func IndexControllersOfType(mgr ctrl.Manager, field string, owner, ownee runtime.Object, ...) error

+ func MergeMaps(maps ...map[string]string) map[string]string

+ func RetrieveValue(ctx context.Context, key StashKey) interface

+ func StashValue(ctx context.Context, key StashKey, value interface{})

+ func WithStash(ctx context.Context) context.Context

+ type Builder = builder.Builder

+ type ChildReconciler struct

+ ChildListType runtime.Object

+ ChildType apis.Object

+ DesiredChild interface{}

+ HarmonizeImmutableFields interface{}

+ IndexField string

+ MergeBeforeUpdate interface{}

+ ParentType apis.Object

+ ReflectChildStatusOnParent interface{}

+ Sanitize interface{}

+ SemanticEquals interface{}

+ Setup func(mgr ctrl.Manager, bldr *builder.Builder) error

+ func (r *ChildReconciler) Reconcile(ctx context.Context, parent apis.Object) (ctrl.Result, error)

+ func (r *ChildReconciler) SetupWithManager(mgr ctrl.Manager, bldr *builder.Builder) error

+ type Config struct

+ APIReader client.Reader

+ Log logr.Logger

+ Recorder record.EventRecorder

+ Scheme *runtime.Scheme

+ Tracker tracker.Tracker

+ type Kind = source.Kind

+ type Manager = manager.Manager

+ type ParentReconciler struct

+ SubReconcilers []SubReconciler

+ Type runtime.Object

+ func (r *ParentReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error)

+ func (r *ParentReconciler) SetupWithManager(mgr ctrl.Manager) error

+ type StashKey string

+ type SubReconciler interface

+ Reconcile func(ctx context.Context, parent apis.Object) (ctrl.Result, error)

+ SetupWithManager func(mgr ctrl.Manager, bldr *builder.Builder) error

+ type SyncReconciler struct

+ Setup func(mgr ctrl.Manager, bldr *builder.Builder) error

+ Sync interface{}

+ func (r *SyncReconciler) Reconcile(ctx context.Context, parent apis.Object) (ctrl.Result, error)

+ func (r *SyncReconciler) SetupWithManager(mgr ctrl.Manager, bldr *builder.Builder) error