diff --git a/README.md b/README.md index a48dcb46..4b5c3058 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,13 @@ This repository holds the source code for configuring DNS for domains managed by 1. After the pull request is merged, ask in [#infrastructure](https://gsa-tts.slack.com/messages/infrastructure/) to get the nameservers for your domain from [Concourse](https://concourse-ci.fr.cloud.gov/teams/gsa-tts-infrastructure/pipelines/dns-prod/). 1. Change the nameservers for the domain to point to AWS. * For `.gov` domains, this will be done by whatever person/group registered/manages the domain in [dotgov.gov](https://www.dotgov.gov/). -1. Add the relevant additional [record sets](http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/rrsets-working-with.html). In Terraform, these are known as [`aws_route53_record`](https://www.terraform.io/docs/providers/aws/r/route53_record.html)s. +1. Add the relevant additional [record sets](http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/rrsets-working-with.html). In Terraform, these are known as [`aws_route53_record`](https://www.terraform.io/docs/providers/aws/r/route53_record.html)s. Generally speaking, the required arguments are: + * `zone_id` + * `name` + * `type` + * Either `alias` or `records` + * If `alias`, then `evaluate_target_health` is also required + * If `records`, then `ttl` is also required On merge, changes are deployed to the cloud.gov AWS account automatically by an instance of Concourse hosted on [cloud.gov](https://cloud.gov). The configuration for the Concourse instance is in `pipeline.yml`.