pod

Documentation

Index

• type Driver
  • func NewDriver(machineName string, storePath string) *Driver
  • func (d *Driver) Create() error
  • func (d *Driver) DriverName() string
  • func (d *Driver) GetCreateFlags() []mcnflag.Flag
  • func (d *Driver) GetIP() (string, error)
  • func (d *Driver) GetSSHHostname() (string, error)
  • func (d *Driver) GetSSHUsername() string
  • func (d *Driver) GetState() (state.State, error)
  • func (d *Driver) GetURL() (string, error)
  • func (d *Driver) Kill() error
  • func (d *Driver) PreCreateCheck() error
  • func (d *Driver) Remove() error
  • func (d *Driver) Restart() error
  • func (d *Driver) SetConfigFromFlags(flags drivers.DriverOptions) error
  • func (d *Driver) Start() error
  • func (d *Driver) Stop() error

Types

type Driver

type Driver struct {
	*drivers.BaseDriver
	Userdata string
	Image    string
}

Driver is a struct compatible with the docker.hosts.drivers.Driver interface.

func NewDriver

func NewDriver(machineName string, storePath string) *Driver

NewDriver creates a Driver with the specified storePath.

func (*Driver) Create

func (d *Driver) Create() error

Create creates a pod VM instance acting as a docker host.

func (*Driver) DriverName

func (d *Driver) DriverName() string

DriverName returns the name of the driver

func (*Driver) GetCreateFlags

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

GetCreateFlags registers the flags this driver adds to "docker hosts create"

func (*Driver) GetIP

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

GetIP returns the IP address of the pod instance.

func (*Driver) GetSSHHostname

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

GetSSHHostname returns hostname for use with ssh

func (*Driver) GetSSHUsername

func (d *Driver) GetSSHUsername() string

GetSSHUsername returns username for use with ssh

func (*Driver) GetState

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

GetState returns a docker.hosts.state.State value representing the current state of the host.

func (*Driver) GetURL

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

GetURL returns the URL of the remote docker daemon.

func (*Driver) Kill

func (d *Driver) Kill() error

Kill stops an existing pod instance.

func (*Driver) PreCreateCheck

func (d *Driver) PreCreateCheck() error

PreCreateCheck is called to enforce pre-creation steps

func (*Driver) Remove

func (d *Driver) Remove() error

Remove deletes the Pod

func (*Driver) Restart

func (d *Driver) Restart() error

Restart restarts a machine which is known to be running.

func (*Driver) SetConfigFromFlags

func (d *Driver) SetConfigFromFlags(flags drivers.DriverOptions) error

SetConfigFromFlags initializes the driver based on the command line flags.

func (*Driver) Start

func (d *Driver) Start() error

Start starts an existing pod instance or create an instance with an existing disk.

func (*Driver) Stop

func (d *Driver) Stop() error

Stop stops an existing pod instance.