drivers

package
v0.16.2-gitlab.18 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 18, 2022 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DefaultSSHUser          = "root"
	DefaultSSHPort          = 22
	DefaultEngineInstallURL = "https://get.docker.com"
)

Variables

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

Functions

func EngineInstallURLFlagSet 

func EngineInstallURLFlagSet(flags DriverOptions) bool

func EngineInstallURLSet 

func EngineInstallURLSet(url string) bool

func GetSSHClientFromDriver 

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

func MachineInState 

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

func MustBeRunning 

func MustBeRunning(d Driver) error

MustBeRunning will return an error if the machine is not in a running state.

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
	MachineName    string
	SSHUser        string
	SSHPort        int
	SSHKeyPath     string
	StorePath      string
	SwarmMaster    bool
	SwarmHost      string
	SwarmDiscovery string
}

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

func (*BaseDriver) DriverName 

func (d *BaseDriver) DriverName() string

DriverName returns the name of the driver

func (*BaseDriver) GetIP 

func (d *BaseDriver) GetIP() (string, error)

GetIP returns the ip

func (*BaseDriver) GetMachineName 

func (d *BaseDriver) GetMachineName() string

GetMachineName returns the machine name

func (*BaseDriver) GetSSHKeyPath 

func (d *BaseDriver) GetSSHKeyPath() string

GetSSHKeyPath returns the ssh key path

func (*BaseDriver) GetSSHPort 

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

GetSSHPort returns the ssh port, 22 if not specified

func (*BaseDriver) GetSSHUsername 

func (d *BaseDriver) GetSSHUsername() string

GetSSHUsername returns the ssh user name, root if not specified

func (*BaseDriver) PreCreateCheck 

func (d *BaseDriver) PreCreateCheck() error

PreCreateCheck is called to enforce pre-creation steps

func (*BaseDriver) ResolveStorePath 

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

ResolveStorePath returns the store path where the machine is

func (*BaseDriver) SetSwarmConfigFromFlags 

func (d *BaseDriver) SetSwarmConfigFromFlags(flags DriverOptions)

SetSwarmConfigFromFlags configures the driver for swarm

type CheckDriverOptions 

type CheckDriverOptions struct {
	FlagsValues  map[string]interface{}
	CreateFlags  []mcnflag.Flag
	InvalidFlags []string
}

CheckDriverOptions implements DriverOptions and is used to validate flag parsing

func (*CheckDriverOptions) Bool 

func (o *CheckDriverOptions) Bool(key string) bool

func (*CheckDriverOptions) Int 

func (o *CheckDriverOptions) Int(key string) int

func (*CheckDriverOptions) String 

func (o *CheckDriverOptions) String(key string) string

func (*CheckDriverOptions) StringSlice 

func (o *CheckDriverOptions) StringSlice(key string) []string

type Driver 

type Driver interface {
	// Create a host using the driver's config
	Create() error

	// DriverName returns the name of the driver
	DriverName() string

	// GetCreateFlags returns the mcnflag.Flag slice representing the flags
	// that can be set, their descriptions and defaults.
	GetCreateFlags() []mcnflag.Flag

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

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

func NewDriverNotSupported 

func NewDriverNotSupported(driverName, hostName, storePath string) Driver

NewDriverNotSupported creates a placeholder Driver that replaces a driver that is not supported on a given platform. eg fusion on linux.

func NewSerialDriver 

func NewSerialDriver(innerDriver Driver) Driver

type DriverNotSupported 

type DriverNotSupported struct {
	*BaseDriver
	Name string
}

func (*DriverNotSupported) Create 

func (d *DriverNotSupported) Create() error

func (*DriverNotSupported) DriverName 

func (d *DriverNotSupported) DriverName() string

func (*DriverNotSupported) GetCreateFlags 

func (d *DriverNotSupported) GetCreateFlags() []mcnflag.Flag

func (*DriverNotSupported) GetSSHHostname 

func (d *DriverNotSupported) GetSSHHostname() (string, error)

func (*DriverNotSupported) GetState 

func (d *DriverNotSupported) GetState() (state.State, error)

func (*DriverNotSupported) GetURL 

func (d *DriverNotSupported) GetURL() (string, error)

func (*DriverNotSupported) Kill 

func (d *DriverNotSupported) Kill() error

func (*DriverNotSupported) PreCreateCheck 

func (d *DriverNotSupported) PreCreateCheck() error

func (*DriverNotSupported) Remove 

func (d *DriverNotSupported) Remove() error

func (*DriverNotSupported) Restart 

func (d *DriverNotSupported) Restart() error

func (*DriverNotSupported) SetConfigFromFlags 

func (d *DriverNotSupported) SetConfigFromFlags(flags DriverOptions) error

func (*DriverNotSupported) Start 

func (d *DriverNotSupported) Start() error

func (*DriverNotSupported) Stop 

func (d *DriverNotSupported) Stop() error

func (*DriverNotSupported) Upgrade 

func (d *DriverNotSupported) Upgrade() error

type DriverOptions 

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

type NotSupported 

type NotSupported struct {
	DriverName string
}

func (NotSupported) Error 

func (e NotSupported) Error() string

type SerialDriver 

type SerialDriver struct {
	Driver
	sync.Locker
}

SerialDriver is a wrapper struct which is used to ensure that RPC calls to a driver only occur one at a time. Some providers, e.g. virtualbox, should not run driver operations at the same time as other driver instances of the same type. Otherwise, we scrape up against VirtualBox's own locking mechanisms.

It would be preferable to simply have a lock around, say, the VBoxManage command, but with our current one-server-process-per-machine model it is impossible to dictate this locking on the server side.

func (*SerialDriver) Create 

func (d *SerialDriver) Create() error

Create a host using the driver's config

func (*SerialDriver) DriverName 

func (d *SerialDriver) DriverName() string

DriverName returns the name of the driver as it is registered

func (*SerialDriver) GetCreateFlags 

func (d *SerialDriver) GetCreateFlags() []mcnflag.Flag

GetCreateFlags returns the mcnflag.Flag slice representing the flags that can be set, their descriptions and defaults.

func (*SerialDriver) GetIP 

func (d *SerialDriver) GetIP() (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

func (*SerialDriver) GetMachineName 

func (d *SerialDriver) GetMachineName() string

GetMachineName returns the name of the machine

func (*SerialDriver) GetSSHHostname 

func (d *SerialDriver) GetSSHHostname() (string, error)

GetSSHHostname returns hostname for use with ssh

func (*SerialDriver) GetSSHKeyPath 

func (d *SerialDriver) GetSSHKeyPath() string

GetSSHKeyPath returns key path for use with ssh

func (*SerialDriver) GetSSHPort 

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

GetSSHPort returns port for use with ssh

func (*SerialDriver) GetSSHUsername 

func (d *SerialDriver) GetSSHUsername() string

GetSSHUsername returns username for use with ssh

func (*SerialDriver) GetState 

func (d *SerialDriver) GetState() (state.State, error)

GetState returns the state that the host is in (running, stopped, etc)

func (*SerialDriver) GetURL 

func (d *SerialDriver) GetURL() (string, error)

GetURL returns a Docker compatible host URL for connecting to this host e.g. tcp://1.2.3.4:2376

func (*SerialDriver) Kill 

func (d *SerialDriver) Kill() error

Kill stops a host forcefully

func (*SerialDriver) MarshalJSON 

func (d *SerialDriver) MarshalJSON() ([]byte, error)

func (*SerialDriver) PreCreateCheck 

func (d *SerialDriver) PreCreateCheck() error

PreCreateCheck allows for pre-create operations to make sure a driver is ready for creation

func (*SerialDriver) Remove 

func (d *SerialDriver) Remove() error

Remove a host

func (*SerialDriver) Restart 

func (d *SerialDriver) Restart() error

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

func (*SerialDriver) SetConfigFromFlags 

func (d *SerialDriver) SetConfigFromFlags(opts DriverOptions) error

SetConfigFromFlags configures the driver with the object that was returned by RegisterCreateFlags

func (*SerialDriver) Start 

func (d *SerialDriver) Start() error

Start a host

func (*SerialDriver) Stop 

func (d *SerialDriver) Stop() error

Stop a host gracefully

Source Files

View all Source files

Directories

Path Synopsis
localbinary

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.