docs(azure-vnet-and-subnet): update docs and added examples

modules/azure-vnet-and-subnet/.terraform-docs.yml

@@ -0,0 +1,48 @@
+formatter: "markdown"
+
+version: ""
+
+header-from: docs/header.md
+footer-from: docs/footer.md
+
+recursive:
+  enabled: false
+  path: modules
+  include-main: true
+
+sections:
+  hide: []
+  show: []
+
+content: ""
+
+output:
+  file: "README.md"
+  mode: inject
+  template: |-
+    <!-- BEGIN_TF_DOCS -->
+    {{ .Content }}
+    <!-- END_TF_DOCS -->
+
+output-values:
+  enabled: false
+  from: ""
+
+sort:
+  enabled: true
+  by: name
+
+settings:
+  anchor: true
+  color: true
+  default: true
+  description: false
+  escape: true
+  hide-empty: false
+  html: true
+  indent: 2
+  lockfile: true
+  read-comments: true
+  required: true
+  sensitive: true
+  type: true

modules/azure-vnet-and-subnet/README.md

@@ -1,129 +1,100 @@
-# Azure virtual network(s) and subnet(s)
+<!-- BEGIN_TF_DOCS -->
+## Azure Virtual Network and Subnet Module
 
-## Overview
+This Terraform module creates and manages a Virtual Network (VNet) and subnets in Azure, including private DNS zones, peerings, and tagging. It is designed for deploying complex and reusable network infrastructures in Azure environments.
 
-This module creates one or more virtual networks and subnets.
+### Features
+- Create a VNet with multiple subnets
+- Support for private DNS zones and virtual network links
+- Configure network peerings
+- Flexible tagging and tag inheritance from the resource group
 
-## DOC
+### Basic example
 
-- [Resource terraform - azurerm_virtual_network](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_network)
-- [Resource terraform - azurerm_subnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/subnet)
-- [Resource terraform - azurerm_virtual_network_peering](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_network_peering)
-- [Resource terraform - azurerm_private_dns_zone](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/private_dns_zone)
-- [Resource terraform - azurerm_private_dns_zone_virtual_network_link](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/private_dns_zone_virtual_network_link)
-
-## Usage
-
-## Observations
-
-Al resources are created in the same resource group.
+```hcl
+module "azure_vnet_and_subnet" {
+  source = "git::https://github.com/prefapp/tfm.git//modules/azure-vnet-and-subnet?ref=<version>"
+
+  resource_group_name = "example-rg"
+
+  virtual_network = {
+    name          = "example-vnet"
+    location      = "westeurope"
+    address_space = ["10.0.0.0/16"]
+    subnets = {
+      internal = {
+        address_prefixes = ["10.0.1.0/24"]
+      }
+    }
+  }
 
-### Set a module
+  private_dns_zones = []
+  peerings          = []
 
-```terraform
-module "githuib-oidc" {
-  source = "git::https://github.com/prefapp/tfm.git//modules/azure-vnet-subnet?ref=<version>"
+  tags = {
+    environment = "dev"
+  }
 }
 ```
 
-#### Example
-
-```terraform
-module "githuib-oidc" {
-  source = "git::https://github.com/prefapp/tfm.git//modules/azure-vnet-subnet?ref=v1.2.3"
-}
-```
-
-## Inputs
-| Name | Description | Type | Default | Required |
-|------|-------------|------|---------|:--------:|
-| `virtual_network` | Properties of the virtual network | object | n/a | yes |
-| `virtual_network.name` | The name of the virtual network | string | n/a | yes |
-| `virtual_network.location` | The location of the virtual network | string | n/a | yes |
-| `virtual_network.address_space` | The address space of the virtual network | list(string) | n/a | yes |
-| `virtual_network.subnets` | Map of subnets within the virtual network | map(object) | n/a | yes |
-| `virtual_network.subnets.address_prefixes` | List of address prefixes for the subnet | list(string) | n/a | yes |
-| `virtual_network.subnets.private_endpoint_network_policies_enabled` | Whether private endpoint network policies are enabled | string | `Enabled` | no |
-| `virtual_network.subnets.private_link_service_network_policies_enabled` | Whether private link service network policies are enabled | bool | `true` | no |
-| `virtual_network.subnets.service_endpoints` | List of service endpoints for the subnet | list(string) | `[]` | no |
-| `virtual_network.subnets.delegation` | List of delegations for the subnet | list(object) | `[]` | no |
-| `virtual_network.subnets.delegation.name` | The name of the delegation | string | n/a | yes |
-| `virtual_network.subnets.delegation.service_delegation` | Service delegation details | object | n/a | yes |
-| `virtual_network.subnets.delegation.service_delegation.name` | The name of the service delegation | string | n/a | yes |
-| `virtual_network.subnets.delegation.service_delegation.actions` | List of actions for the service delegation | list(string) | n/a | yes |
-| `private_dns_zones` | List of private DNS zones to create | list(object) | `[]` | no |
-| `private_dns_zones.name` | The name of the private DNS zone | string | n/a | yes |
-| `private_dns_zones.link_name` | The name of the private DNS zone VNET link | string | n/a | no |
-| `private_dns_zones.auto_registration_enabled` | Whether auto registration is enabled | bool | `false` | no |
-| `peerings` | List of virtual network peerings | list(object) | `[]` | no |
-| `peerings.peering_name` | The name of the peering | string | n/a | yes |
-| `peerings.allow_forwarded_traffic` | Whether forwarded traffic is allowed | bool | `false` | no |
-| `peerings.allow_gateway_transit` | Whether gateway transit is allowed | bool | `false` | no |
-| `peerings.allow_virtual_network_access` | Whether virtual network access is allowed | bool | `true` | no |
-| `peerings.use_remote_gateways` | Whether to use remote gateways | bool | `false` | no |
-| `peerings.resource_group_name` | The name of the resource group for the peering | string | n/a | yes |
-| `peerings.vnet_name` | The name of the virtual network for the peering | string | n/a | yes |
-| `peerings.remote_virtual_network_id` | The ID of the remote virtual network | string | n/a | yes |
-| `resource_group_name` | The name of the resource group in which to create the virtual network | string | n/a | yes |
-| `tags` | A map of tags to add to the public IP | map(string) | `{}` | no |
-| `tags_from_rg` | Use the tags from the resource group, if true, the tags set in the tags variable will be ignored | bool | `true` | no |
-
-### Set a data .tfvars
-
-#### Example
+### Advanced example
 
 ```hcl
-resource_group_name = "myResourceGroupName"
-
-virtual_network = {
-  name = "myVnetName"
-  location = "myLocation"
-  address_space = ["10.107.0.0/32"]
-  subnets = {
-    subnet1 = {
-      address_prefixes = ["10.107.0.0/18"]
-      service_endpoints = ["Microsoft.Storage"]
-    }
-    subnet2 = {
-      address_prefixes = ["10.107.64.0/24"]
-      service_endpoints = ["Microsoft.Storage"]
-      delegation = [
-        {
-          name = "Microsoft.DBforPostgreSQL.flexibleServers"
-          service_delegation = {
-            name = "Microsoft.DBforPostgreSQL/flexibleServers"
-            actions = ["Microsoft.Network/virtualNetworks/subnets/join/action"]
+module "azure_vnet_and_subnet" {
+  source = "git::https://github.com/prefapp/tfm.git//modules/azure-vnet-and-subnet?ref=<version>"
+
+  resource_group_name = "myResourceGroupName"
+
+  virtual_network = {
+    name          = "myVnetName"
+    location      = "myLocation"
+    address_space = ["10.107.0.0/16"]
+    subnets = {
+      subnet1 = {
+        address_prefixes = ["10.107.0.0/18"]
+        service_endpoints = ["Microsoft.Storage"]
+      }
+      subnet2 = {
+        address_prefixes = ["10.107.64.0/24"]
+        service_endpoints = ["Microsoft.Storage"]
+        delegation = [
+          {
+            name = "Microsoft.DBforPostgreSQL.flexibleServers"
+            service_delegation = {
+              name    = "Microsoft.DBforPostgreSQL/flexibleServers"
+              actions = ["Microsoft.Network/virtualNetworks/subnets/join/action"]
+            }
           }
-        }
-      ]
+        ]
+      }
     }
   }
-}
 
-private_dns_zones = [
-  {
-    name = "foo.councilbox.postgres.database.azure.com",
-    auto_registration_enabled = true
-  },
-  {
-    name = "privatelink.redis.cache.windows.net"
-    link_name = "redis_link"
-  }
-]
+  private_dns_zones = [
+    {
+      name                      = "foo.councilbox.postgres.database.azure.com"
+      auto_registration_enabled = true
+    },
+    {
+      name      = "privatelink.redis.cache.windows.net"
+      link_name = "redis_link"
+    }
+  ]
+
+  peerings = [
+    {
+      peering_name              = "myPeeringName"
+      resource_group_name       = "myResourceGroupName"
+      vnet_name                 = "myVnetName"
+      remote_virtual_network_id = "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Network/virtualNetworks/myRemoteVnetName"
+    }
+  ]
 
-peerings = [
-  {
-    peering_name = "myPeeringName"
-    resource_group_name = "myResourceGroupName"
-    vnet_name = "myVnetName"
-    remote_virtual_network_id = "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Network/virtualNetworks/myRemoteVnetName"
+  tags_from_rg = false
+  tags = {
+    environment = "myEnvironment"
+    department  = "myDepartment"
   }
-]
-
-tags_from_rg = false
-tags = {
-  environment = "myEnvironment"
-  department  = "myDepartment"
 }
 ```
 
@@ -136,8 +107,8 @@ private_dns_zone_ids = [
 ]
 
 private_dns_zone_virtual_network_link_ids = [
-  "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Network/privateDnsZones/privatelink.redis.cache.windows.net/virtualNetworkLinks/bar-foo",
-  "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Network/privateDnsZones/foo.bar.postgres.database.azure.com/virtualNetworkLinks/foo-bar",
+  "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Network/privateDnsZones/privatelink.redis.cache.windows.net/virtualNetworkLinks/redis_link",
+  "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Network/privateDnsZones/foo.councilbox.postgres.database.azure.com/virtualNetworkLinks/redis_link",
 ]
 
 subnet_ids = {
@@ -150,3 +121,65 @@ vnet_peering_ids = {
   "myPeeringName" = "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Network/virtualNetworks/myVnetName/virtualNetworkPeerings/myPeeringName"
 }
 ```
+
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | >=4.21.1 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | >=4.21.1 |
+
+## Modules
+
+No modules.
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [azurerm_private_dns_zone.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/private_dns_zone) | resource |
+| [azurerm_private_dns_zone_virtual_network_link.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/private_dns_zone_virtual_network_link) | resource |
+| [azurerm_subnet.subnet](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/subnet) | resource |
+| [azurerm_virtual_network.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_network) | resource |
+| [azurerm_virtual_network_peering.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_network_peering) | resource |
+| [azurerm_resource_group.resource_group](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group) | data source |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_peerings"></a> [peerings](#input\_peerings) | List of virtual network peerings | <pre>list(object({<br/>    peering_name                 = string<br/>    allow_forwarded_traffic      = optional(bool, false)<br/>    allow_gateway_transit        = optional(bool, false)<br/>    allow_virtual_network_access = optional(bool, true)<br/>    use_remote_gateways          = optional(bool, false)<br/>    resource_group_name          = string<br/>    vnet_name                    = string<br/>    remote_virtual_network_id    = string<br/>  }))</pre> | `[]` | no |
+| <a name="input_private_dns_zones"></a> [private\_dns\_zones](#input\_private\_dns\_zones) | List of private DNS zones to create | <pre>list(object({<br/>    name                      = string<br/>    link_name                 = optional(string)<br/>    auto_registration_enabled = optional(bool, false)<br/>  }))</pre> | `[]` | no |
+| <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name) | The name of the resource group in which to create the virtual network | `string` | n/a | yes |
+| <a name="input_tags"></a> [tags](#input\_tags) | The tags to associate with your resources | `map(string)` | `{}` | no |
+| <a name="input_tags_from_rg"></a> [tags\_from\_rg](#input\_tags\_from\_rg) | Use the tags from the resource group | `bool` | `true` | no |
+| <a name="input_virtual_network"></a> [virtual\_network](#input\_virtual\_network) | Properties of the virtual network | <pre>object({<br/>    name          = string<br/>    location      = string<br/>    address_space = list(string)<br/>    subnets = map(object({<br/>      address_prefixes                              = list(string)<br/>      private_endpoint_network_policies_enabled     = optional(string, "Enabled")<br/>      private_link_service_network_policies_enabled = optional(bool, true)<br/>      service_endpoints                             = optional(list(string))<br/>      delegation = optional(list(object({<br/>        name = string<br/>        service_delegation = object({<br/>          name    = string<br/>          actions = list(string)<br/>        })<br/>      })))<br/>    }))<br/>  })</pre> | n/a | yes |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_private_dns_zone_ids"></a> [private\_dns\_zone\_ids](#output\_private\_dns\_zone\_ids) | Output the IDs of the private DNS zones |
+| <a name="output_private_dns_zone_virtual_network_link_ids"></a> [private\_dns\_zone\_virtual\_network\_link\_ids](#output\_private\_dns\_zone\_virtual\_network\_link\_ids) | Output the IDs of the private DNS zone virtual network links |
+| <a name="output_subnet_ids"></a> [subnet\_ids](#output\_subnet\_ids) | Output the IDs of the subnets with their names as keys |
+| <a name="output_vnet_id"></a> [vnet\_id](#output\_vnet\_id) | Output the ID of the virtual network |
+| <a name="output_vnet_peering_ids"></a> [vnet\_peering\_ids](#output\_vnet\_peering\_ids) | Output the IDs of the virtual network peerings with their names as keys |
+
+## Examples
+
+For detailed examples, refer to the [module examples](https://github.com/prefapp/tfm/tree/main/modules/azure-vnet-and-subnet/_examples):
+
+- [basic](https://github.com/prefapp/tfm/tree/main/modules/azure-vnet-and-subnet/_examples/basic) - Virtual network with one internal subnet.
+
+## Resources
+- [Official Azure Virtual Network documentation](https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-overview)
+- [Terraform AzureRM Provider](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_network)
+
+## Support
+For issues, questions, or contributions related to this module, please visit the [repository's issue tracker](https://github.com/prefapp/tfm/issues).
+<!-- END_TF_DOCS -->

modules/azure-vnet-and-subnet/_examples/basic/main.tf

@@ -0,0 +1,25 @@
+// Basic example: Virtual Network with one subnet using azure-vnet-and-subnet module
+
+module "azure_vnet_and_subnet" {
+  source = "../../"
+
+  resource_group_name = "example-rg"
+
+  virtual_network = {
+    name          = "example-vnet"
+    location      = "westeurope"
+    address_space = ["10.0.0.0/16"]
+    subnets = {
+      internal = {
+        address_prefixes = ["10.0.1.0/24"]
+      }
+    }
+  }
+
+  private_dns_zones = []
+  peerings          = []
+
+  tags = {
+    environment = "dev"
+  }
+}

modules/azure-vnet-and-subnet/_examples/basic/values.yaml

@@ -0,0 +1,19 @@
+# Basic example values for azure-vnet-and-subnet module
+
+resource_group_name: example-rg
+
+virtual_network:
+  name: example-vnet
+  location: westeurope
+  address_space:
+    - 10.0.0.0/16
+  subnets:
+    internal:
+      address_prefixes:
+        - 10.0.1.0/24
+
+private_dns_zones: []
+peerings: []
+
+tags:
+  environment: dev

modules/azure-vnet-and-subnet/docs/footer.md

@@ -0,0 +1,12 @@
+## Examples
+
+For detailed examples, refer to the [module examples](https://github.com/prefapp/tfm/tree/main/modules/azure-vnet-and-subnet/_examples):
+
+- [basic](https://github.com/prefapp/tfm/tree/main/modules/azure-vnet-and-subnet/_examples/basic) - Virtual network with one internal subnet.
+
+## Resources
+- [Official Azure Virtual Network documentation](https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-overview)
+- [Terraform AzureRM Provider](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/virtual_network)
+
+## Support
+For issues, questions, or contributions related to this module, please visit the [repository's issue tracker](https://github.com/prefapp/tfm/issues).