Skip to content

Commit f3c6923

Browse files
committed
docs: add defaults and fix type
1 parent 4a5d353 commit f3c6923

2 files changed

Lines changed: 16 additions & 12 deletions

File tree

docs/reference/load_balancer_envs.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ 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. |
9+
| `HCLOUD_LOAD_BALANCERS_ALGORITHM_TYPE` | `round_robin \| least_connections` | `round_robin` | Configures the defult Load Balancer algorithm. |
1010
| `HCLOUD_LOAD_BALANCERS_DISABLE_IPV6` | `bool` | `false` | Disables the use of IPv6 for the Load Balancer by default. |
1111
| `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. |
12+
| `HCLOUD_LOAD_BALANCERS_DISABLE_PUBLIC_NETWORK` | `bool` | `false` | Disables the public interface of the Load Balancer by default. |
1313
| `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. |
15-
| `HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_RETRIES` | `int` | `-` | Configures the amount of unsuccessful retries needed until a target is considered unhealthy. |
16-
| `HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_TIMEOUT` | `duration` | `-` | Configures the time in seconds after an attempt is considered a timeout. |
14+
| `HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_INTERVAL` | `int` | `10` | Configures the default time interval in seconds health checks are performed. |
15+
| `HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_RETRIES` | `int` | `3` | Configures the default amount of unsuccessful retries needed until a target is considered unhealthy. |
16+
| `HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_TIMEOUT` | `int` | `15` | Configures the defult time after an attempt is considered a timeout. |
1717
| `HCLOUD_LOAD_BALANCERS_LOCATION` | `string` | `-` | Specifies the default location where the Load Balancer will be created in. Mutually exclusive with hcloudLoadBalancersNetworkZone. |
1818
| `HCLOUD_LOAD_BALANCERS_NETWORK_ZONE` | `string` | `-` | Specifies the default network zone where the Load Balancer will be created in. Mutually exclusive with hcloudLoadBalancersLocation. |
1919
| `HCLOUD_LOAD_BALANCERS_PRIVATE_SUBNET_IP_RANGE` | `string` | `-` | Configures the IP range in CIDR block notation of the subnet to attach to. |

internal/config/load_balancer_envs.go

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,33 +42,37 @@ const (
4242
// Default: false
4343
hcloudLoadBalancersDisableIPv6 = "HCLOUD_LOAD_BALANCERS_DISABLE_IPV6"
4444

45-
// hcloudLoadBalancersAlgorithmType configures the Load Balancer algorithm.
45+
// hcloudLoadBalancersAlgorithmType configures the defult Load Balancer algorithm.
4646
//
4747
// Type: round_robin | least_connections
4848
// Default: round_robin
4949
hcloudLoadBalancersAlgorithmType = "HCLOUD_LOAD_BALANCERS_ALGORITHM_TYPE"
5050

51-
// hcloudLoadBalancersDisablePublicNetwork disables the public interface of the Load Balancer.
51+
// hcloudLoadBalancersDisablePublicNetwork disables the public interface of the Load Balancer by default.
5252
//
5353
// Type: bool
5454
// Default: false
5555
hcloudLoadBalancersDisablePublicNetwork = "HCLOUD_LOAD_BALANCERS_DISABLE_PUBLIC_NETWORK"
5656

57-
// hcloudLoadBalancersHealthCheckInterval configures the time interval in seconds health checks are performed.
57+
// hcloudLoadBalancersHealthCheckInterval configures the default time interval in seconds
58+
// health checks are performed.
5859
//
59-
// Type: duration
60+
// Type: int
61+
// Default: 10
6062
hcloudLoadBalancersHealthCheckInterval = "HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_INTERVAL"
6163

62-
// hcloudLoadBalancersHealthCheckRetries configures the amount of unsuccessful retries
64+
// hcloudLoadBalancersHealthCheckRetries configures the default amount of unsuccessful retries
6365
// needed until a target is considered unhealthy.
6466
//
6567
// Type: int
68+
// Default: 3
6669
hcloudLoadBalancersHealthCheckRetries = "HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_RETRIES"
6770

68-
// hcloudLoadBalancersHealthCheckTimeout configures the time in seconds after an attempt is
71+
// hcloudLoadBalancersHealthCheckTimeout configures the defult time after an attempt is
6972
// considered a timeout.
7073
//
71-
// Type: duration
74+
// Type: int
75+
// Default: 15
7276
hcloudLoadBalancersHealthCheckTimeout = "HCLOUD_LOAD_BALANCERS_HEALTH_CHECK_TIMEOUT"
7377

7478
// hcloudLoadBalancersPrivateSubnetIPRange configures the IP range in CIDR block notation of

0 commit comments

Comments
 (0)