filenames

Documentation

Overview

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

See docs/internal.md .

Index

• Constants

Constants

const (
	ConfigDir   = "_config"
	CacheDir    = "_cache"    // not yet implemented
	NetworksDir = "_networks" // network log files are stored here
)

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

const (
	MacVZYAML   = "macvz.yaml"
	CIDataISO   = "cidata.iso"
	BaseDiskZip = "basedisk.zip"
	BaseDisk    = "basedisk"
	Kernel      = "vmlinux"
	Initrd      = "initrd"

	HaStdoutLog = "ha.stdout.log"
	HaStderrLog = "ha.stderr.log"

	VZPid       = "vz.pid"
	VZStdoutLog = "vz.stdout.log"
	VZStderrLog = "vz.stderr.log"

	SSHSock   = "ssh.sock"
	SocketDir = "sockets"
)

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