Exoscale

Estimated reading time: 2 minutes

Create machines on Exoscale.

Get your API key and API secret key from API details and pass them to machine create with the --exoscale-api-key and --exoscale-api-secret-key options.

Usage

$ docker-machine create --driver exoscale \
    --exoscale-api-key=API \
    --exoscale-api-secret-key=SECRET \
    vm

Options

  • --exoscale-affinity-group: Anti-affinity group the machine will be started in.
  • --exoscale-api-key: required Your API key;
  • --exoscale-api-secret-key: required Your API secret key;
  • --exoscale-availability-zone: Exoscale availability zone (CH-DK-2, AT-VIE-1, DE-FRA-1, …);
  • --exoscale-disk-size: Disk size for the host in GB (10, 50, 100, 200, 400);
  • --exoscale-image: Image template (e.g. Linux Ubuntu 16.04 LTS 64-bit also known as ubuntu-16.04, see below);
  • --exoscale-instance-profile: Instance profile (Small, Medium, Large, …);
  • --exoscale-security-group: Security group. It will be created if it doesn’t exist;
  • --exoscale-ssh-user: SSH username (e.g. ubuntu, see below);
  • --exoscale-url: Your API endpoint;
  • --exoscale-userdata: Path to file containing user data for cloud-init;

Environment variables and default values

CLI optionEnvironment variableDefault
--exoscale-affinity-groupEXOSCALE_AFFINITY_GROUP-
--exoscale-api-keyEXOSCALE_API_KEY-
--exoscale-api-secret-keyEXOSCALE_API_SECRET-
--exoscale-availability-zoneEXOSCALE_AVAILABILITY_ZONEch-dk-2
--exoscale-disk-sizeEXOSCALE_DISK_SIZE50
--exoscale-imageEXOSCALE_IMAGELinux Ubuntu 16.04 LTS 64-bit
--exoscale-instance-profileEXOSCALE_INSTANCE_PROFILEsmall
--exoscale-security-groupEXOSCALE_SECURITY_GROUPdocker-machine
--exoscale-ssh-userEXOSCALE_SSH_USER-
--exoscale-urlEXOSCALE_ENDPOINThttps://api.exoscale.ch/compute
--exoscale-userdataEXOSCALE_USERDATA-

NB: the instance profile, image, and availability zone are case insensitive.

Image template name

The VM templates available at Exoscale are listed on the Portal when adding a new instance.

For any Linux template, you may use the shorter name composed only of the name and version. E.g.

Full nameShort name
Linux Debian 8 64-bitdebian-8
Linux Ubuntu 16.04 LTS 64-bitubuntu-16.04
Linux CentOS 7.3 64-bitcentos-7.3
Linux CoreOS stable 1298 64-bitcoreos-stable-1298

NB: Docker won’t work for non-Linux machines like OpenBSD and Windows Server.

SSH Username

The exoscale driver does a wild guess to match the default SSH user. If left empty, it picks a suitable one:

  • centos for Centos 7.3+;
  • core for Linux CoreOS;
  • debian for Debian 8+;
  • ubuntu for Ubuntu;
  • otherwise, root.

Custom security group

If a custom security group is provided, you need to ensure that you allow TCP ports 22 and 2376 in an ingress rule.

Moreover, if you want to use Docker Swarm, also add TCP port 2377.

More than 8 docker machines?

There is a limit to the number of machines that an anti-affinity group can have. This can be worked around by specifying an additional anti-affinity group using --exoscale-affinity-group=docker-machineX

machine, exoscale, driver