From 0f959cc98b39262a333356c7401cc4e28d25531c Mon Sep 17 00:00:00 2001 From: Robby Ho Date: Tue, 27 Oct 2015 21:43:21 -0700 Subject: [PATCH] 0.2.0 - [GH-1] aws flow log creation [GH-3] NATs are still allocated when 0 private subnets are selected Added support for optional CloudWatch auto recovery alarms on NAT instances Update examples Renamed Readme.md to README.md Updated terraform version for build Update licenses --- CHANGELOG.md | 7 + LICENSE | 573 ++++++++++++++++++++----------- README.md | 177 ++++++++++ Readme.md | 4 +- az/main.tf | 28 +- az/variables.tf | 14 + base/main.tf | 55 +++ base/outputs.tf | 4 + circle.yml | 2 +- examples/basic/main.tf | 1 + examples/basic/variables.tf | 3 + examples/full_stack/main.tf | 1 + examples/full_stack/variables.tf | 3 + 13 files changed, 667 insertions(+), 205 deletions(-) create mode 100644 README.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e7adc9..18b82fc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,2 +1,9 @@ +## 0.2.0 (Oct 27, 2015) + Fixes/Features + Issue [GH-1] - VPC:Base - Add aws flow log creation. (enhancement) + Issue [GH-3] - NATs are still allocated when 0 private subnets are selected (bug) + Renamed Readme.md to README.md + Updated license + Added support for optional auto recovery CloudWatch alarms for NAT instances ## 0.1.0 (Oct 21, 2015) * Initial Release diff --git a/LICENSE b/LICENSE index 8f71f43..14e2f77 100644 --- a/LICENSE +++ b/LICENSE @@ -1,202 +1,373 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright {yyyy} {name of copyright owner} - - Licensed under the Apache License, Version 2.0 (the "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 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. +Mozilla Public License Version 2.0 +================================== +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 index 0000000..33af1d2 --- /dev/null +++ b/README.md @@ -0,0 +1,177 @@ +# Terraform AWS VPC Stack # +[![Circle CI](https://circleci.com/gh/unifio/terraform-aws-vpc/tree/master.svg?style=svg)](https://circleci.com/gh/unifio/terraform-aws-vpc/tree/master) + +Module stack that supports full AWS VPC deployment. Users can provision a VPC with optional support for +DHCP Options Sets, Virtual Private Gateway creation, and provision one or more availability zones (AZs) each coming with its own NAT setup, external facing (DMZ) and private (LAN) subnets. AWS flow logs are setup VPC wide, and there is optional support for auto recovery on the AZ NAT instances using CloudWatch alarms. + +## Base Module ## + +The Base module provisions the VPC, attaches an Internet Gateway, and creates NAT Security Group and DMZ Routing table + +### Input Variables ### + +- `stack_item_label` - Short form identifier for this stack. This value is used to create the "Name" resource tag for resources created by this stack item, and also serves as a unique key for re-use. +- `stack_item_fullname` - Long form descriptive name for this stack item. This value is used to create the "application" resource tag for resources created by this stack item. +- `vpc_cidr` - CIDR block for the VPC. +- `enable_dns` - (Optional) A boolean flag to enable/disable DNS support in the VPC. Defaults true. +- `enable_hostnames` - (Optional) A boolean flag to enable/disable DNS hostnames in the VPC. Defaults false. +- `lan_cidr` - Comma separated list of CIDR blocks to be given ingress access to NAT boxes in each subnet. + +### Usage ### + +```js +module "vpc_base" { + source = "github.com/unifio/terraform-aws-vpc//base" + + stack_item_label = "mystack1" + stack_item_fullname = "Stack Item Description" + vpc_cidr = "10.10.0.0/22" + enable_dns = true + enable_hostnames = false + lan_cidr = "10.10.2.0/25,10.10.2.128/25,10.10.3.0/25" +} +``` +### Outputs ### + +- `vpc_id` - ID of the VPC +- `igw_id` - ID of the Internet gateway +- `rt_dmz_id` - ID of the DMZ routing table +- `nat_sg_id` - ID of NAT security group + +## DHCP module ## + +The DHCP module provisions a DHCP options resource and associates it with the specified VPC resource. + +### Input Variables ### + +- `vpc_id` - ID of the VPC to associate the DHCP Options Set with. +- `stack_item_label` - Short form identifier for this stack. This value is used to create the "Name" resource tag for resources created by this stack item, and also serves as a unique key for re-use. +- `stack_item_fullname` - Long form descriptive name for this stack item. This value is used to create the "application" resource tag for resources created by this stack item. +- `domain_name` - (Optional) the suffix domain name to use by default when resolving non Fully Qualified Domain Names. In other words, this is what ends up being the search value in the /etc/resolv.conf file. +- `name_servers` - (Optional) List of name servers to configure in /etc/resolv.conf. +- `ntp_servers` - (Optional) List of NTP servers to configure. +- `netbios_name_servers` - (Optional) List of NETBIOS name servers. +- `netbios_node_type` - (Optional) The NetBIOS node type (1, 2, 4, or 8). AWS recommends to specify 2 since broadcast and multicast are not supported in their network. For more information about these node types, see RFC 2132. Defaults to 2. + +### Usage ### + +The usage examples may assume that previous modules in this stack have already been declared, such as the base module, instantiated as "vpc_base". This declaration is not necessary, but does promote a consistent and maintainable standard. + +```js + +module "dhcp" { + source = "github.com/terraform-aws-vpc//dhcp" + + vpc_id = "${module.vpc_base.vpc_id}" + stack_item_label = "mystack1" + stack_item_fullname = "myname" + domain_name = "mydomain.com" + name_servers = "10.128.8.10" + ntp_servers = "10.128.8.10" + netbios_name_servers = "10.128.8.10" + netbios_node_type = 2 +} +``` +### Outputs ### + +- `dhcp_id` - ID of the DHCP Options set + +## VPG Module ## + +Creates a VPC VPN Gateway + +### Input Variables + +- `vpc_id` - The VPC to associate the VPG with. +- `stack_item_label` - Short form identifier for this stack. This value is used to create the "Name" resource tag for resources created by this stack item, and also serves as a unique key for re-use. +- `stack_item_fullname` - Long form descriptive name for this stack item. This value is used to create the "application" resource tag for resources created by this stack item. + +### Usage + +The usage examples may assume that previous modules in this stack have already been declared, such as the base module, instantiated as "vpc_base". This declaration is not necessary, but does promote a consistent and maintainable standard. + +```js + +module "vpg" { + source = "github.com/terraform-aws-vpc//vpg" + + vpc_id = "${module.vpc_base.vpc_id}" + stack_item_fullname = "Stack Item Description" + stack_item_label = "mystack1" +} +``` + +### Outputs ### + +- `vpg_id` - ID of the newly created Virtual Private Gateway + +## AZ Module ## + +In each Availability Zone provided, this module provisions a NAT instance, and creates subnets and routing tables for a public (DMZ) and private (LAN) sub networks. The remote access information for the NAT instance is output to user data. + +### Input Variables ### + +- `stack_item_label` - Short form identifier for this stack. This value is used to create the "Name" resource tag for resources created by this stack item, and also serves as a unique key for re-use. +- `stack_item_fullname` - Long form descriptive name for this stack item. This value is used to create the "application" resource tag for resources created by this stack item. +- `vpc_id` - ID of the VPC to use. +- `region` - AWS region to deploy in. +- `az` - Comma separated list of Availability Zones (AZs) in which to create the previously described infrastructure. +- `dmz_cidr` -Comma separated list of CIDR blocks to be used for DMZ subnet. This list should correspond 1:1 to each AZ. +- `lan_cidr` - Comma separated list of CIDR blocks to be used for LAN subnet. This list should correspond 1:1 to each AZ. +- `lans_per_az` - The number of private subnets to be provisioned per AZ. You will need to double the CIDR blocks specified in the `lan_cidr` variable for each increase in this value. +- `enable_dmz_public_ips` - Specify true to indicate that instances launched into the subnet should be assigned a public IP address. Defaults to true. +- `rt_dmz_id` - ID of the DMZ route table for this VPC. +- `ami` - AWS AMI to use when creating NAT instance in each AZ. +- `instance_type` - EC2 instance type to be used. +- `key_name` - The key name to use for the NAT instances. +- `nat_sg_id` - ID of the NAT security group. +- `user_data_template` - Template to be used to generate user data. Default is "templates/user_data.tpl". This template will be passed the following variables: + * hostname - Name of NAT instance for the current AZ. + * fqdn - Fully Qualified Domain Name for the NAT instance + * ssh_user - SSH username to be given NAT access via SSH +- `domain` - Domain name +- `ssh_user` - Username to use when enabling SSH access to NAT instance. Default is ec2-user. +- `nat_auto_recovery` - Set to 0 or 1. 0 disables and 1 enables. If enabled, CloudWatch alarms will be created that will automatically recover the NAT instances, preserving its instance id, ip, etc. in the case of system failure. Default is 1 (enabled). Please check that the AMI used for the NAT supports recovery of its instances. +- `period` - The period in seconds over which a system failure in the NAT instance occurs. Not used if enable_nat_auto_recovery is 0. +- `evaluation_periods` - The number of consecutive periods in which the system failure must occur for the alarm to fire. Not used if enable_nat_auto_recovery is 0. + + +### Usage ### + +The usage examples may assume that previous modules in this stack have already been declared, such as the base module, instantiated as "vpc_base". This declaration is not necessary, but does promote a consistent and maintainable standard. + +```js +module "AZs" { + source = "github.com/unifio/terraform-aws-vpc//az" + + stack_item_label = "mystack1" + stack_item_fullname = "Stack Item Description" + vpc_id = "${module.vpc_base.vpc_id}" + region = "us-west-2" + az = "a,b" + dmz_cidr = "10.10.0.0/25,10.10.0.128/25,10.10.1.0/25" + lan_cidr = "10.10.2.0/25,10.10.2.128/25,10.10.3.0/25" + lans_per_az = "1" + enable_dmz_public_ips = "true" + rt_dmz_id = "${module.vpc_base.rt_dmz_id}" + ami = "ami-xxxxxxxx" + instance_type = "t2.micro" + key_name = "ops" + nat_sg_id = "${module.vpc_base.nat_sg_id}" + user_data_template = "templates/user_data.tpl" + domain - "mydomain.com" + ssh_user = "ec2-user" +} +``` +### Outputs ### + +- `lan_id` - List of subnet IDs of the LAN subnetworks. The order and association of the IDs match the order of the availability zones passed to the module. +- `dmz_id` - List of subnet IDs of the DMZ subnetworks. The order and association of the IDs match the order of the availability zones passed to the module. + +## Examples ## + +See the [examples](examples) directory for a complete set of example source files. + +## License ## + +MPL 2.0. See LICENSE for full details. diff --git a/Readme.md b/Readme.md index 591765f..b832935 100644 --- a/Readme.md +++ b/Readme.md @@ -6,7 +6,7 @@ DHCP Options Sets, Virtual Private Gateway creation, and provision one or more a ## Base Module ## -The Base module provisions the VPC, attaches an Internet Gateway, and creates NAT Security Group and DMZ Routing table +The Base module provisions the VPC, attaches an Internet Gateway, and creates NAT Security Group, DMZ Routing table, and creates a CloudWatch group, IAM role, and AWS flow log. The flow log is configured to capture all traffic (ALLOW and DENY) over the entire VPC. ### Input Variables ### @@ -17,6 +17,7 @@ The Base module provisions the VPC, attaches an Internet Gateway, and creates NA - `enable_hostnames` - (Optional) A boolean flag to enable/disable DNS hostnames in the VPC. Defaults false. - `lan_cidr` - Comma separated list of CIDR blocks to be given ingress access to NAT boxes in each subnet. + ### Usage ### ```js @@ -37,6 +38,7 @@ module "vpc_base" { - `igw_id` - ID of the Internet gateway - `rt_dmz_id` - ID of the DMZ routing table - `nat_sg_id` - ID of NAT security group +- `flow_log_id` - ID of the AWS flow log ## DHCP module ## diff --git a/az/main.tf b/az/main.tf index a73eb99..dfd1a5f 100644 --- a/az/main.tf +++ b/az/main.tf @@ -36,9 +36,9 @@ resource "template_file" "user_data" { ### Provisions NAT instance resource "aws_instance" "nat" { - count = "${length(split(",",var.az))}" - ami = "${var.ami}" + count = "${length(split(",",var.az)) * element(split(",",var.lans_per_az_is_zero),var.lans_per_az)}" instance_type = "${var.instance_type}" + ami = "${var.ami}" key_name = "${var.key_name}" vpc_security_group_ids = ["${var.nat_sg_id}"] subnet_id = "${element(aws_subnet.dmz.*.id,count.index)}" @@ -51,6 +51,30 @@ resource "aws_instance" "nat" { user_data = "${element(template_file.user_data.*.rendered, count.index)}" } +## Add CloudWatch alarm to recover instance in the case of a fault +resource "aws_cloudwatch_metric_alarm" "recover_alarm" { + ## The use of the lans_per_az_is_zero list is to map any nonzero variable onto a value of 1 + ## and a value of zero variable onto 0. This is not a foolproof way to do this, since + ## technically you need an index for every conceivable value, so instead we count on the following: + ## 1) We have 20 indices, which allows the user up to 20 lans_per_az, which should be plenty + ## 2) If the user accidentally puts some random value in for lans_per_az or nat_auto_recovery the modulo + ## ensures that in the worst case don't get a giant multiplier + count = "${length(split(",",var.az)) * element(split(",",var.lans_per_az_is_zero),var.lans_per_az) * element(split(",",var.lans_per_az_is_zero),var.nat_auto_recovery)}" + alarm_name = "${var.stack_item_label}-nat-${count.index}-alarm" + dimensions = { + InstanceId = "${element(aws_instance.nat.*.id, count.index)}" + } + metric_name = "StatusCheckFailed" + namespace = "AWS/EC2" + statistic = "Average" + comparison_operator = "GreaterThanThreshold" + threshold = "0" + period = "${var.period}" + evaluation_periods = "${var.evaluation_periods}" + alarm_description = "Recover instance upon series of StatusCheckFailed events" + alarm_actions = [ "arn:aws:automate:${var.region}:ec2:recover" ] +} + ## Provisions LAN resources ### Provisions subnet diff --git a/az/variables.tf b/az/variables.tf index 3d4f47d..1b5d61f 100644 --- a/az/variables.tf +++ b/az/variables.tf @@ -13,6 +13,15 @@ variable "lan_cidr" {} variable "enable_dmz_public_ips" { default = true } +variable "nat_auto_recovery" { + default = "1" +} +variable "period" { + default = 60 +} +variable "evaluation_periods" { + default = 2 +} variable "lans_per_az" { default = "1" } @@ -32,3 +41,8 @@ variable "domain" {} variable "ssh_user" { default = "ec2-user" } + +## private/hidden variables +variable "lans_per_az_is_zero" { + default = "0,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1" +} diff --git a/base/main.tf b/base/main.tf index 2d33f4f..0209498 100644 --- a/base/main.tf +++ b/base/main.tf @@ -59,3 +59,58 @@ resource "aws_security_group" "nat_sg" { cidr_blocks = ["0.0.0.0/0"] } } + +# Provision aws_flow_log with reasonable initial settings + +resource "aws_cloudwatch_log_group" "flow_log_group" { + name = "${var.stack_item_label}FlowLogGroup" +} + +resource "aws_iam_role" "flow_log_role" { + name = "${var.stack_item_label}FlowLogRole" + assume_role_policy = <