driver

Documentation

Index

• Constants
• func BareMetal(name string) bool
• func Choices(vm bool) []registry.DriverState
• func ControlPlaneEndpoint(cc *config.ClusterConfig, cp *config.Node, driverName string) (string, net.IP, int, error)
• func DisplaySupportedDrivers() string
• func FullName(name string) string
• func HasResourceLimits(name string) bool
• func InstallOrUpdate(name string, directory string, v semver.Version, interactive bool, ...) error
• func IsDocker(name string) bool
• func IsDockerDesktop(name string) bool
• func IsKIC(name string) bool
• func IsMicrosoftWSL() bool
• func IsMock(name string) bool
• func IsVM(name string) bool
• func MachineName(cc config.ClusterConfig, n config.Node) string
• func MachineType(name string) string
• func NeedsPortForward(name string) bool
• func NeedsRoot(name string) bool
• func NeedsShutdown(name string) bool
• func SetLibvirtURI(v string)
• func Status(name string) registry.DriverState
• func Suggest(options []registry.DriverState) (registry.DriverState, []registry.DriverState, []registry.DriverState)
• func Supported(name string) bool
• func SupportedDrivers() []string
• func VBoxManagePath() string
• type FlagHints
  • func FlagDefaults(name string) FlagHints

Constants

const (
	// Podman is Kubernetes in container using podman driver
	Podman = "podman"
	// Docker is Kubernetes in container using docker driver
	Docker = "docker"
	// Mock driver
	Mock = "mock"
	// None driver
	None = "none"
	// KVM2 driver
	KVM2 = "kvm2"
	// VirtualBox driver
	VirtualBox = "virtualbox"
	// HyperKit driver
	HyperKit = "hyperkit"
	// VMware driver
	VMware = "vmware"
	// VMwareFusion driver
	VMwareFusion = "vmwarefusion"
	// HyperV driver
	HyperV = "hyperv"
	// Parallels driver
	Parallels = "parallels"
)

Functions

func BareMetal

func BareMetal(name string) bool

BareMetal returns if this driver is unisolated

func Choices

func Choices(vm bool) []registry.DriverState

Choices returns a list of drivers which are possible on this system

func ControlPlaneEndpoint

func ControlPlaneEndpoint(cc *config.ClusterConfig, cp *config.Node, driverName string) (string, net.IP, int, error)

ControlPlaneEndpoint returns the location where callers can reach this cluster

func DisplaySupportedDrivers

func DisplaySupportedDrivers() string

DisplaySupportedDrivers returns a string with a list of supported drivers

func FullName

func FullName(name string) string

FullName will return the human-known and title formatted name for the driver based on platform

func HasResourceLimits

func HasResourceLimits(name string) bool

HasResourceLimits returns true if driver can set resource limits such as memory size or CPU count.

func InstallOrUpdate

func InstallOrUpdate(name string, directory string, v semver.Version, interactive bool, autoUpdate bool) error

InstallOrUpdate downloads driver if it is not present, or updates it if there's a newer version

func IsDocker

func IsDocker(name string) bool

IsDocker checks if the driver docker

func IsDockerDesktop

func IsDockerDesktop(name string) bool

IsKIC checks if the driver is a Docker for Desktop (Docker on windows or MacOs) for linux and exotic archs, this will be false

func IsKIC

func IsKIC(name string) bool

IsKIC checks if the driver is a Kubernetes in container

func IsMicrosoftWSL

func IsMicrosoftWSL() bool

IsMicrosoftWSL will return true if process is running in WSL in windows checking for WSL env var based on this https://github.com/microsoft/WSL/issues/423#issuecomment-608237689 also based on https://github.com/microsoft/vscode/blob/90a39ba0d49d75e9a4d7e62a6121ad946ecebc58/resources/win32/bin/code.sh#L24

func IsMock

func IsMock(name string) bool

IsMock checks if the driver is a mock

func IsVM

func IsVM(name string) bool

IsVM checks if the driver is a VM

func MachineName

func MachineName(cc config.ClusterConfig, n config.Node) string

MachineName returns the name of the machine, as seen by the hypervisor given the cluster and node names

func MachineType

func MachineType(name string) string

MachineType returns appropriate machine name for the driver

func NeedsPortForward

func NeedsPortForward(name string) bool

NeedsPortForward returns true if driver is unable provide direct IP connectivity

func NeedsRoot

func NeedsRoot(name string) bool

NeedsRoot returns true if driver needs to run with root privileges

func NeedsShutdown

func NeedsShutdown(name string) bool

NeedsShutdown returns true if driver needs manual shutdown command before stopping. Hyper-V requires special care to avoid ACPI and file locking issues KIC also needs shutdown to avoid container getting stuck, https://github.com/kubernetes/minikube/issues/7657

func SetLibvirtURI

func SetLibvirtURI(v string)

SetLibvirtURI sets the URI to perform libvirt health checks against

func Status

func Status(name string) registry.DriverState

Status returns the status of a driver

func Suggest

func Suggest(options []registry.DriverState) (registry.DriverState, []registry.DriverState, []registry.DriverState)

Suggest returns a suggested driver, alternate drivers, and rejected drivers

func Supported

func Supported(name string) bool

Supported returns if the driver is supported on this host.

func SupportedDrivers

func SupportedDrivers() []string

SupportedDrivers returns a list of supported drivers

func VBoxManagePath

func VBoxManagePath() string

VBoxManagePath returns the path to the VBoxManage command

Types

type FlagHints

type FlagHints struct {
	ExtraOptions     []string
	CacheImages      bool
	ContainerRuntime string
	Bootstrapper     string
}

FlagHints are hints for what default options should be used for this driver

func FlagDefaults

func FlagDefaults(name string) FlagHints

FlagDefaults returns suggested defaults based on a driver