Merge pull request #2 from appvia/feat_updates

feat: adding the ability to provision a vpc, and tested with the landing zone implementation

Author: gambol99

.terraform.lock.hcl

@@ -5,7 +5,7 @@ plugin "aws" {
 }
 
 config {
-  module = true
+  call_module_type = "local"
   force  = false
 }
 

.tflint.hcl

@@ -1,21 +1,42 @@
 ![Github Actions](../../actions/workflows/terraform.yml/badge.svg)
 
-# Terraform <NAME>
+# Terraform AWS Central DNS
 
 ## Description
 
-Add a description of the module here
+This purpose of this module is to manage and provision a central DNS solution with an AWS estate. Under this setup all private hosted zones defined within the spoke accounts have the ability to perform DNS resolution between them.
 
 ## Usage
 
-Add example usage here
-
 ```hcl
-module "example" {
-  source  = "appvia/dns/aws"
-  version = "1.0.0"
-
-  # insert variables here
+module "dns" {
+  source = "../../"
+
+  resolver_name = "outbound-central-dns"
+  tags          = var.tags
+
+  resolver_rule_groups = [
+    {
+      ram_share_name = "internal"
+      ram_principals = {
+        "Deployments" = "arn:aws:organizations::536471746696:ou/o-7enwqk0f2c/ou-1tbg-mq4w830q"
+        "Workloads"   = "arn:aws:organizations::536471746696:ou/o-7enwqk0f2c/ou-1tbg-lk6g79d4"
+      }
+      rules = [
+        {
+          name   = "aws-appvia-local"
+          domain = "aws.appvia.local"
+        }
+      ]
+    }
+  ]
+
+  network = {
+    availability_zones = 2
+    transit_gateway_id = var.transit_gateway_id
+    private_netmask    = 24
+    vpc_cidr           = "10.90.0.0/21"
+  }
 }
 ```
 
@@ -43,7 +64,10 @@ The `terraform-docs` utility is used to generate this README. Follow the below s
 
 ## Modules
 
-No modules.
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_dns_security_group"></a> [dns\_security\_group](#module\_dns\_security\_group) | terraform-aws-modules/security-group/aws | 5.1.2 |
+| <a name="module_vpc"></a> [vpc](#module\_vpc) | appvia/network/aws | 0.3.0 |
 
 ## Resources
 
@@ -55,25 +79,24 @@ No modules.
 | [aws_route53_resolver_endpoint.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_resolver_endpoint) | resource |
 | [aws_route53_resolver_rule.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_resolver_rule) | resource |
 | [aws_route53_zone_association.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_zone_association) | resource |
-| [aws_security_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
 
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
+| <a name="input_network"></a> [network](#input\_network) | The network to use for the endpoints and optinal resolvers | <pre>object({<br>    availability_zones = optional(number, 2)<br>    # Whether to use ipam when creating the network<br>    create = optional(bool, true)<br>    # Indicates if we should create a new network or reuse an existing one<br>    enable_default_route_table_association = optional(bool, true)<br>    # Whether to associate the default route table  <br>    enable_default_route_table_propagation = optional(bool, true)<br>    # Whether to propagate the default route table<br>    ipam_pool_id = optional(string, null)<br>    # The id of the ipam pool to use when creating the network<br>    name = optional(string, "central-dns")<br>    # The name of the network to create<br>    private_netmask = optional(number, 24)<br>    # The subnet mask for private subnets, when creating the network i.e subnet-id => 10.90.0.0/24<br>    private_subnet_ids = optional(list(string), [])<br>    # The ids of the private subnets to if we are reusing an existing network<br>    transit_gateway_id = optional(string, "")<br>    ## The transit gateway id to use for the network<br>    vpc_cidr = optional(string, "")<br>    # The cidrws range to use for the VPC, when creating the network<br>    vpc_id = optional(string, "")<br>    # The vpc id to use when reusing an existing network <br>    vpc_netmask = optional(number, null)<br>    # When using ipam this the netmask to use for the VPC<br>  })</pre> | n/a | yes |
 | <a name="input_resolver_name"></a> [resolver\_name](#input\_resolver\_name) | Name of the Route53 resolver endpoint | `string` | n/a | yes |
-| <a name="input_resolver_subnet_ids"></a> [resolver\_subnet\_ids](#input\_resolver\_subnet\_ids) | List of subnet IDs in which to create the Route53 Outbound Resolver | `list(string)` | n/a | yes |
-| <a name="input_resolver_vpc_id"></a> [resolver\_vpc\_id](#input\_resolver\_vpc\_id) | The ID of the VPC in which to create the Route53 Outbound Resolver | `string` | n/a | yes |
+| <a name="input_tags"></a> [tags](#input\_tags) | Map of tags to apply to resources created by this module | `map(string)` | n/a | yes |
 | <a name="input_resolver_endpoint_type"></a> [resolver\_endpoint\_type](#input\_resolver\_endpoint\_type) | The Route 53 Resolver endpoint IP address type. Valid values: IPV4, IPV6, DUALSTACK. | `string` | `"IPV4"` | no |
-| <a name="input_resolver_protocols"></a> [resolver\_protocols](#input\_resolver\_protocols) | List of protocols that the Route53 Outbound Resolver should support | `list(string)` | <pre>[<br>  "Do53"<br>]</pre> | no |
-| <a name="input_resolver_rule_groups"></a> [resolver\_rule\_groups](#input\_resolver\_rule\_groups) | Map of Route53 Resolver Rules by group. Every rule in each group can be shared with principals via AWS RAM. | <pre>map(object({<br>    name           = optional(string)<br>    ram_principals = optional(list(string), [])<br><br>    rules = list(object({<br>      domain    = string<br>      targets   = list(string)<br>      name      = optional(string)<br>      rule_type = optional(string, "FORWARD")<br>    }))<br>  }))</pre> | `{}` | no |
+| <a name="input_resolver_protocols"></a> [resolver\_protocols](#input\_resolver\_protocols) | List of protocols that the Route53 Outbound Resolver should support | `list(string)` | <pre>[<br>  "Do53",<br>  "DoH"<br>]</pre> | no |
+| <a name="input_resolver_rule_groups"></a> [resolver\_rule\_groups](#input\_resolver\_rule\_groups) | Map of Route53 Resolver Rules by group. Every rule in each group can be shared with principals via AWS RAM. | <pre>list(object({<br>    ram_share_name = string<br>    # The share share name will be the ram_share_name '-' rule_name<br>    ram_principals = optional(map(string), {})<br>    ## A map of principals to share the rules with i.e. Infrastructure OU => ou-1234567890<br>    rules = list(object({<br>      name = string<br>      ## The name of the rule, used when creating the ram share <br>      domain = string<br>      ## The domain to forward the query to <br>      targets = optional(list(string), [])<br>      ## The name of the resolver rule<br>      rule_type = optional(string, "FORWARD")<br>      ## The type of rule to create <br>    }))<br>    ## A list of rules to create in the group <br>  }))</pre> | `[]` | no |
 | <a name="input_route53_zone_ids"></a> [route53\_zone\_ids](#input\_route53\_zone\_ids) | List of Route53 Zone IDs to be associated with the resolver VPC. | `list(string)` | `[]` | no |
-| <a name="input_tags"></a> [tags](#input\_tags) | Map of tags to apply to resources created by this module | `map(string)` | `{}` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
+| <a name="output_all_resolver_rules"></a> [all\_resolver\_rules](#output\_all\_resolver\_rules) | Map of all resolver rules. |
 | <a name="output_endpoint"></a> [endpoint](#output\_endpoint) | Details of the Route53 Outbound Resolver endpoint. |
 | <a name="output_resource_shares"></a> [resource\_shares](#output\_resource\_shares) | Map of AWS RAM Shares by group. |
 | <a name="output_rules"></a> [rules](#output\_rules) | Map of resolver rules by group. |

README.md

@@ -0,0 +1,33 @@
+<!-- BEGIN_TF_DOCS -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.0.0 |
+
+## Providers
+
+No providers.
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_dns"></a> [dns](#module\_dns) | ../../ | n/a |
+
+## Resources
+
+No resources.
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_tags"></a> [tags](#input\_tags) | Map of tags to apply to resources created by this module | `map(string)` | <pre>{<br>  "Environment": "Testing",<br>  "GitRepo": "https://github.com/appvia/terraform-aws-dns"<br>}</pre> | no |
+| <a name="input_transit_gateway_id"></a> [transit\_gateway\_id](#input\_transit\_gateway\_id) | The id of the transit gateway to use for the network | `string` | `"tgw-04ad8f026be8b7eb6"` | no |
+
+## Outputs
+
+No outputs.
+<!-- END_TF_DOCS -->

examples/basic/README.md

@@ -0,0 +1,36 @@
+#####################################################################################
+# Terraform module examples are meant to show an _example_ on how to use a module
+# per use-case. The code below should not be copied directly but referenced in order
+# to build your own root module that invokes this module
+#####################################################################################
+
+module "dns" {
+  source = "../../"
+
+  resolver_name = "outbound-central-dns"
+  tags          = var.tags
+
+  resolver_rule_groups = [
+    {
+      ram_share_name = "internal"
+      ram_principals = {
+        "Deployments" = "arn:aws:organizations::536471746696:ou/o-7enwqk0f2c/ou-1tbg-mq4w830q"
+        "Workloads"   = "arn:aws:organizations::536471746696:ou/o-7enwqk0f2c/ou-1tbg-lk6g79d4"
+      }
+      rules = [
+        {
+          name   = "aws-appvia-local"
+          domain = "aws.appvia.local"
+        }
+      ]
+    }
+  ]
+
+  network = {
+    availability_zones = 2
+    transit_gateway_id = var.transit_gateway_id
+    private_netmask    = 24
+    vpc_cidr           = "10.90.0.0/21"
+  }
+}
+

examples/basic/main.tf

@@ -0,0 +1,16 @@
+
+variable "tags" {
+  description = "Map of tags to apply to resources created by this module"
+  type        = map(string)
+  default = {
+    "Environment" = "Testing"
+    "GitRepo"     = "https://github.com/appvia/terraform-aws-dns"
+  }
+}
+
+variable "transit_gateway_id" {
+  description = "The id of the transit gateway to use for the network"
+  type        = string
+  default     = "tgw-04ad8f026be8b7eb6"
+}
+