Add AWS direct connect virtual interface resources #5212

mhlias · 2016-02-19T09:35:35Z

Hello,

This PR is adding support for DirectConnect virtual interfaces as seen in the documentation here: http://docs.aws.amazon.com/directconnect/latest/UserGuide/createhostedvirtualinterface.html

I decided to not create separate resources for public and private virtual interfaces as they only have minor differences at creation time and from there they are described as the same resource by the API. So I am handling them with parameters instead. I am not sure if that is a good way of doing it or not, so any feedback on that would be welcome.

I also have two types of resources. One for interfaces that will be created on the same AWS account where the direct connect connection has been created and one for when the virtual interface will be created for usage on a separate AWS account to the one that has the direct connect connection.
I provide an example in the documentation on how to use the latter case.

I wasn't sure how to handle some metaparameters that are used for internal logic and not directly for the resource itself. Also how to have required parameters or not based on another parameter's value. e.g. interface_type private or public require 2 different things, the former requires a virtual_gateway_id and the latter requires a route_filter_prefixes. I would appreciate some feedback on that.

I added some testing but it is not easy to run as it requires a pre-existing direct connect connection which requires an offline procedure to get it set up. Please provide some feedback on how testing should be for this kind of resource.

Best,

Ilias.

pixitha · 2016-02-23T06:52:45Z

I should be able to help test this as I have an existing direct connect already up and in service.

mhlias · 2016-03-01T08:51:20Z

@pixitha Did you get a chance to test it ?
Please let me know if you have any questions about it.

williamrhancock · 2016-05-18T00:35:24Z

I'd be available to assist in testing as well, we have a direct connect in several environment that we could work with.

mhlias · 2016-05-18T10:12:13Z

@williamrhancock Please check out the documentation included in the PR as it contains examples for usage.
Let me know if you have any questions.

mcraig88 · 2016-06-14T17:07:06Z

Any update on this? I have a need to connect an existing VGW to our DirectConnect after destroy/apply of our VPC.

mhlias · 2016-06-15T10:31:34Z

@mcraig88 I personally use it without any issues in a custom version. I haven't got back any feedback and it doesn't seem to be a priority at the moment to merge. Please vote for the PR and/or open a feature request mentioning the PR. It should help move things faster.

mcraig88 · 2016-06-15T21:10:44Z

I actually found another way to accomplish what I needed.
Just needed to set this on the route table.

propagating_vgws = ["${var.direct_connect_vgw}"]

Thank you.

On Wed, Jun 15, 2016 at 3:31 AM, mhlias notifications@github.com wrote:

@mcraig88 https://github.com/mcraig88 I personally use it without any
issues in a custom version. I haven't got back any feedback and it doesn't
seem to be a priority at the moment to merge. Please vote for the PR and/or
open a feature request mentioning the PR. It should help move things faster.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#5212 (comment),
or mute the thread
https://github.com/notifications/unsubscribe/AIFybcXTz9SivikV3W4cv2xzAacr24-wks5qL9STgaJpZM4Hd1Gl
.

spkane · 2016-09-02T18:04:37Z

+1
I'd love to see this support get added into Terraform. Is there anything specific holding this up?

…t and intra accounts.

…type public.

mhlias · 2016-10-25T15:59:33Z

Rebased but it seems something fails in the tests. Need to get up to date with what has changed.

mhlias · 2016-11-03T16:45:58Z

@stack72 Any comments on the PR please ?

stack72 · 2016-11-03T17:12:46Z

Hi @mhlias

Will get this on my list to review this week - sorry for the delay!

Paul

mhlias · 2016-11-03T17:15:05Z

Great thanks! No worries, just found some time myself to rebase and fix some issues.

stack72

Hi @mhlias

Thanks for the work here - I belive there are some changes needed. I have gone through and left some general styling comments WRT to the Read funcs and deref - please have a look at rolling those across how all resources in the PR are

Apart from that, the only other file that needs updated is:

website/source/layouts/aws.erb

As this will add the links to the DC pages. I suggest a section of it's own

Please can you include an output of the acceptance tests in the fix up?

Thanks

Paul

stack72 · 2016-11-07T13:13:32Z

builtin/providers/aws/resource_aws_dc_intra_virtual_interface.go

+	})
+
+	if err != nil {
+


Is there a chance that someone can delete the VirtualInterface from the AWS Console? If so, this will error out. We should handle the case of 404 and then remove from state if necessary

Yes, a VirtualInterface can be deleted from the AWS Console.

stack72 · 2016-11-07T13:13:48Z

builtin/providers/aws/resource_aws_dc_intra_virtual_interface.go

+
+	}
+
+	if len(resp.VirtualInterfaces) != 1 {


Why do we error on > 1 VirtualInterfaces?

@stack72 Because the DescribeVirtualInterfaces request is done with filter on VirtualInterfaceId and according to SDK documentation: "If a virtual interface ID is included then only a single virtual interface will be returned." which should be unique and return at most 1 VIF. so if we get 0 we didn't find it and if we get more than 1 something is terribly wrong.

stack72 · 2016-11-07T13:14:05Z

builtin/providers/aws/resource_aws_dc_intra_virtual_interface.go

+	}
+
+	if len(resp.VirtualInterfaces) != 1 {
+		return fmt.Errorf("[ERROR] Error finding DirectConnect PrivateVirtualInterface: %s", d.Id())


Misleading error message - we have found a list of VirtualInterfaces

stack72 · 2016-11-07T13:14:27Z

builtin/providers/aws/resource_aws_dc_intra_virtual_interface.go

+		return fmt.Errorf("[ERROR] Error finding DirectConnect PrivateVirtualInterface: %s", d.Id())
+	}
+
+	virtualInterface := resp.VirtualInterfaces[0]


Can we guarantee that [0] VirtualInterface is the one we want? Shouldn't we range the list here?

stack72 · 2016-11-07T13:14:58Z

builtin/providers/aws/resource_aws_dc_intra_virtual_interface.go

+	virtualInterface := resp.VirtualInterfaces[0]
+
+	// Set attributes under the user's control.
+	d.Set("connection_id", *virtualInterface.ConnectionId)


d.Set takes care of pointer dereference in a safe way - you shouldn't need to deref before passing in - it's safer without it

stack72 · 2016-11-07T13:19:24Z

builtin/providers/aws/resource_aws_dc_intra_virtual_interface_confirm.go

+		return fmt.Errorf("[ERROR] Error finding DirectConnect PrivateVirtualInterface: %s", d.Id())
+	}
+
+	virtualInterface := resp.VirtualInterfaces[0]


Can we guarantee that the first found is the correct one?

stack72 · 2016-11-07T13:19:37Z

builtin/providers/aws/resource_aws_dc_intra_virtual_interface_confirm.go

+	d.Set("vlan", *virtualInterface.Vlan)
+	d.Set("amazon_address", *virtualInterface.AmazonAddress)
+	d.Set("customer_address", *virtualInterface.CustomerAddress)
+	// d.Set("auth_key", *virtualInterface.AuthKey)


do we not want to set an auth_key?

I don't remember why I made that choice back then... it has been a while, but I suspect it was because I was trying to avoid printing the AuthKey. Since any change to a VIF forces a recreate as there is no update method it should not matter, unless I am mistaken and causes an issue with detecting a change in the AuthKey.

stack72 · 2016-11-07T13:21:32Z

builtin/providers/aws/resource_aws_dc_intra_virtual_interface_confirm_test.go

+	"github.com/hashicorp/terraform/terraform"
+)
+
+func TestAccAWSDCINTRAVIRTUALINTERFACECONFIRM_basic(t *testing.T) {


Casing is not consistent - we use CamelCase rather than UPPERCASE :)

stack72 · 2016-11-07T13:22:25Z

builtin/providers/aws/resource_aws_dc_virtual_interface.go

+	var err error
+	var resp *directconnect.VirtualInterface
+
+	if v, ok := d.GetOk("interface_type"); ok && v == "public" {


stack72 · 2016-11-07T13:22:41Z

builtin/providers/aws/resource_aws_dc_virtual_interface.go

+				Asn:                  aws.Int64(int64(d.Get("asn").(int))),
+				VirtualInterfaceName: aws.String(d.Get("virtual_interface_name").(string)),
+				Vlan:                 aws.Int64(int64(d.Get("vlan").(int))),
+				RouteFilterPrefixes:  []*directconnect.RouteFilterPrefix{},


we pass an empty slice here?

mhlias · 2016-11-17T16:58:54Z

@stack72 I made some changes based on your comments. In some cases I will need some more feedback. Please refer to the review comments replies above.

stack72 · 2016-11-18T11:51:31Z

Hi @mhlias

ok, 1 last request, please can you standardise the names of your tests?

Right now I have tests like this:

TestAccAWSDCINTRAVIRTUALINTERFACE_

and this

TestAccAwsDcIntraVirtualInterfaceConfirm_basic

Thanks

Paul

stack72 · 2016-11-18T11:54:03Z

also, FYI:

% make testacc TEST=./builtin/providers/aws TESTARGS='-run=TestAccAWSDC'
==> Checking that code complies with gofmt requirements...
go generate $(go list ./... | grep -v /terraform/vendor/)
2016/11/18 13:50:12 Generated command/internal_plugin_list.go
TF_ACC=1 go test ./builtin/providers/aws -v -run=TestAccAWSDC -timeout 120m
=== RUN   TestAccAWSDCINTRAVIRTUALINTERFACE_basic
--- FAIL: TestAccAWSDCINTRAVIRTUALINTERFACE_basic (44.85s)
    testing.go:265: Step 0 error: Error applying: 1 error(s) occurred:

        * aws_dc_virtual_interface.vif: Error creating DirectConnect connection: DirectConnectClientException: ConnectionID dxcon-xyz has an invalid format.
            status code: 400, request id: 46f75aa1-ad85-11e6-8f57-21f8b033b1fe
=== RUN   TestAccAWSDCVIRTUALINTERFACE_basic
--- FAIL: TestAccAWSDCVIRTUALINTERFACE_basic (41.85s)
    testing.go:265: Step 0 error: Error applying: 1 error(s) occurred:

        * aws_dc_virtual_interface.vif: Error creating DirectConnect connection: DirectConnectClientException: ConnectionID dxcon-xyz has an invalid format.
            status code: 400, request id: 5feafd67-ad85-11e6-bb9f-2f120043637d
FAIL
exit status 1
FAIL    github.com/hashicorp/terraform/builtin/providers/aws    86.712s
make: *** [testacc] Error 1

mhlias · 2016-11-18T14:08:50Z

@stack72 I fixed the naming on the tests.

On the acceptance testing it is a bit of a tricky situation. You need a direct connect connection to create VIFs and those are not a resource that can be automated as it requires manual work on the Datacenter to get it up and running. I also no longer have access to a direct connect connection for testing.

I don't know if I could use https://docs.aws.amazon.com/sdk-for-go/api/service/directconnect/directconnectiface/ this to mock it instead.

mubeta06 · 2017-01-05T22:54:59Z

What is the current status on this one? I have an upcoming project which will involve AWS Direct Connect it would be great to use Terraform to manage this resource. What is required to get this one over the line?

mhlias · 2017-01-06T16:04:09Z

@mubeta06 Testing remains as I don't currently have access to non-production-critical directconnect I can't test it and also the direct connect connection is a part that needs to be set up offline so not easy to create/expect one to be there for testing use. I found out the mocking interface provided in the AWS SDK but I didn't manage to find time to mock all those calls + missing sample data to return for success/failure scenarios.

AndHei · 2017-02-10T15:09:58Z

@mhlias @mubeta06
I might be able to help with QA/QC/testing. What would be next steps?

bodgit · 2017-02-16T12:47:32Z

I have a use case for this whereby a 3rd party we use for DirectConnect services handle most of the heavy lifting and just expose the VIF in our account so I just need to be able to confirm the VIF creation and then use the exposed attributes to create a CGW resource, etc.

mhlias · 2017-02-16T13:03:48Z

@AndHei
Next steps would be another rebase as by now it has more conflicts. Will try to do it over the weekend.
The thing that got this stuck is the difficulty to run test cases as the resource relies on a direct connect connection which is set up offline by AWS and the partner network and client.

It would be great if someone could modify the tests with their direct connect info and run them to get outputs. Right now I don't have access to a direct connect connection for testing so it is impossible for me to do.

bentterp · 2017-03-08T07:31:08Z

We would also very much like to see this. As we will be creating DC's "real soon" and don't have anything in production yet, there will be a window for testing.

Our plans include LACP, VLANs and VIFs in multiple accounts.

doprdele · 2017-05-23T17:26:28Z

Is DC support available yet?

akumria · 2017-05-25T11:28:13Z

builtin/providers/aws/provider.go

@@ -214,6 +214,9 @@ func Provider() terraform.ResourceProvider {
 			"aws_db_parameter_group":                       resourceAwsDbParameterGroup(),
 			"aws_db_security_group":                        resourceAwsDbSecurityGroup(),
 			"aws_db_subnet_group":                          resourceAwsDbSubnetGroup(),
+			"aws_dc_virtual_interface":                     resourceAwsDirectConnectVirtualInterface(),
+			"aws_dc_intra_virtual_interface":               resourceAwsDirectConnectIntraVirtualInterface(),
+			"aws_dc_intra_virtual_interface_confirm":       resourceAwsDirectConnectIntraVirtualInterfaceConfirm(),


AWS refer to direct connects as 'dx' is a fair amount of their documentation (see: https://aws.amazon.com/directconnect/faqs/)

akumria

It'd be great if this used the same shorthand that AWS use themselves (i.e. 'dx' rather than 'dc').

Obviously needs rebase (and, potentially, extracting with the forthcoming 0.10.x changes) and further testing.

akumria · 2017-06-07T16:46:27Z

builtin/providers/aws/resource_aws_dc_intra_virtual_interface.go

+	})
+
+	if err != nil {
+


Yes, a VirtualInterface can be deleted from the AWS Console.

jescarri · 2017-07-17T19:04:58Z

Is there any update on this?

I'm planing to create some vifs and I can help to test.

mhlias · 2017-07-17T19:17:17Z

If someone commits to testing with a DC connection I can rebase and bring it up to date with AWS API in the next 2 weeks.

…

On 17 July 2017 at 20:05, Jesus Rafael Carrillo ***@***.***> wrote: Is there any update on this? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#5212 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AJ9EIXyabjq9xHMyUgLwMyttd7LEu9Pzks5sO7BogaJpZM4Hd1Gl> .

jescarri · 2017-07-17T20:08:50Z

I might be able to test it, I have a DC and we are in the process of creating more vpcs /accounts.

audynespinoza · 2017-07-26T00:46:28Z

i work with Jesus Carrillo and part of the network team. We're in the process of working on a solution to automate direct connect deployments via terraform. I would love to commit to testing. let me know

catsby · 2017-07-26T11:58:15Z

Closing in favor of hashicorp/terraform-provider-aws#876 which is against the newly split out provider

iliasbertsimas · 2017-07-26T12:13:00Z

@catsby The one you mention only has support for a single resource to confirm a VIF and nothing else so it is not a replacement. If you want to move the PR to the new external structure just let me know.

ghost · 2020-04-08T02:00:23Z

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

stack72 added provider/aws new-resource labels Feb 19, 2016

Ilias Bertsimas added 5 commits October 25, 2016 16:27

Add DirectConnect Virtual Interface resource support for local accoun…

7d219f9

…t and intra accounts.

Make virtual_gateway_id optional as it is not required for interface …

d3efc88

…type public.

Add initial documentation for DirectConnect virtual interface resources.

3a6dfa1

Add testing for aws_dc_virtual_interface resource.

939e01b

Add aws_dc_intra_* initial tests.

9827018

mhlias force-pushed the master branch from 52d36f8 to 9827018 Compare October 25, 2016 15:49

Fix errors from rebase.

925a3a9

mhlias force-pushed the master branch from cf82343 to 925a3a9 Compare November 1, 2016 09:48

vagrant and others added 2 commits November 3, 2016 15:55

Add github.com/aws/aws-sdk-go/service/directconnect to vendors.

96a9d2b

Fix tests.

5a6ec78

stack72 self-assigned this Nov 3, 2016

stack72 suggested changes Nov 7, 2016

View reviewed changes

Changes & Fixes based on PR feedback.

821a9c5

Add new section for DirectConnect resources in documentation index.

1648881

Fix inconsistent naming of test functions.

a5d6410

bodgit mentioned this pull request Mar 9, 2017

Add initial Direct Connect resources #12567

Closed

akumria reviewed May 25, 2017

View reviewed changes

akumria suggested changes Jun 14, 2017

View reviewed changes

bodgit mentioned this pull request Jun 15, 2017

Add initial Direct Connect resources hashicorp/terraform-provider-aws#876

Closed

jescarri unassigned stack72 Jul 17, 2017

catsby closed this Jul 26, 2017

ghost locked and limited conversation to collaborators Apr 8, 2020

Add AWS direct connect virtual interface resources #5212

Add AWS direct connect virtual interface resources #5212

Conversation

mhlias commented Feb 19, 2016

pixitha commented Feb 23, 2016

mhlias commented Mar 1, 2016

williamrhancock commented May 18, 2016

mhlias commented May 18, 2016

mcraig88 commented Jun 14, 2016

mhlias commented Jun 15, 2016

mcraig88 commented Jun 15, 2016

spkane commented Sep 2, 2016

mhlias commented Oct 25, 2016

mhlias commented Nov 3, 2016

stack72 commented Nov 3, 2016

mhlias commented Nov 3, 2016

stack72 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mhlias Nov 16, 2016 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mhlias commented Nov 17, 2016

stack72 commented Nov 18, 2016

stack72 commented Nov 18, 2016

mhlias commented Nov 18, 2016

mubeta06 commented Jan 5, 2017

mhlias commented Jan 6, 2017

AndHei commented Feb 10, 2017 • edited

bodgit commented Feb 16, 2017

mhlias commented Feb 16, 2017

bentterp commented Mar 8, 2017

doprdele commented May 23, 2017

Choose a reason for hiding this comment

akumria left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jescarri commented Jul 17, 2017 • edited

mhlias commented Jul 17, 2017 via email

jescarri commented Jul 17, 2017

audynespinoza commented Jul 26, 2017

catsby commented Jul 26, 2017

iliasbertsimas commented Jul 26, 2017

ghost commented Apr 8, 2020

mhlias Nov 16, 2016 •

edited

AndHei commented Feb 10, 2017 •

edited

jescarri commented Jul 17, 2017 •

edited