Skip to content

mtrofimm/docker-machine-vultr

 
 

Repository files navigation

Docker Machine driver plugin for Vultr

This plugin adds support for Vultr cloud instances to the docker-machine command line tool.

CircleCI

Installation

Requirement: Docker Machine >= 0.5.1

Download the docker-machine-driver-vultr binary from the release page. Extract the archive and copy the binary to a folder located in your PATH and make sure it's executable (e.g. chmod +x /usr/local/bin/docker-machine-driver-vultr).

Usage instructions

Grab your API key from the Vultr control panel and pass that to docker-machine create with the --vultr-api-key option.

Example for creating a new machine running RancherOS:

docker-machine create --driver vultr --vultr-api-key=abc123 rancheros-machine

Example for creating a new machine running Ubuntu 14.04:

docker-machine create --driver vultr --vultr-api-key=abc123 --vultr-os-id=160 ubuntu-machine

Command line flags:

  • --vultr-api-key: required Your Vultr API key.
  • --vultr-ssh-user: SSH username for the new VPS
  • --vultr-os-id: Operating system ID to use (OSID). See available OS IDs.
  • --vultr-region-id: Region the VPS will be created in (DCID). See available Region IDs.
  • --vultr-plan-id: Plan to use for this VPS (VPSPLANID). See available Plan IDs.
  • --vultr-pxe-script: PXE boot script ID. Requires custom OS (vultr-os-id=159)
  • --vultr-ipv6: Enable IPv6 support for the VPS.
  • --vultr-private-networking: Enable private networking support for the VPS.
  • --vultr-backups: Enable automatic backups for the VPS.
  • --vultr-userdata: Path to file with cloud-init user-data

When --vultr-os-id is not specified the current stable version of RancherOS will be installed on the VPS.

PXE deployment

You can boot a custom OS using a PXE boot script that you created in your Vultr account panel by supplying it's ID with the --vultr-pxe-script flag and setting --vultr-os-id to 159. The operating system must support Cloud-init and be configured to use the ec2 datasource type.

Environment variables and default values:

CLI option Environment variable Default
--vultr-api-key VULTR_API_KEY -
--vultr-ssh-user VULTR_SSH_USER root
--vultr-region-id VULTR_REGION 1 (New Jersey)
--vultr-plan-id VULTR_PLAN 29 (768 MB RAM,15 GB SSD)
--vultr-os-id VULTR_OS -
--vultr-pxe-script VULTR_PXE_SCRIPT -
--vultr-ipv6 VULTR_IPV6 false
--vultr-private-networking VULTR_PRIVATE_NETWORKING false
--vultr-backups VULTR_BACKUPS false
--vultr-userdata VULTR_USERDATA -

Find available plans for all Vultr locations

Check out vultr-status.appspot.com for a live listing of the available plans per region. Get the applicable --vultr-region-id and --vultr-plan-id parameters with the click of a button.

vultr-status website

About

Ⓜ️ Docker Machine driver plugin for Vultr Cloud

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 86.2%
  • Makefile 13.8%