|
| 1 | +--- |
| 2 | +# |
| 3 | +# This is the canonical configuration for the `README.md` |
| 4 | +# Run `make readme` to rebuild the `README.md` |
| 5 | +# |
| 6 | + |
| 7 | +# Name of this project |
| 8 | +name: terraform-aws-vpn-connection |
| 9 | + |
| 10 | +# Tags of this project |
| 11 | +tags: |
| 12 | + - aws |
| 13 | + - terraform |
| 14 | + - terraform-modules |
| 15 | + - vpc |
| 16 | + - subnet |
| 17 | + - route |
| 18 | + - route-table |
| 19 | + - vpn |
| 20 | + - vpn-connection |
| 21 | + - site-to-site-vpn-connection |
| 22 | + - virtual-private-gateway |
| 23 | + - customer-gateway |
| 24 | + - ip |
| 25 | + - ip-address |
| 26 | + |
| 27 | +# Categories of this project |
| 28 | +categories: |
| 29 | + - terraform-modules/networking |
| 30 | + |
| 31 | +# Logo for this project |
| 32 | +#logo: docs/logo.png |
| 33 | + |
| 34 | +# License of this project |
| 35 | +license: "APACHE2" |
| 36 | + |
| 37 | +# Canonical GitHub repo |
| 38 | +github_repo: cloudposse/terraform-aws-vpn-connection |
| 39 | + |
| 40 | +# Badges to display |
| 41 | +badges: |
| 42 | + - name: "Build Status" |
| 43 | + image: "https://travis-ci.org/cloudposse/terraform-aws-vpn-connection.svg?branch=master" |
| 44 | + url: "https://travis-ci.org/cloudposse/terraform-aws-vpn-connection" |
| 45 | + - name: "Latest Release" |
| 46 | + image: "https://img.shields.io/github/release/cloudposse/terraform-aws-vpn-connection.svg" |
| 47 | + url: "https://github.com/cloudposse/terraform-aws-vpn-connection/releases/latest" |
| 48 | + - name: "Slack Community" |
| 49 | + image: "https://slack.cloudposse.com/badge.svg" |
| 50 | + url: "https://slack.cloudposse.com" |
| 51 | + |
| 52 | +related: |
| 53 | + - name: "terraform-aws-vpc" |
| 54 | + description: "Terraform module that defines a VPC with public/private subnets across multiple AZs with Internet Gateways" |
| 55 | + url: "https://github.com/cloudposse/terraform-aws-vpc" |
| 56 | + |
| 57 | + - name: "terraform-aws-vpc-peering" |
| 58 | + description: "Terraform module to create a peering connection between two VPCs" |
| 59 | + url: "https://github.com/cloudposse/terraform-aws-vpc-peering" |
| 60 | + |
| 61 | + - name: "terraform-aws-kops-vpc-peering" |
| 62 | + description: "Terraform module to create a peering connection between a backing services VPC and a VPC created by Kops" |
| 63 | + url: "https://github.com/cloudposse/terraform-aws-kops-vpc-peering" |
| 64 | + |
| 65 | + - name: "terraform-aws-dynamic-subnets" |
| 66 | + description: "Terraform module for public and private subnets provisioning in existing VPC" |
| 67 | + url: "https://github.com/cloudposse/terraform-aws-dynamic-subnets" |
| 68 | + |
| 69 | + - name: "terraform-aws-multi-az-subnets" |
| 70 | + description: "Terraform module for multi-AZ public and private subnets provisioning" |
| 71 | + url: "https://github.com/cloudposse/terraform-aws-multi-az-subnets" |
| 72 | + |
| 73 | + - name: "terraform-aws-named-subnets" |
| 74 | + description: "Terraform module for named subnets provisioning" |
| 75 | + url: "https://github.com/cloudposse/terraform-aws-named-subnets" |
| 76 | + |
| 77 | + |
| 78 | +# Short description of this project |
| 79 | +description: |- |
| 80 | + Terraform module to provision a [site-to-site](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) [VPN connection](https://docs.aws.amazon.com/vpc/latest/userguide/vpn-connections.html) |
| 81 | + between a VPC and an on-premises network. |
| 82 | +
|
| 83 | + The module does the following: |
| 84 | +
|
| 85 | + - Creates a Virtual Private Gateway (VPG) and attaches it to the VPC |
| 86 | + - Creates a Customer Gateway (CGW) pointing to the provided IP address of the Internet-routable external interface on the on-premises network |
| 87 | + - Creates a Site-to-Site Virtual Private Network (VPN) connection and assigns it to the VPG and CGW |
| 88 | + - Requests automatic route propagation between the VPG and the provided route tables in the VPC |
| 89 | + - If the VPN connection is configured to use static routes, provisions a static route between the VPN connection and the CGW |
| 90 | +
|
| 91 | +# How to use this project |
| 92 | +usage: |- |
| 93 | + ```hcl |
| 94 | + module "vpn_connection" { |
| 95 | + source = "git::https://github.com/cloudposse/terraform-aws-vpn-connection.git?ref=master" |
| 96 | + namespace = "eg" |
| 97 | + stage = "dev" |
| 98 | + name = "test" |
| 99 | + vpc_id = "vpc-xxxxxxxx" |
| 100 | + vpn_gateway_amazon_side_asn = 64512 |
| 101 | + customer_gateway_bgp_asn = 65000 |
| 102 | + customer_gateway_ip_address = "172.0.0.1" |
| 103 | + route_table_ids = ["rtb-xxxxxxxx", "rtb-yyyyyyyy", "rtb-zzzzzzzz"] |
| 104 | + vpn_connection_static_routes_only = "true" |
| 105 | + vpn_connection_static_routes_destinations = ["10.80.1.0/24"] |
| 106 | + } |
| 107 | + ``` |
| 108 | +
|
| 109 | +include: |
| 110 | + - "docs/targets.md" |
| 111 | + - "docs/terraform.md" |
| 112 | + |
| 113 | +# Contributors to this project |
| 114 | +contributors: |
| 115 | + - name: "Erik Osterman" |
| 116 | + github: "osterman" |
| 117 | + - name: "Andriy Knysh" |
| 118 | + github: "aknysh" |
| 119 | + - name: "Igor Rodionov" |
| 120 | + github: "goruha" |
| 121 | + - name: "Josh Myers" |
| 122 | + github: "joshmyers" |
0 commit comments