hibernation

Documentation

Index

• Constants
• func Add(mgr manager.Manager) error
• func AddToManager(mgr manager.Manager, r *hibernationReconciler) error
• func NewReconciler(mgr manager.Manager) *hibernationReconciler
• func RegisterActuator(a HibernationActuator)
• type HibernationActuator

Constants

const (
	// ControllerName is the name of this controller
	ControllerName = "hibernation"
)

Functions

func Add

func Add(mgr manager.Manager) error

Add creates a new Hibernation controller and adds it to the manager with default RBAC.

func AddToManager

func AddToManager(mgr manager.Manager, r *hibernationReconciler) error

AddToManager adds a new Controller to the controller manager

func NewReconciler

func NewReconciler(mgr manager.Manager) *hibernationReconciler

NewReconciler returns a new Reconciler

func RegisterActuator

func RegisterActuator(a HibernationActuator)

RegisterActuator register an actuator with this controller. The actuator determines whether it can handle a particular cluster deployment via the CanHandle function.

Types

type HibernationActuator

type HibernationActuator interface {
	// CanHandle returns true if the actuator can handle a particular ClusterDeployment
	CanHandle(cd *hivev1.ClusterDeployment) bool
	// StopMachines will start machines belonging to the given ClusterDeployment
	StopMachines(cd *hivev1.ClusterDeployment, hiveClient client.Client, logger log.FieldLogger) error
	// StartMachines will select machines belonging to the given ClusterDeployment
	StartMachines(cd *hivev1.ClusterDeployment, hiveClient client.Client, logger log.FieldLogger) error
	// MachinesRunning will return true if the machines associated with the given
	// ClusterDeployment are in a running state.
	MachinesRunning(cd *hivev1.ClusterDeployment, hiveClient client.Client, logger log.FieldLogger) (bool, error)
	// MachinesStopped will return true if the machines associated with the given
	// ClusterDeployment are in a stopped state.
	MachinesStopped(cd *hivev1.ClusterDeployment, hiveClient client.Client, logger log.FieldLogger) (bool, error)
}

HibernationActuator is the interface that the hibernation controller uses to interact with cloud providers.