godaddy

README

Docker Machine GoDaddy Driver

A Docker Machine driver plugin for GoDaddy Cloud Servers.

Requirements

• Docker Machine 0.5.1 or a newer version

Installation

Releases

For a simple single-line install, run the following:

$ curl https://git.io/v63cR | sudo bash

Not a fan of curl | bash? No problem.

Download the latest version of docker-machine-driver-godaddy from GitHub Releases, ensure the plugin is executable, and copy to a directory included in your environment's PATH variable:

$ curl -L https://github.com/aka-bo/docker-machine-godaddy/releases/download/v1.0.0/docker-machine-driver-godaddy-$(uname -s) > docker-machine-driver-godaddy
$ chmod +x docker-machine-driver-godaddy
$ mv docker-machine-driver-godaddy /usr/local/lib/  # use sudo if necessary

From Source

Ensure Go and Godep are properly installed and your $GOPATH variable is set.

$ go get -u github.com/aka-bo/docker-machine-godaddy
$ cd $GOPATH/src/github.com/aka-bo/docker-machine-godaddy
$ make build
$ make install

Usage

Official documentation for Docker Machine is available here.

To create machines on GoDaddy Cloud Servers you will need an API key associated with your GoDaddy account. API keys can be obtained on the GoDaddy Developer Portal.

With an API key in hand, you can create a new server with:

$ docker-machine create --driver godaddy --godaddy-api-key=${APIKEY} myhost

Alternatively, you can use environment variables:

$ export GODADDY_API_KEY=${APIKEY}
$ docker-machine create -d godaddy myhost

Options:

• --godaddy-api-key: Your GoDaddy API key.
• --godaddy-base-api-url: The GoDaddy API endpoint.
• --godaddy-boot-timeout: Amount of time (in seconds) to wait for the initial boot.
• --godaddy-image: The image to use for the new server.
• --godaddy-spec: The server spec to use for the new server.
• --godaddy-ssh-key: Private keyfile to use for SSH (absolute path).
• --godaddy-ssh-key-id: Id of the existing GoDaddy SSH Key to associate with this new server.
• --godaddy-data-center: The GoDaddy data center to launch the server in.
• --godaddy-zone: The data center zone to launch the server in.
• --godaddy-ssh-user: Name of the user to be used for SSH.

Environment variables and default values:

CLI option	Environment variable	Default
--godaddy-api-key	GODADDY_API_KEY	-
--godaddy-base-api-url	GODADDY_API_URL	https://api.godaddy.com
--godaddy-boot-timeout	GODADDY_BOOT_TIMEOUT	120
--godaddy-image	GODADDY_IMAGE	ubuntu-1604
--godaddy-spec	GODADDY_SPEC	tiny
--godaddy-ssh-key	GODADDY_SSH_KEY	-
--godaddy-ssh-key-id	GODADDY_SSH_KEY_ID	-
--godaddy-data-center	GODADDY_DATA_CENTER	phx
--godaddy-zone	GODADDY_ZONE	phx-1
--godaddy-ssh-user	GODADDY_SSH_USER	machine

Documentation

Index

• type Driver
  • func NewDriver(hostName, storePath string) *Driver
  • func (d *Driver) Create() error
  • func (d *Driver) DriverName() string
  • func (d *Driver) GetCreateFlags() []mcnflag.Flag
  • func (d *Driver) GetSSHHostname() (string, error)
  • func (d *Driver) GetSSHKeyPath() string
  • 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

	APIBaseURL        string
	Image             string
	DataCenter        string
	Zone              string
	Spec              string
	SSHKey            string
	SSHKeyID          string
	APIKey            string
	ServerID          string
	UsingSharedSSHKey bool
	BootTimeout       int
	// contains filtered or unexported fields
}

func NewDriver

func NewDriver(hostName, storePath string) *Driver

func (*Driver) Create

func (d *Driver) Create() error

func (*Driver) DriverName

func (d *Driver) DriverName() string

func (*Driver) GetCreateFlags

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

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

func (*Driver) GetSSHHostname

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

func (*Driver) GetSSHKeyPath

func (d *Driver) GetSSHKeyPath() string

func (*Driver) GetSSHUsername

func (d *Driver) GetSSHUsername() string

func (*Driver) GetState

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

func (*Driver) GetURL

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

func (*Driver) Kill

func (d *Driver) Kill() error

func (*Driver) PreCreateCheck

func (d *Driver) PreCreateCheck() error

func (*Driver) Remove

func (d *Driver) Remove() error

func (*Driver) Restart

func (d *Driver) Restart() error

func (*Driver) SetConfigFromFlags

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

func (*Driver) Start

func (d *Driver) Start() error

func (*Driver) Stop

func (d *Driver) Stop() error