Documentation ¶
Index ¶
- func DeleteObject(ctx *synccontext.SyncContext, pObj client.Object, reason string) (ctrl.Result, error)
- func RegisterFakeSyncer(ctx *synccontext.RegisterContext, syncer FakeSyncer) error
- func RegisterSyncer(ctx *synccontext.RegisterContext, syncer Syncer) error
- type ControllerModifier
- type Exporter
- type FakeSyncer
- type IndicesRegisterer
- type Initializer
- type Object
- type ObjectExcluder
- type Options
- type OptionsProvider
- type Starter
- type Syncer
- type UpSyncer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DeleteObject ¶
func DeleteObject(ctx *synccontext.SyncContext, pObj client.Object, reason string) (ctrl.Result, error)
func RegisterFakeSyncer ¶
func RegisterFakeSyncer(ctx *synccontext.RegisterContext, syncer FakeSyncer) error
func RegisterSyncer ¶
func RegisterSyncer(ctx *synccontext.RegisterContext, syncer Syncer) error
Types ¶
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 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 ObjectExcluder ¶ added in v0.14.0
type OptionsProvider ¶ added in v0.14.0
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) }
Click to show internal directories.
Click to hide internal directories.