-
-
Notifications
You must be signed in to change notification settings - Fork 100
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
7 changed files
with
257 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,3 +7,6 @@ | |
| .terraform/ | ||
| .idea | ||
| terraform-aws-vpc-peering.iml | ||
|
|
||
| .build-harness | ||
| build-harness | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,10 @@ | ||
| SHELL := /bin/bash | ||
|
|
||
| # List of targets the `readme` target should call before generating the readme | ||
| export README_DEPS ?= docs/targets.md docs/terraform.md | ||
|
|
||
| -include $(shell curl -sSL -o .build-harness "https://git.io/build-harness"; echo .build-harness) | ||
|
|
||
| ## Lint terraform code | ||
| lint: | ||
| $(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate | ||
| $(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,33 @@ | ||
| # terraform-aws-vpc-peering [](https://travis-ci.org/cloudposse/terraform-aws-vpc-peering) | ||
| <!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. --> | ||
|
|
||
| [](https://cloudposse.com) | ||
|
|
||
| # terraform-aws-vpc-peering [](https://travis-ci.org/cloudposse/terraform-aws-vpc-peering) [](https://github.com/cloudposse/terraform-aws-vpc-peering/releases/latest) [](https://slack.cloudposse.com) | ||
|
|
||
|
|
||
| Terraform module to create a peering connection between two VPCs | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| This project is part of our comprehensive ["SweetOps"](https://docs.cloudposse.com) approach towards DevOps. | ||
|
|
||
|
|
||
| It's 100% Open Source and licensed under the [APACHE2](LICENSE). | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Screenshots | ||
|
|
||
|
|
||
|  | ||
| *VPC Peering Connection in the AWS Web Console* | ||
|
|
||
|
|
||
|
|
||
| ## Usage | ||
|
|
@@ -19,54 +44,90 @@ module "vpc_peering" { | |
| ``` | ||
|
|
||
|
|
||
| ## Variables | ||
|
|
||
| | Name | Default | Description | Required | | ||
| |:---------------------------------------------|:---------------|:---------------------------------------------------------------------------------|:--------:| | ||
| | `namespace` | `` | Namespace (_e.g._ `cp` or `cloudposse`) | Yes | | ||
| | `stage` | `` | Stage (_e.g._ `prod`, `dev`, `staging`) | Yes | | ||
| | `name` | `` | Name (_e.g._ `app` or `cluster`) | Yes | | ||
| | `requestor_vpc_id` | `` | Requestor VPC ID | Yes | | ||
| | `acceptor_vpc_id` | `` | Acceptor VPC ID | Yes | | ||
| | `attributes` | `[]` | Additional attributes (_e.g._ `policy` or `role`) | No | | ||
| | `tags` | `{}` | Additional tags (_e.g._ `map("BusinessUnit","XYZ")` | No | | ||
| | `delimiter` | `-` | Delimiter to be used between `namespace`, `stage`, `name`, and `attributes` | No | | ||
| | `enabled` | `true` | Set to `false` to prevent the module from creating or accessing any resources | No | | ||
| | `auto_accept` | `true` | Automatically accept the peering (both VPCs need to be in the same AWS account) | No | | ||
| | `acceptor_allow_remote_vpc_dns_resolution` | `true` | Allow acceptor VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the requestor VPC | No | | ||
| | `requestor_allow_remote_vpc_dns_resolution` | `true` | Allow requestor VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the acceptor VPC | No | | ||
|
|
||
|
|
||
| __NOTE:__ Both the acceptor and requestor VPCs must have subnets associated with route tables | ||
|
|
||
| __NOTE:__ When enabled, the DNS resolution features (`acceptor_allow_remote_vpc_dns_resolution` and `requestor_allow_remote_vpc_dns_resolution`) | ||
| require that VPCs participating in the peering must have support for the DNS hostnames enabled. | ||
| This can be done using the [`enable_dns_hostnames`](https://www.terraform.io/docs/providers/aws/r/vpc.html#enable_dns_hostnames) attribute in the `aws_vpc` resource. | ||
| ## Makefile Targets | ||
| ``` | ||
| Available targets: | ||
| https://www.terraform.io/docs/providers/aws/r/vpc_peering.html#allow_remote_vpc_dns_resolution | ||
| help This help screen | ||
| help/all Display help for all targets | ||
| lint Lint terraform code | ||
| ``` | ||
|
|
||
| ## Inputs | ||
|
|
||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|:----:|:-----:|:-----:| | ||
| | acceptor_allow_remote_vpc_dns_resolution | Allow acceptor VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the requestor VPC | string | `true` | no | | ||
| | acceptor_vpc_id | Acceptor VPC ID | string | - | yes | | ||
| | attributes | Additional attributes (e.g. `policy` or `role`) | list | `<list>` | no | | ||
| | auto_accept | Automatically accept the peering (both VPCs need to be in the same AWS account) | string | `true` | no | | ||
| | delimiter | Delimiter to be used between `namespace`, `stage`, `name`, and `attributes` | string | `-` | no | | ||
| | enabled | Set to false to prevent the module from creating or accessing any resources | string | `true` | no | | ||
| | name | Name (e.g. `app` or `cluster`) | string | - | yes | | ||
| | namespace | Namespace (e.g. `cp` or `cloudposse`) | string | - | yes | | ||
| | requestor_allow_remote_vpc_dns_resolution | Allow requestor VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the acceptor VPC | string | `true` | no | | ||
| | requestor_vpc_id | Requestor VPC ID | string | - | yes | | ||
| | stage | Stage (e.g. `prod`, `dev`, `staging`) | string | - | yes | | ||
| | tags | Additional tags (e.g. map('BusinessUnit`,`XYZ`) | map | `<map>` | no | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |:--------------------------------|:--------------------------------------------------| | ||
| | `connection_id` | VPC peering connection ID | | ||
| | `accept_status` | The status of the VPC peering connection request | | ||
| | Name | Description | | ||
| |------|-------------| | ||
| | accept_status | The status of the VPC peering connection request | | ||
| | connection_id | VPC peering connection ID | | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Related Projects | ||
|
|
||
| Check out these related projects. | ||
|
|
||
| - [terraform-aws-vpc](https://github.com/cloudposse/terraform-aws-vpc) - Terraform Module that defines a VPC with public/private subnets across multiple AZs with Internet Gateways | ||
| - [terraform-aws-kops-vpc-peering](https://github.com/cloudposse/terraform-aws-kops-vpc-peering) - Terraform module to create a peering connection between two VPCs | ||
|
|
||
| ## Credits | ||
|
|
||
| Thanks to [Gladly.com](https://www.gladly.com/) for the inspiration with this wonderful module: | ||
|
|
||
| https://github.com/sagansystems/terraform-aws-vpc-kops-peering | ||
|
|
||
| ## References | ||
|
|
||
| For additional context, refer to some of these links. | ||
|
|
||
| - [terraform-aws-vpc-kops-peering](https://github.com/sagansystems/terraform-aws-vpc-kops-peering) - Thanks to [Gladly.com](https://www.gladly.com/) for the inspiration with this wonderful module | ||
|
|
||
|
|
||
| ## Help | ||
|
|
||
| **Got a question?** | ||
|
|
||
| File a GitHub [issue](https://github.com/cloudposse/terraform-aws-vpc-peering/issues), send us an [email](mailto:[email protected]) or reach out to us on [Gitter](https://gitter.im/cloudposse/). | ||
| File a GitHub [issue](https://github.com/cloudposse/terraform-aws-vpc-peering/issues), send us an [email][email] or join our [Slack Community][slack]. | ||
|
|
||
| ## Commercial Support | ||
|
|
||
| Work directly with our team of DevOps experts via email, slack, and video conferencing. | ||
|
|
||
| We provide [*commercial support*][commercial_support] for all of our [Open Source][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer. | ||
|
|
||
| [](mailto:[email protected]) | ||
|
|
||
| - **Questions.** We'll use a Shared Slack channel between your team and ours. | ||
| - **Troubleshooting.** We'll help you triage why things aren't working. | ||
| - **Code Reviews.** We'll review your Pull Requests and provide constructive feedback. | ||
| - **Bug Fixes.** We'll rapidly work to fix any bugs in our projects. | ||
| - **Build New Terraform Modules.** We'll develop original modules to provision infrastructure. | ||
| - **Cloud Architecture.** We'll assist with your cloud strategy and design. | ||
| - **Implementation.** We'll provide hands-on support to implement our reference architectures. | ||
|
|
||
|
|
||
| ## Community Forum | ||
|
|
||
| Get access to our [Open Source Community Forum][slack] on Slack. It's **FREE** to join for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build *sweet* infrastructure. | ||
|
|
||
| ## Contributing | ||
|
|
||
|
|
@@ -76,22 +137,28 @@ Please use the [issue tracker](https://github.com/cloudposse/terraform-aws-vpc-p | |
|
|
||
| ### Developing | ||
|
|
||
| If you are interested in being a contributor and want to get involved in developing `terraform-aws-vpc-peering`, we would love to hear from you! Shoot us an [email](mailto:[email protected]). | ||
| If you are interested in being a contributor and want to get involved in developing this project or [help out](https://github.com/orgs/cloudposse/projects/3) with our other projects, we would love to hear from you! Shoot us an [email](mailto:[email protected]). | ||
|
|
||
| In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow. | ||
|
|
||
| 1. **Fork** the repo on GitHub | ||
| 2. **Clone** the project to your own machine | ||
| 3. **Commit** changes to your own branch | ||
| 4. **Push** your work back up to your fork | ||
| 5. Submit a **Pull request** so that we can review your changes | ||
| 5. Submit a **Pull Request** so that we can review your changes | ||
|
|
||
| **NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request! | ||
|
|
||
|
|
||
| ## Copyright | ||
|
|
||
| **NOTE:** Be sure to merge the latest from "upstream" before making a pull request! | ||
| Copyright © 2017-2018 [Cloud Posse, LLC](https://cloudposse.com) | ||
|
|
||
|
|
||
| ## License | ||
|
|
||
| [APACHE 2.0](LICENSE) © 2018 [Cloud Posse, LLC](https://cloudposse.com) | ||
| ## License | ||
|
|
||
| [](https://opensource.org/licenses/Apache-2.0) | ||
|
|
||
| See [LICENSE](LICENSE) for full details. | ||
|
|
||
|
|
@@ -103,7 +170,7 @@ See [LICENSE](LICENSE) for full details. | |
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| https://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
|
|
@@ -113,31 +180,49 @@ See [LICENSE](LICENSE) for full details. | |
| under the License. | ||
|
|
||
|
|
||
| ## About | ||
|
|
||
| `terraform-aws-vpc-peering` is maintained and funded by [Cloud Posse, LLC][website]. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| Like it? Please let us know at <[email protected]> | ||
|
|
||
| We love [Open Source Software](https://github.com/cloudposse/)! | ||
|
|
||
| See [our other projects][community] | ||
| or [hire us][hire] to help build your next cloud platform. | ||
|
|
||
| ## Trademarks | ||
|
|
||
| All other trademarks referenced herein are the property of their respective owners. | ||
|
|
||
| ## About | ||
|
|
||
| This project is maintained and funded by [Cloud Posse, LLC][website]. Like it? Please let us know at <[email protected]> | ||
|
|
||
| [](https://cloudposse.com) | ||
|
|
||
| We're a [DevOps Professional Services][hire] company based in Los Angeles, CA. We love [Open Source Software](https://github.com/cloudposse/)! | ||
|
|
||
| We offer paid support on all of our projects. | ||
|
|
||
| Check out [our other projects][github], [apply for a job][jobs], or [hire us][hire] to help with your cloud strategy and implementation. | ||
|
|
||
| [docs]: https://docs.cloudposse.com/ | ||
| [website]: https://cloudposse.com/ | ||
| [community]: https://github.com/cloudposse/ | ||
| [github]: https://github.com/cloudposse/ | ||
| [commercial_support]: https://github.com/orgs/cloudposse/projects | ||
| [jobs]: https://cloudposse.com/jobs/ | ||
| [hire]: https://cloudposse.com/contact/ | ||
| [slack]: https://slack.cloudposse.com/ | ||
| [linkedin]: https://www.linkedin.com/company/cloudposse | ||
| [twitter]: https://twitter.com/cloudposse/ | ||
| [email]: mailto:[email protected] | ||
|
|
||
|
|
||
| ### Contributors | ||
|
|
||
| | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Vladimir][SweetOps_avatar]][SweetOps_homepage]<br/>[Vladimir][SweetOps_homepage] | | ||
| |---|---| | ||
|
|
||
| ## Contributors | ||
| [aknysh_homepage]: https://github.com/aknysh | ||
| [aknysh_avatar]: https://github.com/aknysh.png?size=150 | ||
| [SweetOps_homepage]: https://github.com/SweetOps | ||
| [SweetOps_avatar]: https://github.com/SweetOps.png?size=150 | ||
|
|
||
| | [![Erik Osterman][erik_img]][erik_web]<br/>[Erik Osterman][erik_web] | [![Andriy Knysh][andriy_img]][andriy_web]<br/>[Andriy Knysh][andriy_web] | | ||
| |-------------------------------------------------------|------------------------------------------------------------------| | ||
|
|
||
| [erik_img]: http://s.gravatar.com/avatar/88c480d4f73b813904e00a5695a454cb?s=144 | ||
| [erik_web]: https://github.com/osterman/ | ||
| [andriy_img]: https://avatars0.githubusercontent.com/u/7356997?v=4&u=ed9ce1c9151d552d985bdf5546772e14ef7ab617&s=144 | ||
| [andriy_web]: https://github.com/aknysh/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| --- | ||
| # | ||
| # This is the canonical configuration for the `README.md` | ||
| # Run `make readme` to rebuild the `README.md` | ||
| # | ||
|
|
||
| # Name of this project | ||
| name: terraform-aws-vpc-peering | ||
|
|
||
| # Logo for this project | ||
| #logo: docs/logo.png | ||
|
|
||
| # License of this project | ||
| license: "APACHE2" | ||
|
|
||
| # Canonical GitHub repo | ||
| github_repo: cloudposse/terraform-aws-vpc-peering | ||
|
|
||
| # Badges to display | ||
| badges: | ||
| - name: "Build Status" | ||
| image: "https://travis-ci.org/cloudposse/terraform-aws-vpc-peering.svg?branch=master" | ||
| url: "https://travis-ci.org/cloudposse/terraform-aws-vpc-peering" | ||
| - name: "Latest Release" | ||
| image: "https://img.shields.io/github/release/cloudposse/terraform-aws-vpc-peering.svg" | ||
| url: "https://github.com/cloudposse/terraform-aws-vpc-peering/releases/latest" | ||
| - name: "Slack Community" | ||
| image: "https://slack.cloudposse.com/badge.svg" | ||
| url: "https://slack.cloudposse.com" | ||
|
|
||
| related: | ||
| - name: "terraform-aws-vpc" | ||
| description: "Terraform Module that defines a VPC with public/private subnets across multiple AZs with Internet Gateways" | ||
| url: "https://github.com/cloudposse/terraform-aws-vpc" | ||
| - name: "terraform-aws-kops-vpc-peering" | ||
| description: "Terraform module to create a peering connection between two VPCs" | ||
| url: "https://github.com/cloudposse/terraform-aws-kops-vpc-peering" | ||
|
|
||
|
|
||
| # Short description of this project | ||
| description: |- | ||
| Terraform module to create a peering connection between two VPCs | ||
| # How to use this project | ||
| usage: |- | ||
| ```hcl | ||
| module "vpc_peering" { | ||
| source = "git::https://github.com/cloudposse/terraform-aws-vpc-peering.git?ref=master" | ||
| namespace = "cp" | ||
| stage = "dev" | ||
| name = "cluster" | ||
| requestor_vpc_id = "vpc-XXXXXXXX" | ||
| acceptor_vpc_id = "vpc-YYYYYYYY" | ||
| } | ||
| ``` | ||
| references: | ||
| - name: "terraform-aws-vpc-kops-peering" | ||
| description: "Thanks to [Gladly.com](https://www.gladly.com/) for the inspiration with this wonderful module" | ||
| url: "https://github.com/sagansystems/terraform-aws-vpc-kops-peering" | ||
|
|
||
| screenshots: | ||
| - name: "vpc-peering" | ||
| description: "VPC Peering Connection in the AWS Web Console" | ||
| url: "images/vpc-peering.png" | ||
|
|
||
| include: | ||
| - "docs/targets.md" | ||
| - "docs/terraform.md" | ||
|
|
||
| # Contributors to this project | ||
| contributors: | ||
| - name: "Andriy Knysh" | ||
| github: "aknysh" | ||
| - name: "Vladimir" | ||
| github: "SweetOps" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| ## Makefile Targets | ||
| ``` | ||
| Available targets: | ||
| help This help screen | ||
| help/all Display help for all targets | ||
| lint Lint terraform code | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
|
|
||
| ## Inputs | ||
|
|
||
| | Name | Description | Type | Default | Required | | ||
| |------|-------------|:----:|:-----:|:-----:| | ||
| | acceptor_allow_remote_vpc_dns_resolution | Allow acceptor VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the requestor VPC | string | `true` | no | | ||
| | acceptor_vpc_id | Acceptor VPC ID | string | - | yes | | ||
| | attributes | Additional attributes (e.g. `policy` or `role`) | list | `<list>` | no | | ||
| | auto_accept | Automatically accept the peering (both VPCs need to be in the same AWS account) | string | `true` | no | | ||
| | delimiter | Delimiter to be used between `namespace`, `stage`, `name`, and `attributes` | string | `-` | no | | ||
| | enabled | Set to false to prevent the module from creating or accessing any resources | string | `true` | no | | ||
| | name | Name (e.g. `app` or `cluster`) | string | - | yes | | ||
| | namespace | Namespace (e.g. `cp` or `cloudposse`) | string | - | yes | | ||
| | requestor_allow_remote_vpc_dns_resolution | Allow requestor VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the acceptor VPC | string | `true` | no | | ||
| | requestor_vpc_id | Requestor VPC ID | string | - | yes | | ||
| | stage | Stage (e.g. `prod`, `dev`, `staging`) | string | - | yes | | ||
| | tags | Additional tags (e.g. map('BusinessUnit`,`XYZ`) | map | `<map>` | no | | ||
|
|
||
| ## Outputs | ||
|
|
||
| | Name | Description | | ||
| |------|-------------| | ||
| | accept_status | The status of the VPC peering connection request | | ||
| | connection_id | VPC peering connection ID | | ||
|
|
Oops, something went wrong.