Documentation
¶
Index ¶
- Constants
- func IPAddress(profile string) string
- func New(host environment.HostActions) environment.VM
- func ShowSSH(profileID string, layer bool, format string) (string, bool, error)
- type Arch
- type Config
- type Containerd
- type File
- type Firmware
- type HostResolver
- type InstanceInfo
- type Mount
- type MountType
- type Network
- type NineP
- type PortForward
- type Proto
- type Provision
- type ProvisionMode
- type SSH
Constants ¶
View Source
const ( TCP Proto = "tcp" REVSSHFS MountType = "reverse-sshfs" NINEP MountType = "9p" )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Arch ¶
type Arch = environment.Arch
type Config ¶
type Config struct {
Arch Arch `yaml:"arch,omitempty"`
Images []File `yaml:"images"`
CPUs *int `yaml:"cpus,omitempty"`
Memory string `yaml:"memory,omitempty"`
Disk string `yaml:"disk,omitempty"`
Mounts []Mount `yaml:"mounts,omitempty"`
MountType MountType `yaml:"mountType,omitempty" json:"mountType,omitempty"`
SSH SSH `yaml:"ssh,omitempty"`
Containerd Containerd `yaml:"containerd"`
Env map[string]string `yaml:"env,omitempty"`
DNS []net.IP `yaml:"dns"`
Firmware Firmware `yaml:"firmware"`
HostResolver HostResolver `yaml:"hostResolver"`
PortForwards []PortForward `yaml:"portForwards,omitempty"`
Networks []Network `yaml:"networks,omitempty"`
Provision []Provision `yaml:"provision,omitempty" json:"provision,omitempty"`
CPUType map[Arch]string `yaml:"cpuType,omitempty" json:"cpuType,omitempty"`
}
Config is lima config. Code copied from lima and modified.
type Containerd ¶
type Firmware ¶
type Firmware struct {
// LegacyBIOS disables UEFI if set.
// LegacyBIOS is ignored for aarch64.
LegacyBIOS bool `yaml:"legacyBIOS"`
}
type HostResolver ¶ added in v0.3.3
type InstanceInfo ¶ added in v0.3.0
type InstanceInfo struct {
Name string `json:"name,omitempty"`
Status string `json:"status,omitempty"`
Arch string `json:"arch,omitempty"`
CPU int `json:"cpus,omitempty"`
Memory int64 `json:"memory,omitempty"`
Disk int64 `json:"disk,omitempty"`
Network []struct {
VNL string `json:"vnl,omitempty"`
Interface string `json:"interface,omitempty"`
} `json:"network,omitempty"`
IPAddress string `json:"address,omitempty"`
Runtime string `json:"runtime,omitempty"`
}
InstanceInfo is the information about a Lima instance
func Instances ¶ added in v0.3.0
func Instances() ([]InstanceInfo, error)
Instances returns Lima instances created by colima.
type Network ¶ added in v0.4.0
type Network struct {
// VNL is a Virtual Network Locator (https://github.com/rd235/vdeplug4/commit/089984200f447abb0e825eb45548b781ba1ebccd).
// On macOS, only VDE2-compatible form (optionally with vde:// prefix) is supported.
VNL string `yaml:"vnl,omitempty" json:"vnl,omitempty"`
SwitchPort uint16 `yaml:"switchPort,omitempty" json:"switchPort,omitempty"` // VDE Switch port, not TCP/UDP port (only used by VDE networking)
Interface string `yaml:"interface,omitempty" json:"interface,omitempty"`
}
type NineP ¶ added in v0.4.0
type NineP struct {
SecurityModel string `yaml:"securityModel,omitempty" json:"securityModel,omitempty"`
ProtocolVersion string `yaml:"protocolVersion,omitempty" json:"protocolVersion,omitempty"`
Msize string `yaml:"msize,omitempty" json:"msize,omitempty"`
Cache string `yaml:"cache,omitempty" json:"cache,omitempty"`
}
type PortForward ¶ added in v0.3.0
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 Provision ¶ added in v0.4.0
type Provision struct {
Mode ProvisionMode `yaml:"mode" json:"mode"` // default: "system"
Script string `yaml:"script" json:"script"`
}
type ProvisionMode ¶ added in v0.4.0
type ProvisionMode = string
const ( ProvisionModeSystem ProvisionMode = "system" ProvisionModeUser ProvisionMode = "user" )
Click to show internal directories.
Click to hide internal directories.