machine

Documentation

Index

• Variables
• func CacheAndLoadImages(images []string) error
• func CacheBinariesForBootstrapper(version string, clusterBootstrapper string) error
• func CacheImagesForBootstrapper(imageRepository string, version string, clusterBootstrapper string) error
• func CheckIfHostExistsAndLoad(api libmachine.API, machineName string) (*host.Host, error)
• func CommandRunner(h *host.Host) (command.Runner, error)
• func CopyBinary(cr command.Runner, src string, dest string) error
• func CreateSSHShell(api libmachine.API, cc config.ClusterConfig, n config.Node, args []string) error
• func DeleteHost(api libmachine.API, machineName string) error
• func GetHostStatus(api libmachine.API, machineName string) (string, error)
• func IsHostRunning(api libmachine.API, name string) bool
• func List(miniHome ...string) (validMachines []*Machine, inValidMachines []*Machine, err error)
• func LoadImages(cc *config.ClusterConfig, runner command.Runner, images []string, ...) error
• func NewAPIClient() (libmachine.API, error)
• func NewRPCClient(storePath, certsDir string) libmachine.API
• func StartDriver()
• func StartHost(api libmachine.API, cfg config.ClusterConfig, n config.Node) (*host.Host, error)
• func StopHost(api libmachine.API, machineName string) error
• type CertGenerator
  • func (cg *CertGenerator) ValidateCertificate(addr string, authOptions *auth.Options) (bool, error)
• type ConnChecker
  • func (cc *ConnChecker) Check(h *host.Host, swarm bool) (string, *auth.Options, error)
• type LocalClient
  • func (api *LocalClient) Close() error
  • func (api *LocalClient) Create(h *host.Host) error
  • func (api *LocalClient) Load(name string) (*host.Host, error)
  • func (api *LocalClient) NewHost(drvName string, rawDriver []byte) (*host.Host, error)
• type Machine
  • func Load(name string) (*Machine, error)
  • func (h *Machine) IsValid() bool

Variables

var (
	// ErrorMachineNotExist is returned when virtual machine does not exist due to user interrupt cancel(i.e. Ctrl + C)
	ErrorMachineNotExist = errors.New("machine does not exist")
)

Functions

func CacheAndLoadImages

func CacheAndLoadImages(images []string) error

CacheAndLoadImages caches and loads images to all profiles

func CacheBinariesForBootstrapper

func CacheBinariesForBootstrapper(version string, clusterBootstrapper string) error

CacheBinariesForBootstrapper will cache binaries for a bootstrapper

func CacheImagesForBootstrapper

func CacheImagesForBootstrapper(imageRepository string, version string, clusterBootstrapper string) error

CacheImagesForBootstrapper will cache images for a bootstrapper

func CheckIfHostExistsAndLoad

func CheckIfHostExistsAndLoad(api libmachine.API, machineName string) (*host.Host, error)

CheckIfHostExistsAndLoad checks if a host exists, and loads it if it does

func CommandRunner

func CommandRunner(h *host.Host) (command.Runner, error)

CommandRunner returns best available command runner for this host

func CopyBinary

func CopyBinary(cr command.Runner, src string, dest string) error

CopyBinary copies a locally cached binary to the guest VM

func CreateSSHShell

func CreateSSHShell(api libmachine.API, cc config.ClusterConfig, n config.Node, args []string) error

CreateSSHShell creates a new SSH shell / client

func DeleteHost

func DeleteHost(api libmachine.API, machineName string) error

DeleteHost deletes the host VM.

func GetHostStatus

func GetHostStatus(api libmachine.API, machineName string) (string, error)

GetHostStatus gets the status of the host VM.

func IsHostRunning

func IsHostRunning(api libmachine.API, name string) bool

IsHostRunning asserts that this profile's primary host is in state "Running"

func List

func List(miniHome ...string) (validMachines []*Machine, inValidMachines []*Machine, err error)

List return all valid and invalid machines If a machine is valid or invalid is determined by the cluster.IsValid function

func LoadImages

func LoadImages(cc *config.ClusterConfig, runner command.Runner, images []string, cacheDir string) error

LoadImages loads previously cached images into the container runtime

func NewAPIClient

func NewAPIClient() (libmachine.API, error)

NewAPIClient gets a new client.

func NewRPCClient

func NewRPCClient(storePath, certsDir string) libmachine.API

NewRPCClient gets a new client.

func StartDriver

func StartDriver()

StartDriver starts the driver

func StartHost

func StartHost(api libmachine.API, cfg config.ClusterConfig, n config.Node) (*host.Host, error)

StartHost starts a host VM.

func StopHost

func StopHost(api libmachine.API, machineName string) error

StopHost stops the host VM, saving state to disk.

Types

type CertGenerator

type CertGenerator struct {
	cert.X509CertGenerator
}

CertGenerator is used to override the default machine CertGenerator with a longer timeout.

func (*CertGenerator) ValidateCertificate

func (cg *CertGenerator) ValidateCertificate(addr string, authOptions *auth.Options) (bool, error)

ValidateCertificate is a reimplementation of the default generator with a longer timeout.

type ConnChecker

type ConnChecker struct {
}

ConnChecker can check the connection

func (*ConnChecker) Check

func (cc *ConnChecker) Check(h *host.Host, swarm bool) (string, *auth.Options, error)

Check checks the connection

type LocalClient

type LocalClient struct {
	*persist.Filestore
	// contains filtered or unexported fields
}

LocalClient is a non-RPC implementation of the libmachine API

func (*LocalClient) Close

func (api *LocalClient) Close() error

Close closes the client

func (*LocalClient) Create

func (api *LocalClient) Create(h *host.Host) error

Create creates the host

func (*LocalClient) Load

func (api *LocalClient) Load(name string) (*host.Host, error)

Load a new client, creating driver

func (*LocalClient) NewHost

func (api *LocalClient) NewHost(drvName string, rawDriver []byte) (*host.Host, error)

NewHost creates a new Host

type Machine

type Machine struct {
	*host.Host
}

Machine contains information about a machine

func Load

func Load(name string) (*Machine, error)

Load loads a machine or throws an error if the machine could not be loaded.

func (*Machine) IsValid

func (h *Machine) IsValid() bool

IsValid checks if the machine has the essential info needed for a machine