install

Documentation

Overview

Package install provides the installation routine.

Index

• func Install(ctx context.Context, p runtime.Platform, mode Mode, opts *Options) error
• type Installer
  • func NewInstaller(ctx context.Context, cmdline *procfs.Cmdline, mode Mode, opts *Options) (i *Installer, err error)
  • func (i *Installer) Install(ctx context.Context, mode Mode) (err error)
• type MetaValues
  • func FromMeta(values meta.Values) MetaValues
  • func (s *MetaValues) Append(val string) error
  • func (s *MetaValues) Decode(val string) error
  • func (s *MetaValues) Encode() string
  • func (s *MetaValues) GetMetaValues() meta.Values
  • func (s *MetaValues) GetSlice() []string
  • func (s *MetaValues) Replace(val []string) error
  • func (s *MetaValues) Set(val string) error
  • func (s *MetaValues) String() string
  • func (s *MetaValues) Type() string
• type Mode
  • func (m Mode) IsImage() bool
• type Options
• type PreflightChecks
  • func NewPreflightChecks(ctx context.Context) (*PreflightChecks, error)
  • func (checks *PreflightChecks) Close() error
  • func (checks *PreflightChecks) Run(ctx context.Context) error

Functions

func Install

func Install(ctx context.Context, p runtime.Platform, mode Mode, opts *Options) error

Install installs Talos.

Types

type Installer

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

Installer represents the installer logic. It serves as the entrypoint to all installation methods.

func NewInstaller

func NewInstaller(ctx context.Context, cmdline *procfs.Cmdline, mode Mode, opts *Options) (i *Installer, err error)

NewInstaller initializes and returns an Installer.

func (*Installer) Install

func (i *Installer) Install(ctx context.Context, mode Mode) (err error)

Install fetches the necessary data locations and copies or extracts to the target locations.

type MetaValues

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

MetaValues is a list of MetaValue.

func FromMeta

func FromMeta(values meta.Values) MetaValues

FromMeta returns a new MetaValues from a meta.Values.

func (*MetaValues) Append

func (s *MetaValues) Append(val string) error

Append implements pflag.SliceValue.

func (*MetaValues) Decode

func (s *MetaValues) Decode(val string) error

Decode the values from the given string.

func (*MetaValues) Encode

func (s *MetaValues) Encode() string

Encode returns the encoded values.

func (*MetaValues) GetMetaValues

func (s *MetaValues) GetMetaValues() meta.Values

GetMetaValues returns the wrapped meta.Values.

func (*MetaValues) GetSlice

func (s *MetaValues) GetSlice() []string

GetSlice implements pflag.SliceValue.

func (*MetaValues) Replace

func (s *MetaValues) Replace(val []string) error

Replace implements pflag.SliceValue.

func (*MetaValues) Set

func (s *MetaValues) Set(val string) error

Set implements pflag.Value.

func (*MetaValues) String

func (s *MetaValues) String() string

String implements pflag.Value.

func (*MetaValues) Type

func (s *MetaValues) Type() string

Type implements pflag.Value.

type Mode

type Mode int

Mode is the install mode.

const (
	// ModeInstall is the install mode.
	ModeInstall Mode = iota
	// ModeUpgrade is the upgrade mode.
	ModeUpgrade
	// ModeImage is the image creation mode.
	ModeImage
)

func (Mode) IsImage

func (m Mode) IsImage() bool

IsImage returns true if the mode is image creation.

type Options

type Options struct {
	ConfigSource        string
	Disk                string
	Platform            string
	Arch                string
	Board               string
	ExtraKernelArgs     []string
	Upgrade             bool
	Force               bool
	Zero                bool
	LegacyBIOSSupport   bool
	MetaValues          MetaValues
	OverlayInstaller    overlay.Installer[overlay.ExtraOptions]
	OverlayName         string
	OverlayExtractedDir string
	ExtraOptions        overlay.ExtraOptions

	ImageCachePath string

	// Options specific for the image creation mode.
	ImageSecureboot bool
	Version         string
	BootAssets      bootloaderoptions.BootAssets
	Printf          func(string, ...any)
	MountPrefix     string
}

Options represents the set of options available for an install.

type PreflightChecks

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

PreflightChecks runs the preflight checks.

func NewPreflightChecks

func NewPreflightChecks(ctx context.Context) (*PreflightChecks, error)

NewPreflightChecks initializes and returns the installation PreflightChecks.

func (*PreflightChecks) Close

func (checks *PreflightChecks) Close() error

Close closes the client.

func (*PreflightChecks) Run

func (checks *PreflightChecks) Run(ctx context.Context) error

Run the checks, return the error if the check fails.