config

Documentation

Index

• Constants
• func CacheDir() string
• func CtxKey() any
• func Dir() string
• func File() string
• 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 ProfileInfo
  • func CurrentProfile() ProfileInfo
  • func Profile(name string) ProfileInfo
• type Provision
• type VersionInfo
  • func AppVersion() VersionInfo

Constants

const (
	AppName = "colima"
)

const ConfigFileName = "colima.yaml"

Functions

func CacheDir

func CacheDir() string

CacheDir returns the cache directory.

func CtxKey

func CtxKey() any

CtxKey returns the context key for config.

func Dir

func Dir() string

Dir returns the configuration directory.

func File

func File() string

File returns the path to the config file.

func LimaDir

func LimaDir() string

TemplatesDir returns the templates' 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"`
	ForwardAgent bool              `yaml:"forwardAgent,omitempty"`
	Network      Network           `yaml:"network,omitempty"`
	Env          map[string]string `yaml:"env,omitempty"` // environment variables
	Hostname     string            `yaml:"hostname"`

	// VM
	VMType    string `yaml:"vmType,omitempty"`
	VZRosetta bool   `yaml:"rosetta,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"`

	// SSH config generation
	SSHConfig bool `yaml:"sshConfig,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"`
}

Network is VM network configuration

type ProfileInfo

type ProfileInfo struct {
	ID          string
	DisplayName string
	ShortName   string
}

ProfileInfo is information about the colima profile.

func CurrentProfile

func CurrentProfile() ProfileInfo

CurrentProfile returns the current application profile.

func Profile

func Profile(name string) ProfileInfo

Profile converts string to profile info.

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