multidocker

Documentation

Index

• Constants
• type Host
  • func NewHost(config HostConfig, dir string) (Host, error)
• type HostConfig
• type Provisioner
  • func NewBundleProvisioner(bundlePath string) (Provisioner, error)
• type State
  • func (s State) String() string
• type Store
  • func DefaultStore() Store

Constants

const (
	// HostConfigJSONFile is the basename for the HostConfig JSON.
	HostConfigJSONFile = "config.v0.json"
)

Types

type Host

type Host interface {
	Config() HostConfig
	Dir() (string, error)
	Create() error
	URL() (string, error)
	State() (State, error)
	Remove() error
	Start() error
	Stop() error
}

Host is similar to Docker Machine's Driver.

func NewHost

func NewHost(config HostConfig, dir string) (Host, error)

NewHost create a host with config. dir must be an absolute path.

type HostConfig

type HostConfig struct {
	// name of the host. e.g. "foobar"
	Name string `json:"name"`

	// storage driver
	EngineStorageDriver string `json:"engine_storage_driver"`
}

HostConfig is a config JSON for a host.

type Provisioner

type Provisioner interface {
	Install(Host) error
}

Provisioner installs Docker Engine to a host.

func NewBundleProvisioner

func NewBundleProvisioner(bundlePath string) (Provisioner, error)

NewBundleProvisioner instantiates a provisioner for the bundle.

type State

type State int

State represents the state of a host

const (
	// UnknownState is an unknown state.
	UnknownState State = iota
	// Running denotes that the host is running.
	Running
	// Stopped denotes that the host is not running.
	Stopped
)

func (State) String

func (s State) String() string

type Store

type Store interface {
	StorePath() string
	Host(string) (Host, error)
	Hosts() ([]Host, error)
	AllocateHostDir(string) (string, error)
	RegisterHost(Host) error
}

Store is the root directory for a multidocker environment.

func DefaultStore

func DefaultStore() Store

DefaultStore uses /var/lib/multidocker as the store.