controlplane

Documentation

Index

• Constants
• func Add(mgr manager.Manager, args AddArgs) error
• func ClusterToControlPlaneMapper(predicates []predicate.Predicate) handler.Mapper
• func ComputeChecksums(secrets map[string]*corev1.Secret, cms map[string]*corev1.ConfigMap) map[string]string
• func DefaultPredicates(ignoreOperationAnnotation bool) []predicate.Predicate
• func MergeSecretMaps(a, b map[string]*corev1.Secret) map[string]*corev1.Secret
• func NewReconciler(mgr manager.Manager, actuator Actuator) reconcile.Reconciler
• type Actuator
• type AddArgs

Constants

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

const (
	// EventControlPlaneReconciliation an event reason to describe control plane reconciliation.
	EventControlPlaneReconciliation string = "ControlPlaneReconciliation"
	// EventControlPlaneRestoration an event reason to describe control plane restoration.
	EventControlPlaneRestoration string = "ControlPlaneRestoration"
	// EventControlPlaneDeletion an event reason to describe control plane deletion.
	EventControlPlaneDeletion string = "ControlPlaneDeletion"
	// EventControlPlaneMigration an event reason to describe control plane migration.
	EventControlPlaneMigration string = "ControlPlaneMigration"

	// RequeueAfter is the duration to requeue a controlplane reconciliation if indicated by the actuator.
	RequeueAfter time.Duration = 2 * time.Second
)

Functions

func Add

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

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

func ClusterToControlPlaneMapper

func ClusterToControlPlaneMapper(predicates []predicate.Predicate) handler.Mapper

ClusterToControlPlaneMapper returns a mapper that returns requests for ControlPlanes whose referenced clusters have been modified.

func ComputeChecksums

func ComputeChecksums(secrets map[string]*corev1.Secret, cms map[string]*corev1.ConfigMap) map[string]string

ComputeChecksums computes and returns SAH256 checksums for the given secrets and configmaps.

func DefaultPredicates

func DefaultPredicates(ignoreOperationAnnotation bool) []predicate.Predicate

DefaultPredicates returns the default predicates for a controlplane reconciler.

func MergeSecretMaps

func MergeSecretMaps(a, b map[string]*corev1.Secret) map[string]*corev1.Secret

MergeSecretMaps merges the 2 given secret maps.

func NewReconciler

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

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

Types

type Actuator

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

Actuator acts upon ControlPlane resources.

type AddArgs

type AddArgs struct {
	// Actuator is an controlplane 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 an controlplane controller to a manager.