Vultr Driver for docker-machine and Rancher Node Driver
docker-machine
is required,
see the installation documentation
.
Then install the
docker-machine-driver-vultr
driver by copying the build to
/usr/local/bin/
.
Use overlay2 as the storage engine
If you would rather build from source, you will need to have a working
go
1.11+ environment,
eval $(go env)
export PATH="$PATH:$GOPATH/bin"
curl -O "https://gitlab-docker-machine-downloads.s3.amazonaws.com/v0.16.2-gitlab.11/docker-machine-Linux-x86_64"
cp docker-machine-Linux-x86_64 /usr/local/bin/docker-machine
chmod +x /usr/local/bin/docker-machine
And then compile the docker-machine-driver-vultr driver:
go get -u github.com/vultr/docker-machine-driver-vultr@latest
cd $GOPATH/src/github.com/vultr/docker-machine-driver-vultr
make install
You will need a Vultr APIv4 Personal API key. Is only available in members area https://my.vultr.com/settings/#settingsapi, you need to create an account (https://www.vultr.com/register/) to get there
You will also need to use the 19.03.9 install enginer as shown in the example below
docker-machine create -d vultr --vultr-api-key=<vultr-api-key> --engine-install-url "https://releases.rancher.com/install-docker/19.03.9.sh" <machine-name>
Argument
Default
Description
VULTR_IPXE_CHAIN_URL
(optional) If you've selected the 'custom' operating system, this can be set to chainload the specified URL on bootup, via iPXE
vultr-iso-id
VULTR_ISO_ID
(optional) If you've selected the 'custom' operating system, this is the ID of a specific ISO to mount during the deployment
vultr-script-id
VULTR_SCRIPT_ID
(optional) If you've not selected a 'custom' operating system, this can be the SCRIPTID of a startup script to execute on boot
vultr-snapshot-id
VULTR_SNAPSHOT_ID
(optional) If you've selected the 'snapshot' operating system, this should be the SNAPSHOTID (see v1/snapshot/list) to restore for the initial installation
vultr-app-id
VULTR_APP_ID
(optional) If launching an application (OSID 186), this is the APPID to launch
vultr-reserved-ip-v4
VULTR_RESERVED_IP_V4
(optional) IP address of the floating IP to use as the main IP of this server
vultr-ip-v6
VULTR_IP_V6
(optional) If true, an IPv6 subnet will be assigned to the machine (where available)
vultr-auto-backups
VULTR_AUTO_BACKUPS
(optional) If true, automatic backups will be enabled for this server (these have an extra charge associated with them)
vultr-private-network
VULTR_PRIVATE_NETWORK
(optional) If true, private networking support will be added to the new server
vultr-network-id
VULTR_NETWORK_ID
(optional) List of private networks to attach to this server. Use either this field or enable_private_network, not both
vultr-notify-activate
VULTR_NOTIFY_ACTIVATE
(optional) If true, an activation email will be sent when the server is ready
vultr-ddos-protection
VULTR_DDOS_PROTECTION
(optional) If true, DDOS protection will be enabled on the subscription (there is an additional charge for this)
vultr-userdata
VULTR_USERDATA
(optional) Base64 encoded user-data
vultr-label
VULTR_LABEL
(optional) This is a text label that will be shown in the control panel
vultr-hostname
VULTR_HOSTNAME
(optional) The hostname to assign to this server
vultr-tag
VULTR_TAG
(optional) The tag to assign to this server
vultr-firewall-group-id
VULTR_FIREWALL_GROUP_ID
(optional) The firewall group to assign to this server
vultr-sshkey-id
VULTR_SSHKEY_ID
(optional) List of SSH keys to apply to this server on install (only valid for Linux/FreeBSD)
Detailed run output will be emitted when using the docker-machine --debug option.
docker-machine --debug create -d vultr --vultr-api-key=<vultr-api-key> machinename
docker-machine create -d vultr --vultr-api-key=<vultr-api-key> vultr
eval $(docker-machine env vultr)
$ docker-machine ls
NAME ACTIVE DRIVER STATE URL SWARM DOCKER ERRORS
vultr - vultr Running tcp://207.246.87.114:2376 v19.03.5
$ docker-machine rm vultr
About to remove vultr
WARNING: This action will delete both local reference and remote instance.
Are you sure? (y/n): y
Successfully removed vultr
By default, Vultr images have UFW enabled with only port 22 open. The default cloud-init script in this driver completely disables UFW, however, for production environments we recommend only opening specific ports as needed.
The port requirements for Rancher can be found here:
https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/installation-requirements/port-requirements