Skip to content

Commit 081b46e

Browse files
inihkishorj
authored andcommitted
Add documentation on how to add load balancer attributes to Ingress Class Params (kubernetes-sigs#2321)
* Add doc on how to implement loadBalancerAttributes * Update docs/guide/ingress/ingress_class.md Co-authored-by: Kishor Joshi <[email protected]> * Update docs/guide/ingress/ingress_class.md Co-authored-by: Kishor Joshi <[email protected]> Co-authored-by: Kishor Joshi <[email protected]>
1 parent beb0df4 commit 081b46e

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/guide/ingress/ingress_class.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,19 @@ You can use IngressClassParams to enforce settings for a set of Ingresses.
9191
group:
9292
name: my-group
9393
```
94+
- with loadBalancerAttributes
95+
```
96+
apiVersion: elbv2.k8s.aws/v1beta1
97+
kind: IngressClassParams
98+
metadata:
99+
name: awesome-class
100+
spec:
101+
loadBalancerAttributes:
102+
- key: deletion_protection.enabled
103+
value: "true"
104+
- key: idle_timeout.timeout_seconds
105+
value: "120"
106+
```
94107

95108
### IngressClassParams specification
96109

@@ -142,3 +155,12 @@ Cluster administrators can use `tags` field to specify the custom tags for AWS r
142155
1. controller-level flag `--default-tags` will have the highest priority.
143156
2. `spec.tags` in IngressClassParams will have the middle priority.
144157
3. `alb.ingress.kubernetes.io/tags` annotation will have the lowest priority.
158+
159+
#### spec.loadBalancerAttributes
160+
161+
`loadBalancerAttributes` is an optional setting.
162+
163+
Cluster administrators can use `loadBalancerAttributes` field to specify the [Load Balancer Attributes](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#load-balancer-attributes) that should be applied to the load balancers that belong to this IngressClass. You can specify the list of load balancer attribute name and the desired value in the `spec.loadBalancerAttributes` field.
164+
165+
1. If `loadBalancerAttributes` is set, the attributes defined will be applied to the load balancer that belong to this IngressClass. If you specify invalid keys or values for the load balancer attributes, the controller will fail to reconcile ingresses belonging to the particular ingress class.
166+
2. If `loadBalancerAttributes` un-specified, Ingresses with this IngressClass can continue to use `alb.ingress.kubernetes.io/load-balancer-attributes` annotation to specify the load balancer attributes.

0 commit comments

Comments
 (0)