backupentry

Documentation

Index

• Constants
• func Add(mgr manager.Manager, args AddArgs) error
• func DefaultPredicates(ignoreOperationAnnotation bool) []predicate.Predicate
• func ExtractShootDetailsFromBackupEntryName(backupEntryName string) (shootTechnicalID, shootUID string)
• func NamespaceToBackupEntryMapper(client client.Client, predicates []predicate.Predicate) extensionshandler.Mapper
• func NewReconciler(mgr manager.Manager, actuator Actuator) reconcile.Reconciler
• func SecretToBackupEntryMapper(client client.Client, predicates []predicate.Predicate) extensionshandler.Mapper
• type Actuator
• type AddArgs

Constants

const (
	// FinalizerName is the backupentry controller finalizer.
	FinalizerName = "extensions.gardener.cloud/backupentry"
	// ControllerName is the name of the controller
	ControllerName = "backupentry_controller"
)

const (
	// EventBackupEntryReconciliation an event reason to describe backup entry reconciliation.
	EventBackupEntryReconciliation string = "BackupEntryReconciliation"
	// EventBackupEntryDeletion an event reason to describe backup entry deletion.
	EventBackupEntryDeletion string = "BackupEntryDeletion"
	// EventBackupEntryMigration an event reason to describe backup entry migration.
	EventBackupEntryMigration string = "BackupEntryMigration"
	// EventBackupEntryRestoration an event reason to describe backup entry restoration.
	EventBackupEntryRestoration string = "BackupEntryRestoration"
)

Functions

func Add

func Add(mgr manager.Manager, args AddArgs) error

Add creates a new BackupEntry Controller and adds it to the Manager. and Start it when the Manager is Started.

func DefaultPredicates

func DefaultPredicates(ignoreOperationAnnotation bool) []predicate.Predicate

DefaultPredicates returns the default predicates for a controlplane reconciler.

func ExtractShootDetailsFromBackupEntryName

func ExtractShootDetailsFromBackupEntryName(backupEntryName string) (shootTechnicalID, shootUID string)

ExtractShootDetailsFromBackupEntryName returns Shoot resource technicalID its UID from provided <backupEntryName>.

func NamespaceToBackupEntryMapper

func NamespaceToBackupEntryMapper(client client.Client, predicates []predicate.Predicate) extensionshandler.Mapper

NamespaceToBackupEntryMapper returns a mapper that returns requests for BackupEntry whose associated Shoot's seed namespace have been modified.

func NewReconciler

func NewReconciler(mgr manager.Manager, actuator Actuator) reconcile.Reconciler

NewReconciler creates a new reconcile.Reconciler that reconciles backupentry resources of Gardener's `extensions.gardener.cloud` API group.

func SecretToBackupEntryMapper

func SecretToBackupEntryMapper(client client.Client, predicates []predicate.Predicate) extensionshandler.Mapper

SecretToBackupEntryMapper returns a mapper that returns requests for BackupEntry whose referenced secrets have been modified.

Types

type Actuator

type Actuator interface {
	// Reconcile reconciles the BackupEntry.
	Reconcile(context.Context, *extensionsv1alpha1.BackupEntry) error
	// Delete deletes the BackupEntry.
	Delete(context.Context, *extensionsv1alpha1.BackupEntry) error
	// Restore restores the BackupEntry.
	Restore(context.Context, *extensionsv1alpha1.BackupEntry) error
	// Migrate migrates the BackupEntry.
	Migrate(context.Context, *extensionsv1alpha1.BackupEntry) error
}

Actuator acts upon BackupEntry resources.

type AddArgs

type AddArgs struct {
	// Actuator is a BackupEntry actuator.
	Actuator Actuator
	// ControllerOptions are the controller options used for creating a controller.
	// The options.Reconciler is always overridden with a reconciler created from the
	// given actuator.
	ControllerOptions controller.Options
	// Predicates are the predicates to use.
	// If unset, GenerationChangedPredicate will be used.
	Predicates []predicate.Predicate
	// Type is the type of the resource considered for reconciliation.
	Type string
	// IgnoreOperationAnnotation specifies whether to ignore the operation annotation or not.
	// If the annotation is not ignored, the extension controller will only reconcile
	// with a present operation annotation typically set during a reconcile (e.g in the maintenance time) by the Gardenlet
	IgnoreOperationAnnotation bool
}

AddArgs are arguments for adding a BackupEntry controller to a manager.