limautil

Documentation

Index

• Constants
• func ColimaDiffDisk(profileID string) string
• func CreateDisk(size int) error
• func DeleteDisk() error
• 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 Limactl(args ...string) *exec.Cmd
• func NetworkAssetsDirectory() string
• func NetworkFile() string
• func ShowSSH(profileID string) (resp struct{ ... }, err error)
• type InstanceInfo
  • func Instance() (InstanceInfo, error)
  • func Instances(ids ...string) ([]InstanceInfo, error)
  • func RunningInstances() ([]InstanceInfo, error)
  • func (i InstanceInfo) Config() (config.Config, error)
  • func (i InstanceInfo) Running() bool

Constants

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 = 300

network metric for the route

Functions

func ColimaDiffDisk

func ColimaDiffDisk(profileID string) string

ColimaDiffDisk returns path to the diffdisk for the colima VM.

func CreateDisk

func CreateDisk(size int) error

CreateDisk creates a lima disk with size in GiB.

func DeleteDisk

func DeleteDisk() error

DeleteDisk deletes lima disk for the current instance.

func DownloadImage

func DownloadImage(arch environment.Arch, runtime string) (f limaconfig.File, err error)

DownloadImage downloads the image for arch and runtime.

func HasDisk

func HasDisk() bool

HasDisk checks if a lima disk exists for the current instance.

func IPAddress

func IPAddress(profileID string) string

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

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

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 Limactl

func Limactl(args ...string) *exec.Cmd

Limactl prepares a limactl command.

func NetworkAssetsDirectory

func NetworkAssetsDirectory() string

NetworkAssetsDirecotry returns the directory for the generated network assets.

func NetworkFile

func NetworkFile() string

NetworkFile returns path to the network file.

func ShowSSH

func ShowSSH(profileID string) (resp struct {
	Output string
	File   struct {
		Lima   string
		Colima string
	}
}, err error)

ShowSSH runs the show-ssh command in Lima. returns the ssh output, if in layer, and an error if any

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 Instance

func Instance() (InstanceInfo, error)

Instance returns current instance.

func Instances

func Instances(ids ...string) ([]InstanceInfo, error)

Instances returns Lima instances created by colima.

func RunningInstances

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.