docker-machine

README

Docker Machine

Machine makes it really easy to create Docker hosts on local hypervisors and cloud providers. It creates servers, installs Docker on them, then configures the Docker client to talk to them.

It works a bit like this:

$ docker-machine create -d virtualbox dev
[info] Downloading boot2docker...
[info] Creating SSH key...
[info] Creating VirtualBox VM...
[info] Starting VirtualBox VM...
[info] Waiting for VM to start...
[info] "dev" has been created and is now the active host. Docker commands will now run against that host.

$ docker-machine ls
NAME  	ACTIVE   DRIVER     	STATE 	URL
dev   	*    	virtualbox 	Running   tcp://192.168.99.100:2375

$ docker $(docker-machine config dev) run busybox echo hello world
Unable to find image 'busybox' locally
Pulling repository busybox
e72ac664f4f0: Download complete
511136ea3c5a: Download complete
df7546f9f060: Download complete
e433a6c5b276: Download complete
hello world

$ docker-machine create -d digitalocean --digitalocean-access-token=... staging
[info] Creating SSH key...
[info] Creating Digital Ocean droplet...
[info] Waiting for SSH...
[info] "staging" has been created and is now the active host. Docker commands will now run against that host.

$ docker-machine ls
NAME      ACTIVE   DRIVER         STATE     URL
dev                virtualbox     Running   tcp://192.168.99.108:2376
staging   *        digitalocean   Running   tcp://104.236.37.134:2376

Machine creates Docker hosts that are secure by default. The connection between the client and daemon is encrypted and authenticated using TLS security. To get the Docker arguments for a machine use the command: docker-machine config <machine-name> i.e. docker-machine config dev.

You can also get the commands to export environment variables to use with the Docker CLI: docker-machine env <machine-name> i.e. docker-machine env dev to show or $(docker-machine env dev) to load in your environment.

## Try it out

Machine is still in its early stages. If you'd like to try out a preview build, download it here.

Swarm

Machine can create Docker Swarm clusters.

First, create a Swarm token. Optionally, you can use another discovery service. See the Swarm docs for details.

To create the token, first create a Machine. This example will use VirtualBox.

$ docker-machine create -d virtualbox local

Load the Machine configuration into your shell:

$ $(docker-machine env local)

Then run generate the token using the Swarm Docker image:

$ docker run swarm create
1257e0f0bbb499b5cd04b4c9bdb2dab3

Once you have the token, you can create the cluster.

Swarm Master

Create the Swarm master:

docker-machine create -d virtualbox --swarm --swarm-master --swarm-discovery token://<TOKEN-FROM-ABOVE> swarm-master

Replace <TOKEN-FROM-ABOVE> with your random token. This will create the Swarm master.

Swarm Nodes

Now, create more Swarm nodes:

docker-machine create -d virtualbox --swarm --swarm-discovery token://<TOKEN-FROM-ABOVE> swarm-node-00

You now have a Swarm cluster. To connect to the Swarm master, you can use docker-machine env --swarm swarm-master

For example:

$ docker-machine env --swarm swarm-master
export DOCKER_TLS_VERIFY=yes
export DOCKER_CERT_PATH=/home/ehazlett/.docker/machines/.client
export DOCKER_HOST=tcp://192.168.99.100:3376

You can load this into your environment using $(docker-machine env --swarm swarm-master).

Now you can use the Docker CLI to query:

$ docker info
Containers: 1
Nodes: 1
 swarm-node-00: 192.168.99.101:2376

Drivers

VirtualBox

Creates machines locally on VirtualBox. Requires VirtualBox to be installed.

Options:

• --virtualbox-boot2docker-url: The URL of the boot2docker image. Defaults to the latest available version.
• --virtualbox-disk-size: Size of disk for the host in MB. Default: 20000
• --virtualbox-memory: Size of memory for the host in MB. Default: 1024

### Digital Ocean

Creates machines on Digital Ocean. You need to create a personal access token under "Apps & API" in the Digital Ocean Control Panel and pass that to docker-machine create with the --digitalocean-access-token option.

Options:

• --digitalocean-access-token: Your personal access token for the Digital Ocean API.
• --digitalocean-image: The name of the Digital Ocean image to use. Default: docker
• --digitalocean-region: The region to create the droplet in. Default: nyc3
• --digitalocean-size: The size of the Digital Ocean driver. Default: 512mb

Microsoft Azure

Create machines on Microsoft Azure.

You need to create a subscription with a cert. Run these commands:

$ openssl req -x509 -nodes -days 365 -newkey rsa:1024 -keyout mycert.pem -out mycert.pem
$ openssl pkcs12 -export -out mycert.pfx -in mycert.pem -name "My Certificate"
$ openssl x509 -inform pem -in mycert.pem -outform der -out mycert.cer

Go to the Azure portal, go to the "Settings" page, then "Manage Certificates" and upload mycert.cer.

Grab your subscription ID from the portal, then run docker-machine create with these details:

$ docker-machine create -d azure --azure-subscription-id="SUB_ID" --azure-subscription-cert="mycert.pem"

Options:

• --azure-subscription-id: required Your Azure subscription ID.
• --azure-subscription-cert: required Your Azure subscription cert.
• --azure-docker-port: Azure Docker port. Default '2376'
• --azure-image: Azure image name. Default is Ubuntu 14.04 LTS x64 [$AZURE_IMAGE]
• --azure-location: Azure location. Default is 'West US' [$AZURE_LOCATION]
• --azure-name: Azure cloud service name
• --azure-password: Azure user password
• --azure-publish-settings-file: Azure publish settings file [$AZURE_PUBLISH_SETTINGS_FILE]
• --azure-size: Azure size. Default 'Small' [$AZURE_SIZE]
• --azure-ssh-port: Azure SSH port. Default '22'
• --azure-username: Azure username. Default 'ubuntu'

Note: the machine name will be used as DNS name for the Cloud Service (e.g. machinename.cloudapp.net) and needs to be unique within Azure.

Amazon EC2

Create machines on Amazon Web Services. You will need an Access Key ID, Secret Access Key and a VPC ID. To find the VPC ID, login to the AWS console and go to Services -> VPC -> Your VPCs. Select the one where you would like to launch the instance.

Options:

• --amazonec2-access-key: required Your access key id for the Amazon Web Services API.
• --amazonec2-ami: The AMI ID of the instance to use Default: ami-4ae27e22
• --amazonec2-instance-type: The instance type to run. Default: t2.micro
• --amazonec2-region: The region to use when launching the instance. Default: us-east-1
• --amazonec2-root-size: The root disk size of the instance (in GB). Default: 16
• --amazonec2-secret-key: required Your secret access key for the Amazon Web Services API.
• --amazonec2-security-group-name: AWS VPC security group name. Default: docker-machine
• --amazonec2-session-token: Your session token for the Amazon Web Services API.
• --amazonec2-subnet-id: AWS VPC subnet id
• --amazonec2-vpc-id: required Your VPC ID to launch the instance in.
• --amazonec2-zone: The AWS zone launch the instance in (i.e. one of a,b,c,d,e). Default: a

Google Compute Engine

Create machines on Google Compute Engine. You will need a Google account and project name. See https://cloud.google.com/compute/docs/projects for details on projects.

The Google driver uses oAuth. When creating the machine, you will have your browser opened to authorize. Once authorized, paste the code given in the prompt to launch the instance.

Options:

• --google-zone: The zone to launch the instance. Default: us-central1-a
• --google-machine-type: The type of instance. Default: f1-micro
• --google-disk-size: The disk size of the instance (in GB). Default: 10
• --google-username: The username to use for the instance. Default: docker-user
• --google-instance-name: The name of the instance. Default: docker-machine
• --google-project: The name of your project to use when launching the instance.

VMware Fusion

Creates machines locally on VMware Fusion. Requires VMware Fusion to be installed.

Options:

• --vmwarefusion-boot2docker-url: URL for boot2docker image.
• --vmwarefusion-disk-size: Size of disk for host VM (in MB). Default: 20000
• --vmwarefusion-memory-size: Size of memory for host VM (in MB). Default: 1024

VMware vCloud Air

Creates machines on vCloud Air subscription service. You need an account within an existing subscription of vCloud Air VPC or Dedicated Cloud.

Options:

• --vmwarevcloudair-username: vCloud Air Username.
• --vmwarevcloudair-password: vCloud Air Password.
• --vmwarevcloudair-catalog: Catalog. Default: Public Catalog
• --vmwarevcloudair-catalogitem: Catalog Item. Default: Ubuntu Server 12.04 LTS (amd64 20140927)
• --vmwarevcloudair-computeid: Compute ID (if using Dedicated Cloud).
• --vmwarevcloudair-cpu-count: VM Cpu Count. Default: 1
• --vmwarevcloudair-docker-port: Docker port. Default: 2376
• --vmwarevcloudair-edgegateway: Organization Edge Gateway. Default: <vdcid>
• --vmwarevcloudair-memory-size: VM Memory Size in MB. Default: 2048
• --vmwarevcloudair-name: vApp Name. Default: <autogenerated>
• --vmwarevcloudair-orgvdcnetwork: Organization VDC Network to attach. Default: <vdcid>-default-routed
• --vmwarevcloudair-provision: Install Docker binaries. Default: true
• --vmwarevcloudair-publicip: Org Public IP to use.
• --vmwarevcloudair-ssh-port: SSH port. Default: 22
• --vmwarevcloudair-vdcid: Virtual Data Center ID.

VMware vSphere

Creates machines on a VMware vSphere Virtual Infrastructure. Requires a working vSphere (ESXi and optionally vCenter) installation. The vSphere driver depends on govc (must be in path) and has been tested with vmware/govmomi@c848630.

Options:

• --vmwarevsphere-username: vSphere Username.
• --vmwarevsphere-password: vSphere Password.
• --vmwarevsphere-boot2docker-url: URL for boot2docker image.
• --vmwarevsphere-compute-ip: Compute host IP where the Docker VM will be instantiated.
• --vmwarevsphere-cpu-count: CPU number for Docker VM. Default: 2
• --vmwarevsphere-datacenter: Datacenter for Docker VM (must be set to ha-datacenter when connecting to a single host).
• --vmwarevsphere-datastore: Datastore for Docker VM.
• --vmwarevsphere-disk-size: Size of disk for Docker VM (in MB). Default: 20000
• --vmwarevsphere-memory-size: Size of memory for Docker VM (in MB). Default: 2048
• --vmwarevsphere-network: Network where the Docker VM will be attached.
• --vmwarevsphere-pool: Resource pool for Docker VM.
• --vmwarevsphere-vcenter: IP/hostname for vCenter (or ESXi if connecting directly to a single host).

OpenStack

Create machines on Openstack

Mandatory:

• --openstack-flavor-id: The flavor ID to use when creating the machine
• --openstack-image-id: The image ID to use when creating the machine.

Options:

• --openstack-auth-url: Keystone service base URL.
• --openstack-username: User identifer to authenticate with.
• --openstack-password: User password. It can be omitted if the standard environment variable OS_PASSWORD is set.
• --openstack-tenant-name or --openstack-tenant-id: Identify the tenant in which the machine will be created.
• --openstack-region: The region to work on. Can be omitted if there is ony one region on the OpenStack.
• --openstack-endpoint-type: Endpoint type can be internalURL, adminURL or publicURL. It is a helper for the driver to choose the right URL in the OpenStack service catalog. If not provided the default is publicURL.
• --openstack-net-id: The private network id the machine will be connected on. If your OpenStack project contains only one private network it will be use automatically.
• --openstack-sec-groups: If security groups are available on your OpenStack you can specify a comma separated list to use for the machine (e.g. secgrp001,secgrp002).
• --openstack-floatingip-pool: The IP pool that will be used to get a public IP and assign it to the machine. If there is an IP address already allocated but not assigned to any machine, this IP will be chosen and assigned to the machine. If there is no IP address already allocated a new IP will be allocated and assigned to the machine.
• --openstack-ssh-user: The username to use for SSH into the machine. If not provided root will be used.
• --openstack-ssh-port: Customize the SSH port if the SSH server on the machine does not listen on the default port.
• --openstack-docker-install: Boolean flag to indicate if docker has to be installed on the machine. Useful when docker is already installed and configured in the OpenStack image. Default set to true

Environment variables:

Here comes the list of the supported variables with the corresponding options. If both environment variable and CLI option are provided the CLI option takes the precedence.

Environment variable	CLI option
OS_AUTH_URL	--openstack-auth-url
OS_USERNAME	--openstack-username
OS_PASSWORD	--openstack-password
OS_TENANT_NAME	--openstack-tenant-name
OS_TENANT_ID	--openstack-tenant-id
OS_REGION_NAME	--openstack-region
OS_ENDPOINT_TYPE	--openstack-endpoint-type

Rackspace

Create machines on Rackspace cloud

Options:

• --rackspace-username: Rackspace account username
• --rackspace-api-key: Rackspace API key
• --rackspace-region: Rackspace region name
• --rackspace-endpoint-type: Rackspace endpoint type (adminURL, internalURL or the default publicURL)
• --rackspace-image-id: Rackspace image ID. Default: Ubuntu 14.10 (Utopic Unicorn) (PVHVM)
• --rackspace-flavor-id: Rackspace flavor ID. Default: General Purpose 1GB
• --rackspace-ssh-user: SSH user for the newly booted machine. Set to root by default
• --rackspace-ssh-port: SSH port for the newly booted machine. Set to 22 by default

Environment variables:

Here comes the list of the supported variables with the corresponding options. If both environment variable and CLI option are provided the CLI option takes the precedence.

Environment variable	CLI option
OS_USERNAME	--rackspace-username
OS_API_KEY	--rackspace-ap-key
OS_REGION_NAME	--rackspace-region
OS_ENDPOINT_TYPE	--rackspace-endpoint-type

Softlayer

Create machines on Softlayer.

You need to generate an API key in the softlayer control panel. Retrieve your API key

Options:

• --softlayer-api-endpoint=: Change softlayer API endpoint
• --softlayer-user: required username for your softlayer account, api key needs to match this user.
• --softlayer-api-key: required API key for your user account
• --softlayer-cpu: Number of CPU's for the machine.
• --softlayer-disk-size: Size of the disk in MB. 0` sets the softlayer default.
• --softlayer-domain: required domain name for the machine
• --softlayer-hostname: hostname for the machine
• --softlayer-hourly-billing: Sets the hourly billing flag (default), otherwise uses monthly billing
• --softlayer-image: OS Image to use
• --softlayer-install-script: custom install script to use for installing Docker, other setup actions
• --softlayer-local-disk: Use local machine disk instead of softlayer SAN.
• --softlayer-memory: Memory for host in MB
• --softlayer-private-net-only: Disable public networking
• --softlayer-region: softlayer region

Hyper-V

Creates a Boot2Docker virtual machine locally on your Windows machine using Hyper-V. See here for instructions to enable Hyper-V. You will need to use an Administrator level account to create and manage Hyper-V machines.

Note: You will need an existing virtual switch to use the driver. Hyper-V can share an external network interface (aka bridging), see this blog. If you would like to use NAT, create an internal network, and use Internet Connection Sharing.

Options:

• --hyper-v-boot2docker-location: Location of a local boot2docker iso to use. Overrides the URL option below.
• --hyper-v-boot2docker-url: The URL of the boot2docker iso. Defaults to the latest available version.
• --hyper-v-disk-size: Size of disk for the host in MB. Defaults to 20000.
• --hyper-v-memory: Size of memory for the host in MB. Defaults to 1024. The machine is setup to use dynamic memory.
• --hyper-v-virtual-switch: Name of the virtual switch to use. Defaults to first found.

Running on Windows

Machine needs some helper applications to be installed (ssh, etc). The easiest way to get started on Windows is to install msysGit and OpenSSL on Windows. After this, you should have a working setup to use Machine.

Contributing

Want to hack on Machine? Docker's contributions guidelines apply.

The requirements to build Machine are:

1. A running instance of Docker
2. The bash shell

To build, run:

$ script/build

From the Machine repository's root. Machine will run the build inside of a Docker container and the compiled binaries will appear in the project directory on the host.

By default, Machine will run a build which cross-compiles binaries for a variety of architectures and operating systems. If you know that you are only compiling for a particular architecture and/or operating system, you can speed up compilation by overriding the default argument that the build script passes to gox. This is very useful if you want to iterate quickly on a new feature, bug fix, etc.

For instance, if you only want to compile for use on OSX with the x86_64 arch, run:

$ script/build -osarch="darwin/amd64"

If you have any questions we're in #docker-machine on Freenode.

Unit Tests

To run the unit tests for the whole project, using the following script:

$ script/test

This will run the unit tests inside of a container, so you don't have to worry about configuring your environment properly before doing so.

To run the unit tests for only a specific subdirectory of the project, you can pass an argument to that script to specify which directory, e.g.:

$ script/test ./drivers/amazonec2

If you make a pull request, it is highly encouraged that you submit tests for the code that you have added or modified in the same pull request.

Code Coverage

Machine includes a script to check for missing *_test.go files and to generate an HTML-based repesentation of which code is covered by tests.

To run the code coverage script, execute:

$ ./script/coverage serve

You will see the results of the code coverage check as they come in.

This will also generate the code coverage website and serve it from a container on port 8000. By default, / will show you the source files from the base directory, and you can navigate to the coverage for any particular subdirectory of the Docker Machine repo's root by going to that path. For instance, to see the coverage for the VirtualBox driver's package, browse to /drivers/virtualbox.

You can hit CTRL+C to stop the server.

Integration Tests

There is a suite of integration tests that will run for the drivers. In order to use these you must export the corresponding environment variables for each driver as these perform the actual actions (start, stop, restart, kill, etc).

By default, the suite will run tests against all drivers in master. You can override this by setting the environment variable MACHINE_TESTS. For example, MACHINE_TESTS="virtualbox" ./script/run-integration-tests will only run the virtualbox driver integration tests.

You can set the path to the machine binary under test using the MACHINE_BINARY environment variable.

To run, use the helper script ./script/run-integration-tests.