genericactuator

Documentation

Index

• Constants
• func NewActuator(mgr manager.Manager, delegateFactory DelegateFactory, mcmName string, ...) (worker.Actuator, error)
• func ReadMachineConfiguration(pool extensionsv1alpha1.WorkerPool) *machinev1alpha1.MachineConfiguration
• func RestoreWithoutReconcile(ctx context.Context, log logr.Logger, cl client.Client, ...) error
• type DelegateFactory
• type ReplicaCount
• type WorkerDelegate

Constants

const (
	// McmShootResourceName is the name of the managed resource that contains the Machine Controller Manager
	McmShootResourceName = "extension-worker-mcm-shoot"

	// McmDeploymentName is the name of the deployment that spawn machine-cotroll-manager pods
	McmDeploymentName = "machine-controller-manager"
)

const GardenPurposeMachineClass = "machineclass"

GardenPurposeMachineClass is a constant for the 'machineclass' value in a label.

Functions

func NewActuator

func NewActuator(
	mgr manager.Manager,
	delegateFactory DelegateFactory,
	mcmName string,
	mcmSeedChart,
	mcmShootChart chart.Interface,
	imageVector imagevector.ImageVector,
	chartRendererFactory extensionscontroller.ChartRendererFactory,
	errorCodeCheckFunc healthcheck.ErrorCodeCheckFunc,
) (worker.Actuator, error)

NewActuator creates a new Actuator that reconciles Worker resources of Gardener's `extensions.gardener.cloud` API group. It provides a default implementation that allows easier integration of providers. If machine-controller-manager should not be managed then only the delegateFactory must be provided.

func ReadMachineConfiguration

func ReadMachineConfiguration(pool extensionsv1alpha1.WorkerPool) *machinev1alpha1.MachineConfiguration

ReadMachineConfiguration reads the configuration from worker-pool and returns the corresponding configuration of machine-deployment.

func RestoreWithoutReconcile

func RestoreWithoutReconcile(
	ctx context.Context,
	log logr.Logger,
	cl client.Client,
	delegateFactory DelegateFactory,
	worker *extensionsv1alpha1.Worker,
	cluster *extensionscontroller.Cluster,
) error

RestoreWithoutReconcile restores the worker state without calling 'Reconcile'.

Types

type DelegateFactory

type DelegateFactory interface {
	// WorkerDelegate returns a worker delegate interface that is used for the Worker reconciliation
	// based on this generic actuator.
	WorkerDelegate(context.Context, *extensionsv1alpha1.Worker, *extensionscontroller.Cluster) (WorkerDelegate, error)
}

DelegateFactory acts upon Worker resources.

type ReplicaCount

type ReplicaCount func() int32

ReplicaCount determines the number of replicas.

type WorkerDelegate

type WorkerDelegate interface {
	// GetMachineControllerManagerChartValues should return the chart and the values for the machine-controller-manager
	// deployment.
	GetMachineControllerManagerChartValues(context.Context) (map[string]interface{}, error)
	// GetMachineControllerManagerShootChartValues should return the values to render the chart containing resources
	// that are required by the machine-controller-manager inside the shoot cluster itself.
	GetMachineControllerManagerShootChartValues(context.Context) (map[string]interface{}, error)

	// MachineClassKind yields the name of the provider specific machine class.
	MachineClassKind() string
	// MachineClass yields a newly initialized machine class object.
	MachineClass() client.Object
	// MachineClassList yields a newly initialized machine class list object.
	MachineClassList() client.ObjectList
	// DeployMachineClasses generates and creates the provider specific machine classes.
	DeployMachineClasses(context.Context) error

	// GenerateMachineDeployments generates the configuration for the desired machine deployments.
	GenerateMachineDeployments(context.Context) (worker.MachineDeployments, error)

	// UpdateMachineImagesStatus will store a list of machine images used by the
	// machines associated with this Worker resource in its provider status.
	// The controller can look up its provider-specific machine image information
	// in case the required version has been removed from the `CloudProfile`.
	UpdateMachineImagesStatus(context.Context) error

	// PreReconcileHook is a hook called at the beginning of the worker reconciliation flow.
	PreReconcileHook(context.Context) error
	// PostReconcileHook is a hook called at the end of the worker reconciliation flow.
	PostReconcileHook(context.Context) error
	// PreDeleteHook is a hook called at the beginning of the worker deletion flow.
	PreDeleteHook(context.Context) error
	// PostDeleteHook is a hook called at the end of the worker deletion flow.
	PostDeleteHook(context.Context) error
}

WorkerDelegate is used for the Worker reconciliation.