cloudnationhq / terraform-azure-vwan

Terraform module which creates azure virtual wan resources used by workloads and accelerators.

Virtual Wan

This terraform module streamlines the setup and management of virtual wan components on azure, offering customizable choices for wan topology, connectivity and security policies.

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

• simplified virtual wan deployment across regions
• multiple secure virtual hub support
• utilization of terratest for robust validation
• multiple collection groups, collections and rules support
• optional ip group integration in collection rule groups
• supports base and child policy inheritance

Requirements

Name	Version
terraform	~> 1.0
azurerm	~> 3.61

Providers

Name	Version
azurerm	~> 3.61

Modules

Name	Source
collection-rule-groups	resource
firewall-policy	resource

Resources

Name	Type
azurerm_firewall	resource
azurerm_firewall_policy	resource
azurerm_firewall_policy_rule_collection_group	resource
azurerm_ip_group	resource
azurerm_ip_group_cidr	resource
azurerm_virtual_hub	resource
azurerm_virtual_wan	resource

Inputs

Name	Description	Type	Required
vwan	describes virtual wan configuration	object	yes
naming	contains naming convention	string	yes
location	default azure region and can be used if location is not specified inside the object	string	no
resourcegroup	default resource group and can be used if resourcegroup is not specified inside the object	string	no

Outputs

Name	Description
vwan	contains virtual wan configuration
policy	contains firewall policy configuration
vhub	contains virtual hub configuration
firewall	contains firewall configuration
firewall_public_ip_addresses	list of public ip addresses associated with the firewall

Testing

As a prerequirement, please ensure that both go and terraform are properly installed on your system.

The Makefile includes two distinct variations of tests. The first one is designed to deploy different usage scenarios of the module. These tests are executed by specifying the TF_PATH environment variable, which determines the different usages located in the example directory.

To execute this test, input the command make test TF_PATH=default, substituting default with the specific usage you wish to test.

The second variation is known as a extended test. This one performs additional checks and can be executed without specifying any parameters, using the command make test_extended.

Both are designed to be executed locally and are also integrated into the github workflow.

Each of these tests contributes to the robustness and resilience of the module. They ensure the module performs consistently and accurately under different scenarios and 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

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

• Documentation
• Rest Api
• Rest Api Specs

terraform-azure-vwan's Issues

create initial resources