generic

Documentation

Index

• func RegisterBackwardSyncer(ctx *context.ControllerContext, syncer Syncer, name string, ...) error
• func RegisterClusterSyncer(ctx *context.ControllerContext, clusterSyncer ClusterSyncer, name string) error
• func RegisterFakeSyncer(ctx *context.ControllerContext, syncer FakeSyncer, name string) error
• func RegisterForwardSyncer(ctx *context.ControllerContext, syncer Syncer, name string, ...) error
• func RegisterSyncer(ctx *context.ControllerContext, syncer Syncer, name string, ...) error
• func RegisterSyncerIndices(ctx *context.ControllerContext, syncer Syncer) error
• type BackwardLifecycle
• type BackwardUpdate
• type ClusterSyncer
• type FakeSyncer
• type ForwardCreate
• type ForwardLifecycle
• type Object
• type RegisterSyncerOptions
• type Syncer

Functions

func RegisterBackwardSyncer

func RegisterBackwardSyncer(ctx *context.ControllerContext, syncer Syncer, name string, modifyBuilder func(builder *builder.Builder) *builder.Builder) error

func RegisterClusterSyncer

func RegisterClusterSyncer(ctx *context.ControllerContext, clusterSyncer ClusterSyncer, name string) error

func RegisterFakeSyncer

func RegisterFakeSyncer(ctx *context.ControllerContext, syncer FakeSyncer, name string) error

func RegisterForwardSyncer

func RegisterForwardSyncer(ctx *context.ControllerContext, syncer Syncer, name string, modifyBuilder func(builder *builder.Builder) *builder.Builder) error

func RegisterSyncer

func RegisterSyncer(ctx *context.ControllerContext, syncer Syncer, name string, options RegisterSyncerOptions) error

func RegisterSyncerIndices

func RegisterSyncerIndices(ctx *context.ControllerContext, syncer Syncer) error

Types

type BackwardLifecycle

type BackwardLifecycle interface {
	BackwardStart(ctx context.Context, req ctrl.Request) (bool, error)
	BackwardEnd()
}

type BackwardUpdate

type BackwardUpdate interface {
	BackwardUpdate(ctx context.Context, pObj client.Object, vObj client.Object, log loghelper.Logger) (ctrl.Result, error)
	BackwardUpdateNeeded(pObj client.Object, vObj client.Object) (bool, error)
}

type ClusterSyncer

type ClusterSyncer interface {
	Object

	BackwardCreate(ctx context.Context, pObj client.Object, log loghelper.Logger) (ctrl.Result, error)
	BackwardCreateNeeded(pObj client.Object) (bool, error)
	BackwardUpdate
}

type FakeSyncer

type FakeSyncer interface {
	Object
	DependantObjectList() client.ObjectList
	NameFromDependantObject(ctx context.Context, obj client.Object) (types.NamespacedName, error)

	ReconcileStart(ctx context.Context, req ctrl.Request) (bool, error)
	ReconcileEnd()

	Create(ctx context.Context, name types.NamespacedName) error
	CreateNeeded(ctx context.Context, name types.NamespacedName) (bool, error)

	Delete(ctx context.Context, obj client.Object) error
	DeleteNeeded(ctx context.Context, obj client.Object) (bool, error)
}

type ForwardCreate

type ForwardCreate interface {
	ForwardCreate(ctx context.Context, vObj client.Object, log loghelper.Logger) (ctrl.Result, error)
	ForwardCreateNeeded(vObj client.Object) (bool, error)
}

type ForwardLifecycle

type ForwardLifecycle interface {
	ForwardStart(ctx context.Context, req ctrl.Request) (bool, error)
	ForwardEnd()
}

type Object

type Object interface {
	New() client.Object
	NewList() client.ObjectList
}

type RegisterSyncerOptions

type RegisterSyncerOptions struct {
	ModifyBackwardSyncer func(builder *builder.Builder) *builder.Builder
	ModifyForwardSyncer  func(builder *builder.Builder) *builder.Builder
}

type Syncer

type Syncer interface {
	Object

	ForwardCreate(ctx context.Context, vObj client.Object, log loghelper.Logger) (ctrl.Result, error)
	ForwardUpdate(ctx context.Context, pObj client.Object, vObj client.Object, log loghelper.Logger) (ctrl.Result, error)
	ForwardUpdateNeeded(pObj client.Object, vObj client.Object) (bool, error)

	BackwardUpdate
}