The provider to host the infrastructure. It must be AWS, OVH or SCW. There is no default value.
region
The region to host the infrastructure. There is no default value. The default value for AWS is eu-central-1, for OVH is GRA5 and for Scaleway is fr-par.
availability_zone
The availability zone to host the infrastructure. On AWS and Scaleway, the default value is set to the first availability zone of the specified region. For instance, if you provide the eu-central-1 region on AWS, the default value will be eu-central-1a, and if you provide the region fr-par on Scaleway the default value will be fr-par-1
The mount point used to mount the volume share created by Gluster. The default value is /mnt/share.
skip_gluster
A boolean to skip the Gluster shared volume setup. Defaults to false.
rclone_conf
The path to the rclone configuration you want to provision on the nodes. The default values is "".
user_script
The user scripts to be executed when the instances are created. It must be the file path to the script. Refer to the section Using user script to learn more. The default value is "".
The instance type of the manager instances. It must be a X86 64bits architecture and it depends on the provider. There is no default value.
manager_instance_count
The number of manager instances. The default value is 1
manager_additional_volume_size
The size in giga bytes of the additional volume. You must provide a size larger than 0 to setup an additional volume. The default value is 0
manager_additional_volume_type
The type of additional volumes to add. This option only works on AWS. The different types(opens new window) are gp2, io1, st1 and sc1. The default value is sc1
manager_additional_volume_mount_point
The mount point used to mount the devices. The default value is /mnt/data
manager_ips
If defined, it represents the IP addressed to be retrieved and attached to each managers. On Scaleway it must be the IDs of a Flexible IP(opens new window), on AWS the address of an Elastic IP(opens new window) and on OVH the address of a Floating IP(opens new window). If undefined, the managers are assigned a public IP defined by the provider.
manager_crontabs
The crontabs file to be provisioned on the managers. The default value is [].
TIP
On Scaleway the ID of a flexible IP can be retrieved using the More info entry of the overflow menu assigned to this flexible IP.
The instance type of the Docker Swarm workers. It must be a X86 64bits architecture and it depends on the provider. There is no default value
worker_instance_count
The number of worker instances. The default value is 0
worker_additional_volume_size
The size in giga bytes of the additional volume. You must provide a size larger than 0 to setup an additional volume. The default value is 0
worker_additional_volume_type
The type of additional volumes to add. This option only works on AWS. The different types(opens new window) are gp2, io1, st1 and sc1. The default value is sc1
worker_additional_volume_mount_point
The mount point used to mount the devices. The default value is /mnt/data
The version of the Docker engine to be installed. The available versions can be obtained using the command apt-cache madison docker-ce . The default value is 5:19.03.2~3-0~ubuntu-bionic
docker_tls_ca_key
The path to the CA private key. The default value is ca.key
docker_tls_ca_cert
The path to the CA public key. The default value is ca.cert
docker_tls_ca_pass
The path to the CA passphrase file. The default value is ca.pass