api

Documentation

Index

• type Disk
• type FsType
• type Guest
• type HostVolume
• type NetworkInterface
• type OS

Types

type Disk

type Disk struct {
	ID string

	Size   string
	File   string
	IsRoot bool

	Filesystem FsType
}

type FsType

type FsType string

const (
	// filesystem type
	XFS  FsType = "xfs"
	EXT4 FsType = "ext4"
)

type Guest

type Guest struct {
	Name string

	CPUs   string
	Memory string

	Disks       []Disk
	HostVolumes []HostVolume

	// Guest OS
	OS OS

	// DHCP Interfaces
	NICs []NetworkInterface
}

Guest describes the configuration of a VM created and run by QEMU

type HostVolume

type HostVolume struct {
	// MountTag is a label used as a hint to the guest.
	MountTag string

	// HostPath is the host filesystem path for this volume.
	HostPath string
}

HostVolume is a shared volume between the host and the VM, defined by its mount tag and its host path.

type NetworkInterface

type NetworkInterface struct {
	GatewayIP   *net.IP
	InterfaceIP *net.IP
	Routes      []netlink.Route
	MacAddr     string
	TAP         string
}

NetworkInterface describe the network interface of the guest

type OS

type OS struct {
	Kernel string
	Initrd string

	IgnitionConfig string
}

OS describe sthe configuration of the OS