diff --git a/README.md b/README.md index 656f4e0..75b7939 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Virtual Network Gateway terraform module -Terraform module to create Virtual network gateway to send encrypted traffic between an Azure virtual network and an on-premises location over the public Internet. +Terraform module to create a Virtual Network Gateway to send encrypted traffic between an Azure virtual network and an on-premises location over the public Internet. Supports both VPN and ExpressRoute gateway types. VPN configuration supports ExpressRoute (private connection), Site-to-Site and Multi-Site (IPsec/IKE VPN tunnel). Optional active-active mode and point-to-site supported as well. + +>## *Creating a virtual network gateway can take up to **45 minutes** to complete. When you create a virtual network gateway, gateway VMs are deployed to the gateway subnet and configured with the settings that you specify* Types of resources are supported: @@ -8,8 +10,6 @@ Types of resources are supported: * Site-to-Site * ExpressRoute ->## *Creating a virtual network gateway can take up to **45 minutes** to complete. When you create a virtual network gateway, gateway VMs are deployed to the gateway subnet and configured with the settings that you specify* - ## Module Usage ```hcl @@ -18,6 +18,7 @@ module "vpn-gateway" { version = "1.0.0" # Resource Group, location, VNet and Subnet details + # IPSec Site-to-Site connection configuration requirements resource_group_name = "rg-shared-westeurope-01" virtual_network_name = "vnet-shared-hub-westeurope-001" vpn_gateway_name = "shared-vpn-gw01" @@ -96,7 +97,7 @@ Name | Description ---- | ----------- `address_space`|The address space out of which IP addresses for VPN clients will be taken. You can provide more than one address space, e.g. in CIDR notation `certifciate_path`|The public certificate of the root certificate authority. The certificate must be provided in Base-64 encoded X.509 format (PEM). In particular, this argument must not include the -----BEGIN CERTIFICATE----- or -----END CERTIFICATE----- markers -`vpn_client_protocols`|) List of the protocols supported by the VPN client. The supported values are `SSTP`, `IkeV2` and `OpenVPN` +`vpn_client_protocols`| List of the protocols supported by the VPN client. The supported values are `SSTP`, `IkeV2` and `OpenVPN` ## Recommended naming and tagging conventions diff --git a/examples/point-to-site/cert.pem b/examples/point-to-site/cert.pem deleted file mode 100644 index 630ff49..0000000 --- a/examples/point-to-site/cert.pem +++ /dev/null @@ -1,20 +0,0 @@ -MIIDnjCCAoagAwIBAgIhAKB7fd2/hLLoXJHF57TGm7ACkjrWrtgb+KnO+mMsvCw/ -MA0GCSqGSIb3DQEBBQUAMGUxCTAHBgNVBAYTADEQMA4GA1UECgwHZXhhbXBsZTEJ -MAcGA1UECwwAMRQwEgYDVQQDDAtleGFtcGxlLmNvbTEPMA0GCSqGSIb3DQEJARYA -MRQwEgYDVQQDDAtleGFtcGxlLmNvbTAeFw0yMDA5MjQyMDAxMDBaFw0yMTA5MjUy -MDAxMDBaME8xCTAHBgNVBAYTADEQMA4GA1UECgwHZXhhbXBsZTEJMAcGA1UECwwA -MRQwEgYDVQQDDAtleGFtcGxlLmNvbTEPMA0GCSqGSIb3DQEJARYAMIIBIjANBgkq -hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAudme3h7l52ZrCX9uMYtsaJQikuPFCPFw -mZFNCkILDoox03Ag4u+qPcS/Z3pT3QJQrM4Vy/I6K2ZnTWCTUhdh4QD69YPotcvC -/0UBDkaZXO0XHMdqoWJFeqDF0WXvI+Suo2nxmx1lRNc5jZi36VW4SwzDdm31LfWI -7FCDFyBQc3aBgc2SFxWkU0IKsLUnmfXIyWbBYioKcAUj7OuD9MY3TGrKB1xwjHxa -abFQzuPFKTkLMmlXCBWweSS8XJXlnY6gvc1jAz6Vq3KET7V83ZCDVaikKeIstG+y -DFp/Bs+CxMLi0k4nv0fHyXo9dCDkXQlYPgyENi+jo6KLxFdlxa3rmQIDAQABo08w -TTAdBgNVHQ4EFgQUwMSixpf56/TXQNUvGwr/S4dpOlkwHwYDVR0jBBgwFoAUwMSi -xpf56/TXQNUvGwr/S4dpOlkwCwYDVR0RBAQwAoIAMA0GCSqGSIb3DQEBBQUAA4IB -AQCB3UGnJb3k2Sx1m47TQgPnQI3T16XIFsGHMivvwGuxIYz1hZrDhQ/2EepnLicK -oPalygS0ko/1r3xGHcn1Ei/0N4SQTrRMfn4pjvXRGx+Rs2Nl9E3PUAMMcEuqW1Pa -cUQrkEdlGg0t0fBtTpUHqyUFh0xU6Qlk2CIZdo2NaDoI6xpYYJtXqJWtTvOTe5op -MOyajCaVrAXxY4Kk53Yrl1+yhbL+x4JNMrdO4wAn0bR0Teawm1y1WFsu9OHMoZzX -Dgos8H06PH6rPvvvI1IFv3l5flPei3+YaO8m67nINbicW4BkBFwoxqjRnkCjZ+y0 -38xRFiD0G8J0rE6wPB/9sAwP \ No newline at end of file diff --git a/examples/point-to-site/main.tf b/examples/point-to-site/main.tf index 547ff47..36aa6f4 100644 --- a/examples/point-to-site/main.tf +++ b/examples/point-to-site/main.tf @@ -1,13 +1,13 @@ module "vpn-gateway" { - // source = "kumarvna/vpn-gateway/azurerm" - // version = "1.0.0" - source = "../../" + source = "kumarvna/vpn-gateway/azurerm" + version = "1.0.0" + # Resource Group, location, VNet and Subnet details resource_group_name = "rg-shared-westeurope-01" virtual_network_name = "vnet-shared-hub-westeurope-001" vpn_gateway_name = "shared-vpn-gw01" - # client configuration + # client configuration for Point-to-Site VPN Gateway connections vpn_client_configuration = { address_space = "10.1.0.0/24" vpn_client_protocols = ["SSTP", "IkeV2"] diff --git a/examples/site-to-site/main.tf b/examples/site-to-site/main.tf index 7834515..a84b888 100644 --- a/examples/site-to-site/main.tf +++ b/examples/site-to-site/main.tf @@ -3,6 +3,7 @@ module "vpn-gateway" { version = "1.0.0" # Resource Group, location, VNet and Subnet details + # IPSec Site-to-Site connection configuration requirements resource_group_name = "rg-shared-westeurope-01" virtual_network_name = "vnet-shared-hub-westeurope-001" vpn_gateway_name = "shared-vpn-gw01"