machine

Documentation

Index

• Constants
• func Providers() []string
• func Register(name string, provider Provider)
• type APIProvider
• type ControllerProvider
• type DelegateProvider
  • func (p *DelegateProvider) AfterCreate(machine *platform.Machine) error
  • func (p *DelegateProvider) Name() string
  • func (p *DelegateProvider) NeedUpdate(old, new *platformv1.Machine) bool
  • func (p *DelegateProvider) OnCreate(ctx context.Context, machine *platformv1.Machine, cluster *typesv1.Cluster) error
  • func (p *DelegateProvider) OnDelete(ctx context.Context, machine *platformv1.Machine, cluster *typesv1.Cluster) error
  • func (p *DelegateProvider) OnUpdate(ctx context.Context, machine *platformv1.Machine, cluster *typesv1.Cluster) error
  • func (p *DelegateProvider) PreCreate(machine *platform.Machine) error
  • func (p *DelegateProvider) Validate(machine *platform.Machine) field.ErrorList
• type Handler
  • func (h Handler) Name() string
• type Provider
  • func GetProvider(name string) (Provider, error)

Constants

const (
	ReasonWaiting      = "Waiting"
	ReasonSkip         = "Skip"
	ReasonFailedInit   = "FailedInit"
	ReasonFailedUpdate = "FailedUpdate"
	ReasonFailedDelete = "FailedDelete"

	ConditionTypeDone = "EnsureDone"
)

Functions

func Providers

func Providers() []string

Providers returns a sorted list of the names of the registered providers.

func Register

func Register(name string, provider Provider)

Register makes a provider available by the provided name. If Register is called twice with the same name or if provider is nil, it panics.

Types

type APIProvider

type APIProvider interface {
	Validate(machine *platform.Machine) field.ErrorList
}

type ControllerProvider

type ControllerProvider interface {
	// NeedUpdate could be implemented by user to judge whether machine need update or not.
	NeedUpdate(old, new *platformv1.Machine) bool

	PreCreate(machine *platform.Machine) error
	AfterCreate(machine *platform.Machine) error

	OnCreate(ctx context.Context, machine *platformv1.Machine, cluster *typesv1.Cluster) error
	OnUpdate(ctx context.Context, machine *platformv1.Machine, cluster *typesv1.Cluster) error
	OnDelete(ctx context.Context, machine *platformv1.Machine, cluster *typesv1.Cluster) error
}

type DelegateProvider

type DelegateProvider struct {
	ProviderName string

	ValidateFunc    func(machine *platform.Machine) field.ErrorList
	PreCreateFunc   func(machine *platform.Machine) error
	AfterCreateFunc func(machine *platform.Machine) error

	CreateHandlers []Handler
	DeleteHandlers []Handler
	UpdateHandlers []Handler
}

func (*DelegateProvider) AfterCreate

func (p *DelegateProvider) AfterCreate(machine *platform.Machine) error

func (*DelegateProvider) Name

func (p *DelegateProvider) Name() string

func (*DelegateProvider) NeedUpdate

func (p *DelegateProvider) NeedUpdate(old, new *platformv1.Machine) bool

func (*DelegateProvider) OnCreate

func (p *DelegateProvider) OnCreate(ctx context.Context, machine *platformv1.Machine, cluster *typesv1.Cluster) error

func (*DelegateProvider) OnDelete

func (p *DelegateProvider) OnDelete(ctx context.Context, machine *platformv1.Machine, cluster *typesv1.Cluster) error

func (*DelegateProvider) OnUpdate

func (p *DelegateProvider) OnUpdate(ctx context.Context, machine *platformv1.Machine, cluster *typesv1.Cluster) error

func (*DelegateProvider) PreCreate

func (p *DelegateProvider) PreCreate(machine *platform.Machine) error

func (*DelegateProvider) Validate

func (p *DelegateProvider) Validate(machine *platform.Machine) field.ErrorList

type Handler

type Handler func(context.Context, *platformv1.Machine, *typesv1.Cluster) error

func (Handler) Name

func (h Handler) Name() string

type Provider

type Provider interface {
	Name() string

	APIProvider
	ControllerProvider
}

Provider defines a set of response interfaces for specific machine types in machine management.

func GetProvider

func GetProvider(name string) (Provider, error)

GetProvider returns provider by name