alpha

Documentation

Overview

Package alpha implements clusterctl alpha functionality.

Index

• Constants
• type Client
  • func New(options ...Option) Client
• type Option
  • func InjectRollout(rollout Rollout) Option
• type Rollout

Constants

const (
	// MachineDeployment is a resource type.
	MachineDeployment = "machinedeployment"
	// KubeadmControlPlane is a resource type.
	KubeadmControlPlane = "kubeadmcontrolplane"
)

Types

type Client

type Client interface {
	Rollout() Rollout
}

Client is the alpha client.

func New

func New(options ...Option) Client

New returns a Client.

type Option

type Option func(*alphaClient)

Option is a configuration option supplied to New.

func InjectRollout

func InjectRollout(rollout Rollout) Option

InjectRollout allows to override the rollout implementation to use.

type Rollout

type Rollout interface {
	ObjectRestarter(context.Context, cluster.Proxy, corev1.ObjectReference) error
	ObjectPauser(context.Context, cluster.Proxy, corev1.ObjectReference) error
	ObjectResumer(context.Context, cluster.Proxy, corev1.ObjectReference) error
	ObjectRollbacker(context.Context, cluster.Proxy, corev1.ObjectReference, int64) error
}

Rollout defines the behavior of a rollout implementation.