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(reader client.Reader, predicates []predicate.Predicate) handler.MapFunc
- func NewReconciler(mgr manager.Manager, actuator Actuator) reconcile.Reconciler
- func SecretToBackupEntryMapper(reader client.Reader, predicates []predicate.Predicate) handler.MapFunc
- 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" )
Variables ¶
This section is empty.
Functions ¶
func Add ¶
Add creates a new BackupEntry Controller and adds it to the Manager. and Start it when the Manager is Started.
func DefaultPredicates ¶
DefaultPredicates returns the default predicates for a controlplane reconciler.
func ExtractShootDetailsFromBackupEntryName ¶
func ExtractShootDetailsFromBackupEntryName(backupEntryName string) (shootTechnicalID, shootUID string)
ExtractShootDetailsFromBackupEntryName returns Shoot resource technicalID and UID from provided <backupEntryName>.
func NamespaceToBackupEntryMapper ¶
func NamespaceToBackupEntryMapper(reader client.Reader, predicates []predicate.Predicate) handler.MapFunc
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.
Types ¶
type Actuator ¶
type Actuator interface {
// Reconcile reconciles the [extensionsv1alpha1.BackupEntry] resource.
//
// Implementations should ensure that the backup entry is created or
// updated to reach the desired state.
Reconcile(context.Context, logr.Logger, *extensionsv1alpha1.BackupEntry) error
// Delete is invoked when [extensionsv1alpha1.BackupEntry] resource is
// deleted.
//
// Implementations must wait until the backup entry is gracefully
// deleted.
Delete(context.Context, logr.Logger, *extensionsv1alpha1.BackupEntry) error
// Restore restores the [extensionsv1alpha1.BackupEntry] from a
// previously saved state.
//
// This method is invoked when the shoot cluster associated with the
// [extensionsv1alpha1.BackupEntry] resource is being restored on the
// target seed cluster.
//
// Implementations may use the persisted data in the .status.state field
// for restoring the state, when the shoot is being migrated to a
// different seed cluster.
Restore(context.Context, logr.Logger, *extensionsv1alpha1.BackupEntry) error
// Migrate prepares the [extensionsv1alpha1.BackupEntry] resource for
// migration.
//
// This method is invoked when the shoot cluster associated with the
// [extensionsv1alpha1.BackupEntry] resource is being migrated to
// another seed cluster.
//
// Implementations should take care of storing any required state in the
// .status.state field, so that it can later be restored from this
// state.
Migrate(context.Context, logr.Logger, *extensionsv1alpha1.BackupEntry) error
}
Actuator acts upon extensionsv1alpha1.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
// ExtensionClasses defines the extension classes this controller is responsible for.
ExtensionClasses []extensionsv1alpha1.ExtensionClass
}
AddArgs are arguments for adding a BackupEntry controller to a manager.