yaml

Documentation

Index

• Variables
• func Cname(host string) string
• func FillDefault(y, d, o *MacVZYaml, filePath string)
• func FillPortForwardDefaults(rule *PortForward, instDir string)
• func Validate(y MacVZYaml, warn bool) error
• type Arch
  • func NewArch(arch string) Arch
  • func ResolveArch() Arch
• type HostResolver
• type Image
• type MacVZYaml
  • func Load(b []byte, filePath string) (*MacVZYaml, error)
• type Mount
• type PortForward
• type Probe
• type ProbeMode
• type Proto
• type Provision
• type ProvisionMode
• type SSH

Variables

var DefaultTemplate []byte

Functions

func Cname

func Cname(host string) string

func FillDefault

func FillDefault(y, d, o *MacVZYaml, filePath string)

func FillPortForwardDefaults

func FillPortForwardDefaults(rule *PortForward, instDir string)

func Validate

func Validate(y MacVZYaml, warn bool) error

Types

type Arch

type Arch = string

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

func NewArch

func NewArch(arch string) Arch

func ResolveArch

func ResolveArch() Arch

type HostResolver

type HostResolver struct {
	Enabled *bool             `yaml:"enabled,omitempty" json:"enabled,omitempty"`
	IPv6    *bool             `yaml:"ipv6,omitempty" json:"ipv6,omitempty"`
	Hosts   map[string]string `yaml:"hosts,omitempty" json:"hosts,omitempty"`
}

type Image

type Image struct {
	Kernel  string `yaml:"kernel" json:"kernel"`   // REQUIRED
	Initram string `yaml:"initram" json:"initram"` // REQUIRED
	Base    string `yaml:"base" json:"base"`       // REQUIRED
	Arch    Arch   `yaml:"arch,omitempty" json:"arch,omitempty"`
}

type MacVZYaml

type MacVZYaml struct {
	Images     []Image `yaml:"images" json:"images"` // REQUIRED
	CPUs       *int    `yaml:"cpus,omitempty" json:"cpus,omitempty"`
	Memory     *string `yaml:"memory,omitempty" json:"memory,omitempty"` // go-units.RAMInBytes
	Disk       *string `yaml:"disk,omitempty" json:"disk,omitempty"`     // go-units.RAMInBytes
	Mounts     []Mount `yaml:"mounts,omitempty" json:"mounts,omitempty"`
	MACAddress *string `yaml:"MACAddress,omitempty" json:"MACAddress,omitempty"`

	SSH          SSH           `yaml:"ssh,omitempty" json:"ssh,omitempty"` // REQUIRED
	PortForwards []PortForward `yaml:"portForwards,omitempty" json:"portForwards,omitempty"`
	Provision    []Provision   `yaml:"provision,omitempty" json:"provision,omitempty"`
	Probes       []Probe       `yaml:"probes,omitempty" json:"probes,omitempty"`
	HostResolver HostResolver  `yaml:"hostResolver,omitempty" json:"hostResolver,omitempty"`
}

func Load

func Load(b []byte, filePath string) (*MacVZYaml, 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" json:"location"` // REQUIRED
	Writable *bool  `yaml:"writable,omitempty" json:"writable,omitempty"`
}

type PortForward

type PortForward struct {
	GuestIPMustBeZero bool   `yaml:"guestIPMustBeZero,omitempty" json:"guestIPMustBeZero,omitempty"`
	GuestIP           net.IP `yaml:"guestIP,omitempty" json:"guestIP,omitempty"`
	GuestPort         int    `yaml:"guestPort,omitempty" json:"guestPort,omitempty"`
	GuestPortRange    [2]int `yaml:"guestPortRange,omitempty" json:"guestPortRange,omitempty"`
	GuestSocket       string `yaml:"guestSocket,omitempty" json:"guestSocket,omitempty"`
	HostIP            net.IP `yaml:"hostIP,omitempty" json:"hostIP,omitempty"`
	HostPort          int    `yaml:"hostPort,omitempty" json:"hostPort,omitempty"`
	HostPortRange     [2]int `yaml:"hostPortRange,omitempty" json:"hostPortRange,omitempty"`
	HostSocket        string `yaml:"hostSocket,omitempty" json:"hostSocket,omitempty"`
	Proto             Proto  `yaml:"proto,omitempty" json:"proto,omitempty"`
	Ignore            bool   `yaml:"ignore,omitempty" json:"ignore,omitempty"`
}

type Probe

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

type ProbeMode

type ProbeMode = string

const (
	ProbeModeReadiness ProbeMode = "readiness"
)

type Proto

type Proto = string

const (
	TCP Proto = "tcp"
)

type Provision

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

type ProvisionMode

type ProvisionMode = string

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

type SSH

type SSH struct {
	LocalPort *int `yaml:"localPort,omitempty" json:"localPort,omitempty"`

	// LoadDotSSHPubKeys loads ~/.ssh/*.pub in addition to $MACVZ_HOME/_config/user.pub .
	LoadDotSSHPubKeys *bool `yaml:"loadDotSSHPubKeys,omitempty" json:"loadDotSSHPubKeys,omitempty"` // default: true
	ForwardAgent      *bool `yaml:"forwardAgent,omitempty" json:"forwardAgent,omitempty"`           // default: false
}