This page references the different configurations for the Hetzner Cloud fleeting plugin.
[TOC]
The [runners.autoscaler.plugin_config] section supports the following parameters:
| Parameter | Type | Description |
|---|---|---|
name |
string (required) | Name of the fleeting plugin instance group. The created instance names will be prefixed using this name. |
token |
string (required) | Hetzner Cloud API token to access your Hetzner Cloud project. |
endpoint |
string | Hetzner Cloud API endpoint to use. |
location |
string (required) |
Hetzner Cloud location
in which the instances will run.
You can list the available locations by running hcloud location list.
|
server_type |
string (required) |
Hetzner Cloud server type
on which the instances will run.
You can list the available server types by running hcloud server-type list.
|
image |
string (required) |
Hetzner Cloud image from which the instances will run.
You can list the available images by running hcloud image list.
|
public_ipv4_disabled and public_ipv6_disabled |
boolean |
Disable the instances public IPv4/IPv6. If no public IPs are enabled, you must
enable a private network (see the private_networks config) to be able
to communicate with the instances.
|
public_ip_pool_enabled |
boolean | Enable a public IP pool, from which Hetzner Cloud Primary IPs will be picked when creating new instances. This feature offers a way to have predictable public IPs for the fleeting instances. |
public_ip_pool_selector |
string | [Label selector](https://docs.hetzner.cloud/#label-selector) used to filter the Hetzner Cloud Primary IPs in your Hetzner Cloud project when populating the public IP pool. |
private_networks |
list of string |
List of Hetzner Cloud Networks the instances will be attached to. To communicate
with the instances via the private network, you must configure the connector to
use the internal address (see the connector use_external_addr config).
|
user_data and user_data_file |
string |
Configuration for the provisioning utility that runs during the instances creation.
On Ubuntu, you can provide a Cloud Init configuration to setup the instances. Make
sure to wait for the instances to be ready before scheduling jobs on them by using
the autoscaler instance_ready_command config.
Note that user_data and user_data_file are mutually exclusive.
|
volume_size |
integer |
Size in GB for the Volume
that will be attached to each instance. No Volume will be attached if the
volume_size is 0 GB. The minimal volume_size is 10 GB.
|
Below are parameters from the [runners.autoscaler] section that are important for our plugin:
| Parameter | Description |
|---|---|
instance_ready_command |
When using the user_data or user_data_file config, you
must wait for the instances to be ready before scheduling jobs on them. When using
Cloud Init, this can be done with the following: cloud-init status --wait || test $? -eq 2
|
Below are parameters from the [runners.autoscaler.connector_config] section that are important for our plugin:
| Parameter | Value |
|---|---|
use_external_addr |
Access the instances through their public addresses. Note that without private
networks, this field must be set to true.
|
os |
Only linux is supported. |
protocol |
Only ssh is supported. |