config

Documentation

Index

• Constants
• func CacheDir() string
• func CtxKey() any
• func LimaDir() string
• func SSHConfigFile() string
• func SetProfile(profileName string)
• func TemplatesDir() string
• type Config
  • func (c Config) AutoActivate() bool
  • func (c Config) DriverLabel() string
  • func (c Config) Empty() bool
  • func (c Config) MountsOrDefault() []Mount
• type Kubernetes
• type Mount
• type Network
• type Profile
  • func CurrentProfile() *Profile
  • func ProfileFromName(name string) *Profile
  • func (p *Profile) ConfigDir() string
  • func (p *Profile) File() string
  • func (p *Profile) LimaFile() string
  • func (p *Profile) LimaInstanceDir() string
  • func (p *Profile) StateFile() string
• type ProfileInfo
• type Provision
• type VersionInfo
  • func AppVersion() VersionInfo

Constants

const (
	AppName = "colima"
)

Functions

func CacheDir

func CacheDir() string

CacheDir returns the cache directory.

func CtxKey

func CtxKey() any

CtxKey returns the context key for config.

func LimaDir

func LimaDir() string

LimaDir returns Lima directory.

func SSHConfigFile

func SSHConfigFile() string

SSHConfigFile returns the path to generated ssh config.

func SetProfile

func SetProfile(profileName string)

SetProfile sets the profile name for the application. This is an avenue to test Colima without breaking an existing stable setup. Not perfect, but good enough for testing.

func TemplatesDir

func TemplatesDir() string

TemplatesDir returns the templates' directory.

Types

type Config

type Config struct {
	CPU      int               `yaml:"cpu,omitempty"`
	Disk     int               `yaml:"disk,omitempty"`
	Memory   int               `yaml:"memory,omitempty"`
	Arch     string            `yaml:"arch,omitempty"`
	CPUType  string            `yaml:"cpuType,omitempty"`
	Network  Network           `yaml:"network,omitempty"`
	Env      map[string]string `yaml:"env,omitempty"` // environment variables
	Hostname string            `yaml:"hostname"`

	// SSH
	SSHPort      int  `yaml:"sshPort,omitempty"`
	ForwardAgent bool `yaml:"forwardAgent,omitempty"`
	SSHConfig    bool `yaml:"sshConfig,omitempty"` // config generation

	// VM
	VMType               string `yaml:"vmType,omitempty"`
	VZRosetta            bool   `yaml:"rosetta,omitempty"`
	NestedVirtualization bool   `yaml:"nestedVirtualization,omitempty"`

	// volume mounts
	Mounts       []Mount `yaml:"mounts,omitempty"`
	MountType    string  `yaml:"mountType,omitempty"`
	MountINotify bool    `yaml:"mountInotify,omitempty"`

	// Runtime is one of docker, containerd.
	Runtime         string `yaml:"runtime,omitempty"`
	ActivateRuntime *bool  `yaml:"autoActivate,omitempty"`

	// Kubernetes configuration
	Kubernetes Kubernetes `yaml:"kubernetes,omitempty"`

	// Docker configuration
	Docker map[string]any `yaml:"docker,omitempty"`

	// provision scripts
	Provision []Provision `yaml:"provision,omitempty"`
}

Config is the application config.

func (Config) AutoActivate

func (c Config) AutoActivate() bool

AutoActivate returns if auto-activation of host client config is enabled.

func (Config) DriverLabel

func (c Config) DriverLabel() string

func (Config) Empty

func (c Config) Empty() bool

Empty checks if the configuration is empty.

func (Config) MountsOrDefault

func (c Config) MountsOrDefault() []Mount

type Kubernetes

type Kubernetes struct {
	Enabled bool     `yaml:"enabled"`
	Version string   `yaml:"version"`
	K3sArgs []string `yaml:"k3sArgs"`
}

Kubernetes is kubernetes configuration

type Mount

type Mount struct {
	Location   string `yaml:"location"`
	MountPoint string `yaml:"mountPoint,omitempty"`
	Writable   bool   `yaml:"writable"`
}

Mount is volume mount

type Network

type Network struct {
	Address       bool              `yaml:"address"`
	DNSResolvers  []net.IP          `yaml:"dns"`
	DNSHosts      map[string]string `yaml:"dnsHosts"`
	HostAddresses bool              `yaml:"hostAddresses"`
}

Network is VM network configuration

type Profile

type Profile struct {
	ID          string
	DisplayName string
	ShortName   string
	// contains filtered or unexported fields
}

Profile is colima profile.

func CurrentProfile

func CurrentProfile() *Profile

CurrentProfile returns the current running profile.

func ProfileFromName

func ProfileFromName(name string) *Profile

ProfileFromName retrieves profile given name.

func (*Profile) ConfigDir

func (p *Profile) ConfigDir() string

ConfigDir returns the configuration directory.

func (*Profile) File

func (p *Profile) File() string

File returns the path to the config file.

func (*Profile) LimaFile

func (p *Profile) LimaFile() string

LimaFile returns the path to the lima config file.

func (*Profile) LimaInstanceDir

func (p *Profile) LimaInstanceDir() string

LimaInstanceDir returns the directory for the Lima instance.

func (*Profile) StateFile

func (p *Profile) StateFile() string

StateFile returns the path to the state file.

type ProfileInfo

type ProfileInfo interface {
	// ConfigDir returns the configuration directory.
	ConfigDir() string

	// LimaInstanceDir returns the directory for the Lima instance.
	LimaInstanceDir() string

	// File returns the path to the config file.
	File() string

	// LimaFile returns the path to the lima config file.
	LimaFile() string

	// StateFile returns the path to the state file.
	StateFile() string
}

ProfileInfo is the information about a profile.

type Provision

type Provision struct {
	Mode   string `yaml:"mode"`
	Script string `yaml:"script"`
}

type VersionInfo

type VersionInfo struct {
	Version  string
	Revision string
}

VersionInfo is the application version info.

func AppVersion

func AppVersion() VersionInfo