Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@clouddrove-ci
clouddrove-ci committed Jul 6, 2021
1 parent 0b5e720 commit 7acf24c
Showing 1 changed file with 25 additions and 24 deletions.
49 changes: 25 additions & 24 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@
Terraform AWS Route53
</h1>

<p align="center" style="font-size: 1.2rem;">
<p align="center" style="font-size: 1.2rem;">
Terraform module to create Route53 resource on AWS for zone and record set.
</p>

<p align="center">

<a href="https://www.terraform.io">
<img src="https://img.shields.io/badge/terraform-v0.13-green" alt="Terraform">
<img src="https://img.shields.io/badge/terraform-v0.15-green" alt="Terraform">
</a>
<a href="LICENSE.md">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="Licence">
Expand All @@ -38,7 +38,7 @@
<hr>


We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure.
We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure.

This module is basically combination of [Terraform open source](https://www.terraform.io/) and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself.

Expand All @@ -49,7 +49,7 @@ We have [*fifty plus terraform modules*][terraform_modules]. A few of them are c

## Prerequisites

This module has a few dependencies:
This module has a few dependencies:

- [Terraform 0.13](https://learn.hashicorp.com/terraform/getting-started/install.html)
- [Go](https://golang.org/doc/install)
Expand All @@ -73,11 +73,11 @@ Here are some examples of how you can use this module in your inventory structur
```hcl
module "route53" {
source = "clouddrove/route53/aws"
version = "0.13.0"
version = "0.15.0"
name = "route53"
application = "clouddrove"
environment = "test"
label_order = ["environment", "name", "application"]
label_order = ["environment", "name"]
public_enabled = true
record_enabled = true
domain_name = "clouddrove.com"
Expand Down Expand Up @@ -106,11 +106,11 @@ Here are some examples of how you can use this module in your inventory structur
```hcl
module "route53" {
source = "clouddrove/route53/aws"
version = "0.13.0"
version = "0.15.0"
name = "route53"
application = "clouddrove"
environment = "test"
label_order = ["environment", "name", "application"]
label_order = ["environment", "name"]
private_enabled = true
record_enabled = true
domain_name = "clouddrove.com"
Expand All @@ -137,11 +137,11 @@ Here are some examples of how you can use this module in your inventory structur
```hcl
module "route53" {
source = "clouddrove/route53/aws"
version = "0.13.0"
version = "0.15.0"
name = "route53"
application = "clouddrove"
environment = "test"
label_order = ["environment", "name", "application"]
label_order = ["environment", "name"]
private_enabled = true
enabled = true
domain_name = "clouddrove.com"
Expand All @@ -160,10 +160,10 @@ Here are some examples of how you can use this module in your inventory structur

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| alias | An alias block. Conflicts with ttl & records. Alias record documented below. | `map` | <pre>{<br> "evaluate_target_healths": [],<br> "names": [],<br> "zone_ids": []<br>}</pre> | no |
| allow\_overwrites | Allow creation of this record in Terraform to overwrite an existing record, if any. This does not affect the ability to update the record in Terraform and does not prevent other resources within Terraform or manual Route 53 changes outside Terraform from overwriting this record. false by default. This configuration is not recommended for most environments. | `list` | `[]` | no |
| alias | An alias block. Conflicts with ttl & records. Alias record documented below. | `map(any)` | <pre>{<br> "evaluate_target_healths": [],<br> "names": [],<br> "zone_ids": []<br>}</pre> | no |
| allow\_overwrites | Allow creation of this record in Terraform to overwrite an existing record, if any. This does not affect the ability to update the record in Terraform and does not prevent other resources within Terraform or manual Route 53 changes outside Terraform from overwriting this record. false by default. This configuration is not recommended for most environments. | `list(any)` | `[]` | no |
| application | Application (e.g. `cd` or `clouddrove`). | `string` | `""` | no |
| attributes | Additional attributes (e.g. `1`). | `list` | `[]` | no |
| attributes | Additional attributes (e.g. `1`). | `list(any)` | `[]` | no |
| comment | A comment for the hosted zone. Defaults to 'Managed by Terraform'. | `string` | `""` | no |
| delegation\_set\_id | The ID of the reusable delegation set whose NS records you want to assign to the hosted zone. Conflicts with vpc as delegation sets can only be used for public zones. | `string` | `""` | no |
| delimiter | Delimiter to be used between `organization`, `environment`, `name` and `attributes`. | `string` | `"-"` | no |
Expand All @@ -175,25 +175,26 @@ Here are some examples of how you can use this module in your inventory structur
| force\_destroy | Whether to destroy all records (possibly managed outside of Terraform) in the zone when destroying the zone. | `bool` | `true` | no |
| geolocation\_enabled | Whether to create Route53 record set. | `bool` | `false` | no |
| geolocation\_routing\_policies | A block indicating a routing policy based on the geolocation of the requestor. Conflicts with any other routing policy. Documented below. | `any` | `null` | no |
| health\_check\_ids | The health check the record should be associated with. | `list` | `[]` | no |
| label\_order | Label order, e.g. `name`,`application`. | `list` | `[]` | no |
| health\_check\_ids | The health check the record should be associated with. | `list(any)` | `[]` | no |
| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | `[]` | no |
| latency\_enabled | Whether to create Route53 record set. | `bool` | `false` | no |
| latency\_routing\_policies | A block indicating a routing policy based on the latency between the requestor and an AWS region. Conflicts with any other routing policy. Documented below. | `any` | `null` | no |
| managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. | `string` | `"[email protected]"` | no |
| multivalue\_answer\_routing\_policies | Set to true to indicate a multivalue answer routing policy. Conflicts with any other routing policy. | `list` | `[]` | no |
| multivalue\_answer\_routing\_policies | Set to true to indicate a multivalue answer routing policy. Conflicts with any other routing policy. | `list(any)` | `[]` | no |
| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
| names | The name of the record. | `list` | `[]` | no |
| names | The name of the record. | `list(any)` | `[]` | no |
| private\_enabled | Whether to create private Route53 zone. | `bool` | `false` | no |
| public\_enabled | Whether to create public Route53 zone. | `bool` | `false` | no |
| record\_enabled | Whether to create Route53 record set. | `bool` | `false` | no |
| record\_set\_enabled | Whether to create seperate Route53 record set. | `bool` | `false` | no |
| repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-aws-route53"` | no |
| secondary\_vpc\_id | The VPC to associate with the private hosted zone. | `string` | `""` | no |
| secondary\_vpc\_region | The VPC's region. Defaults to the region of the AWS provider. | `string` | `""` | no |
| set\_identifiers | Unique identifier to differentiate records with routing policies from one another. Required if using failover, geolocation, latency, or weighted routing policies documented below. | `list` | `[]` | no |
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map` | `{}` | no |
| ttls | (Required for non-alias records) The TTL of the record. | `list` | `[]` | no |
| types | The record type. Valid values are A, AAAA, CAA, CNAME, MX, NAPTR, NS, PTR, SOA, SPF, SRV and TXT. | `list` | `[]` | no |
| values | (Required for non-alias records) A string list of records. To specify a single record value longer than 255 characters such as a TXT record for DKIM, add "" inside the Terraform configuration string (e.g. "first255characters""morecharacters"). | `list` | `[]` | no |
| set\_identifiers | Unique identifier to differentiate records with routing policies from one another. Required if using failover, geolocation, latency, or weighted routing policies documented below. | `list(any)` | `[]` | no |
| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(any)` | `{}` | no |
| ttls | (Required for non-alias records) The TTL of the record. | `list(any)` | `[]` | no |
| types | The record type. Valid values are A, AAAA, CAA, CNAME, MX, NAPTR, NS, PTR, SOA, SPF, SRV and TXT. | `list(any)` | `[]` | no |
| values | (Required for non-alias records) A string list of records. To specify a single record value longer than 255 characters such as a TXT record for DKIM, add "" inside the Terraform configuration string (e.g. "first255characters""morecharacters"). | `list(any)` | `[]` | no |
| vpc\_id | VPC ID. | `string` | `""` | no |
| weighted\_enabled | Whether to create Route53 record set. | `bool` | `false` | no |
| weighted\_routing\_policies | A block indicating a weighted routing policy. Conflicts with any other routing policy. Documented below. | `any` | `null` | no |
Expand All @@ -210,7 +211,7 @@ Here are some examples of how you can use this module in your inventory structur


## Testing
In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system.
In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system.

You need to run the following command in the testing folder:
```hcl
Expand All @@ -219,7 +220,7 @@ You need to run the following command in the testing folder:



## Feedback
## Feedback
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-route53/issues), or feel free to drop us an email at [[email protected]](mailto:[email protected]).

If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-route53)!
Expand Down

0 comments on commit 7acf24c

Please sign in to comment.