types

Documentation

Index

• type Base
• type ControllerModifier
• type ControllerStarter
• type Exporter
• type FakeSyncer
• type IndicesRegisterer
• type Initializer
• type Object
• type ObjectExcluder
• type Options
• type OptionsProvider
• type Starter
• type Syncer
• type UpSyncer

Types

type Base

type Base interface {
	Name() string
}

type ControllerModifier

type ControllerModifier interface {
	ModifyController(ctx *synccontext.RegisterContext, builder *builder.Builder) (*builder.Builder, error)
}

ControllerModifier is used to modify the created controller for the syncer

type ControllerStarter

type ControllerStarter interface {
	Register(ctx *synccontext.RegisterContext) error
}

ControllerStarter is a generic controller that can be used if the syncer abstraction does not fit the use case

type Exporter

type Exporter interface {
	Base
	Register()
}

type FakeSyncer

type FakeSyncer interface {
	Object

	FakeSyncUp(ctx *synccontext.SyncContext, req types.NamespacedName) (ctrl.Result, error)
	FakeSync(ctx *synccontext.SyncContext, vObj client.Object) (ctrl.Result, error)
}

type IndicesRegisterer

type IndicesRegisterer interface {
	RegisterIndices(ctx *synccontext.RegisterContext) error
}

IndicesRegisterer registers additional indices for the controller

type Initializer

type Initializer interface {
	Init(registerContext *synccontext.RegisterContext) error
}

Initializer is used to create and update the prerequisites of the syncer before the controller is started

type Object

type Object interface {
	Base
	Resource() client.Object
}

type ObjectExcluder

type ObjectExcluder interface {
	ExcludeVirtual(vObj client.Object) bool
	ExcludePhysical(vObj client.Object) bool
}

type Options

type Options struct {
	// DisableUIDDeletion disables automatic deletion of physical objects if the uid between physical
	// and virtual doesn't match anymore.
	DisableUIDDeletion bool

	IsClusterScopedCRD   bool
	HasStatusSubresource bool
}

type OptionsProvider

type OptionsProvider interface {
	WithOptions() *Options
}

type Starter

type Starter interface {
	ReconcileStart(ctx *synccontext.SyncContext, req ctrl.Request) (bool, error)
	ReconcileEnd()
}

type Syncer

type Syncer interface {
	Object
	translator.NameTranslator

	// SyncDown is called when a virtual object was created and needs to be synced down to the physical cluster
	SyncDown(ctx *synccontext.SyncContext, vObj client.Object) (ctrl.Result, error)
	// Sync is called to sync a virtual object with a physical object
	Sync(ctx *synccontext.SyncContext, pObj client.Object, vObj client.Object) (ctrl.Result, error)
}

type UpSyncer

type UpSyncer interface {
	// SyncUp is called when a physical object exists but the virtual object does not exist
	SyncUp(ctx *synccontext.SyncContext, pObj client.Object) (ctrl.Result, error)
}