store

Documentation

Index

• Variables
• func DiskDir(name string) (string, error)
• func Disks() ([]string, error)
• func GetSSHAddress(_ string) (string, error)
• func InstanceDir(name string) (string, error)
• func Instances() ([]string, error)
• func LimaVersionGreaterThan(limaVersion, oldVersion string) bool
• func LoadYAMLByFilePath(filePath string) (*limayaml.LimaYAML, error)
• func PrintInstances(w io.Writer, instances []*Instance, format string, options *PrintOptions) error
• func ReadPIDFile(path string) (int, error)
• type Disk
  • func InspectDisk(diskName string) (*Disk, error)
  • func (d *Disk) Lock(instanceDir string) error
  • func (d *Disk) Unlock() error
• type FormatData
  • func AddGlobalFields(inst *Instance) (FormatData, error)
• type Instance
  • func Inspect(instName string) (*Instance, error)
  • func (inst *Instance) LoadYAML() (*limayaml.LimaYAML, error)
  • func (inst *Instance) Protect() error
  • func (inst *Instance) Unprotect() error
• type PrintOptions
• type Status

Variables

var FormatHelp = "\n" +
	"These functions are available to go templates:\n\n" +
	textutil.IndentString(2,
		strings.Join(textutil.FuncHelp, "\n")+"\n")

Functions

func DiskDir

func DiskDir(name string) (string, error)

func Disks

func Disks() ([]string, error)

func GetSSHAddress

func GetSSHAddress(_ string) (string, error)

func InstanceDir

func InstanceDir(name string) (string, error)

InstanceDir returns the instance dir. InstanceDir does not check whether the instance exists

func Instances

func Instances() ([]string, error)

Instances returns the names of the instances under LimaDir.

func LimaVersionGreaterThan

func LimaVersionGreaterThan(limaVersion, oldVersion string) bool

LimaVersionGreaterThan returns true if the Lima version used to create an instance is greater than a specific older version. Always returns false if the Lima version is the empty string. Unparsable lima versions (like SHA1 commit ids) are treated as the latest version and return true. limaVersion is a `github describe` string, not a semantic version. So "0.19.1-16-gf3dc6ed.m" will be considered greater than "0.19.1".

func LoadYAMLByFilePath

func LoadYAMLByFilePath(filePath string) (*limayaml.LimaYAML, error)

LoadYAMLByFilePath loads and validates the yaml.

func PrintInstances

func PrintInstances(w io.Writer, instances []*Instance, format string, options *PrintOptions) error

PrintInstances prints instances in a requested format to a given io.Writer. Supported formats are "json", "yaml", "table", or a go template

func ReadPIDFile

func ReadPIDFile(path string) (int, error)

ReadPIDFile returns 0 if the PID file does not exist or the process has already terminated (in which case the PID file will be removed).

Types

type Disk

type Disk struct {
	Name        string `json:"name"`
	Size        int64  `json:"size"`
	Format      string `json:"format"`
	Dir         string `json:"dir"`
	Instance    string `json:"instance"`
	InstanceDir string `json:"instanceDir"`
	MountPoint  string `json:"mountPoint"`
}

func InspectDisk

func InspectDisk(diskName string) (*Disk, error)

func (*Disk) Lock

func (d *Disk) Lock(instanceDir string) error

func (*Disk) Unlock

func (d *Disk) Unlock() error

type FormatData

type FormatData struct {
	Instance
	HostOS       string
	HostArch     string
	LimaHome     string
	IdentityFile string
}

func AddGlobalFields

func AddGlobalFields(inst *Instance) (FormatData, error)

type Instance

type Instance struct {
	Name            string             `json:"name"`
	Status          Status             `json:"status"`
	Dir             string             `json:"dir"`
	VMType          limayaml.VMType    `json:"vmType"`
	Arch            limayaml.Arch      `json:"arch"`
	CPUType         string             `json:"cpuType"`
	CPUs            int                `json:"cpus,omitempty"`
	Memory          int64              `json:"memory,omitempty"` // bytes
	Disk            int64              `json:"disk,omitempty"`   // bytes
	Message         string             `json:"message,omitempty"`
	AdditionalDisks []limayaml.Disk    `json:"additionalDisks,omitempty"`
	Networks        []limayaml.Network `json:"network,omitempty"`
	SSHLocalPort    int                `json:"sshLocalPort,omitempty"`
	SSHConfigFile   string             `json:"sshConfigFile,omitempty"`
	HostAgentPID    int                `json:"hostAgentPID,omitempty"`
	DriverPID       int                `json:"driverPID,omitempty"`
	Errors          []error            `json:"errors,omitempty"`
	Config          *limayaml.LimaYAML `json:"config,omitempty"`
	SSHAddress      string             `json:"sshAddress,omitempty"`
	Protected       bool               `json:"protected"`
	LimaVersion     string             `json:"limaVersion"`
}

func Inspect

func Inspect(instName string) (*Instance, error)

Inspect returns err only when the instance does not exist (os.ErrNotExist). Other errors are returned as *Instance.Errors

func (*Instance) LoadYAML

func (inst *Instance) LoadYAML() (*limayaml.LimaYAML, error)

func (*Instance) Protect

func (inst *Instance) Protect() error

Protect protects the instance to prohibit accidental removal. Protect does not return an error even when the instance is already protected.

func (*Instance) Unprotect

func (inst *Instance) Unprotect() error

Unprotect unprotects the instance. Unprotect does not return an error even when the instance is already unprotected.

type PrintOptions

type PrintOptions struct {
	AllFields     bool
	TerminalWidth int
}

type Status

type Status = string

const (
	StatusUnknown       Status = ""
	StatusUninitialized Status = "Uninitialized"
	StatusInstalling    Status = "Installing"
	StatusBroken        Status = "Broken"
	StatusStopped       Status = "Stopped"
	StatusRunning       Status = "Running"
)