machine

Documentation

Index

• Constants
• func GetControlPlaneMachines(machineList *clusterv1.MachineList) []*clusterv1.Machine
• type Actuator
  • func NewActuator(params ActuatorParams) *Actuator
  • func (a *Actuator) Create(ctx context.Context, cluster *clusterv1.Cluster, machine *clusterv1.Machine) error
  • func (a *Actuator) Delete(ctx context.Context, cluster *clusterv1.Cluster, machine *clusterv1.Machine) error
  • func (a *Actuator) Exists(ctx context.Context, cluster *clusterv1.Cluster, machine *clusterv1.Machine) (bool, error)
  • func (a *Actuator) Update(ctx context.Context, cluster *clusterv1.Cluster, machine *clusterv1.Machine) error
• type ActuatorParams
• type ControlPlaneInitLocker

Constants

const (
	// SecurityGroupsLastAppliedAnnotation is the key for the machine object
	// annotation which tracks the SecurityGroups that the machine actuator is
	// responsible for. These are the SecurityGroups that have been handled by
	// the AdditionalSecurityGroups in the Machine Provider Config.
	// See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
	// for annotation formatting rules.
	SecurityGroupsLastAppliedAnnotation = "sigs.k8s.io/cluster-api-provider-aws-last-applied-security-groups"
)

const (
	// TagsLastAppliedAnnotation is the key for the machine object annotation
	// which tracks the SecurityGroups that the machine actuator is responsible
	// for. These are the SecurityGroups that have been handled by the
	// AdditionalTags in the Machine Provider Config.
	// See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
	// for annotation formatting rules.
	TagsLastAppliedAnnotation = "sigs.k8s.io/cluster-api-provider-aws-last-applied-tags"
)

Functions

func GetControlPlaneMachines

func GetControlPlaneMachines(machineList *clusterv1.MachineList) []*clusterv1.Machine

GetControlPlaneMachines retrieves all non-deleted control plane nodes from a MachineList

Types

type Actuator

type Actuator struct {
	*deployer.Deployer
	// contains filtered or unexported fields
}

Actuator is responsible for performing machine reconciliation.

func NewActuator

func NewActuator(params ActuatorParams) *Actuator

NewActuator returns an actuator.

func (*Actuator) Create

func (a *Actuator) Create(ctx context.Context, cluster *clusterv1.Cluster, machine *clusterv1.Machine) error

Create creates a machine and is invoked by the machine controller.

func (*Actuator) Delete

func (a *Actuator) Delete(ctx context.Context, cluster *clusterv1.Cluster, machine *clusterv1.Machine) error

Delete deletes a machine and is invoked by the Machine Controller

func (*Actuator) Exists

func (a *Actuator) Exists(ctx context.Context, cluster *clusterv1.Cluster, machine *clusterv1.Machine) (bool, error)

Exists test for the existence of a machine and is invoked by the Machine Controller

func (*Actuator) Update

func (a *Actuator) Update(ctx context.Context, cluster *clusterv1.Cluster, machine *clusterv1.Machine) error

Update updates a machine and is invoked by the Machine Controller. If the Update attempts to mutate any immutable state, the method will error and no updates will be performed.

type ActuatorParams

type ActuatorParams struct {
	CoreClient             corev1.CoreV1Interface
	ClusterClient          client.ClusterV1alpha1Interface
	LoggingContext         string
	ControlPlaneInitLocker ControlPlaneInitLocker
}

ActuatorParams holds parameter information for Actuator.

type ControlPlaneInitLocker

type ControlPlaneInitLocker interface {
	// Acquire returns true if it acquires the lock for the cluster.
	Acquire(cluster *clusterv1.Cluster) bool
}

ControlPlaneInitLocker provides a locking mechanism for cluster initialization.