Documentation
¶
Index ¶
- Constants
- func ColimaDiffDisk(profileID string) string
- func CreateDisk(size int) error
- func DeleteDisk() error
- func DiskProvisioned(runtime string) bool
- func DownloadImage(arch environment.Arch, runtime string) (f limaconfig.File, err error)
- func HasDisk() bool
- func IPAddress(profileID string) string
- func Image(arch environment.Arch, runtime string) (limaconfig.File, error)
- func ImageCached(arch environment.Arch, runtime string) (limaconfig.File, bool)
- func InternalIPAddress(profileID string) string
- func Limactl(args ...string) *exec.Cmd
- func MountPoint() string
- func NetworkAssetsDirectory() string
- func NetworkFile() string
- func ResizeDisk(size int) error
- func ShowSSH(profileID string) (resp struct{ ... }, err error)
- type InstanceInfo
- type LimaNetwork
- type LimaNetworkConfig
Constants ¶
const EnvLimaDrivers = "LIMA_DRIVERS_PATH"
EnvLimaDrivers is the environment variable for the path to external Lima drivers.
const EnvLimaHome = "LIMA_HOME"
EnvLimaHome is the environment variable for the Lima directory.
const LimactlCommand = "limactl"
LimactlCommand is the limactl command.
const NetInterface = "col0"
network interface for shared network in the virtual machine.
const NetMetric uint32 = 300
network metric for the route
const NetMetricPreferred uint32 = 100
Variables ¶
This section is empty.
Functions ¶
func ColimaDiffDisk ¶ added in v0.5.3
ColimaDiffDisk returns path to the diffdisk for the colima VM.
func CreateDisk ¶ added in v0.7.4
CreateDisk creates a lima disk with size in GiB.
func DeleteDisk ¶ added in v0.7.4
func DeleteDisk() error
DeleteDisk deletes lima disk for the current instance.
func DiskProvisioned ¶ added in v0.9.0
DiskPrivisioned returns if the disk exists and has been provisioned for the specified runtime.
func DownloadImage ¶ added in v0.7.0
func DownloadImage(arch environment.Arch, runtime string) (f limaconfig.File, err error)
DownloadImage downloads the image for arch and runtime.
func HasDisk ¶ added in v0.7.4
func HasDisk() bool
HasDisk checks if a lima disk exists for the current instance.
func IPAddress ¶
IPAddress returns the ip address for profile. It returns the PTP address if networking is enabled or falls back to 127.0.0.1. It is guaranteed to return a value.
TODO: unnecessary round-trip is done to get instance details from Lima.
func Image ¶ added in v0.8.1
func Image(arch environment.Arch, runtime string) (limaconfig.File, error)
Image returns the details of the disk image to download for the arch and runtime.
func ImageCached ¶ added in v0.7.0
func ImageCached(arch environment.Arch, runtime string) (limaconfig.File, bool)
ImageCached returns if the image for architecture and runtime has been previously downloaded and cached.
func InternalIPAddress ¶ added in v0.9.0
InternalIPAddress returns the internal IP address for the profile.
func MountPoint ¶ added in v0.9.0
func MountPoint() string
MountPoint returns the lima disk mount point for the current instance.
func NetworkAssetsDirectory ¶ added in v0.8.1
func NetworkAssetsDirectory() string
NetworkAssetsDirecotry returns the directory for the generated network assets.
func NetworkFile ¶ added in v0.6.2
func NetworkFile() string
NetworkFile returns path to the network file.
func ResizeDisk ¶ added in v0.9.0
ResizeDisk resizes disk to new size
Types ¶
type InstanceInfo ¶
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"`
Dir string `json:"dir,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 ¶
func Instances(ids ...string) ([]InstanceInfo, error)
Instances returns Lima instances created by colima.
func RunningInstances ¶ added in v0.8.1
func RunningInstances() ([]InstanceInfo, error)
RunningInstances return Lima instances that are has a running status.
func (InstanceInfo) Config ¶
func (i InstanceInfo) Config() (config.Config, error)
Config returns the current Colima config
func (InstanceInfo) Running ¶
func (i InstanceInfo) Running() bool
Running checks if the instance is running.
type LimaNetwork ¶ added in v0.10.0
type LimaNetwork struct {
Networks struct {
UserV2 LimaNetworkConfig `yaml:"user-v2"`
} `yaml:"networks"`
}
Source Files