Documentation
¶
Index ¶
- Variables
- type 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) GetSSHPort() (int, 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
Constants ¶
This section is empty.
Variables ¶
var VERSION = "devel"
VERSION represents the semver version of the package
Functions ¶
This section is empty.
Types ¶
type Driver ¶
type Driver struct {
*drivers.BaseDriver
APIToken string
UserAgentPrefix string
IPAddress string
PrivateIPAddress string
CreatePrivateIP bool
DockerPort int
InstanceID int
InstanceLabel string
Region string
InstanceType string
RootPassword string
AuthorizedUsers string
SSHPort int
InstanceImage string
SwapSize int
StackScriptID int
StackScriptUser string
StackScriptLabel string
StackScriptData map[string]string
Tags string
// contains filtered or unexported fields
}
Driver is the implementation of BaseDriver interface
func (*Driver) DriverName ¶
DriverName returns the name of the driver
func (*Driver) GetCreateFlags ¶
GetCreateFlags returns the mcnflag.Flag slice representing the flags that can be set, their descriptions and defaults.
func (*Driver) GetIP ¶
GetIP returns an IP or hostname that this host is available at e.g. 1.2.3.4 or docker-host-d60b70a14d3a.cloudapp.net Note that currently the IP Address is cached
func (*Driver) GetSSHHostname ¶
GetSSHHostname returns hostname for use with ssh
func (*Driver) GetSSHPort ¶ added in v0.0.12
GetSSHPort returns port for use with ssh
func (*Driver) GetSSHUsername ¶
GetSSHUsername returns username for use with ssh
func (*Driver) GetURL ¶
GetURL returns a Docker compatible host URL for connecting to this host e.g. tcp://1.2.3.4:2376
func (*Driver) PreCreateCheck ¶
PreCreateCheck allows for pre-create operations to make sure a driver is ready for creation
func (*Driver) Restart ¶
Restart a host. This may just call Stop(); Start() if the provider does not have any special restart behaviour.
func (*Driver) SetConfigFromFlags ¶
func (d *Driver) SetConfigFromFlags(flags drivers.DriverOptions) error
SetConfigFromFlags configures the driver with the object that was returned by RegisterCreateFlags
Source Files