tf-azurerm-module_reference-virtual_network

Overview

This module is used to deploy one or more virtual networks and subnets.

Pre-Commit hooks

.pre-commit-config.yaml file defines certain pre-commit hooks that are relevant to terraform, golang and common linting tasks. There are no custom hooks added.

commitlint hook enforces commit message in certain format. The commit contains the following structural elements, to communicate intent to the consumers of your commit messages:

• fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
• feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
• BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type. footers other than BREAKING CHANGE: may be provided and follow a convention similar to git trailer format.
• build: a commit of the type build adds changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
• chore: a commit of the type chore adds changes that don't modify src or test files
• ci: a commit of the type ci adds changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
• docs: a commit of the type docs adds documentation only changes
• perf: a commit of the type perf adds code change that improves performance
• refactor: a commit of the type refactor adds code change that neither fixes a bug nor adds a feature
• revert: a commit of the type revert reverts a previous commit
• style: a commit of the type style adds code changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• test: a commit of the type test adds missing tests or correcting existing tests

Base configuration used for this project is commitlint-config-conventional (based on the Angular convention)

If you are a developer using vscode, this plugin may be helpful.

detect-secrets-hook prevents new secrets from being introduced into the baseline. TODO: INSERT DOC LINK ABOUT HOOKS

In order for pre-commit hooks to work properly

• You need to have the pre-commit package manager installed. Here are the installation instructions.
• pre-commit would install all the hooks when commit message is added by default except for commitlint hook. commitlint hook would need to be installed manually using the command below

pre-commit install --hook-type commit-msg

To test the resource group module locally

1. For development/enhancements to this module locally, you'll need to install all of its components. This is controlled by the configure target in the project's Makefile. Before you can run configure, familiarize yourself with the variables in the Makefile and ensure they're pointing to the right places.

make configure

This adds in several files and directories that are ignored by git. They expose many new Make targets.

2. THIS STEP APPLIES ONLY TO MICROSOFT AZURE. IF YOU ARE USING A DIFFERENT PLATFORM PLEASE SKIP THIS STEP. The first target you care about is env. This is the common interface for setting up environment variables. The values of the environment variables will be used to authenticate with cloud provider from local development workstation.

make configure command will bring down azure_env.sh file on local workstation. Devloper would need to modify this file, replace the environment variable values with relevant values.

These environment variables are used by terratest integration suit.

Service principle used for authentication(value of ARM_CLIENT_ID) should have below privileges on resource group within the subscription.

"Microsoft.Resources/subscriptions/resourceGroups/write"
"Microsoft.Resources/subscriptions/resourceGroups/read"
"Microsoft.Resources/subscriptions/resourceGroups/delete"

Then run this make target to set the environment variables on developer workstation.

make env

3. The first target you care about is check.

Pre-requisites Before running this target it is important to ensure that, developer has created files mentioned below on local workstation under root directory of git repository that contains code for primitives/segments. Note that these files are azure specific. If primitive/segment under development uses any other cloud provider than azure, this section may not be relevant.

• A file named provider.tf with contents below

provider "azurerm" {
  features {}
}

• A file named terraform.tfvars which contains key value pair of variables used.

Note that since these files are added in gitignore they would not be checked in into primitive/segment's git repo.

After creating these files, for running tests associated with the primitive/segment, run

make check

If make check target is successful, developer is good to commit the code to primitive/segment's git repo.

make check target

• runs terraform commands to lint,validate and plan terraform code.
• runs conftests. conftests make sure policy checks are successful.
• runs terratest. This is integration test suit.
• runs opa tests

Requirements

Name	Version
terraform	<= 1.5.5
azurerm	~> 3.77

Providers

No providers.

Modules

Name	Source	Version
resource_names	terraform.registry.launch.nttdata.com/module_library/resource_name/launch	~> 1.0
resource_names_v2	terraform.registry.launch.nttdata.com/module_library/resource_name/launch	~> 2.0
resource_group	terraform.registry.launch.nttdata.com/module_primitive/resource_group/azurerm	~> 1.0
network	terraform.registry.launch.nttdata.com/module_primitive/virtual_network/azurerm	~> 3.0
subnets	terraform.registry.launch.nttdata.com/module_primitive/virtual_network_subnet/azurerm	~> 1.0
private_dns_zones	terraform.registry.launch.nttdata.com/module_primitive/private_dns_zone/azurerm	~> 1.0
private_dns_zone_vnet_links	terraform.registry.launch.nttdata.com/module_primitive/private_dns_vnet_link/azurerm	~> 1.0
private_endpoint_resource_names	terraform.registry.launch.nttdata.com/module_library/resource_name/launch	~> 1.0
private_endpoint_resource_names_v2	terraform.registry.launch.nttdata.com/module_library/resource_name/launch	~> 2.0
private_service_connection_resource_names	terraform.registry.launch.nttdata.com/module_library/resource_name/launch	~> 1.0
private_service_connection_resource_names_v2	terraform.registry.launch.nttdata.com/module_library/resource_name/launch	~> 2.0
private_endpoints	terraform.registry.launch.nttdata.com/module_primitive/private_endpoint/azurerm	~> 1.0
route_tables	terraform.registry.launch.nttdata.com/module_primitive/route_table/azurerm	~> 1.0
routes	terraform.registry.launch.nttdata.com/module_primitive/route/azurerm	~> 1.0
monitor_private_link_scope	terraform.registry.launch.nttdata.com/module_primitive/azure_monitor_private_link_scope/azurerm	~> 1.0
monitor_private_link_scope_dns_zone	terraform.registry.launch.nttdata.com/module_primitive/private_dns_zone/azurerm	~> 1.0
monitor_private_link_scope_vnet_link	terraform.registry.launch.nttdata.com/module_primitive/private_dns_vnet_link/azurerm	~> 1.0
monitor_private_link_scope_private_endpoint	terraform.registry.launch.nttdata.com/module_primitive/private_endpoint/azurerm	~> 1.0

Resources

No resources.

Inputs

Name	Description	Type	Default	Required
location	The location of the vnet and resource group to create.	string	n/a	yes
address_space	The address space that is used by the virtual network.	list(string)	n/a	yes
bgp_community	(Optional) The BGP community attribute in format <as-number>:<community-value>.	string	null	no
ddos_protection_plan	The set of DDoS protection plan configuration	object({ enable = bool id = string })	null	no
dns_servers	The DNS servers to be used with vNet.	list(string)	[]	no
subnets	A mapping of subnet names to their configurations.	map(object({ prefix = string delegation = optional(map(object({ service_name = string service_actions = list(string) })), {}) service_endpoints = optional(list(string), []), private_endpoint_network_policies = optional(string, null) private_endpoint_network_policies_enabled = optional(bool, false) private_link_service_network_policies_enabled = optional(bool, false) network_security_group_id = optional(string, null) route_table_id = optional(string, null) route_table_alias = optional(string, null) }))	{}	no
private_endpoint_resource_names_map	A map of key to resource_name that will be used to generate private endpoint resource names	map(object({ name = string max_length = optional(number, 60) }))	{ "private_endpoint": { "max_length": 80, "name": "pe" }, "private_service_connection": { "max_length": 80, "name": "psc" } }	no
private_dns_zone_suffixes	A set of private DNS zones to create	set(string)	[]	no
private_endpoints	A mapping of private endpoints to create in the virtual network For a list of subresources and DNS zone suffixes see https://learn.microsoft.com/en-us/azure/private-link/private-endpoint-dns	map(object({ private_dns_zone_suffixes = list(string) private_dns_zone_group_name = string private_link_subresource_names = list(string) target_resource_id = string subnet_name = string }))	{}	no
enable_monitor_private_link_scope	Enable deployment of a private link scope for Azure Monitor This allows workloads on the virtual network to access Azure Monitor services (i.e. log analytics, app insights) privately	bool	false	no
monitor_private_link_scope_subnet_name	The name of the subnet to deploy a private endpoint for the monitor private link scope. Required when enable_monitor_private_link_scope is true.	string	null	no
monitor_private_link_scope_dns_zone_suffixes	The DNS zone suffixes for the private link scope	set(string)	[ "privatelink.monitor.azure.com", "privatelink.oms.opinsights.azure.com", "privatelink.ods.opinsights.azure.com", "privatelink.agentsvc.azure-automation.net", "privatelink.blob.core.windows.net" ]	no
route_tables	A mapping of route table aliases to route table configuration.	map(object({ name = string disable_bgp_route_propagation = optional(bool, false) extra_tags = optional(map(string), {}) }))	{}	no
routes	A mapping of routes to create.	map(object({ name = string route_table_alias = string address_prefix = string next_hop_type = string next_hop_in_ip_address = optional(string, null) }))	{}	no
tags	Tags to be applied to all resources that are created by this module.	map(string)	{}	no
resource_names_map	A map of key to resource_name that will be used by tf-launch-module_library-resource_name to generate resource names	map(object({ name = string max_length = optional(number, 60) }))	{ "monitor_private_link_scope": { "max_length": 80, "name": "ampls" }, "monitor_private_link_scope_private_endpoint": { "max_length": 80, "name": "amplspe" }, "resource_group": { "max_length": 80, "name": "rg" }, "virtual_network": { "max_length": 80, "name": "vnet" } }	no
resource_names_version	Major version of the resource names module to use	string	"1"	no
environment	Environment in which the resource should be provisioned like dev, qa, prod etc.	string	"sandbox"	no
class_env	Environment where resource is going to be deployed. For example. dev, qa, uat	string	null	no
environment_number	The environment count for the respective environment. Defaults to 000. Increments in value of 1	string	"000"	no
instance_env	Number that represents the instance of the environment.	number	null	no
resource_number	The resource count for the respective resource. Defaults to 000. Increments in value of 1	string	"000"	no
instance_resource	Number that represents the instance of the resource.	number	null	no
logical_product_family	(Required) Name of the product family for which the resource is created. Example: org_name, department_name.	string	n/a	yes
logical_product_service	(Required) Name of the product service for which the resource is created. For example, backend, frontend, middleware etc.	string	n/a	yes

Outputs

Name	Description
vnet_address_space	The address space of the newly created vNet
vnet_guid	The GUID of the newly created vNet
vnet_id	The id of the newly created vNet
vnet_location	The location of the newly created vNet
vnet_name	The Name of the newly created vNet
subnet_map	The ids of subnets created inside the newly created vNet
private_dns_zones	The private dns zones associated with the newly created vNet
private_endpoints	The private endpoints associated with the newly created vNet
monitor_private_link_scope_id	The id of the monitor private link scope
subnet_name_id_map	Can be queried subnet-id by subnet name by using lookup(module.vnet.vnet_subnets_name_id, subnet1)
resource_group_id	resource group id
resource_group_name	resource group name
transformed_routes	n/a
route_tables_map	n/a
subnet_route_associations	n/a