Adding support for VPC association in DHCPOptions (#143)

Issue #, if available:

Description of changes:
Adding support in EC2 controller to associate VPC in DHCPOptions resource.

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

Author: nishant221

apis/v1alpha1/ack-generate-metadata.yaml

@@ -1,13 +1,13 @@
 ack_generate_info:
-  build_date: "2023-07-07T07:03:45Z"
+  build_date: "2023-07-17T14:36:56Z"
   build_hash: e9b68590da73ce9143ba1e4361cebdc1d876c81e
   go_version: go1.19
   version: v0.26.1-7-ge9b6859
-api_directory_checksum: 9af0bb4ef3924278a9490af8b0b6956a41cda601
+api_directory_checksum: cd75b9b3537b16abdbf981cc60ab948e978ad939
 api_version: v1alpha1
 aws_sdk_go_version: v1.44.93
 generator_config_info:
-  file_checksum: 2630331c335136e1f45c564750f1d20b61a51b12
+  file_checksum: e3d618bcc0a018d73959e27cc0d74c7abfa0502d
   original_file_name: generator.yaml
 last_modification:
   reason: API generation

apis/v1alpha1/dhcp_options.go

@@ -197,6 +197,15 @@ resources:
         print:
           path: Status.dhcpOptionsID
           name: ID
+      VPC:
+        # from:
+        #   operation: AssociateDhcpOptions
+        #   path: VpcId
+        custom_field:
+          list_of: String
+        references:
+          resource: VPC
+          path: Status.VPCID
       Tags:
         from:
           operation: CreateTags
@@ -208,6 +217,12 @@ resources:
         code: compareTags(delta, a, b)
       sdk_create_post_build_request:
         template_path: hooks/dhcp_options/sdk_create_post_build_request.go.tpl
+      sdk_create_post_set_output:
+        template_path: hooks/dhcp_options/sdk_create_post_set_output.go.tpl
+      sdk_delete_pre_build_request:
+        template_path: hooks/dhcp_options/sdk_delete_pre_build_request.go.tpl
+      sdk_read_many_post_set_output:
+        template_path: hooks/dhcp_options/sdk_read_many_post_set_output.go.tpl
       sdk_file_end:
         template_path: hooks/dhcp_options/sdk_file_end.go.tpl
     update_operation:

apis/v1alpha1/generator.yaml

@@ -65,6 +65,26 @@ spec:
                       type: string
                   type: object
                 type: array
+              vpc:
+                items:
+                  type: string
+                type: array
+              vpcRefs:
+                items:
+                  description: "AWSResourceReferenceWrapper provides a wrapper around
+                    *AWSResourceReference type to provide more user friendly syntax
+                    for references using 'from' field Ex: APIIDRef: \n from: name:
+                    my-api"
+                  properties:
+                    from:
+                      description: AWSResourceReference provides all the values necessary
+                        to reference another k8s resource for finding the identifier(Id/ARN/Name)
+                      properties:
+                        name:
+                          type: string
+                      type: object
+                  type: object
+                type: array
             required:
             - dhcpConfigurations
             type: object

apis/v1alpha1/zz_generated.deepcopy.go

@@ -197,6 +197,15 @@ resources:
         print:
           path: Status.dhcpOptionsID
           name: ID
+      VPC:
+        # from:
+        #   operation: AssociateDhcpOptions
+        #   path: VpcId
+        custom_field:
+          list_of: String
+        references:
+          resource: VPC
+          path: Status.VPCID
       Tags:
         from:
           operation: CreateTags
@@ -208,6 +217,12 @@ resources:
         code: compareTags(delta, a, b)
       sdk_create_post_build_request:
         template_path: hooks/dhcp_options/sdk_create_post_build_request.go.tpl
+      sdk_create_post_set_output:
+        template_path: hooks/dhcp_options/sdk_create_post_set_output.go.tpl
+      sdk_delete_pre_build_request:
+        template_path: hooks/dhcp_options/sdk_delete_pre_build_request.go.tpl
+      sdk_read_many_post_set_output:
+        template_path: hooks/dhcp_options/sdk_read_many_post_set_output.go.tpl
       sdk_file_end:
         template_path: hooks/dhcp_options/sdk_file_end.go.tpl
     update_operation:

config/crd/bases/ec2.services.k8s.aws_dhcpoptions.yaml

@@ -65,6 +65,26 @@ spec:
                       type: string
                   type: object
                 type: array
+              vpc:
+                items:
+                  type: string
+                type: array
+              vpcRefs:
+                items:
+                  description: "AWSResourceReferenceWrapper provides a wrapper around
+                    *AWSResourceReference type to provide more user friendly syntax
+                    for references using 'from' field Ex: APIIDRef: \n from: name:
+                    my-api"
+                  properties:
+                    from:
+                      description: AWSResourceReference provides all the values necessary
+                        to reference another k8s resource for finding the identifier(Id/ARN/Name)
+                      properties:
+                        name:
+                          type: string
+                      type: object
+                  type: object
+                type: array
             required:
             - dhcpConfigurations
             type: object

generator.yaml

@@ -20,6 +20,7 @@ import (
 	ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare"
 	ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log"
 	svcsdk "github.com/aws/aws-sdk-go/service/ec2"
+	"github.com/samber/lo"
 )
 
 func (rm *resourceManager) customUpdateDHCPOptions(
@@ -39,6 +40,16 @@ func (rm *resourceManager) customUpdateDHCPOptions(
 	// (now updated.Spec) reflects the latest resource state.
 	updated = rm.concreteResource(desired.DeepCopy())
 
+	if delta.DifferentAt("Spec.VPC") {
+		if err = rm.syncVPCs(ctx, desired, latest); err != nil {
+			return nil, err
+		}
+		updated, err = rm.sdkFind(ctx, desired)
+		if err != nil {
+			return nil, err
+		}
+	}
+
 	if delta.DifferentAt("Spec.Tags") {
 		if err := rm.syncTags(ctx, desired, latest); err != nil {
 			return nil, err
@@ -48,6 +59,72 @@ func (rm *resourceManager) customUpdateDHCPOptions(
 	return updated, nil
 }
 
+func (rm *resourceManager) syncVPCs(
+	ctx context.Context,
+	desired *resource,
+	latest *resource,
+) (err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.syncEntries")
+	defer exit(err)
+
+	latestVPC := []string{}
+	desiredVPC := []string{}
+
+	if latest != nil {
+		for _, vpc := range latest.ko.Spec.VPC {
+			latestVPC = append(latestVPC, *vpc)
+		}
+	}
+	for _, vpc := range desired.ko.Spec.VPC {
+		desiredVPC = append(desiredVPC, *vpc)
+	}
+
+	toAdd, toDelete := lo.Difference(desiredVPC, latestVPC)
+
+	for _, vpc := range toAdd {
+		rm.attachToVPC(ctx, desired, vpc)
+
+	}
+	for _, vpc := range toDelete {
+		rm.detachFromVPC(ctx, desired, vpc)
+
+	}
+	return nil
+}
+
+func (rm *resourceManager) getAttachedVPC(
+	ctx context.Context,
+	latest *resource,
+) (vpcID []*string, err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.getAttachedVPC")
+	defer func(err error) {
+		exit(err)
+	}(err)
+
+	input := &svcsdk.DescribeVpcsInput{
+		Filters: []*svcsdk.Filter{
+			{
+				Name:   lo.ToPtr("dhcp-options-id"),
+				Values: []*string{latest.ko.Status.DHCPOptionsID},
+			},
+		},
+	}
+
+	var resp *svcsdk.DescribeVpcsOutput
+	resp, err = rm.sdkapi.DescribeVpcsWithContext(ctx, input)
+	rm.metrics.RecordAPICall("READ_MANY", "DescribeVpcs", err)
+	if err != nil {
+		return nil, err
+	}
+	for _, vpc := range resp.Vpcs {
+		vpcID = append(vpcID, vpc.VpcId)
+	}
+
+	return vpcID, nil
+}
+
 // syncTags used to keep tags in sync by calling Create and Delete API's
 func (rm *resourceManager) syncTags(
 	ctx context.Context,
@@ -187,3 +264,53 @@ func updateTagSpecificationsInCreateRequest(r *resource,
 		input.TagSpecifications = []*svcsdk.TagSpecification{&desiredTagSpecs}
 	}
 }
+
+func (rm *resourceManager) attachToVPC(
+	ctx context.Context,
+	desired *resource,
+	vpc string,
+) (err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.attachToVPC")
+	defer func(err error) {
+		exit(err)
+	}(err)
+
+	if vpc == "" {
+		return nil
+	}
+	input := &svcsdk.AssociateDhcpOptionsInput{
+		DhcpOptionsId: desired.ko.Status.DHCPOptionsID,
+		VpcId:         &vpc,
+	}
+	_, err = rm.sdkapi.AssociateDhcpOptionsWithContext(ctx, input)
+	rm.metrics.RecordAPICall("UPDATE", "AssociateDhcpOptions", err)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (rm *resourceManager) detachFromVPC(
+	ctx context.Context,
+	desired *resource,
+	vpc string,
+) (err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.detachFromVPC")
+	defer func(err error) {
+		exit(err)
+	}(err)
+
+	input := &svcsdk.AssociateDhcpOptionsInput{
+		DhcpOptionsId: lo.ToPtr("default"),
+		VpcId:         &vpc,
+	}
+	_, err = rm.sdkapi.AssociateDhcpOptionsWithContext(ctx, input)
+	rm.metrics.RecordAPICall("UPDATE", "AssociateDhcpOptions", err)
+	if err != nil {
+		return err
+	}
+	return nil
+}