Skip to content

docs: clarify security group name comes from tag #1038

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

Merged
merged 1 commit into from
Oct 1, 2019

Conversation

bendrucker
Copy link

This clarifies the alb.ingress.kubernetes.io/security-groups documentation. We found ourselves momentarily confused when our security groups were not attached to the load balancer. I read the code and realized it's looking for a Name tag, but we'd only specified the groupName property (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html).

https://github.com/kubernetes-sigs/aws-alb-ingress-controller/blob/4bba2f2b0ba2fb171c38c9382a85627c196f48e9/internal/aws/ec2.go#L167-L189

The code later assumes that multiple values could be returned which is possible with tag:Name but not possible when setting the actual group name (must be unique). I found this behavior surprising (since the user can specify multiple SG names if they want to match multiple SGs).

If you're interested in supporting groupName, I'd be happy to work on a PR that makes two API calls in GetSecurityGroupsByName, one filtering by name tag and the other by group name, and then merges the results. In the mean time, wanted to make sure the docs clarified the current behavior appropriately.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 24, 2019
@k8s-ci-robot
Copy link
Contributor

Hi @bendrucker. Thanks for your PR.

I'm waiting for a kubernetes-sigs or kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 24, 2019
@bendrucker
Copy link
Author

/assign @M00nF1sh

@M00nF1sh
Copy link
Collaborator

/ok-to-test
/lgtm

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. lgtm "Looks good to me", indicates that a PR is ready to be merged. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 30, 2019
@M00nF1sh
Copy link
Collaborator

M00nF1sh commented Sep 30, 2019

Thanks so much for making this change.
I think it's maybe better not to add a groupName discovery for now since it will add another APICalls on every reconcile, and discover by tag:name should be able to satisfy all use cases :D.(i'm open to this and happy to add support for groupName if there is customers for this :D)

@bendrucker
Copy link
Author

Agreed, I think it's safe to assume that someone that needs this will consult the docs. If we could start from scratch I'd definitely make a case for groupName but the upside of changing things now is small.

@M00nF1sh
Copy link
Collaborator

M00nF1sh commented Oct 1, 2019

/approve

@bendrucker
Copy link
Author

Seems like prow didn't pick up the edited commit

@M00nF1sh
Copy link
Collaborator

M00nF1sh commented Oct 1, 2019

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bendrucker, M00nF1sh

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 1, 2019
@k8s-ci-robot k8s-ci-robot merged commit b5873f4 into kubernetes-sigs:master Oct 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants