-
- 
+
+
+ 
@@ -36,6 +41,12 @@
+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 Bigger problems are always solved by breaking them into smaller manageable problems. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller connected yet manageable pieces 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.
+
+We have [*fifty plus terraform modules*][terraform_modules]. A few of them are comepleted and are available for open source usage while a few others are in progress.
+
@@ -48,6 +59,7 @@ This module has a few dependencies:
+## Examples
**IMPORTANT:** Since the `master` branch used in `source` varies based on new modifications, we suggest that you use the release versions [here](https://github.com/clouddrove/terraform-azure-subnet/releases).
@@ -59,18 +71,20 @@ Here is an example of how you can use this module in your inventory structure:
```hcl
module "subnet" {
source = "clouddrove/subnet/azure"
- name = "app"
- environment = "test"
- label_order = ["name", "environment"]
+ name = local.name
+ environment = local.environment
+ label_order = local.label_order
resource_group_name = module.resource_group.resource_group_name
location = module.resource_group.resource_group_location
virtual_network_name = join("", module.vnet.vnet_name)
#subnet
- subnet_names = ["subnet1", "subnet2"]
- subnet_prefixes = ["10.0.1.0/24", "10.0.2.0/24"]
+ subnet_names = ["subnet1", "subnet2"]
+ subnet_prefixes = ["10.0.1.0/24", "10.0.2.0/24"]
# route_table
+ enable_route_table = true
+ route_table_name = "default_subnet"
routes = [
{
name = "rt-test"
@@ -84,9 +98,9 @@ Here is an example of how you can use this module in your inventory structure:
```hcl
module "name_specific_subnet" {
source = "clouddrove/subnet/azure"
- name = "app"
- environment = "test"
- label_order = ["name", "environment"]
+ name = local.name
+ environment = local.environment
+ label_order = local.label_order
resource_group_name = module.resource_group.resource_group_name
location = module.resource_group.resource_group_location
virtual_network_name = join("", module.vnet.vnet_name)
@@ -97,6 +111,8 @@ Here is an example of how you can use this module in your inventory structure:
subnet_prefixes = ["10.0.1.0/24"]
# route_table
+ enable_route_table = true
+ route_table_name = "name_specific_subnet"
routes = [
{
name = "rt-test"
@@ -110,19 +126,21 @@ Here is an example of how you can use this module in your inventory structure:
```hcl
module "name_specific_subnet" {
source = "clouddrove/subnet/azure"
- name = "app"
- environment = "test"
- label_order = ["name", "environment"]
+ name = local.name
+ environment = local.environment
+ label_order = local.label_order
resource_group_name = module.resource_group.resource_group_name
location = module.resource_group.resource_group_location
virtual_network_name = join("", module.vnet.vnet_name)
#subnet
- create_nat_gateway = true
- subnet_names = ["subnet1", "subnet2"]
- subnet_prefixes = ["10.0.1.0/24", "10.0.2.0/24"]
+ create_nat_gateway = true
+ subnet_names = ["subnet1", "subnet2"]
+ subnet_prefixes = ["10.0.1.0/24", "10.0.2.0/24"]
# route_table
+ enable_route_table = true
+ route_table_name = "nat_gateway"
routes = [
{
name = "rt-test"
@@ -142,33 +160,34 @@ Here is an example of how you can use this module in your inventory structure:
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
-| attributes | Additional attributes (e.g. `1`). | `list(any)` | `[]` | no |
+| allocation\_method | Defines the allocation method for this IP address. Possible values are Static or Dynamic. | `string` | `"Static"` | no |
| create\_nat\_gateway | Flag to control nat gateway creation. | `bool` | `false` | no |
| delegation | Configuration delegations on subnet
object({
name = object({
name = string,
actions = list(string)
})
}) | `map(list(any))` | `{}` | no |
-| delimiter | Delimiter to be used between `organization`, `environment`, `name` and `attributes`. | `string` | `"-"` | no |
| disable\_bgp\_route\_propagation | Boolean flag which controls propagation of routes learned by BGP on that route table. | `bool` | `false` | no |
| enable | Flag to control the module creation | `bool` | `true` | no |
| enable\_route\_table | Flag to control route table creation. | `bool` | `true` | no |
-| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `""` | no |
+| environment | Environment (e.g. `prod`, `dev`, `staging`). | `string` | `null` | no |
| label\_order | Label order, e.g. `name`,`application`. | `list(any)` | [
| no |
-| location | The location/region where the virtual network is created. Changing this forces a new resource to be created. | `string` | `""` | no |
+| location | The location/region where the virtual network is created. Changing this forces a new resource to be created. | `string` | `null` | no |
| managedby | ManagedBy, eg 'CloudDrove'. | `string` | `"hello@clouddrove.com"` | no |
-| name | Name (e.g. `app` or `cluster`). | `string` | `""` | no |
+| name | Name (e.g. `app` or `cluster`). | `string` | `null` | no |
| nat\_gateway\_idle\_timeout | Idle timeout configuration in minutes for Nat Gateway | `number` | `4` | no |
-| public\_ip\_zones | Public ip Zones to configure. | `list(string)` | `null` | no |
| repository | Terraform current module repo | `string` | `"https://github.com/clouddrove/terraform-azure-subnet.git"` | no |
-| resource\_group\_name | The name of an existing resource group to be imported. | `string` | `""` | no |
+| resource\_group\_name | The name of an existing resource group to be imported. | `string` | `null` | no |
| route\_table\_name | The name of the route table. | `string` | `null` | no |
| routes | List of objects that represent the configuration of each route. | `list(map(string))` | `[]` | no |
+| service\_endpoint\_policy\_ids | The list of IDs of Service Endpoint Policies to associate with the subnet. | `list(string)` | `null` | no |
| service\_endpoints | A map with key (string) `subnet name`, value (list(string)) to indicate enabled service endpoints on the subnet. Default value is []. | `list(string)` | `[]` | no |
-| specific\_name\_subnet | n/a | `bool` | `false` | no |
-| specific\_subnet\_names | A list of subnets inside the vNet. | `string` | `""` | no |
-| subnet\_enforce\_private\_link\_endpoint\_network\_policies | A map with key (string) `subnet name`, value (bool) `true` or `false` to indicate enable or disable network policies for the private link endpoint on the subnet. Default value is false. | `map(bool)` | `{}` | no |
+| sku | The SKU of the Public IP. Accepted values are Basic and Standard. Defaults to Basic. Changing this forces a new resource to be created. | `string` | `"Standard"` | no |
+| sku\_name | The SKU which should be used. At this time the only supported value is Standard. Defaults to Standard. | `string` | `"Standard"` | no |
+| specific\_name\_subnet | fName of the specific subnet. | `bool` | `false` | no |
+| specific\_subnet\_names | A list of subnets inside the vNet. | `list(string)` |
"name",
"environment"
][
| no |
+| subnet\_enforce\_private\_link\_endpoint\_network\_policies | A map with key (string) `subnet name`, value (bool) `true` or `false` to indicate enable or disable network policies for the private link endpoint on the subnet. Default value is false. | `bool` | `false` | no |
| subnet\_enforce\_private\_link\_service\_network\_policies | A map with key (string) `subnet name`, value (bool) `true` or `false` to indicate enable or disable network policies for the private link endpoint on the subnet. Default value is false. | `bool` | `true` | no |
| subnet\_names | A list of public subnets inside the vNet. | `list(string)` | `[]` | no |
| subnet\_prefixes | The address prefix to use for the subnet. | `list(string)` | `[]` | no |
-| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | `map(any)` | `{}` | no |
-| virtual\_network\_name | The name of the virtual network in which the subnet is created in | `string` | `""` | no |
+| virtual\_network\_name | The name of the virtual network in which the subnet is created in | `string` | `null` | no |
+| zones | Public ip Zones to configure. | `list(string)` | `null` | no |
## Outputs
@@ -183,12 +202,20 @@ Here is an example of how you can use this module in your inventory structure:
| route\_table\_associated\_subnets | The collection of Subnets associated with this route table. |
| route\_table\_id | The Route Table ID. |
| specific\_subnet\_address\_prefixes | The address prefixes for the subnet. |
-| specific\_subnet\_id | The subnet ID. |
+| specific\_subnet\_id | The name of the subnet. |
| specific\_subnet\_name | The name of the subnet. |
+## 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.
+
+You need to run the following command in the testing folder:
+```hcl
+ go test -run Test
+```
+
## Feedback
""
]