Skip to content

Commit 3dc8976

Browse files
committed
docs: add new environment variables
1 parent 81df387 commit 3dc8976

File tree

3 files changed

+58
-9
lines changed

3 files changed

+58
-9
lines changed

docs/reference/load_balancer_envs.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,17 @@ This page contains all environment variables, which can be specified to configur
66

77
| Annotation | Type | Default | Description |
88
| --- | --- | --- | --- |
9+
| `HCLOUD_LOAD_BALANCERS_ALGORITHM_TYPE` | `round_robin \| least_connections` | `round_robin` | Configures the Load Balancer algorithm. |
910
| `HCLOUD_LOAD_BALANCERS_DISABLE_IPV6` | `bool` | `false` | Disables the use of IPv6 for the Load Balancer by default. |
1011
| `HCLOUD_LOAD_BALANCERS_DISABLE_PRIVATE_INGRESS` | `bool` | `false` | Disables the use of the private network for ingress by default. |
12+
| `HCLOUD_LOAD_BALANCERS_DISABLE_PUBLIC_NETWORK` | `bool` | `false` | Disables the public interface of the Load Balancer. |
1113
| `HCLOUD_LOAD_BALANCERS_ENABLED` | `bool` | `true` | Controls whether the load balancer controller of HCCM should run. |
14+
| `HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_INTERVAL` | `duration` | `-` | Configures the time interval in seconds health checks are performed. Required when health check is enabled. |
15+
| `HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_RETRIES` | `int` | `-` | Configures the amount of unsuccessful retries needed until a target is considered unhealthy. Required when health check is enabled. |
16+
| `HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_TIMEOUT` | `duration` | `-` | Configures the time in seconds after an attempt is considered a timeout. Required when health check is enabled. |
1217
| `HCLOUD_LOAD_BALANCERS_LOCATION` | `string` | `-` | Specifies the default location where the Load Balancer will be created in. Mutually exclusive with hcloudLoadBalancersNetworkZone. |
1318
| `HCLOUD_LOAD_BALANCERS_NETWORK_ZONE` | `string` | `-` | Specifies the default network zone where the Load Balancer will be created in. Mutually exclusive with hcloudLoadBalancersLocation. |
19+
| `HCLOUD_LOAD_BALANCERS_PRIVATE_SUBNET_IP_RANGE` | `string` | `-` | Configures the IP range in CIDR block notation of the subnet to attach to. |
20+
| `HCLOUD_LOAD_BALANCERS_TYPE` | `string` | `lb11` | Configures the Load Balancer type this Load Balancer should be created with. |
21+
| `HCLOUD_LOAD_BALANCERS_USES_PROXYPROTOCOL` | `bool` | `false` | Enables the proxyprotocol for a Load Balancer service. |
1422
| `HCLOUD_LOAD_BALANCERS_USE_PRIVATE_IP` | `bool` | `false` | Configures the Load Balancer to use the private IP for Load Balancer server targets by default. |

internal/config/config.go

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,6 @@ const (
3434
hcloudNetworkDisableAttachedCheck = "HCLOUD_NETWORK_DISABLE_ATTACHED_CHECK"
3535
hcloudNetworkRoutesEnabled = "HCLOUD_NETWORK_ROUTES_ENABLED"
3636

37-
hcloudLoadBalancersAlgorithmType = "HCLOUD_LOAD_BALANCERS_ALGORITHM_TYPE"
38-
hcloudLoadBalancersDisablePublicNetwork = "HCLOUD_LOAD_BALANCERS_DISABLE_PUBLIC_NETWORK"
39-
hcloudLoadBalancersHealthCheckInterval = "HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_INTERVAL"
40-
hcloudLoadBalancersHealthCheckRetries = "HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_RETRIES"
41-
hcloudLoadBalancersHealthCheckTimeout = "HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_TIMEOUT"
42-
hcloudLoadBalancersPrivateSubnetIPRange = "HCLOUD_LOAD_BALANCERS_PRIVATE_SUBNET_IP_RANGE"
43-
hcloudLoadBalancersType = "HCLOUD_LOAD_BALANCERS_TYPE"
44-
hcloudLoadBalancersUsesProxyProtocol = "HCLOUD_LOAD_BALANCERS_USES_PROXYPROTOCOL"
45-
4637
hcloudMetricsEnabled = "HCLOUD_METRICS_ENABLED"
4738
hcloudMetricsAddress = "HCLOUD_METRICS_ADDRESS"
4839
)

internal/config/load_balancer_envs.go

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,54 @@ const (
4141
// Type: bool
4242
// Default: false
4343
hcloudLoadBalancersDisableIPv6 = "HCLOUD_LOAD_BALANCERS_DISABLE_IPV6"
44+
45+
// hcloudLoadBalancersAlgorithmType configures the Load Balancer algorithm.
46+
//
47+
// Type: round_robin | least_connections
48+
// Default: round_robin
49+
hcloudLoadBalancersAlgorithmType = "HCLOUD_LOAD_BALANCERS_ALGORITHM_TYPE"
50+
51+
// hcloudLoadBalancersDisablePublicNetwork disables the public interface of the Load Balancer.
52+
//
53+
// Type: bool
54+
// Default: false
55+
hcloudLoadBalancersDisablePublicNetwork = "HCLOUD_LOAD_BALANCERS_DISABLE_PUBLIC_NETWORK"
56+
57+
// hcloudLoadBalancersHealthCheckInterval configures the time interval in seconds health checks are performed.
58+
// Required when health check is enabled.
59+
//
60+
// Type: duration
61+
hcloudLoadBalancersHealthCheckInterval = "HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_INTERVAL"
62+
63+
// hcloudLoadBalancersHealthCheckRetries configures the amount of unsuccessful retries
64+
// needed until a target is considered unhealthy.
65+
// Required when health check is enabled.
66+
//
67+
// Type: int
68+
hcloudLoadBalancersHealthCheckRetries = "HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_RETRIES"
69+
70+
// hcloudLoadBalancersHealthCheckTimeout configures the time in seconds after an attempt is
71+
// considered a timeout.
72+
// Required when health check is enabled.
73+
//
74+
// Type: duration
75+
hcloudLoadBalancersHealthCheckTimeout = "HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_TIMEOUT"
76+
77+
// hcloudLoadBalancersPrivateSubnetIPRange configures the IP range in CIDR block notation of
78+
// the subnet to attach to.
79+
//
80+
// Type: string
81+
hcloudLoadBalancersPrivateSubnetIPRange = "HCLOUD_LOAD_BALANCERS_PRIVATE_SUBNET_IP_RANGE"
82+
83+
// hcloudLoadBalancersType configures the Load Balancer type this Load Balancer should be created with.
84+
//
85+
// Type: string
86+
// Default: lb11
87+
hcloudLoadBalancersType = "HCLOUD_LOAD_BALANCERS_TYPE"
88+
89+
// hcloudLoadBalancersUsesProxyProtocol enables the proxyprotocol for a Load Balancer service.
90+
//
91+
// Type: bool
92+
// Default: false
93+
hcloudLoadBalancersUsesProxyProtocol = "HCLOUD_LOAD_BALANCERS_USES_PROXYPROTOCOL"
4494
)

0 commit comments

Comments
 (0)