Virtual Network Gateway

This terraform module simplifies the process of creating and managing virtual network gateways, local network gateways, and their connections. It offers customizable options and features, providing a flexible solution for integrating vpn functionality.

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.

Features

• supports both active-active and active-passive configurations for enhanced redundancy and availability.
• utilization of terratest for robust validation.
• allows multiple ip configurations.
• enables the configuration of multiple local network gateways and connections.
• optionally allows the addition of NAT rules, enabling customized network address translation.

Requirements

Name	Version
terraform	~> 1.0
azurerm	~> 3.61

Providers

Name	Version
azurerm	~> 3.61

Modules

Name	Source
local-gateway	resource
nat-rules	resource

Resources

Name	Type
azurerm_public_ip	resource
azurerm_virtual_network_gateway	resource
azurerm_local_network_gateway	resource
azurerm_virtual_network_gateway_connection	resource
azurerm_virtual_network_gateway_nat_rule	resource
azurerm_subscription	data source

Inputs

Name	Description	Type	Required
gateway	virtual network gateway details	object	yes
naming	contains naming convention	string	no
location	default azure region tho be used	string	no
resourcegroup	default resource group to be used	string	no
tags	tags to be added to the resources	map(string)	no

Outputs

Name	Description
gateway	virtual network gateway details
ip_configuration_ids	contains virtual network gateway ip configuration ids

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.

License

MIT Licensed. See LICENSE for full details.

References

• Documentation
• Rest Api
• Rest Api Specs