store

Documentation

Index

• func InstanceDir(name string) (string, error)
• func Instances() ([]string, error)
• func LoadYAMLByFilePath(filePath string) (*limayaml.LimaYAML, error)
• func ReadPIDFile(path string) (int, error)
• type FormatData
  • func AddGlobalFields(inst *Instance) (FormatData, error)
• type Instance
  • func Inspect(instName string) (*Instance, error)
  • func (inst *Instance) LoadYAML() (*limayaml.LimaYAML, error)
• type Status

Functions

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 LoadYAMLByFilePath

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

LoadYAMLByFilePath loads and validates the yaml.

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 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"`
	Arch         limayaml.Arch      `json:"arch"`
	CPUs         int                `json:"cpus,omitempty"`
	Memory       int64              `json:"memory,omitempty"` // bytes
	Disk         int64              `json:"disk,omitempty"`   // bytes
	Message      string             `json:"message,omitempty"`
	Networks     []limayaml.Network `json:"network,omitempty"`
	SSHLocalPort int                `json:"sshLocalPort,omitempty"`
	HostAgentPID int                `json:"hostAgentPID,omitempty"`
	QemuPID      int                `json:"qemuPID,omitempty"`
	Errors       []error            `json:"errors,omitempty"`
}

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)

type Status

type Status = string

const (
	StatusUnknown Status = ""
	StatusBroken  Status = "Broken"
	StatusStopped Status = "Stopped"
	StatusRunning Status = "Running"
)