cluster

Documentation

Index

• Constants
• func Providers() []string
• func Register(name string, provider Provider)
• func RegisterHandler(mux *mux.PathRecorderMux)
• func Setup() error
• func Teardown() error
• type APIProvider
• type ControllerProvider
• type DelegateProvider
  • func (p *DelegateProvider) AfterCreate(cluster *types.Cluster) error
  • func (p *DelegateProvider) Name() string
  • func (p *DelegateProvider) OnCreate(ctx context.Context, cluster *v1.Cluster) error
  • func (p *DelegateProvider) OnDelete(ctx context.Context, cluster *v1.Cluster) error
  • func (p *DelegateProvider) OnRunning(ctx context.Context, cluster *v1.Cluster) error
  • func (p *DelegateProvider) OnUpdate(ctx context.Context, cluster *v1.Cluster) error
  • func (p *DelegateProvider) PreCreate(cluster *types.Cluster) error
  • func (p *DelegateProvider) RegisterHandler(mux *mux.PathRecorderMux)
  • func (p *DelegateProvider) Setup() error
  • func (p *DelegateProvider) Teardown() error
  • func (p *DelegateProvider) Validate(cluster *types.Cluster) 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.

func RegisterHandler

func RegisterHandler(mux *mux.PathRecorderMux)

RegisterHandler register all provider's hanlder.

func Setup

func Setup() error

Setup call all provider's setup method.

func Teardown

func Teardown() error

Teardown call all provider's teardown method.

Types

type APIProvider

type APIProvider interface {
	RegisterHandler(mux *mux.PathRecorderMux)
	Validate(cluster *types.Cluster) field.ErrorList
	PreCreate(cluster *types.Cluster) error
	AfterCreate(cluster *types.Cluster) error
}

type ControllerProvider

type ControllerProvider interface {
	// Setup called by controller to give an chance for plugin do some init work.
	Setup() error
	// Teardown called by controller for plugin do some clean job.
	Teardown() error

	OnCreate(ctx context.Context, cluster *v1.Cluster) error
	OnUpdate(ctx context.Context, cluster *v1.Cluster) error
	OnDelete(ctx context.Context, cluster *v1.Cluster) error

	// OnRunning call on first running.
	OnRunning(ctx context.Context, cluster *v1.Cluster) error
}

type DelegateProvider

type DelegateProvider struct {
	ProviderName string

	ValidateFunc    func(cluster *types.Cluster) field.ErrorList
	PreCreateFunc   func(cluster *types.Cluster) error
	AfterCreateFunc func(cluster *types.Cluster) error

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

func (*DelegateProvider) AfterCreate

func (p *DelegateProvider) AfterCreate(cluster *types.Cluster) error

func (*DelegateProvider) Name

func (p *DelegateProvider) Name() string

func (*DelegateProvider) OnCreate

func (p *DelegateProvider) OnCreate(ctx context.Context, cluster *v1.Cluster) error

func (*DelegateProvider) OnDelete

func (p *DelegateProvider) OnDelete(ctx context.Context, cluster *v1.Cluster) error

func (*DelegateProvider) OnRunning

func (p *DelegateProvider) OnRunning(ctx context.Context, cluster *v1.Cluster) error

func (*DelegateProvider) OnUpdate

func (p *DelegateProvider) OnUpdate(ctx context.Context, cluster *v1.Cluster) error

func (*DelegateProvider) PreCreate

func (p *DelegateProvider) PreCreate(cluster *types.Cluster) error

func (*DelegateProvider) RegisterHandler

func (p *DelegateProvider) RegisterHandler(mux *mux.PathRecorderMux)

func (*DelegateProvider) Setup

func (p *DelegateProvider) Setup() error

func (*DelegateProvider) Teardown

func (p *DelegateProvider) Teardown() error

func (*DelegateProvider) Validate

func (p *DelegateProvider) Validate(cluster *types.Cluster) field.ErrorList

type Handler

type Handler func(context.Context, *v1.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 cluster types in cluster management.

func GetProvider

func GetProvider(name string) (Provider, error)

GetProvider returns provider by name