limayaml

package
Version: v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 6, 2021 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var DefaultTemplate []byte

Functions

func FillDefault

func FillDefault(y *LimaYAML)

func Validate

func Validate(y LimaYAML) error

func ValidateRaw

func ValidateRaw(y LimaYAML) error

Types

type Arch

type Arch = string
const (
	X8664   Arch = "x86_64"
	AARCH64 Arch = "aarch64"
)

type Containerd added in v0.2.0

type Containerd struct {
	System *bool `yaml:"system,omitempty"` // default: false
	User   *bool `yaml:"user,omitempty"`   // default: true
}

type File added in v0.5.0

type File struct {
	Location string        `yaml:"location"` // REQUIRED
	Arch     Arch          `yaml:"arch,omitempty"`
	Digest   digest.Digest `yaml:"digest,omitempty"`
}

type Firmware

type Firmware struct {
	// LegacyBIOS disables UEFI if set.
	// LegacyBIOS is ignored for aarch64.
	LegacyBIOS bool `yaml:"legacyBIOS,omitempty"`
}

type LimaYAML

type LimaYAML struct {
	Arch       Arch        `yaml:"arch,omitempty"`
	Images     []File      `yaml:"images"` // REQUIRED
	CPUs       int         `yaml:"cpus,omitempty"`
	Memory     string      `yaml:"memory,omitempty"` // go-units.RAMInBytes
	Disk       string      `yaml:"disk,omitempty"`   // go-units.RAMInBytes
	Mounts     []Mount     `yaml:"mounts,omitempty"`
	SSH        SSH         `yaml:"ssh,omitempty"` // REQUIRED (FIXME)
	Firmware   Firmware    `yaml:"firmware,omitempty"`
	Video      Video       `yaml:"video,omitempty"`
	Provision  []Provision `yaml:"provision,omitempty"`
	Containerd Containerd  `yaml:"containerd,omitempty"`
	Probes     []Probe     `yaml:"probes,omitempty"`
}

func Load

func Load(b []byte) (*LimaYAML, error)

Load loads the yaml and fulfills unspecified fields with the default values.

Load does not validate. Use Validate for validation.

type Mount

type Mount struct {
	Location string `yaml:"location"` // REQUIRED
	Writable bool   `yaml:"writable,omitempty"`
}

type Probe added in v0.2.0

type Probe struct {
	Mode        ProbeMode // default: "readiness"
	Description string
	Script      string
	Hint        string
}

type ProbeMode added in v0.2.0

type ProbeMode = string
const (
	ProbeModeReadiness ProbeMode = "readiness"
)

type Provision added in v0.2.0

type Provision struct {
	Mode   ProvisionMode `yaml:"mode"` // default: "system"
	Script string        `yaml:"script"`
}

type ProvisionMode added in v0.2.0

type ProvisionMode = string
const (
	ProvisionModeSystem ProvisionMode = "system"
	ProvisionModeUser   ProvisionMode = "user"
)

type SSH

type SSH struct {
	LocalPort int `yaml:"localPort,omitempty"` // REQUIRED (FIXME: auto assign)

	// LoadDotSSHPubKeys loads ~/.ssh/*.pub in addition to $LIMA_HOME/_config/user.pub .
	// Default: true
	LoadDotSSHPubKeys *bool `yaml:"loadDotSSHPubKeys,omitempty"`
}

type Video added in v0.1.2

type Video struct {
	// Display is a QEMU display string
	Display string `yaml:"display,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL