drivers

Documentation

Index

• type Driver
• type DriverConfig
• type HostConfig

Types

type Driver

type Driver interface {
	// Context returns the base context.
	Context() *base.Context

	// DockerMachineDriver returns the name of the docker-machine driver.
	DockerMachineDriver() string

	// Init is called when creating the driver. This will typically
	// setup credentials.
	Init() error

	// DockerMachineCreateArgs returns the list of driver-specific arguments
	// to pass to 'docker-machine create'
	DockerMachineCreateArgs() []string

	// PrintStatus asks the driver to print some basic status to stdout.
	PrintStatus()

	// GetNodeConfig takes a node name and reads its docker-machine config.
	GetNodeConfig(name string) (*HostConfig, error)

	// AfterFirstNode runs any steps needed after the first node was created.
	AfterFirstNode() error

	// StartNode runs any steps needed when starting an existing node.
	StartNode(name string, config *HostConfig) error

	// StopNode runs any steps needed when stopping a node.
	StopNode(name string, config *HostConfig) error
}

Driver is the interface for all drivers.

type DriverConfig

type DriverConfig interface {
	// DataDir is the directory used as the data directory.
	DataDir() string
	// IPAddress is the node address cockroach should bind to.
	IPAddress() string
	// GossipAddress is the address to reach the gossip network.
	GossipAddress() string
}

DriverConfig describes the docker-machine host driver configs. It is implemented by each driver.

type HostConfig

type HostConfig struct {
	DriverName string
	Driver     DriverConfig
}

HostConfig describes the docker-machine host config. Driver is the driver-specific config. We only specify the fields we currently use. For the full list, see: https://github.com/docker/machine/blob/master/libmachine/host.go