Documentation
¶
Index ¶
- Constants
- func CacheDir() string
- func CtxKey() any
- func EnvProfile() string
- func LimaDir() string
- func SSHConfigFile() string
- func SetProfile(profileName string)
- func TemplatesDir() string
- type Config
- type Disk
- type Kubernetes
- type Mount
- type Network
- type Profile
- type ProfileInfo
- type Provision
- type VersionInfo
Constants ¶
const (
AppName = "colima"
)
Variables ¶
This section is empty.
Functions ¶
func EnvProfile ¶ added in v0.8.2
func EnvProfile() string
func SSHConfigFile ¶ added in v0.5.6
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 ¶ added in v0.4.0
func TemplatesDir() string
TemplatesDir returns the templates' directory.
Types ¶
type Config ¶
type Config struct {
CPU int `yaml:"cpu,omitempty"`
Disk int `yaml:"disk,omitempty"`
RootDisk int `yaml:"rootDisk,omitempty"`
Memory float32 `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"`
Binfmt *bool `yaml:"binfmt,omitempty"`
NestedVirtualization bool `yaml:"nestedVirtualization,omitempty"`
DiskImage string `yaml:"diskImage,omitempty"`
PortForwarder string `yaml:"portForwarder,omitempty"` // "ssh", "grpc"
// 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 ¶ added in v0.4.5
AutoActivate returns if auto-activation of host client config is enabled.
func (Config) DriverLabel ¶ added in v0.5.0
func (Config) MountsOrDefault ¶ added in v0.4.3
type Disk ¶ added in v0.9.0
type Disk int
Disk is an instance disk size
type Kubernetes ¶
type Kubernetes struct {
Enabled bool `yaml:"enabled"`
Version string `yaml:"version"`
K3sArgs []string `yaml:"k3sArgs"`
Port int `yaml:"port,omitempty"`
}
Kubernetes is kubernetes configuration
type Mount ¶ added in v0.4.0
type Mount struct {
Location string `yaml:"location"`
MountPoint string `yaml:"mountPoint,omitempty"`
Writable bool `yaml:"writable"`
}
Mount is volume mount
type Network ¶ added in v0.4.0
type Network struct {
Address bool `yaml:"address"`
DNSResolvers []net.IP `yaml:"dns"`
DNSHosts map[string]string `yaml:"dnsHosts"`
HostAddresses bool `yaml:"hostAddresses"`
Mode string `yaml:"mode"` // shared, bridged
BridgeInterface string `yaml:"interface"`
PreferredRoute bool `yaml:"preferredRoute"`
}
Network is VM network configuration
type Profile ¶
type Profile struct {
ID string
DisplayName string
ShortName string
Changed bool // indicates if the profile has been changed
// contains filtered or unexported fields
}
Profile is colima profile.
func CurrentProfile ¶ added in v0.4.2
func CurrentProfile() *Profile
CurrentProfile returns the current running profile.
func ProfileFromName ¶ added in v0.7.0
ProfileFromName retrieves profile given name.
func (*Profile) LimaInstanceDir ¶ added in v0.7.0
LimaInstanceDir returns the directory for the Lima instance.
type ProfileInfo ¶ added in v0.3.0
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
// StoreFile returns the path to the store file.
StoreFile() string
}
ProfileInfo is the information about a profile.
type VersionInfo ¶
VersionInfo is the application version info.
func AppVersion ¶
func AppVersion() VersionInfo