Skip to content

Commit 8761edb

Browse files
authored
add documentation for manage-backend-security-group-rules (#2486)
1 parent fbf568d commit 8761edb

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/guide/ingress/annotations.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ You can add annotations to kubernetes Ingress and Service objects to customize t
2424
|[alb.ingress.kubernetes.io/scheme](#scheme)|internal \| internet-facing|internal|Ingress|Exclusive|
2525
|[alb.ingress.kubernetes.io/subnets](#subnets)|stringList|N/A|Ingress|Exclusive|
2626
|[alb.ingress.kubernetes.io/security-groups](#security-groups)|stringList|N/A|Ingress|Exclusive|
27+
|[alb.ingress.kubernetes.io/manage-backend-security-group-rules](#manage-backend-security-group-rules)|boolean|N/A|Ingress|Exclusive|
2728
|[alb.ingress.kubernetes.io/customer-owned-ipv4-pool](#customer-owned-ipv4-pool)|string|N/A|Ingress|Exclusive|
2829
|[alb.ingress.kubernetes.io/load-balancer-attributes](#load-balancer-attributes)|stringMap|N/A|Ingress|Exclusive|
2930
|[alb.ingress.kubernetes.io/wafv2-acl-arn](#wafv2-acl-arn)|string|N/A|Ingress|Exclusive|
@@ -470,9 +471,12 @@ Access control for LoadBalancer can be controlled with following annotations:
470471
- <a name="security-groups">`alb.ingress.kubernetes.io/security-groups`</a> specifies the securityGroups you want to attach to LoadBalancer.
471472

472473
!!!note ""
473-
When this annotation is not present, the controller will automatically create one security groups: the security group will be attached to the LoadBalancer and allow access from [`inbound-cidrs`](#inbound-cidrs) to the [`listen-ports`](#listen-ports).
474+
When this annotation is not present, the controller will automatically create one security group, the security group will be attached to the LoadBalancer and allow access from [`inbound-cidrs`](#inbound-cidrs) to the [`listen-ports`](#listen-ports).
474475
Also, the securityGroups for Node/Pod will be modified to allow inbound traffic from this securityGroup.
475476

477+
!!!note ""
478+
If you specify this annotation, you need to configure the security groups on your Node/Pod to allow inbound traffic from the load balancer. You could also set the [`manage-backend-security-group-rules`](#manage-backend-security-group-rules) if you want the controller to manage the access rules.
479+
476480
!!!tip ""
477481
Both name or ID of securityGroups are supported. Name matches a `Name` tag, not the `groupName` attribute.
478482

@@ -481,6 +485,16 @@ Access control for LoadBalancer can be controlled with following annotations:
481485
alb.ingress.kubernetes.io/security-groups: sg-xxxx, nameOfSg1, nameOfSg2
482486
```
483487

488+
- <a name="manage-backend-security-group-rules">`alb.ingress.kubernetes.io/manage-backend-security-group-rules`</a> specifies whether you want the controller to configure security group rules on Node/Pod for traffic access when you specify [`security-groups`](#security-groups).
489+
490+
!!!note ""
491+
This annotation applies only in case you specify the security groups via [`security-groups`](#security-groups) annotation. If set to true, controller attaches an additional shared backend security group to your load balancer. This backend security group is used in the Node/Pod security group rules.
492+
493+
!!!example
494+
```
495+
alb.ingress.kubernetes.io/manage-backend-security-group-rules: "true"
496+
```
497+
484498
## Authentication
485499
ALB supports authentication with Cognito or OIDC. See [Authenticate Users Using an Application Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/listener-authenticate-users.html) for more details.
486500

0 commit comments

Comments
 (0)