Add DNS attributes to VPC spec (#38)

RedbackThomson · web-flow · commit aaafa24c7d84 · 2022-03-21T12:03:30.000-07:00
Issue #, if available: aws-controllers-k8s/community#1215 Description of changes: Adds two new fields to the `VPC` spec: `EnableDNSSupport` and `EnableDNSHostnames`. Both properties are set using the `ModifyVpcAttribute` method, but can only be updated one at a time. By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
diff --git a/apis/v1alpha1/generator.yaml b/apis/v1alpha1/generator.yaml
@@ -171,6 +171,26 @@ resources:
       terminal_codes:
         - InvalidVpcID.Malformed
         - InvalidVpcID.NotFound
+  Vpc:
+    update_operation:
+      custom_method_name: customUpdate
+    exceptions:
+      terminal_codes:
+        - InvalidParameterCombination
+    fields:
+      EnableDNSSupport:
+        from:
+          operation: ModifyVpcAttribute
+          path: EnableDnsSupport.Value
+      EnableDNSHostnames:
+        from:
+          operation: ModifyVpcAttribute
+          path: EnableDnsHostnames.Value
+    hooks:
+      sdk_create_post_set_output:
+        template_path: hooks/vpc/sdk_create_post_set_output.go.tpl
+      sdk_read_many_post_set_output:
+        template_path: hooks/vpc/sdk_read_many_post_set_output.go.tpl
   VpcEndpoint:
     fields:
       VpcId:
diff --git a/apis/v1alpha1/vpc.go b/apis/v1alpha1/vpc.go
diff --git a/apis/v1alpha1/zz_generated.deepcopy.go b/apis/v1alpha1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/ec2.services.k8s.aws_vpcs.yaml b/config/crd/bases/ec2.services.k8s.aws_vpcs.yaml
@@ -48,6 +48,12 @@ spec:
                   its canonical form; for example, if you specify 100.68.0.18/18,
                   we modify it to 100.68.0.0/18.
                 type: string
+              enableDNSHostnames:
+                description: The attribute value. The valid values are true or false.
+                type: boolean
+              enableDNSSupport:
+                description: The attribute value. The valid values are true or false.
+                type: boolean
               instanceTenancy:
                 description: "The tenancy options for instances launched into the
                   VPC. For default, instances are launched with shared tenancy by
diff --git a/generator.yaml b/generator.yaml
@@ -171,6 +171,26 @@ resources:
       terminal_codes:
         - InvalidVpcID.Malformed
         - InvalidVpcID.NotFound
+  Vpc:
+    update_operation:
+      custom_method_name: customUpdate
+    exceptions:
+      terminal_codes:
+        - InvalidParameterCombination
+    fields:
+      EnableDNSSupport:
+        from:
+          operation: ModifyVpcAttribute
+          path: EnableDnsSupport.Value
+      EnableDNSHostnames:
+        from:
+          operation: ModifyVpcAttribute
+          path: EnableDnsHostnames.Value
+    hooks:
+      sdk_create_post_set_output:
+        template_path: hooks/vpc/sdk_create_post_set_output.go.tpl
+      sdk_read_many_post_set_output:
+        template_path: hooks/vpc/sdk_read_many_post_set_output.go.tpl
   VpcEndpoint:
     fields:
       VpcId:
diff --git a/helm/crds/ec2.services.k8s.aws_vpcs.yaml b/helm/crds/ec2.services.k8s.aws_vpcs.yaml
@@ -48,6 +48,12 @@ spec:
                   its canonical form; for example, if you specify 100.68.0.18/18,
                   we modify it to 100.68.0.0/18.
                 type: string
+              enableDNSHostnames:
+                description: The attribute value. The valid values are true or false.
+                type: boolean
+              enableDNSSupport:
+                description: The attribute value. The valid values are true or false.
+                type: boolean
               instanceTenancy:
                 description: "The tenancy options for instances launched into the
                   VPC. For default, instances are launched with shared tenancy by
diff --git a/pkg/resource/vpc/delta.go b/pkg/resource/vpc/delta.go
diff --git a/pkg/resource/vpc/hook.go b/pkg/resource/vpc/hook.go
@@ -0,0 +1,178 @@
+// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"). You may
+// not use this file except in compliance with the License. A copy of the
+// License is located at
+//
+//     http://aws.amazon.com/apache2.0/
+//
+// or in the "license" file accompanying this file. This file is distributed
+// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+// express or implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+package vpc
+
+import (
+	"context"
+
+	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"
+)
+
+type DNSAttrs struct {
+	EnableSupport   *bool
+	EnableHostnames *bool
+}
+
+func newDescribeVpcAttributePayload(
+	vpcID string,
+	attribute string,
+) *svcsdk.DescribeVpcAttributeInput {
+	res := &svcsdk.DescribeVpcAttributeInput{}
+	res.SetVpcId(vpcID)
+	res.SetAttribute(attribute)
+	return res
+}
+
+func (rm *resourceManager) getDNSAttributes(
+	ctx context.Context,
+	vpcID string,
+) (res *DNSAttrs, err error) {
+	res = &DNSAttrs{}
+	dnsSupport, err := rm.sdkapi.DescribeVpcAttributeWithContext(
+		ctx,
+		newDescribeVpcAttributePayload(vpcID, svcsdk.VpcAttributeNameEnableDnsSupport),
+	)
+	if err != nil {
+		return nil, err
+	}
+	res.EnableSupport = dnsSupport.EnableDnsSupport.Value
+
+	dnsHostnames, err := rm.sdkapi.DescribeVpcAttributeWithContext(
+		ctx,
+		newDescribeVpcAttributePayload(vpcID, svcsdk.VpcAttributeNameEnableDnsHostnames),
+	)
+	if err != nil {
+		return nil, err
+	}
+	res.EnableHostnames = dnsHostnames.EnableDnsHostnames.Value
+
+	return res, nil
+}
+
+func newModifyDNSSupportAttributeInputPayload(
+	r *resource,
+) *svcsdk.ModifyVpcAttributeInput {
+	res := &svcsdk.ModifyVpcAttributeInput{}
+	res.SetVpcId(*r.ko.Status.VPCID)
+
+	if r.ko.Spec.EnableDNSSupport != nil {
+		res.SetEnableDnsSupport(&svcsdk.AttributeBooleanValue{
+			Value: r.ko.Spec.EnableDNSSupport,
+		})
+	}
+
+	return res
+}
+
+func newModifyDNSHostnamesAttributeInputPayload(
+	r *resource,
+) *svcsdk.ModifyVpcAttributeInput {
+	res := &svcsdk.ModifyVpcAttributeInput{}
+	res.SetVpcId(*r.ko.Status.VPCID)
+
+	if r.ko.Spec.EnableDNSHostnames != nil {
+		res.SetEnableDnsHostnames(&svcsdk.AttributeBooleanValue{
+			Value: r.ko.Spec.EnableDNSHostnames,
+		})
+	}
+
+	return res
+}
+
+func (rm *resourceManager) syncDNSSupportAttribute(
+	ctx context.Context,
+	r *resource,
+) (err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.syncDNSSupportAttribute")
+	defer exit(err)
+	input := newModifyDNSSupportAttributeInputPayload(r)
+
+	_, err = rm.sdkapi.ModifyVpcAttributeWithContext(ctx, input)
+	rm.metrics.RecordAPICall("UPDATE", "ModifyVpcAttribute", err)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (rm *resourceManager) syncDNSHostnamesAttribute(
+	ctx context.Context,
+	r *resource,
+) (err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.syncDNSHostnamesAttribute")
+	defer exit(err)
+	input := newModifyDNSHostnamesAttributeInputPayload(r)
+
+	_, err = rm.sdkapi.ModifyVpcAttributeWithContext(ctx, input)
+	rm.metrics.RecordAPICall("UPDATE", "ModifyVpcAttribute", err)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (rm *resourceManager) createAttributes(
+	ctx context.Context,
+	r *resource,
+) (err error) {
+	if r.ko.Spec.EnableDNSHostnames != nil {
+		if err = rm.syncDNSHostnamesAttribute(ctx, r); err != nil {
+			return err
+		}
+	}
+
+	if r.ko.Spec.EnableDNSSupport != nil {
+		if err = rm.syncDNSSupportAttribute(ctx, r); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func (rm *resourceManager) customUpdate(
+	ctx context.Context,
+	desired *resource,
+	latest *resource,
+	delta *ackcompare.Delta,
+) (updated *resource, err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.customUpdateVPC")
+	defer exit(err)
+
+	// Merge in the information we read from the API call above to the copy of
+	// the original Kubernetes object we passed to the function
+	ko := desired.ko.DeepCopy()
+
+	if delta.DifferentAt("Spec.EnableDNSSupport") {
+		if err := rm.syncDNSSupportAttribute(ctx, desired); err != nil {
+			return nil, err
+		}
+	}
+
+	if delta.DifferentAt("Spec.EnableDNSHostnames") {
+		if err := rm.syncDNSHostnamesAttribute(ctx, desired); err != nil {
+			return nil, err
+		}
+	}
+
+	rm.setStatusDefaults(ko)
+	return &resource{ko}, nil
+}
diff --git a/pkg/resource/vpc/sdk.go b/pkg/resource/vpc/sdk.go
diff --git a/templates/hooks/vpc/sdk_create_post_set_output.go.tpl b/templates/hooks/vpc/sdk_create_post_set_output.go.tpl
@@ -0,0 +1,4 @@
+    err = rm.createAttributes(ctx, &resource{ko})
+    if err != nil {
+        return nil, err
+    } 
diff --git a/templates/hooks/vpc/sdk_read_many_post_set_output.go.tpl b/templates/hooks/vpc/sdk_read_many_post_set_output.go.tpl
@@ -0,0 +1,6 @@
+	if dnsAttrs, err := rm.getDNSAttributes(ctx, *ko.Status.VPCID); err != nil {
+		return nil, err
+	} else {
+		ko.Spec.EnableDNSSupport = dnsAttrs.EnableSupport
+		ko.Spec.EnableDNSHostnames = dnsAttrs.EnableHostnames
+	}
diff --git a/test/e2e/.gitignore b/test/e2e/.gitignore
@@ -0,0 +1,3 @@
+__pycache__/
+*.py[cod]
+**/bootstrap.pkl
diff --git a/test/e2e/replacement_values.py b/test/e2e/replacement_values.py
@@ -15,5 +15,6 @@
 """
 
 REPLACEMENT_VALUES = {
-
+    "ENABLE_DNS_SUPPORT": "False",
+    "ENABLE_DNS_HOSTNAMES": "False",
 }
diff --git a/test/e2e/resources/vpc.yaml b/test/e2e/resources/vpc.yaml
@@ -3,4 +3,6 @@ kind: VPC
 metadata:
   name: $VPC_NAME
 spec:
-  cidrBlock: $CIDR_BLOCK
+  cidrBlock: $CIDR_BLOCK
+  enableDNSSupport: $ENABLE_DNS_SUPPORT
+  enableDNSHostnames: $ENABLE_DNS_HOSTNAMES
diff --git a/test/e2e/tests/test_vpc.py b/test/e2e/tests/test_vpc.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+__pycache__/`
	`2`	`+*.py[cod]`
	`3`	`+**/bootstrap.pkl`
Original file line number	Diff line number	Diff line change
`@@ -15,5 +15,6 @@`
`15`	`15`	`"""`
`16`	`16`
`17`	`17`	`REPLACEMENT_VALUES = {`
`18`		`-`
	`18`	`+ "ENABLE_DNS_SUPPORT": "False",`
	`19`	`+ "ENABLE_DNS_HOSTNAMES": "False",`
`19`	`20`	`}`