filenames

Documentation

Overview

Package filenames defines the names of the files that appear under an instance dir or inside the config directory.

See https://lima-vm.io/docs/dev/internals/

Index

• Constants
• Variables
• func PIDFile(name string) string

Constants

const (
	CacheDir     = "_cache" // not yet implemented
	ConfigDir    = "_config"
	DisksDir     = "_disks"     // disks are stored here
	NetworksDir  = "_networks"  // network log files are stored here
	TemplatesDir = "_templates" // user templates are stored here
)

const (
	UserPrivateKey = "user"
	UserPublicKey  = UserPrivateKey + ".pub"
	NetworksConfig = "networks.yaml"
	Default        = "default.yaml"
	Override       = "override.yaml"
	Base           = "base.yaml"
)

const (
	LimaYAML             = "lima.yaml"
	LimaVersion          = "lima-version" // Lima version used to create instance
	CIDataISO            = "cidata.iso"
	CIDataISODir         = "cidata"
	CloudConfig          = "cloud-config.yaml"
	BaseDisk             = "basedisk"
	DiffDisk             = "diffdisk"
	Kernel               = "kernel"
	KernelCmdline        = "kernel.cmdline"
	Initrd               = "initrd"
	QMPSock              = "qmp.sock"
	SerialLog            = "serial.log" // default serial (ttyS0, but ttyAMA0 on qemu-system-{arm,aarch64})
	SerialSock           = "serial.sock"
	SerialPCILog         = "serialp.log" // pci serial (ttyS0 on qemu-system-{arm,aarch64})
	SerialPCISock        = "serialp.sock"
	SerialVirtioLog      = "serialv.log" // virtio serial
	SerialVirtioSock     = "serialv.sock"
	SSHSock              = "ssh.sock"
	SSHConfig            = "ssh.config"
	VhostSock            = "virtiofsd-%d.sock"
	VNCDisplayFile       = "vncdisplay"
	VNCPasswordFile      = "vncpassword"
	GuestAgentSock       = "ga.sock"
	VirtioPort           = "io.lima-vm.guest_agent.0"
	HostAgentPID         = "ha.pid"
	HostAgentSock        = "ha.sock"
	HostAgentStdoutLog   = "ha.stdout.log"
	HostAgentStderrLog   = "ha.stderr.log"
	VzIdentifier         = "vz-identifier"
	VzEfi                = "vz-efi"           // efi variable store
	QemuEfiCodeFD        = "qemu-efi-code.fd" // efi code; not always created
	QemuEfiFullFD        = "qemu-efi-full.fd" // concatenated efi vars and code; not always created
	AnsibleInventoryYAML = "ansible-inventory.yaml"

	// SocketDir is the default location for forwarded sockets with a relative paths in HostSocket.
	SocketDir = "sock"

	Protected = "protected" // empty file; used by `limactl protect`
)

const (
	DataDisk = "datadisk"
	InUseBy  = "in_use_by"
)

const LongestSock = SSHSock + ".1234567890123456"

LongestSock is the longest socket name. On macOS, the full path of the socket (excluding the NUL terminator) must be less than 104 characters. See unix(4).

On Linux, the full path must be less than 108 characters.

ssh appends 16 bytes of random characters when it first creates the socket: https://github.com/openssh/openssh-portable/blob/V_8_7_P1/mux.c#L1271-L1285

Variables

var NullifyOnClone = []string{
	VzIdentifier,
}

NullifyOnClone files should be nullified on cloning an instance. FIXME: this list should be provided by the VM driver.

var SkipOnClone = []string{
	Protected,
}

SkipOnClone files should be skipped on cloning an instance.

var TmpFileSuffixes = []string{".pid", ".sock", ".tmp"}

TmpFileSuffixes is the list of the tmp file suffixes.

Functions

func PIDFile

func PIDFile(name string) string