runtime

Documentation

Index

• Variables
• type Configurator
• type ConfiguratorBundle
• type DefaultRuntime
  • func (d *DefaultRuntime) Config() Configurator
  • func (d *DefaultRuntime) Platform() Platform
  • func (d *DefaultRuntime) Sequence() Sequence
• type Mode
  • func ModeFromString(s string) (m Mode, err error)
  • func (m Mode) String() string
• type Platform
• type Runtime
  • func NewRuntime(p Platform, c Configurator, s Sequence) Runtime
• type Sequence

Variables

var ErrReboot = errors.New("reboot")

ErrReboot is raised to initiate early reboot sequence via panic.

Types

type Configurator

type Configurator interface {
	Version() string
	Debug() bool
	Persist() bool
	Machine() machine.Machine
	Cluster() cluster.Cluster
	Validate(Mode) error
	String() (string, error)
	Bytes() ([]byte, error)
}

Configurator defines the configuration interface.

type ConfiguratorBundle

type ConfiguratorBundle interface {
	Init() Configurator
	ControlPlane() Configurator
	Join() Configurator
	TalosConfig() *config.Config
}

ConfiguratorBundle defines the configuration bundle interface.

type DefaultRuntime

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

DefaultRuntime implements the Runtime interface.

func (*DefaultRuntime) Config

func (d *DefaultRuntime) Config() Configurator

Config implements the Runtime interface.

func (*DefaultRuntime) Platform

func (d *DefaultRuntime) Platform() Platform

Platform implements the Runtime interface.

func (*DefaultRuntime) Sequence

func (d *DefaultRuntime) Sequence() Sequence

Sequence implements the Runtime interface.

type Mode

type Mode int

Mode is a runtime mode.

const (
	// Cloud represents a runtime mode.
	Cloud Mode = iota
	// Container represents a runtime mode.
	Container
	// Interactive represents a runtime mode.
	Interactive
	// Metal represents a runtime mode.
	Metal
)

func ModeFromString

func ModeFromString(s string) (m Mode, err error)

ModeFromString returns a runtime mode that matches the given string.

func (Mode) String

func (m Mode) String() string

String returns the string representation of a Mode.

type Platform

type Platform interface {
	Name() string
	Configuration() ([]byte, error)
	Hostname() ([]byte, error)
	Mode() Mode
	ExternalIPs() ([]net.IP, error)
	KernelArgs() procfs.Parameters
}

Platform is an interface describing a platform.

type Runtime

type Runtime interface {
	Platform() Platform
	Config() Configurator
	Sequence() Sequence
}

Runtime defines the runtime parameters.

func NewRuntime

func NewRuntime(p Platform, c Configurator, s Sequence) Runtime

NewRuntime initializes and returns the runtime interface.

type Sequence

type Sequence int

Sequence represents the sequence type.

const (
	// None is the none sequence.
	None Sequence = iota
	// Boot is the boot sequence.
	Boot
	// Shutdown is the shutdown sequence.
	Shutdown
	// Upgrade is the upgrade sequence.
	Upgrade
	// Reset is the reset sequence.
	Reset
)