drivers

Documentation

Index

• Variables
• func AddPublicKeyToAuthorizedHosts(d Driver, authorizedKeysPath string) error
• func GetDriverNames() []string
• func Register(name string, registeredDriver *RegisteredDriver) error
• func RegisterCreateFlags(cmd *flag.FlagSet) map[string]interface{}
• type Driver
  • func NewDriver(name string, storePath string) (Driver, error)
• type RegisteredDriver

Variables

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

Functions

func AddPublicKeyToAuthorizedHosts

func AddPublicKeyToAuthorizedHosts(d Driver, authorizedKeysPath string) error

func GetDriverNames

func GetDriverNames() []string

GetDriverNames returns a slice of all registered driver names

func Register

func Register(name string, registeredDriver *RegisteredDriver) error

Register a driver

func RegisterCreateFlags

func RegisterCreateFlags(cmd *flag.FlagSet) map[string]interface{}

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

Types

type Driver

type Driver interface {
	// DriverName returns the name of the driver as it is registered
	DriverName() string

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

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

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

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

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

	// Remove a host
	Remove() error

	// Start a host
	Start() error

	// Stop a host gracefully
	Stop() error

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

	// Kill stops a host forcefully
	Kill() error

	// Upgrade the version of Docker on the host to the latest version
	Upgrade() error

	// GetSSHCommand returns a command for SSH pointing at the correct user, host
	// and keys for the host with args appended. If no args are passed, it will
	// initiate an interactive SSH session as if SSH were passed no args.
	GetSSHCommand(args ...string) (*exec.Cmd, 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)

func NewDriver

func NewDriver(name string, storePath string) (Driver, error)

NewDriver creates a new driver of type "name"

type RegisteredDriver

type RegisteredDriver struct {
	New                 func(storePath string) (Driver, error)
	RegisterCreateFlags func(cmd *flag.FlagSet) interface{}
}

RegisteredDriver is used to register a driver with the Register function. It has two attributes:

• New: a function that returns a new driver given a path to store host configuration in
• RegisterCreateFlags: a function that takes the FlagSet for "docker hosts create" and returns an object to pass to SetConfigFromFlags