mirror of
https://github.com/docker/docs.git
synced 2026-04-04 18:28:58 +07:00
861b16dba9
This work sets the machine name in the Cloud API or Hypervisor. As well as setting the hostname inside the VM. I've added the machine name to the NewDriver func to allow for identification by Cloud APIs and for the driver package. Each driver will attempt to set the hostname for the VM, except for Azure, which sets it based on the DNS name. Signed-off-by: Simon Thulbourn <simon+github@thulbourn.com>
135 lines
3.5 KiB
Go
135 lines
3.5 KiB
Go
package drivers
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"os/exec"
|
|
"sort"
|
|
|
|
"github.com/codegangsta/cli"
|
|
"github.com/docker/machine/state"
|
|
)
|
|
|
|
// 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)
|
|
type Driver interface {
|
|
// DriverName returns the name of the driver as it is registered
|
|
DriverName() string
|
|
|
|
// SetConfigFromFlags configures the driver with the object that was returned
|
|
// by RegisterCreateFlags
|
|
SetConfigFromFlags(flags DriverOptions) error
|
|
|
|
// GetURL returns a Docker compatible host URL for connecting to this host
|
|
// e.g. tcp://1.2.3.4:2376
|
|
GetURL() (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
|
|
GetIP() (string, error)
|
|
|
|
// GetState returns the state that the host is in (running, stopped, etc)
|
|
GetState() (state.State, error)
|
|
|
|
// Create a host using the driver's config
|
|
Create() error
|
|
|
|
// Remove a host
|
|
Remove() error
|
|
|
|
// Start a host
|
|
Start() error
|
|
|
|
// Stop a host gracefully
|
|
Stop() error
|
|
|
|
// Restart a host. This may just call Stop(); Start() if the provider does not
|
|
// have any special restart behaviour.
|
|
Restart() error
|
|
|
|
// Kill stops a host forcefully
|
|
Kill() error
|
|
|
|
// Upgrade the version of Docker on the host to the latest version
|
|
Upgrade() error
|
|
|
|
// GetSSHCommand returns a command for SSH pointing at the correct user, host
|
|
// and keys for the host with args appended. If no args are passed, it will
|
|
// initiate an interactive SSH session as if SSH were passed no args.
|
|
GetSSHCommand(args ...string) (*exec.Cmd, error)
|
|
}
|
|
|
|
// RegisteredDriver is used to register a driver with the Register function.
|
|
// It has two attributes:
|
|
// - New: a function that returns a new driver given a path to store host
|
|
// configuration in
|
|
// - RegisterCreateFlags: a function that takes the FlagSet for
|
|
// "docker hosts create" and returns an object to pass to SetConfigFromFlags
|
|
type RegisteredDriver struct {
|
|
New func(machineName string, storePath string) (Driver, error)
|
|
GetCreateFlags func() []cli.Flag
|
|
}
|
|
|
|
var ErrHostIsNotRunning = errors.New("host is not running")
|
|
|
|
var (
|
|
drivers map[string]*RegisteredDriver
|
|
)
|
|
|
|
func init() {
|
|
drivers = make(map[string]*RegisteredDriver)
|
|
}
|
|
|
|
// Register a driver
|
|
func Register(name string, registeredDriver *RegisteredDriver) error {
|
|
if _, exists := drivers[name]; exists {
|
|
return fmt.Errorf("Name already registered %s", name)
|
|
}
|
|
|
|
drivers[name] = registeredDriver
|
|
return nil
|
|
}
|
|
|
|
// NewDriver creates a new driver of type "name"
|
|
func NewDriver(name string, machineName string, storePath string) (Driver, error) {
|
|
driver, exists := drivers[name]
|
|
if !exists {
|
|
return nil, fmt.Errorf("hosts: Unknown driver %q", name)
|
|
}
|
|
return driver.New(machineName, storePath)
|
|
}
|
|
|
|
// GetCreateFlags runs GetCreateFlags for all of the drivers and
|
|
// returns their return values indexed by the driver name
|
|
func GetCreateFlags() []cli.Flag {
|
|
flags := []cli.Flag{}
|
|
|
|
for driverName := range drivers {
|
|
driver := drivers[driverName]
|
|
for _, f := range driver.GetCreateFlags() {
|
|
flags = append(flags, f)
|
|
}
|
|
}
|
|
|
|
sort.Sort(ByFlagName(flags))
|
|
|
|
return flags
|
|
}
|
|
|
|
// GetDriverNames returns a slice of all registered driver names
|
|
func GetDriverNames() []string {
|
|
names := make([]string, 0, len(drivers))
|
|
for k := range drivers {
|
|
names = append(names, k)
|
|
}
|
|
sort.Strings(names)
|
|
return names
|
|
}
|
|
|
|
type DriverOptions interface {
|
|
String(key string) string
|
|
Int(key string) int
|
|
Bool(key string) bool
|
|
}
|