Skip to content

Commit f5cd452

Browse files
yankawaiyankawai
committed
docs(tcp-balancer): say that whitelistHTTP needs a non-empty whitelist
The render now fails when whitelistHTTP is set with an empty whitelist, so the values description tells users that before they hit the error. Signed-off-by: Yan Bondarenko <[email protected]>
1 parent 8c1f0af commit f5cd452

5 files changed

Lines changed: 14 additions & 14 deletions

File tree

‎api/apps/v1alpha1/tcpbalancer/types.go‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/apps/tcp-balancer/README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,16 @@ Managed TCP Load Balancer Service efficiently utilizes HAProxy for load balancin
2424

2525
### Application-specific parameters
2626

27-
| Name | Description | Type | Value |
28-
| -------------------------------- | ------------------------------------------------------------- | ---------- | ------- |
29-
| `httpAndHttps` | HTTP and HTTPS configuration. | `object` | `{}` |
30-
| `httpAndHttps.mode` | Mode for balancer. | `string` | `tcp` |
31-
| `httpAndHttps.targetPorts` | Target ports configuration. | `object` | `{}` |
32-
| `httpAndHttps.targetPorts.http` | HTTP port number. | `int` | `80` |
33-
| `httpAndHttps.targetPorts.https` | HTTPS port number. | `int` | `443` |
34-
| `httpAndHttps.endpoints` | Endpoint addresses list. | `[]string` | `[]` |
35-
| `whitelistHTTP` | Secure HTTP by whitelisting client networks (default: false). | `bool` | `false` |
36-
| `whitelist` | List of allowed client networks. | `[]string` | `[]` |
27+
| Name | Description | Type | Value |
28+
| -------------------------------- | --------------------------------------------------------------------------------------------------------- | ---------- | ------- |
29+
| `httpAndHttps` | HTTP and HTTPS configuration. | `object` | `{}` |
30+
| `httpAndHttps.mode` | Mode for balancer. | `string` | `tcp` |
31+
| `httpAndHttps.targetPorts` | Target ports configuration. | `object` | `{}` |
32+
| `httpAndHttps.targetPorts.http` | HTTP port number. | `int` | `80` |
33+
| `httpAndHttps.targetPorts.https` | HTTPS port number. | `int` | `443` |
34+
| `httpAndHttps.endpoints` | Endpoint addresses list. | `[]string` | `[]` |
35+
| `whitelistHTTP` | Secure HTTP and HTTPS by whitelisting client networks. Requires a non-empty `whitelist` (default: false). | `bool` | `false` |
36+
| `whitelist` | List of allowed client networks. | `[]string` | `[]` |
3737

3838

3939
## Parameter examples and reference

‎packages/apps/tcp-balancer/values.schema.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@
149149
}
150150
},
151151
"whitelistHTTP": {
152-
"description": "Secure HTTP by whitelisting client networks (default: false).",
152+
"description": "Secure HTTP and HTTPS by whitelisting client networks. Requires a non-empty `whitelist` (default: false).",
153153
"type": "boolean",
154154
"default": false
155155
},

‎packages/apps/tcp-balancer/values.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ httpAndHttps:
9292
https: 443
9393
endpoints: []
9494

95-
## @param {bool} whitelistHTTP - Secure HTTP by whitelisting client networks (default: false).
95+
## @param {bool} whitelistHTTP - Secure HTTP and HTTPS by whitelisting client networks. Requires a non-empty `whitelist` (default: false).
9696
whitelistHTTP: false
9797
## Example:
9898
## whitelistHTTP: true

‎packages/system/tcp-balancer-rd/cozyrds/tcp-balancer.yaml‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)