generic

Documentation

Index

• func DeleteObject(ctx context.Context, localClient client.Client, pObj client.Object, ...) (ctrl.Result, error)
• func RegisterFakeSyncerWithOptions(ctx *context2.ControllerContext, name string, syncer FakeSyncer, ...) error
• func RegisterSyncer(ctx *context2.ControllerContext, name string, syncer Syncer) error
• func RegisterSyncerIndices(ctx *context2.ControllerContext, obj client.Object) error
• func RegisterSyncerWithOptions(ctx *context2.ControllerContext, name string, syncer Syncer, ...) error
• type BackwardSyncer
• type FakeSyncer
• type GenericCreator
  • func NewGenericCreator(localClient client.Client, eventRecorder record.EventRecorder, name string) *GenericCreator
  • func (g *GenericCreator) Create(ctx context.Context, vObj, pObj client.Object, log loghelper.Logger) (ctrl.Result, error)
  • func (g *GenericCreator) Update(ctx context.Context, vObj, pObj client.Object, log loghelper.Logger) (ctrl.Result, error)
• type Object
• type Starter
• type Syncer
• type SyncerOptions
• type Translator
  • func NewClusterTranslator(physicalNamespace string, virtualClient client.Client, obj client.Object, ...) Translator
  • func NewMirrorBackwardTranslator() Translator
  • func NewNamespacedTranslator(physicalNamespace string, virtualClient client.Client, obj client.Object) Translator

Functions

func DeleteObject

func DeleteObject(ctx context.Context, localClient client.Client, pObj client.Object, log loghelper.Logger) (ctrl.Result, error)

func RegisterFakeSyncerWithOptions

func RegisterFakeSyncerWithOptions(ctx *context2.ControllerContext, name string, syncer FakeSyncer, options *SyncerOptions) error

func RegisterSyncer

func RegisterSyncer(ctx *context2.ControllerContext, name string, syncer Syncer) error

func RegisterSyncerIndices

func RegisterSyncerIndices(ctx *context2.ControllerContext, obj client.Object) error

func RegisterSyncerWithOptions

func RegisterSyncerWithOptions(ctx *context2.ControllerContext, name string, syncer Syncer, options *SyncerOptions) error

Types

type BackwardSyncer

type BackwardSyncer interface {
	Backward(ctx context.Context, pObj client.Object, log loghelper.Logger) (ctrl.Result, error)
}

type FakeSyncer

type FakeSyncer interface {
	Object

	Create(ctx context.Context, req types.NamespacedName, log loghelper.Logger) (ctrl.Result, error)
	Update(ctx context.Context, vObj client.Object, log loghelper.Logger) (ctrl.Result, error)
}

type GenericCreator

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

func NewGenericCreator

func NewGenericCreator(localClient client.Client, eventRecorder record.EventRecorder, name string) *GenericCreator

func (*GenericCreator) Create

func (g *GenericCreator) Create(ctx context.Context, vObj, pObj client.Object, log loghelper.Logger) (ctrl.Result, error)

func (*GenericCreator) Update

func (g *GenericCreator) Update(ctx context.Context, vObj, pObj client.Object, log loghelper.Logger) (ctrl.Result, error)

type Object

type Object interface {
	New() client.Object
}

type Starter

type Starter interface {
	ReconcileStart(ctx context.Context, req ctrl.Request) (bool, error)
	ReconcileEnd()
}

type Syncer

type Syncer interface {
	Object
	Translator

	Forward(ctx context.Context, vObj client.Object, log loghelper.Logger) (ctrl.Result, error)
	Update(ctx context.Context, pObj client.Object, vObj client.Object, log loghelper.Logger) (ctrl.Result, error)
}

type SyncerOptions

type SyncerOptions struct {
	ModifyController        func(builder *builder.Builder) *builder.Builder
	MaxConcurrentReconciles int
}

type Translator

type Translator interface {
	IsManaged(pObj client.Object) (bool, error)

	VirtualToPhysical(req types.NamespacedName, vObj client.Object) types.NamespacedName
	PhysicalToVirtual(pObj client.Object) types.NamespacedName
}

func NewClusterTranslator

func NewClusterTranslator(physicalNamespace string, virtualClient client.Client, obj client.Object, nameTranslator translate.PhysicalNameTranslator) Translator

func NewMirrorBackwardTranslator

func NewMirrorBackwardTranslator() Translator

func NewNamespacedTranslator

func NewNamespacedTranslator(physicalNamespace string, virtualClient client.Client, obj client.Object) Translator