Skip to content

Latest commit

 

History

History
120 lines (79 loc) · 6.75 KB

README.md

File metadata and controls

120 lines (79 loc) · 6.75 KB

Virtual Network

This terraform module simplifies the process of creating and managing virtual network resources on azure with configurable options for network topology, subnets, security groups, and more to ensure a secure and efficient environment for resource communication in the cloud.

Goals

The main objective is to create a more logic data structure, achieved by combining and grouping related resources together in a complex object.

The structure of the module promotes reusability. It's intended to be a repeatable component, simplifying the process of building diverse workloads and platform accelerators consistently.

A primary goal is to utilize keys and values in the object that correspond to the REST API's structure. This enables us to carry out iterations, increasing its practical value as time goes on.

A last key goal is to separate logic from configuration in the module, thereby enhancing its scalability, ease of customization, and manageability.

Non-Goals

These modules are not intended to be complete, ready-to-use solutions; they are designed as components for creating your own patterns.

They are not tailored for a single use case but are meant to be versatile and applicable to a range of scenarios.

Security standardization is applied at the pattern level, while the modules include default values based on best practices but do not enforce specific security standards.

End-to-end testing is not conducted on these modules, as they are individual components and do not undergo the extensive testing reserved for complete patterns or solutions.

Features

  • dedicated network security group for each subnet, capable of managing multiple rules
  • support for multiple service endpoints and delegations, including actions
  • utilization of terratest for robust validation
  • route table support with multiple user defined routes
  • association of multiple subnets with a single route table
  • optional virtual hub connections for enhanced network integration

Requirements

Name Version
terraform ~> 1.0
azurerm ~> 4.0
random ~> 3.6
time ~> 0.10.0

Providers

Name Version
azurerm ~> 4.0

Resources

Name Type
azurerm_network_security_group.this resource
azurerm_network_security_rule.this resource
azurerm_route.this resource
azurerm_route_table.this resource
azurerm_subnet.subnets resource
azurerm_subnet_network_security_group_association.this resource
azurerm_subnet_route_table_association.this resource
azurerm_virtual_network.vnet resource
azurerm_virtual_network_dns_servers.dns resource
azurerm_virtual_network.existing data source

Inputs

Name Description Type Default Required
location default azure region to be used. string null no
naming Used for naming purposes map(string) null no
resource_group default resource group to be used. string null no
tags tags to be added to the resources map(string) {} no
vnet Contains all virtual network settings any n/a yes

Outputs

Name Description
network_security_group n/a
subnets n/a
vnet contains frontdoor configuration

Testing

Ensure go and terraform are installed.

Run tests for different usage scenarios by specifying the EXAMPLE environment variable. Usage examples are in the examples directory.

To execute a test, run make test EXAMPLE=default

Replace default with the specific example you want to test. These tests ensure the module performs reliably across various configurations.

Notes

Using a dedicated module, we've developed a naming convention for resources that's based on specific regular expressions for each type, ensuring correct abbreviations and offering flexibility with multiple prefixes and suffixes.

Full examples detailing all usages, along with integrations with dependency modules, are located in the examples directory.

To update the module's documentation run make doc

Authors

Module is maintained by these awesome contributors.

Contributing

We welcome contributions from the community! Whether it's reporting a bug, suggesting a new feature, or submitting a pull request, your input is highly valued.

For more information, please see our contribution guidelines.

License

MIT Licensed. See LICENSE for full details.

Reference