driver

Documentation

Index

• Constants
• func AllowsPreload(driverName string) bool
• func AutoPauseProxyEndpoint(cc *config.ClusterConfig, cp *config.Node, driverName string) (string, net.IP, int, error)
• 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 IndexFromMachineName(machineName string) int
• func IsAlias(name, alias string) bool
• func IsDocker(name string) bool
• func IsDockerDesktop(name string) bool
• func IsHyperV(name string) bool
• func IsKIC(name string) bool
• func IsKVM(name string) bool
• func IsMock(name string) bool
• func IsNone(name string) bool
• func IsQEMU(name string) bool
• func IsSSH(name string) bool
• func IsVM(name string) bool
• func IsVMware(name string) bool
• func IsVirtualBox(name string) bool
• func MachineType(name string) string
• func NeedsPortForward(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"
	// SSH driver
	SSH = "ssh"
	// KVM2 driver
	KVM2 = "kvm2"
	// QEMU2 driver
	QEMU2 = "qemu2"
	// QEMU driver
	QEMU = "qemu"
	// VirtualBox driver
	VirtualBox = "virtualbox"
	// HyperKit driver
	HyperKit = "hyperkit"
	// VMware driver
	VMware = "vmware"
	// HyperV driver
	HyperV = "hyperv"
	// Parallels driver
	Parallels = "parallels"
	// VFKit driver
	VFKit = "vfkit"

	// AliasKVM is driver name alias for kvm2
	AliasKVM = "kvm"
	// AliasSSH is driver name alias for ssh
	AliasSSH = "generic"
	// AliasNative is driver name alias for None driver
	AliasNative = "native"
	// AliasQEMU is the driver name alias for qemu2
	AliasQEMU = "qemu"
)

Functions

func AllowsPreload

func AllowsPreload(driverName string) bool

AllowsPreload returns if preload is allowed for the driver

func AutoPauseProxyEndpoint

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

AutoPauseProxyEndpoint returns the endpoint for the auto-pause (reverse proxy to api-sever)

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 IndexFromMachineName

func IndexFromMachineName(machineName string) int

IndexFromMachineName returns the order of the container based on it is name

func IsAlias

func IsAlias(name, alias string) bool

IsAlias checks if an alias belongs to provided driver by name.

func IsDocker

func IsDocker(name string) bool

IsDocker checks if the driver docker

func IsDockerDesktop

func IsDockerDesktop(name string) bool

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

func IsHyperV

func IsHyperV(name string) bool

IsHyperV check if the driver is Hyper-V

func IsKIC

func IsKIC(name string) bool

IsKIC checks if the driver is a Kubernetes in container

func IsKVM

func IsKVM(name string) bool

IsKVM checks if the driver is a KVM[2]

func IsMock

func IsMock(name string) bool

IsMock checks if the driver is a mock

func IsNone

func IsNone(name string) bool

IsNone checks if the driver is a none

func IsQEMU

func IsQEMU(name string) bool

IsQEMU checks if the driver is a QEMU[2]

func IsSSH

func IsSSH(name string) bool

IsSSH checks if the driver is ssh

func IsVM

func IsVM(name string) bool

IsVM checks if the driver is a VM

func IsVMware

func IsVMware(name string) bool

IsVMware checks if the driver is VMware

func IsVirtualBox

func IsVirtualBox(name string) bool

IsVirtualBox checks if the driver is VirtualBox

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 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