Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsistency across docs/code for aws-load-balancer-manage-backend-security-group-rules #3660

Open
rgs1 opened this issue Apr 23, 2024 · 2 comments
Labels
kind/documentation Categorizes issue or PR as related to documentation.

Comments

@rgs1
Copy link
Contributor

rgs1 commented Apr 23, 2024

In the annotations docs it says that aws-load-balancer-manage-backend-security-group-rules defaults to true:

https://github.com/kubernetes-sigs/aws-load-balancer-controller/blame/main/docs/guide/service/annotations.md#L52

[service.beta.kubernetes.io/aws-load-balancer-manage-backend-security-group-rules](#manage-backend-sg-rules)  | boolean    | true          

However in the security docs the writing implies that it needs to be explicitly set:

https://github.com/kubernetes-sigs/aws-load-balancer-controller/blame/main/docs/deploy/security_groups.md#L64

- To enable managing backend security group rules, apply an additional annotation to Ingress and Service resources.
  - For Ingress resources, set the `alb.ingress.kubernetes.io/manage-backend-security-group-rules` annotation to `true`.
  - For Service resources, set the `service.beta.kubernetes.io/aws-load-balancer-manage-backend-security-group-rules` annotation to `true`.

To make things consistent we either need to document that the annotation defaults to false or make the default actually true. Making it true by default is probably the desired path for most setups.

rgs1 added a commit to rgs1/aws-load-balancer-controller that referenced this issue Apr 23, 2024
Issue kubernetes-sigs#3660.

Signed-off-by: Raul Gutierrez Segales <rsegales@nvidia.com>
rgs1 added a commit to rgs1/aws-load-balancer-controller that referenced this issue Apr 23, 2024
Issue kubernetes-sigs#3660.

Signed-off-by: Raul Gutierrez Segales <rsegales@nvidia.com>
@rgs1
Copy link
Contributor Author

rgs1 commented Apr 23, 2024

Ok I see the issue now, it's true by default if aws-load-balancer-security-groups is not set. If aws-load-balancer-security-groups is set, then you must specifically opt in. I'll update the docs to make this more clear.

@shraddhabang shraddhabang added kind/documentation Categorizes issue or PR as related to documentation. triage/needs-investigation labels Apr 24, 2024
@oliviassss
Copy link
Collaborator

@rgs1, yes your understanding is correct. If the user specifies the self-managed SG through aws-load-balancer-security-groups annotation, the controller by default won't manage the backend sg rules. You can also check here for more details
https://kubernetes-sigs.github.io/aws-load-balancer-controller/v2.8/deploy/security_groups/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

No branches or pull requests

3 participants