provider/aws: data source for AWS Hosted Zone #9766

mathieuherbert · 2016-11-01T10:19:41Z

To add Hosted Zone data source for AWS provider.

data "aws_route53_zone" "selected" {
  name = "test.com."
}

For example we can do that with this data source

resource "aws_route53_record" "www" {
  zone_id = "${data.aws_route53_zone.selected.zone_id}"
  name = "www.${data.aws_route53_zone.selected.name}"
  type = "A"
  ttl = "300"
  records = ["10.0.0.1"]
}

The acceptance test

TF_ACC=true go test -v github.com/hashicorp/terraform/builtin/providers/aws -run ^TestAccDataSourceAwsRoute53Zone$
=== RUN   TestAccDataSourceAwsRoute53Zone
--- PASS: TestAccDataSourceAwsRoute53Zone (48.92s)
PASS
ok  	github.com/hashicorp/terraform/builtin/providers/aws	48.932s

jen20

Hi @mathieuherbert! This looks like a great addition! I've left a few comments on the code inline, but there is one missing feature I think we need to add - zone name is not sufficient to narrow down the search to one zone, since you may have the same name in a private and public zone. I think we need to add a private_zone boolean field, defaulting to false, to control which of these we find in this case. Thanks for the PR! If you are able to make the changes noted we'll get this merged soon, if not one of us can pick it up and take it through to completion!

jen20 · 2016-11-01T13:50:43Z

builtin/providers/aws/data_source_aws_route53_zone.go

+package aws
+
+import (
+	"fmt"


This should have goimports run on it for correct formatting.

jen20 · 2016-11-01T13:50:48Z

builtin/providers/aws/data_source_aws_route53_zone.go

+package aws
+
+import (
+	"fmt"


This should have goimports run on it for correct formatting.

jen20 · 2016-11-01T13:52:04Z

builtin/providers/aws/data_source_aws_route53_zone.go

+		d.Set("name", hostedZone.Name)
+		d.Set("comment", hostedZone.Config.Comment)
+	} else {
+		return fmt.Errorf("name or zone_id have to be setted")


This should read either name or zone_id must be set, I think.

jen20 · 2016-11-01T13:52:40Z

builtin/providers/aws/data_source_aws_route53_zone.go

+		resp, err := conn.GetHostedZone(req)
+
+		if err != nil {
+			return err


We should wrap this in errwrap.Wrapf("Error finding Route 53 Hosted Zone: {{err}}", err).

jen20 · 2016-11-01T13:53:07Z

builtin/providers/aws/data_source_aws_route53_zone.go

+		d.SetId(id)
+		d.Set("zone_id", id)
+		d.Set("name", hostedZone.Name)
+		d.Set("comment", hostedZone.Config.Comment)


This will fail - since there is no comment field defined in the schema. This should be declared as Computed since it is set here.

kwilczynski · 2016-11-01T14:28:37Z

@mathieuherbert hi there! Thank you for this! This is a highly desirable new data source.

I mean to send a Pull Request which adds such data source, but since you did it already, I will focus on helping you make yours amazing!

The output we would be aiming at is something along the lines of the following:

data.aws_route53_hosted_zone.example:
  id = hostedzone-475ac21f
  caller_reference = 2016-10-18T11:43:41.139220387+01:00
  comment = Managed by Terraform
  private_zone = true
  resource_record_set_count = 2
  zone_id = Z24ZQHYYGFIKHW
  zone_name = example.com
  vpc_id = vpc-47ba0223

Above shows a Hosted Zone which was found based on zone name and VPC ID, as per:

data "aws_route53_hosted_zone" "example" {
  zone_name = "example.com"
  vpc_id = "${aws_vpc.example.id}"
}

In other words, for this resource to be very useful, it should support:

Ability to pass either Hosted Zone ID or name
Ability to pass VPC ID, to allow for searches involving private zones
Ability to specify whether we are looking for a Private Zone by setting private_zone
attribute accordingly (implied by specifying VPC ID)
Handle name with and without the trailing dot (e.g. example.com.)
Refresh data should attributes have changed
Handle the case where the list of Hosted Zones is truncated (and request needs to continue)
Return meaningful errors to the user

I will be more than happy to help you to get there.

kwilczynski · 2016-11-01T14:31:26Z

Related to #9590.

…e zone and trailing dot

kwilczynski · 2016-11-01T18:20:20Z

builtin/providers/aws/data_source_aws_route53_zone.go

+}
+
+// used to manage trailing .
+func HostedZoneName(name string) string {


This is a good idea to have a helper, but few things to consider:

Have a look at the https://golang.org/pkg/strings/ package which is part of the Go's standard library, it should have the tools you need to add and/or remove a trailing dot.

Also, if you are not planning on making this method accessible outside of this package, it should by a convention (and also language mechanics) start with a lower-case letter, so that the symbol is not going to be exported. Albeit, the aws package (namespace) is large at the moment, nevertheless we should follow some common idioms.

kwilczynski · 2016-11-01T18:22:09Z

website/source/docs/providers/aws/d/hosted_zone.html.markdown

+
+`aws_hosted_zone` provides details about a specific Hosted Zone.
+
+This resource can be useful when a module accepts a Hosted Zone name as


Should probably say "data source".

kwilczynski · 2016-11-01T18:23:06Z

website/source/docs/providers/aws/d/hosted_zone.html.markdown

+`aws_hosted_zone` provides details about a specific Hosted Zone.
+
+This resource can be useful when a module accepts a Hosted Zone name as
+an input variable and needs to, for example, add a Record Set in Route 53


I would mention that it allows to find Hosted Zone ID, which is often needed, given a Hosted Zone name and certain search criteria.

kwilczynski · 2016-11-01T18:26:32Z

builtin/providers/aws/data_source_aws_route53_zone.go

+		}
+		// We test that the first HZ is private or not, if it's not match the field private_zone, we test the second one
+		index := -1
+		if *resp.HostedZones[0].Config.PrivateZone == d.Get("private_zone") {


You might need to do d.Get("private_zone").(bool) in this case, as Get() and GetOk() both return interface{} when they return the value.

mathieuherbert · 2016-11-01T18:27:40Z

Hi,
Thank you for you help, I really appreciate that.
I take your comments and I will put an other commit soon.
I just have an issue with the VPC ID. A private Hosted zone can be associate with multiple VPCs. So do we accept a list in input of the data source and a list also in the output? So the request will match if every VPCs are in hosted zone.
Thank you!

kwilczynski · 2016-11-01T19:41:13Z

@mathieuherbert hi there! You are welcome!

I had a look at the changes and it looks good. I would have few suggestions to consider which might help with the VPC ID logic implementation - especially, since the ListHostedZones and ListHostedZonesByName do not carry the VPC details in the response data.

The search criteria are either:

Find Hosted Zone by name or by ID; and
Filter by whether it is private or not; and
Filter if associated with a particular VPC.

Also, only a Private Zone can have an association with a VPC, and it can only be associated once with a Hosted Zone that has unique name (domain name, if you wish). It can be associated with multiple Hosted Zones, but they need to have different name (which implies different Hosted Zone altogether; different ID).

Given the above, you could search for:

A Public Hosted Zone based on a name or ID; or
A Public Hosted Zone based on a name or ID with private_zone attribute set; or
A Private Hosted Zone based on a name or ID; or
A Private Hosted Zone based on a name or ID with private_zone attribute set; or
A Private Hosted Zone based on a name or ID which is attached to a particular VPC.

Where the (2) and (3) probably makes little sense (especially (2) would yield empty results), rest of them are useful, especially concerning a scenario when people have multiple Private Hosted Zones that have the same name. One could also add region there as the filter to be able to only consider VPCs from current or given regions when looking them up.

This allows for removal of duplication around nameExists and idExists since a lot of the logic would result in getting a list of the Hosted Zones and then performing search on it to reduce the list to a single zone (the one we want to find).

Note, that you need only to fetch details about each and every zone only when match against a given VPC has to be performed.

I hope this helps! Let me know if you anything else - I am here to help.

kwilczynski · 2016-11-02T10:14:45Z

Adding an example of what happens when you try to associate VPC with a different private hosted zone that has the same name as the one that already has VPC associated with it (since you can have multiple zones having the same name):

Thus, for a private zone, its name together with a VPC ID would be enough to identify it.

radeksimko · 2016-11-02T10:19:55Z

Good work so far @mathieuherbert

I agree with @kwilczynski about the ambiguity of the zone - it may look like a 🐰 hole by now, but we do need to support VPC ID as a field. private_zone isn't sufficient.

Also I think we should not just simply take the 1st matching zone - as it may not be what the user wants. We should probably error out if we get >1 zones from the API and suggest the user to narrow down the search (e.g. by specifying VPC ID or other attributes).

A private Hosted zone can be associate with multiple VPCs. So do we accept a list in input of the data source and a list also in the output?

As @kwilczynski mentioned above you can have multiple private zones w/ the same name, but each zone would have 1-1 mapping between zone name - VPC ID - so there is hopefully no need to accept/output a list.

kwilczynski · 2016-11-02T14:12:56Z

@mathieuherbert @radeksimko just to add, support for searching tags would also be nice (and might help resolve some of the issues around multiple zone with the same name).

mathieuherbert · 2016-11-02T20:23:07Z

Thank you for the help.
I added the support of vpc_id. I don't have the time to add tags support today, but I hope to do that tomorrow.
I have a question, do you know why my tests are red (I think it's really simple but I don't understand) ?

Unchecked errors found in the following places:
builtin/providers/aws/data_source_aws_route53_zone.go:81:17:    errwrap.Wrapf("Error finding Route 53 Hosted Zone: {{err}}", err)

Thank you!

mathieuherbert · 2016-11-03T21:31:23Z

In my last commit I added the support of tags

mathieuherbert · 2016-11-10T13:40:43Z

Hi,
Any comments on my PR ?
Thank you :)

devinsba · 2016-11-10T22:18:43Z

Would be nice to output the NS records for the zone. We would use this for delegating zones from other zones and dns providers

stack72 · 2016-12-13T16:21:05Z

Hi @mathieuherbert

Thanks for all the work here - this LGTM! now :)

% make testacc TEST=./builtin/providers/aws TESTARGS='-run=TestAccDataSourceAwsRoute53Zone'
==> Checking that code complies with gofmt requirements...
go generate $(go list ./... | grep -v /terraform/vendor/)
2016/12/13 16:17:50 Generated command/internal_plugin_list.go
TF_ACC=1 go test ./builtin/providers/aws -v -run=TestAccDataSourceAwsRoute53Zone -timeout 120m
=== RUN   TestAccDataSourceAwsRoute53Zone
--- PASS: TestAccDataSourceAwsRoute53Zone (78.35s)
PASS
ok  	github.com/hashicorp/terraform/builtin/providers/aws	78.374s

Paul

ghost · 2020-04-18T02:29:19Z

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.

provider/aws: data source for AWS Hosted Zone

e924510

stack72 added enhancement provider/aws new-data-source labels Nov 1, 2016

jen20 suggested changes Nov 1, 2016

View reviewed changes

Mathieu Herbert added 2 commits November 1, 2016 19:06

add caller_reference, resource_record_set_count fields, manage privat…

e70a9b9

…e zone and trailing dot

fix fmt

8594664

kwilczynski reviewed Nov 1, 2016

View reviewed changes

update documentation, use string function in hostedZoneNamewq

2dff3d2

add vpc_id support

0a64852

add tags support

25c866a

add documentation for hosted zone data source tags support

9c094ec

stack72 merged commit 3239138 into hashicorp:master Dec 13, 2016

ghost locked and limited conversation to collaborators Apr 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

provider/aws: data source for AWS Hosted Zone #9766

provider/aws: data source for AWS Hosted Zone #9766

mathieuherbert commented Nov 1, 2016

jen20 left a comment

jen20 Nov 1, 2016

jen20 Nov 1, 2016

jen20 Nov 1, 2016

jen20 Nov 1, 2016

jen20 Nov 1, 2016

kwilczynski commented Nov 1, 2016

kwilczynski commented Nov 1, 2016

kwilczynski Nov 1, 2016

kwilczynski Nov 1, 2016

kwilczynski Nov 1, 2016

kwilczynski Nov 1, 2016

mathieuherbert commented Nov 1, 2016

kwilczynski commented Nov 1, 2016

kwilczynski commented Nov 2, 2016

radeksimko commented Nov 2, 2016

kwilczynski commented Nov 2, 2016

mathieuherbert commented Nov 2, 2016

mathieuherbert commented Nov 3, 2016

mathieuherbert commented Nov 10, 2016

devinsba commented Nov 10, 2016

stack72 commented Dec 13, 2016 •

edited

Loading

ghost commented Apr 18, 2020


		`aws_hosted_zone` provides details about a specific Hosted Zone.

		This resource can be useful when a module accepts a Hosted Zone name as

provider/aws: data source for AWS Hosted Zone #9766

provider/aws: data source for AWS Hosted Zone #9766

Conversation

mathieuherbert commented Nov 1, 2016

jen20 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kwilczynski commented Nov 1, 2016

kwilczynski commented Nov 1, 2016

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

mathieuherbert commented Nov 1, 2016

kwilczynski commented Nov 1, 2016

kwilczynski commented Nov 2, 2016

radeksimko commented Nov 2, 2016

kwilczynski commented Nov 2, 2016

mathieuherbert commented Nov 2, 2016

mathieuherbert commented Nov 3, 2016

mathieuherbert commented Nov 10, 2016

devinsba commented Nov 10, 2016

stack72 commented Dec 13, 2016 • edited Loading

ghost commented Apr 18, 2020

stack72 commented Dec 13, 2016 •

edited

Loading