Feature: Add option to delete default SG rule created upon VPC creation #212

nnbu · 2024-08-19T17:28:29Z

Issue #, if available:

Description of changes:
When a VPC is created, it also creates 'default' security group. The 'default' security group has widely open egress rules. We need to have an option to delete this autocreated rules from 'default' security group. The 'default' security group itself can not be deleted.

Discussion:
https://kubernetes.slack.com/archives/C0402D8JJS1/p1720560499642019

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

ack-prow · 2024-08-19T17:28:39Z

Hi @nnbu. Thanks for your PR.

I'm waiting for a aws-controllers-k8s 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.

a-hilaly · 2024-08-27T08:08:31Z

/ok-to-test

a-hilaly

Good stuff, thank you so much @nnbu for your contribution! :)
i left few comments in-line

a-hilaly · 2024-08-27T08:14:44Z

pkg/resource/vpc/sdk.go

@@ -207,6 +207,15 @@ func (rm *resourceManager) sdkFind(
 		ko.Spec.EnableDNSSupport = dnsAttrs.EnableSupport
 		ko.Spec.EnableDNSHostnames = dnsAttrs.EnableHostnames
 	}
+	defaultSGRuleExist, err := rm.hasDefaultSecurityGroupRule(ctx, &resource{ko})


We need to handle this error

a-hilaly · 2024-08-27T08:16:48Z

pkg/resource/vpc/hooks.go

+		return nil, err
+	}
+
+	return resp.SecurityGroups[0].GroupId, nil


I guess it's safe to access [0] here, since default SG can't be deleted?

yes, default SG has to be present. But I guess, it does not hurt checking for the access. So, I added it now

a-hilaly · 2024-08-27T08:17:17Z

pkg/resource/vpc/hooks.go

+func toStrPtr(str string) *string {
+	return &str
+}
+
+func toInt64Ptr(integer int64) *int64 {
+	return &integer
+}


nit:

func ptr[t T](target T) *T { return &t }

done. Thanks

a-hilaly · 2024-08-27T08:18:32Z

pkg/resource/vpc/hooks.go

+	if rule.CidrIpv4 == nil || rule.FromPort == nil || rule.ToPort == nil || rule.IpProtocol == nil || rule.IsEgress == nil {
+		return false
+	}
+
+	if *rule.CidrIpv4 == "0.0.0.0/0" &&
+		*rule.FromPort == -1 &&
+		*rule.ToPort == -1 &&
+		*rule.IpProtocol == "-1" &&
+		*rule.IsEgress {
+		return true
+	}


i wonder if non default security groups can have these attributes? i guess no, ~~just making sure we're getting it right~~

isDefaultSGEgressRule is only checking whether the passed rule is same as auto populated egress rule or not. Non-default security groups can intentionally add this rule, if they need. However, isDefaultSGEgressRule function gets called from hasDefaultEgressRule which gets security group ID of 'default' security group. So, we are never going to touch this rule for non-default security groups.

a-hilaly · 2024-08-27T08:20:08Z

pkg/resource/vpc/hooks.go

+	if desired.ko.Spec.DeleteDefaultSecurityGroupRule != nil && *desired.ko.Spec.DeleteDefaultSecurityGroupRule {
+		if err = rm.deleteDefaultSecurityGroupRule(ctx, desired); err != nil {
+			// if deleteDefaultSecurityGroupRule fails, assume that the rule
+			// still exists and update the status accordingly.
+			exist := true
+			updated.ko.Status.DefaultSecurityGroupRuleExist = &exist
+			return nil, err
+		}
+		exist := false
+		updated.ko.Status.DefaultSecurityGroupRuleExist = &exist
+	}


Do we want to wrap this with if delta.DifferentAt("Spec.DeleteDefaultSecurityGroupRule") ?

a-hilaly · 2024-08-27T08:21:16Z

test/e2e/tests/test_vpc.py

+        # Set deleteDefaultSecurityGroupRule to delete default security group
+        # rule
+        updates = {
+            "spec": {"deleteDefaultSecurityGroupRule": True}
+        }


This feels a little like an imperative call, instead of a declarative approach.. especially when switching back to False is a no-op. Just thinking out-loud, i'm not against this approach.

My intentions was to test two scenarios.

In test_delete_default_security_group_rule : set deleteDefaultSecurityGroupRule to true upfront. This tests create path

In test_update_delete_default_security_group_rule : set deleteDefaultSecurityGroupRule to true as part of Update. This tests update path

TiberiuGC

Outstanding work @nnbu! 🔥 Thanks a lot for updating the PR as discussed.
Just a few nits inline.

TiberiuGC · 2024-09-11T20:22:24Z

apis/v1alpha1/generator.yaml

+      DisallowSecurityGroupDefaultRules:
+        type: bool
+        is_required: false
+      DefaultSecurityGroupRuleExist:


Suggested change

DefaultSecurityGroupRuleExist:

SecurityGroupDefaultRulesExist:

should this be plural? how about the name change suggestion, wdyt?

It's really annoying that ideally we'd use the word default twice. As both the SG is the default one for VPC and the rules are the default ones for SG.

I agree. I have now renamed everything to on the lines of SecurityGroupDefaultRules

pkg/resource/vpc/hooks.go

.

ack-prow · 2024-09-12T19:00:34Z

@nnbu: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ec2-verify-attribution	`48d668a`	link	false	`/test ec2-verify-attribution`

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

a-hilaly

This is awesome! Thank you @nnbu @TiberiuGC !!

a-hilaly · 2024-09-13T20:00:12Z

/lgtm

ack-prow · 2024-09-13T20:00:40Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: a-hilaly, nnbu, TiberiuGC

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:

~~OWNERS~~ [a-hilaly]

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

…ws-controllers-k8s#212) Issue #, if available: Description of changes: When a VPC is created, it also creates 'default' security group. The 'default' security group has widely open egress rules. We need to have an option to delete this autocreated rules from 'default' security group. The 'default' security group itself can not be deleted. Discussion: https://kubernetes.slack.com/archives/C0402D8JJS1/p1720560499642019 By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

ack-prow bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 19, 2024

ack-prow bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 19, 2024

ack-prow bot requested review from a-hilaly and LikithaVemulapalli August 19, 2024 17:28

nnbu force-pushed the delDefaultSG branch 5 times, most recently from b316b1e to b8f2c63 Compare August 19, 2024 18:40

nnbu changed the title ~~Fix VPC default SG rule~~ Fix: Add option to delete default SG rule created upon VPC creation Aug 19, 2024

nnbu marked this pull request as ready for review August 19, 2024 18:50

ack-prow bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 19, 2024

ack-prow bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 27, 2024

a-hilaly reviewed Aug 27, 2024

View reviewed changes

nnbu force-pushed the delDefaultSG branch 5 times, most recently from 9b7e4c3 to b7a60e4 Compare August 30, 2024 18:32

nnbu force-pushed the delDefaultSG branch from b7a60e4 to 95d0b9f Compare September 10, 2024 19:49

TiberiuGC reviewed Sep 11, 2024

View reviewed changes

pkg/resource/vpc/hooks.go Outdated Show resolved Hide resolved

Fix VPC default SG rule

48d668a

.

nnbu force-pushed the delDefaultSG branch from 95d0b9f to 48d668a Compare September 12, 2024 19:00

TiberiuGC approved these changes Sep 13, 2024

View reviewed changes

a-hilaly approved these changes Sep 13, 2024

View reviewed changes

ack-prow bot added the approved label Sep 13, 2024

ack-prow bot assigned a-hilaly Sep 13, 2024

ack-prow bot added the lgtm Indicates that a PR is ready to be merged. label Sep 13, 2024

ack-prow bot merged commit b18aa39 into aws-controllers-k8s:main Sep 13, 2024
6 of 7 checks passed

nnbu changed the title ~~Fix: Add option to delete default SG rule created upon VPC creation~~ Feature: Add option to delete default SG rule created upon VPC creation Sep 16, 2024

a-hilaly mentioned this pull request Oct 14, 2024

EC2 controller - no way of managing default security group in VPC aws-controllers-k8s/community#1896

Open

	DefaultSecurityGroupRuleExist:
	SecurityGroupDefaultRulesExist:

Feature: Add option to delete default SG rule created upon VPC creation #212

Feature: Add option to delete default SG rule created upon VPC creation #212

Uh oh!

Conversation

nnbu commented Aug 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ack-prow bot commented Aug 19, 2024

Uh oh!

a-hilaly commented Aug 27, 2024

Uh oh!

a-hilaly left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

a-hilaly Aug 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TiberiuGC left a comment

Choose a reason for hiding this comment

Uh oh!

TiberiuGC Sep 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ack-prow bot commented Sep 12, 2024

Uh oh!

a-hilaly left a comment

Choose a reason for hiding this comment

Uh oh!

a-hilaly commented Sep 13, 2024

Uh oh!

ack-prow bot commented Sep 13, 2024

Uh oh!

Uh oh!

Uh oh!

nnbu commented Aug 19, 2024 •

edited

Loading

a-hilaly Aug 27, 2024 •

edited

Loading

TiberiuGC Sep 11, 2024 •

edited

Loading