Skip to content

Commit 3c6281a

Browse files
authored
Improve documentations for tolerate-non-existent-backend-{service,action} (#3442)
1 parent f4ff5d2 commit 3c6281a

File tree

4 files changed

+9
-7
lines changed

4 files changed

+9
-7
lines changed

docs/deploy/configurations.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@ Currently, you can set only 1 namespace to watch in this flag. See [this Kuberne
101101
|[sync-period](#sync-period) | duration | 10h0m0s | Period at which the controller forces the repopulation of its local object stores|
102102
|targetgroupbinding-max-concurrent-reconciles | int | 3 | Maximum number of concurrently running reconcile loops for targetGroupBinding |
103103
|targetgroupbinding-max-exponential-backoff-delay | duration | 16m40s | Maximum duration of exponential backoff for targetGroupBinding reconcile failures |
104-
|tolerate-non-existent-backend-service | boolean | true | Whether to allow rules which refer to backend services that do not exist |
105-
|tolerate-non-existent-backend-action | boolean | true | Whether to allow rules which refer to backend actions that do not exist |
104+
|tolerate-non-existent-backend-service | boolean | true | Whether to allow rules which refer to backend services that do not exist (When enabled, it will return 503 error if backend service not exist) |
105+
|tolerate-non-existent-backend-action | boolean | true | Whether to allow rules which refer to backend actions that do not exist (When enabled, it will return 503 error if backend action not exist) |
106106
|watch-namespace | string | | Namespace the controller watches for updates to Kubernetes objects, If empty, all namespaces are watched. |
107107
|webhook-bind-port | int | 9443 | The TCP port the Webhook server binds to |
108108
|webhook-cert-dir | string | /tmp/k8s-webhook-server/serving-certs | The directory that contains the server key and certificate |
@@ -139,7 +139,7 @@ By default, the controller assumes sole ownership of the WAF addons associated t
139139
And the users should disable them accordingly if they want a third party like AWS Firewall Manager to associate or remove the WAF-ACL of the ALBs.
140140
Once disabled, the controller shall not take any actions on the waf addons of the provisioned ALBs.
141141

142-
### throttle config
142+
### throttle config
143143

144144
Controller uses the following default throttle config:
145145

helm/aws-load-balancer-controller/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,8 @@ The default values set by the application itself can be confirmed [here](https:/
233233
| `watchNamespace` | Namespace the controller watches for updates to Kubernetes objects, If empty, all namespaces are watched | None |
234234
| `disableIngressClassAnnotation` | Disables the usage of kubernetes.io/ingress.class annotation | None |
235235
| `disableIngressGroupNameAnnotation` | Disables the usage of alb.ingress.kubernetes.io/group.name annotation | None |
236+
| `tolerateNonExistentBackendService` | whether to allow rules that reference a backend service that does not exist. (When enabled, it will return 503 error if backend service not exist) | `true` |
237+
| `tolerateNonExistentBackendAction` | whether to allow rules that reference a backend action that does not exist. (When enabled, it will return 503 error if backend action not exist) | `true` |
236238
| `defaultSSLPolicy` | Specifies the default SSL policy to use for HTTPS or TLS listeners | None |
237239
| `externalManagedTags` | Specifies the list of tag keys on AWS resources that are managed externally | `[]` |
238240
| `livenessProbe` | Liveness probe settings for the controller | (see `values.yaml`) |

helm/aws-load-balancer-controller/test.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,10 +209,10 @@ disableIngressClassAnnotation:
209209
# disableIngressGroupNameAnnotation disables the usage of alb.ingress.kubernetes.io/group.name annotation, false by default
210210
disableIngressGroupNameAnnotation:
211211

212-
# tolerateNonExistentBackendService permits rules which specify backend services that don't exist, true by default
212+
# tolerateNonExistentBackendService permits rules which specify backend services that don't exist, true by default (When enabled, it will return 503 error if backend service not exist)
213213
tolerateNonExistentBackendService:
214214

215-
# tolerateNonExistentBackendAction permits rules which specify backend actions that don't exist, true by default
215+
# tolerateNonExistentBackendAction permits rules which specify backend actions that don't exist, true by default (When enabled, it will return 503 error if backend action not exist)
216216
tolerateNonExistentBackendAction:
217217

218218
# defaultSSLPolicy specifies the default SSL policy to use for TLS/HTTPS listeners

helm/aws-load-balancer-controller/values.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -227,10 +227,10 @@ disableIngressClassAnnotation:
227227
# disableIngressGroupNameAnnotation disables the usage of alb.ingress.kubernetes.io/group.name annotation, false by default
228228
disableIngressGroupNameAnnotation:
229229

230-
# tolerateNonExistentBackendService permits rules which specify backend services that don't exist, true by default
230+
# tolerateNonExistentBackendService permits rules which specify backend services that don't exist, true by default (When enabled, it will return 503 error if backend service not exist)
231231
tolerateNonExistentBackendService:
232232

233-
# tolerateNonExistentBackendAction permits rules which specify backend actions that don't exist, true by default
233+
# tolerateNonExistentBackendAction permits rules which specify backend actions that don't exist, true by default (When enabled, it will return 503 error if backend action not exist)
234234
tolerateNonExistentBackendAction:
235235

236236
# defaultSSLPolicy specifies the default SSL policy to use for TLS/HTTPS listeners

0 commit comments

Comments
 (0)