agent

Documentation

Index

• Constants
• Variables
• func CurrentImage() (string, error)
• func Install(sourceImgURL string, dir ...string) error
• func InteractiveInstall(debug, spawnShell bool, sourceImgURL string) error
• func ListAllReleases(includePrereleases bool) ([]string, error)
• func ListNewerReleases(includePrereleases bool) ([]string, error)
• func ManualInstall(c, sourceImgURL, device string, reboot, poweroff, strictValidations bool) error
• func Notify(event string, dirs []string) error
• func Recovery() error
• func Reset(reboot, unattended, resetOem bool, dir ...string) error
• func Run(opts ...Option) error
• func RunInstall(c *config.Config) error
• func Upgrade(source string, force, strictValidations bool, dirs []string, ...) error
• type BrandingText
• type Config
  • func LoadConfig(path ...string) (*Config, error)
• type ExtraConfigReset
• type ExtraConfigUpgrade
• type Option
  • func WithAPI(address string) Option
  • func WithDirectory(dirs ...string) Option
• type Options
  • func (o *Options) Apply(opts ...Option) error
• type WebUI
  • func (w WebUI) HasAddress() bool

Constants

const (
	KiB
	MiB
	GiB
	TiB
)

Variables

var DefaultBanner = []byte{}/* 12853 elements not displayed */

Functions

func CurrentImage

func CurrentImage() (string, error)

func Install

func Install(sourceImgURL string, dir ...string) error

func InteractiveInstall

func InteractiveInstall(debug, spawnShell bool, sourceImgURL string) error

func ListAllReleases

func ListAllReleases(includePrereleases bool) ([]string, error)

func ListNewerReleases

func ListNewerReleases(includePrereleases bool) ([]string, error)

func ManualInstall

func ManualInstall(c, sourceImgURL, device string, reboot, poweroff, strictValidations bool) error

func Notify

func Notify(event string, dirs []string) error

func Recovery

func Recovery() error

func Reset

func Reset(reboot, unattended, resetOem bool, dir ...string) error

func Run

func Run(opts ...Option) error

Run starts the agent provider emitting the bootstrap event.

func RunInstall

func RunInstall(c *config.Config) error

func Upgrade

func Upgrade(
	source string, force, strictValidations bool, dirs []string, upgradeEntry string, preReleases bool) error

Types

type BrandingText

type BrandingText struct {
	InteractiveInstall string `yaml:"interactive-install"`
	Install            string `yaml:"install"`
	Reset              string `yaml:"reset"`
	Recovery           string `yaml:"recovery"`
}

type Config

type Config struct {
	Fast     bool         `yaml:"fast,omitempty"`
	WebUI    WebUI        `yaml:"webui"`
	Branding BrandingText `yaml:"branding"`
}

func LoadConfig

func LoadConfig(path ...string) (*Config, error)

type ExtraConfigReset

type ExtraConfigReset struct {
	Reset struct {
		ResetOem        bool `json:"reset-oem,omitempty"`
		ResetPersistent bool `json:"reset-persistent,omitempty"`
		Reboot          bool `json:"reboot,omitempty"`
	} `json:"reset"`
}

ExtraConfigReset is the struct that holds the reset options that come from flags and events

type ExtraConfigUpgrade

type ExtraConfigUpgrade struct {
	Upgrade struct {
		Entry          string `json:"entry,omitempty"`
		RecoverySystem struct {
			URI string `json:"uri,omitempty"`
		} `json:"recovery-system,omitempty"`
		System struct {
			URI string `json:"uri,omitempty"`
		} `json:"system,omitempty"`
	} `json:"upgrade,omitempty"`
}

ExtraConfigUpgrade is the struct that holds the upgrade options that come from flags and events

type Option

type Option func(o *Options) error

Option is a generic option for the Agent.

var ForceAgent Option = func(o *Options) error {
	o.Force = true
	return nil
}

ForceAgent forces the agent to run.

var RestartAgent Option = func(o *Options) error {
	o.Restart = true
	return nil
}

RestartAgent makes the agent restart on error.

func WithAPI

func WithAPI(address string) Option

WithAPI sets the API address used to talk to EdgeVPN and co-ordinate node bootstrapping.

func WithDirectory

func WithDirectory(dirs ...string) Option

WithDirectory sets the Agent config directories.

type Options

type Options struct {
	APIAddress string
	Dir        []string
	Force      bool
	Restart    bool
}

Options yields the options for the running agent.

func (*Options) Apply

func (o *Options) Apply(opts ...Option) error

Apply applies option to the options struct.

type WebUI

type WebUI struct {
	Disable       bool   `yaml:"disable"`
	ListenAddress string `yaml:"listen_address"`
}

func (WebUI) HasAddress

func (w WebUI) HasAddress() bool