drivers

Documentation

Index

• Constants
• Variables
• func GetCreateFlags() []cli.Flag
• func GetCreateFlagsForDriver(name string) ([]cli.Flag, error)
• func GetDriverNames() []string
• func GetSSHClientFromDriver(d Driver) (ssh.Client, error)
• func MachineInState(d Driver, desiredState state.State) func() bool
• func Register(name string, registeredDriver *RegisteredDriver) error
• func RunSSHCommandFromDriver(d Driver, command string) (string, error)
• func WaitForSSH(d Driver) error
• type BaseDriver
  • func (d *BaseDriver) AuthorizePort(ports []*Port) error
  • func (d *BaseDriver) DeauthorizePort(ports []*Port) error
  • func (d *BaseDriver) DriverName() string
  • func (d *BaseDriver) GetMachineName() string
  • func (d *BaseDriver) GetSSHKeyPath() string
  • func (d *BaseDriver) GetSSHPort() (int, error)
  • func (d *BaseDriver) GetSSHUsername() string
  • func (d *BaseDriver) GlobalArtifactPath() string
  • func (d *BaseDriver) LocalArtifactPath(file string) string
• type ByFlagName
  • func (flags ByFlagName) Len() int
  • func (flags ByFlagName) Less(i, j int) bool
  • func (flags ByFlagName) Swap(i, j int)
• type Driver
• type DriverOptions
• type DriverOptionsMock
  • func (d DriverOptionsMock) Bool(key string) bool
  • func (d DriverOptionsMock) Int(key string) int
  • func (d DriverOptionsMock) String(key string) string
  • func (d DriverOptionsMock) StringSlice(key string) []string
• type Port
• type RegisteredDriver

Constants

const (
	ErrExitCode255 = "255"
)

Variables

var ErrHostIsNotRunning = errors.New("Host is not running")

Functions

func GetCreateFlags

func GetCreateFlags() []cli.Flag

GetCreateFlags runs GetCreateFlags for all of the drivers and returns their return values indexed by the driver name

func GetCreateFlagsForDriver

func GetCreateFlagsForDriver(name string) ([]cli.Flag, error)

func GetDriverNames

func GetDriverNames() []string

GetDriverNames returns a slice of all registered driver names

func GetSSHClientFromDriver

func GetSSHClientFromDriver(d Driver) (ssh.Client, error)

func MachineInState

func MachineInState(d Driver, desiredState state.State) func() bool

func Register

func Register(name string, registeredDriver *RegisteredDriver) error

Register a driver

func RunSSHCommandFromDriver

func RunSSHCommandFromDriver(d Driver, command string) (string, error)

func WaitForSSH

func WaitForSSH(d Driver) error

Types

type BaseDriver

type BaseDriver struct {
	IPAddress      string
	SSHUser        string
	SSHPort        int
	MachineName    string
	SwarmMaster    bool
	SwarmHost      string
	SwarmDiscovery string
	ArtifactPath   string
}

BaseDriver - Embed this struct into drivers to provide the common set of fields and functions.

func (*BaseDriver) AuthorizePort

func (d *BaseDriver) AuthorizePort(ports []*Port) error

AuthorizePort -

func (*BaseDriver) DeauthorizePort

func (d *BaseDriver) DeauthorizePort(ports []*Port) error

DeauthorizePort -

func (*BaseDriver) DriverName

func (d *BaseDriver) DriverName() string

DriverName - This must be implemented in every driver

func (*BaseDriver) GetMachineName

func (d *BaseDriver) GetMachineName() string

GetMachineName -

func (*BaseDriver) GetSSHKeyPath

func (d *BaseDriver) GetSSHKeyPath() string

GetSSHKeyPath -

func (*BaseDriver) GetSSHPort

func (d *BaseDriver) GetSSHPort() (int, error)

GetSSHPort -

func (*BaseDriver) GetSSHUsername

func (d *BaseDriver) GetSSHUsername() string

GetSSHUsername -

func (*BaseDriver) GlobalArtifactPath

func (d *BaseDriver) GlobalArtifactPath() string

GlobalArtifactPath -

func (*BaseDriver) LocalArtifactPath

func (d *BaseDriver) LocalArtifactPath(file string) string

LocalArtifactPath -

type ByFlagName

type ByFlagName []cli.Flag

func (ByFlagName) Len

func (flags ByFlagName) Len() int

func (ByFlagName) Less

func (flags ByFlagName) Less(i, j int) bool

func (ByFlagName) Swap

func (flags ByFlagName) Swap(i, j int)

type Driver

type Driver interface {
	// AuthorizePort authorizes a port for machine access
	AuthorizePort(ports []*Port) error

	// Create a host using the driver's config
	Create() error

	// DeauthorizePort removes a port for machine access
	DeauthorizePort(ports []*Port) error

	// DriverName returns the name of the driver as it is registered
	DriverName() string

	// GetIP returns an IP or hostname that this host is available at
	// e.g. 1.2.3.4 or docker-host-d60b70a14d3a.cloudapp.net
	GetIP() (string, error)

	// GetMachineName returns the name of the machine
	GetMachineName() string

	// GetSSHHostname returns hostname for use with ssh
	GetSSHHostname() (string, error)

	// GetSSHKeyPath returns key path for use with ssh
	GetSSHKeyPath() string

	// GetSSHPort returns port for use with ssh
	GetSSHPort() (int, error)

	// GetSSHUsername returns username for use with ssh
	GetSSHUsername() string

	// GetURL returns a Docker compatible host URL for connecting to this host
	// e.g. tcp://1.2.3.4:2376
	GetURL() (string, error)

	// GetState returns the state that the host is in (running, stopped, etc)
	GetState() (state.State, error)

	// Kill stops a host forcefully
	Kill() error

	LocalArtifactPath(string) string

	GlobalArtifactPath() string

	// PreCreateCheck allows for pre-create operations to make sure a driver is ready for creation
	PreCreateCheck() error

	// Remove a host
	Remove() error

	// Restart a host. This may just call Stop(); Start() if the provider does not
	// have any special restart behaviour.
	Restart() error

	// SetConfigFromFlags configures the driver with the object that was returned
	// by RegisterCreateFlags
	SetConfigFromFlags(flags DriverOptions) error

	// Start a host
	Start() error

	// Stop a host gracefully
	Stop() error
}

Driver defines how a host is created and controlled. Different types of driver represent different ways hosts can be created (e.g. different hypervisors, different cloud providers)

type DriverOptions

type DriverOptions interface {
	String(key string) string
	StringSlice(key string) []string
	Int(key string) int
	Bool(key string) bool
}

type DriverOptionsMock

type DriverOptionsMock struct {
	Data map[string]interface{}
}

func (DriverOptionsMock) Bool

func (d DriverOptionsMock) Bool(key string) bool

func (DriverOptionsMock) Int

func (d DriverOptionsMock) Int(key string) int

func (DriverOptionsMock) String

func (d DriverOptionsMock) String(key string) string

func (DriverOptionsMock) StringSlice

func (d DriverOptionsMock) StringSlice(key string) []string

type Port

type Port struct {
	Protocol string
	Port     int
}

type RegisteredDriver

type RegisteredDriver struct {
	// GetCreateFlags gets the FlagSet for "docker-machine create" for
	// display to the user.
	GetCreateFlags func() []cli.Flag
}

RegisteredDriver is a wrapper struct used to "register" drivers so that information about them can be displayed in the CLI.