|
| 1 | +<!-- markdownlint-disable --> |
1 | 2 | # terraform-aws-route53-alias [](https://github.com/cloudposse/terraform-aws-route53-alias/releases/latest) [](https://slack.cloudposse.com) |
| 3 | +<!-- markdownlint-restore --> |
2 | 4 |
|
3 | 5 | [![README Header][readme_header_img]][readme_header_link] |
4 | 6 |
|
@@ -63,15 +65,24 @@ We literally have [*hundreds of terraform modules*][terraform_modules] that are |
63 | 65 | ## Usage |
64 | 66 |
|
65 | 67 |
|
66 | | -**IMPORTANT:** The `master` branch is used in `source` just as an example. In your code, do not pin to `master` because there may be breaking changes between releases. |
67 | | -Instead pin to the release tag (e.g. `?ref=tags/x.y.z`) of one of our [latest releases](https://github.com/cloudposse/terraform-aws-route53-alias/releases). |
| 68 | +**IMPORTANT:** We do not pin modules to versions in our examples because of the |
| 69 | +difficulty of keeping the versions in the documentation in sync with the latest released versions. |
| 70 | +We highly recommend that in your code you pin the version to the exact version you are |
| 71 | +using so that your infrastructure remains stable, and update versions in a |
| 72 | +systematic way so that they do not catch you by surprise. |
| 73 | + |
| 74 | +Also, because of a bug in the Terraform registry ([hashicorp/terraform#21417](https://github.com/hashicorp/terraform/issues/21417)), |
| 75 | +the registry shows many of our inputs as required when in fact they are optional. |
| 76 | +The table below correctly indicates which inputs are required. |
68 | 77 |
|
69 | 78 |
|
70 | 79 | This will define a `A` resource record for `www.example.com` as an alias of the `aws_elb.example.dns_name`. |
71 | 80 |
|
72 | 81 | ```terraform |
73 | 82 | module "production_www" { |
74 | | - source = "git::https://github.com/cloudposse/terraform-aws-route53-alias.git?ref=master" |
| 83 | + source = "cloudposse/route53-alias/aws" |
| 84 | + # Cloud Posse recommends pinning every module to a specific version |
| 85 | + # version = "x.x.x" |
75 | 86 | aliases = ["www.example.com.", "static1.cdn.example.com.", "static2.cdn.example.com"] |
76 | 87 | parent_zone_id = var.parent_zone_id |
77 | 88 | target_dns_name = aws_elb.example.dns_name |
@@ -101,7 +112,7 @@ Available targets: |
101 | 112 |
|
102 | 113 | | Name | Version | |
103 | 114 | |------|---------| |
104 | | -| terraform | >= 0.12.0 | |
| 115 | +| terraform | >= 0.12.26 | |
105 | 116 | | aws | >= 2.0 | |
106 | 117 | | local | >= 1.2 | |
107 | 118 |
|
@@ -295,8 +306,10 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply |
295 | 306 |
|
296 | 307 | ### Contributors |
297 | 308 |
|
| 309 | +<!-- markdownlint-disable --> |
298 | 310 | | [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Vladimir][SweetOps_avatar]][SweetOps_homepage]<br/>[Vladimir][SweetOps_homepage] | |
299 | 311 | |---|---|---|---| |
| 312 | +<!-- markdownlint-restore --> |
300 | 313 |
|
301 | 314 | [osterman_homepage]: https://github.com/osterman |
302 | 315 | [osterman_avatar]: https://img.cloudposse.com/150x150/https://github.com/osterman.png |
|
0 commit comments