docs(azure-nsg-nsr): update docs and added examples

modules/azure-nsg-nsr/.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-nsg-nsr/README.MD

@@ -137,3 +137,166 @@ values:
       source_address_prefix: "0.0.0.0/0"
       destination_address_prefix: "*"
 ```
+
+<!-- BEGIN_TF_DOCS -->
+# Azure Network Security Group & Rules Terraform Module
+
+## Overview
+
+This Terraform module allows you to create and manage an Azure Network Security Group (NSG) and its rules, with support for:
+- Custom NSG and security rule definitions.
+- Tag inheritance from the resource group.
+- Flexible configuration for ports, protocols, and address prefixes.
+
+## Main features
+- Create an NSG with custom tags and location.
+- Define multiple security rules with granular control.
+- Support for both single and multiple port/address fields.
+- Realistic configuration example.
+
+## Complete usage example
+
+### HCL
+```hcl
+tags_from_rg        = false
+tags = {
+  env = "Production"
+}
+nsg = {
+  name                = "example-nsg"
+  location            = "East US"
+  resource_group_name = "example-rg"
+}
+rules = {
+  rule1 = {
+    name                       = "AllowSSH"
+    priority                   = 100
+    direction                  = "Inbound"
+    access                     = "Allow"
+    protocol                   = "Tcp"
+    source_port_range          = "*"
+    destination_port_range     = "22"
+    source_address_prefix      = "10.0.0.0/24"
+    destination_address_prefix = "*"
+  }
+  rule2 = {
+    name                       = "AllowHTTP"
+    priority                   = 200
+    direction                  = "Inbound"
+    access                     = "Allow"
+    protocol                   = "Tcp"
+    source_port_range          = "*"
+    destination_port_range     = "80"
+    source_address_prefix      = "0.0.0.0/0"
+    destination_address_prefix = "*"
+  }
+}
+```
+
+### YAML
+```yaml
+values:
+  tags_from_rg: false
+  tags:
+    env: "Production"
+  nsg:
+    name: "example-nsg"
+    location: "East US"
+    resource_group_name: "example-rg"
+  rules:
+    rule1:
+      name: "AllowSSH"
+      priority: 100
+      direction: "Inbound"
+      access: "Allow"
+      protocol: "Tcp"
+      source_port_range: "*"
+      destination_port_range: "22"
+      source_address_prefix: "10.0.0.0/24"
+      destination_address_prefix: "*"
+    rule2:
+      name: "AllowHTTP"
+      priority: 200
+      direction: "Inbound"
+      access: "Allow"
+      protocol: "Tcp"
+      source_port_range: "*"
+      destination_port_range: "80"
+      source_address_prefix: "0.0.0.0/0"
+      destination_address_prefix: "*"
+```
+
+## Notes
+- You must provide at least one of each: `*_range` or `*_ranges` and `*_prefix` or `*_prefixes`, but not both at the same time.
+- You can use `tags_from_rg` to inherit tags exclusively from the resource group.
+
+## File structure
+
+```
+.
+├── main.tf
+├── variables.tf
+├── outputs.tf
+├── README.MD
+├── CHANGELOG.md
+└── docs/
+    ├── header.md
+    └── footer.md
+```
+
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.7.0 |
+| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | >= 4.16.0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | >= 4.16.0 |
+
+## Modules
+
+No modules.
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [azurerm_network_security_group.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_security_group) | resource |
+| [azurerm_network_security_rule.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_security_rule) | resource |
+| [azurerm_resource_group.this](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/data-sources/resource_group) | data source |
+
+## Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_nsg"></a> [nsg](#input\_nsg) | Network Security Group configuration | <pre>object({<br/>    name                = string<br/>    location            = string<br/>    resource_group_name = string<br/>  })</pre> | n/a | yes |
+| <a name="input_rules"></a> [rules](#input\_rules) | Network Security Rule configuration | <pre>map(object({<br/>    name                         = string<br/>    priority                     = number<br/>    direction                    = string<br/>    access                       = string<br/>    protocol                     = string<br/>    source_port_range            = optional(string)<br/>    source_port_ranges           = optional(list(string))<br/>    destination_port_range       = optional(string)<br/>    destination_port_ranges      = optional(list(string))<br/>    source_address_prefix        = optional(string)<br/>    source_address_prefixes      = optional(list(string))<br/>    destination_address_prefix   = optional(string)<br/>    destination_address_prefixes = optional(list(string))<br/>  }))</pre> | n/a | yes |
+| <a name="input_tags"></a> [tags](#input\_tags) | Tags to apply to resources | `map(string)` | `{}` | no |
+| <a name="input_tags_from_rg"></a> [tags\_from\_rg](#input\_tags\_from\_rg) | Use resource group tags as base for module tags | `bool` | `false` | no |
+
+## Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_id"></a> [id](#output\_id) | OUTPUTS SECTION |
+
+## Examples
+
+For detailed examples, refer to the [module examples](https://github.com/prefapp/tfm/tree/main/modules/azure-nsg-nsr/_examples):
+
+- [basic](https://github.com/prefapp/tfm/tree/main/modules/azure-nsg-nsr/_examples/basic) - Network Security Group with a set of common inbound and outbound rules.
+
+## Resources and support
+
+- [Official Azure Network Security Group documentation](https://learn.microsoft.com/en-us/azure/virtual-network/network-security-groups-overview)
+- [Terraform reference for azurerm\_network\_security\_group](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_security_group)
+- [Terraform reference for azurerm\_network\_security\_rule](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_security_rule)
+
+## 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-nsg-nsr/_examples/basic/main.tf

@@ -0,0 +1,39 @@
+module "azure_nsg_nsr" {
+  source = "../../"
+
+  tags_from_rg = false
+  tags = {
+    env = "Production"
+  }
+
+  nsg = {
+    name                = "example-nsg"
+    location            = "westeurope"
+    resource_group_name = "example-rg"
+  }
+
+  rules = {
+    rule1 = {
+      name                       = "AllowSSH"
+      priority                   = 100
+      direction                  = "Inbound"
+      access                     = "Allow"
+      protocol                   = "Tcp"
+      source_port_range          = "*"
+      destination_port_range     = "22"
+      source_address_prefix      = "10.0.0.0/24"
+      destination_address_prefix = "*"
+    }
+    rule2 = {
+      name                       = "AllowHTTP"
+      priority                   = 200
+      direction                  = "Inbound"
+      access                     = "Allow"
+      protocol                   = "Tcp"
+      source_port_range          = "*"
+      destination_port_range     = "80"
+      source_address_prefix      = "0.0.0.0/0"
+      destination_address_prefix = "*"
+    }
+  }
+}

modules/azure-nsg-nsr/_examples/basic/values.yaml

@@ -0,0 +1,30 @@
+tags_from_rg: false
+tags:
+  env: Production
+
+nsg:
+  name: example-nsg
+  location: westeurope
+  resource_group_name: example-rg
+
+rules:
+  rule1:
+    name: AllowSSH
+    priority: 100
+    direction: Inbound
+    access: Allow
+    protocol: Tcp
+    source_port_range: "*"
+    destination_port_range: "22"
+    source_address_prefix: 10.0.0.0/24
+    destination_address_prefix: "*"
+  rule2:
+    name: AllowHTTP
+    priority: 200
+    direction: Inbound
+    access: Allow
+    protocol: Tcp
+    source_port_range: "*"
+    destination_port_range: "80"
+    source_address_prefix: 0.0.0.0/0
+    destination_address_prefix: "*"

modules/azure-nsg-nsr/docs/footer.md

@@ -0,0 +1,15 @@
+## Examples
+
+For detailed examples, refer to the [module examples](https://github.com/prefapp/tfm/tree/main/modules/azure-nsg-nsr/_examples):
+
+- [basic](https://github.com/prefapp/tfm/tree/main/modules/azure-nsg-nsr/_examples/basic) - Network Security Group with a set of common inbound and outbound rules.
+
+## Resources and support
+
+- [Official Azure Network Security Group documentation](https://learn.microsoft.com/en-us/azure/virtual-network/network-security-groups-overview)
+- [Terraform reference for azurerm_network_security_group](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_security_group)
+- [Terraform reference for azurerm_network_security_rule](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/network_security_rule)
+
+## Support
+
+For issues, questions, or contributions related to this module, please visit the [repository's issue tracker](https://github.com/prefapp/tfm/issues).