Documentation ¶
Index ¶
- func CacheISO(config cfg.MachineConfig) error
- func CheckIfHostExistsAndLoad(api libmachine.API, machineName string) (*host.Host, error)
- func CreateSSHShell(api libmachine.API, args []string) error
- func DeleteHost(api libmachine.API) error
- func GetHostDockerEnv(api libmachine.API) (map[string]string, error)
- func GetHostDriverIP(api libmachine.API, machineName string) (net.IP, error)
- func GetHostStatus(api libmachine.API) (string, error)
- func GetVMHostIP(host *host.Host) (net.IP, error)
- func IsMinikubeRunning(api libmachine.API) bool
- func ListMachines(miniHome ...string) (validMachines []*Machine, inValidMachines []*Machine, err error)
- func MachinePath(machine string, miniHome ...string) string
- func Mount(r mountRunner, source string, target string, c *MountConfig) error
- func StartHost(api libmachine.API, config cfg.MachineConfig) (*host.Host, error)
- func StopHost(api libmachine.API) error
- func Unmount(r mountRunner, target string) error
- type Machine
- type MountConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CacheISO ¶ added in v1.0.1
func CacheISO(config cfg.MachineConfig) error
CacheISO downloads and caches ISO.
func CheckIfHostExistsAndLoad ¶ added in v0.31.0
CheckIfHostExistsAndLoad checks if a host exists, and loads it if it does
func CreateSSHShell ¶ added in v0.2.0
func CreateSSHShell(api libmachine.API, args []string) error
CreateSSHShell creates a new SSH shell / client
func GetHostDockerEnv ¶
func GetHostDockerEnv(api libmachine.API) (map[string]string, error)
GetHostDockerEnv gets the necessary docker env variables to allow the use of docker through minikube's vm
func GetHostDriverIP ¶ added in v0.20.0
GetHostDriverIP gets the ip address of the current minikube cluster
func GetHostStatus ¶
func GetHostStatus(api libmachine.API) (string, error)
GetHostStatus gets the status of the host VM.
func GetVMHostIP ¶ added in v0.19.0
GetVMHostIP gets the ip address to be used for mapping host -> VM and VM -> host
func IsMinikubeRunning ¶ added in v1.5.0
func IsMinikubeRunning(api libmachine.API) bool
IsMinikubeRunning checks that minikube has a status available and that the status is `Running`
func ListMachines ¶ added in v1.5.0
func ListMachines(miniHome ...string) (validMachines []*Machine, inValidMachines []*Machine, err error)
ListMachines return all valid and invalid machines If a machine is valid or invalid is determined by the cluster.IsValid function
func MachinePath ¶ added in v1.5.0
MachinePath returns the Minikube machine path of a machine
func Mount ¶ added in v1.0.0
func Mount(r mountRunner, source string, target string, c *MountConfig) error
Mount runs the mount command from the 9p client on the VM to the 9p server on the host
func StartHost ¶
func StartHost(api libmachine.API, config cfg.MachineConfig) (*host.Host, error)
StartHost starts a host VM.
func StopHost ¶
func StopHost(api libmachine.API) error
StopHost stops the host VM, saving state to disk.
Types ¶
type Machine ¶ added in v1.5.0
Machine contains information about a machine
func LoadMachine ¶ added in v1.5.0
LoadMachine loads a machine or throws an error if the machine could not be loadedG
type MountConfig ¶ added in v1.0.0
type MountConfig struct { // Type is the filesystem type (Typically 9p) Type string // UID is the User ID which this path will be mounted as UID string // GID is the Group ID which this path will be mounted as GID string // Version is the 9P protocol version. Valid options: 9p2000, 9p200.u, 9p2000.L Version string // MSize is the number of bytes to use for 9p packet payload MSize int // Port is the port to connect to on the host Port int // Mode is the file permissions to set the mount to (octals) Mode os.FileMode // Extra mount options. See https://www.kernel.org/doc/Documentation/filesystems/9p.txt Options map[string]string }
MountConfig defines the options available to the Mount command