locking

Documentation

Overview

Package locking implements locking functionality.

Index

• type ControlPlaneInitMutex
  • func NewControlPlaneInitMutex(client client.Client) *ControlPlaneInitMutex
  • func (c *ControlPlaneInitMutex) Lock(ctx context.Context, cluster *clusterv1.Cluster, machine *clusterv1.Machine) bool
  • func (c *ControlPlaneInitMutex) Unlock(ctx context.Context, cluster *clusterv1.Cluster) bool

Types

type ControlPlaneInitMutex

type ControlPlaneInitMutex struct {
	// contains filtered or unexported fields
}

ControlPlaneInitMutex uses a ConfigMap to synchronize cluster initialization.

func NewControlPlaneInitMutex

func NewControlPlaneInitMutex(client client.Client) *ControlPlaneInitMutex

NewControlPlaneInitMutex returns a lock that can be held by a control plane node before init.

func (*ControlPlaneInitMutex) Lock

func (c *ControlPlaneInitMutex) Lock(ctx context.Context, cluster *clusterv1.Cluster, machine *clusterv1.Machine) bool

Lock allows a control plane node to be the first and only node to initialize an RKE2 cluster.

func (*ControlPlaneInitMutex) Unlock

func (c *ControlPlaneInitMutex) Unlock(ctx context.Context, cluster *clusterv1.Cluster) bool

Unlock releases the lock.