From f959a0f4127ed5698aff56d8cd447316de40577d Mon Sep 17 00:00:00 2001 From: A Nomad Date: Mon, 21 Aug 2023 02:01:00 +0200 Subject: [PATCH] copy repo --- .circleci/config.yml | 15 ++++ CHANGELOG.md | 84 ++++++++++++++++++ LICENSE | 202 +++++++++++++++++++++++++++++++++++++++++ README.md | 109 +++++++++++++++++++++++ main.tf | 207 +++++++++++++++++++++++++++++++++++++++++++ outputs.tf | 39 ++++++++ scripts/cibuild | 22 +++++ variables.tf | 73 +++++++++++++++ versions.tf | 6 ++ 9 files changed, 757 insertions(+) create mode 100644 .circleci/config.yml create mode 100644 CHANGELOG.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 main.tf create mode 100644 outputs.tf create mode 100755 scripts/cibuild create mode 100644 variables.tf create mode 100644 versions.tf diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 0000000..416cbf3 --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,15 @@ +version: 2 + +jobs: + build: + docker: + - image: hashicorp/terraform:latest + + steps: + - checkout + - run: + name: Install Bash + command: apk add --no-cache bash + - run: + name: Execute cibuild + command: ./scripts/cibuild diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..9ce43d2 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,84 @@ +## 6.0.1 + +- Fix deprecated use of quoted resource in `depends_on`. + +## 6.0.0 + +- Add support for Terraform 0.12. +- Update the default for `bastion_instance_type` to `t3.nano`. +- Add a `tags` variable. +- Add continuous integration support via CircleCI. + +## 5.0.1 + +- `element()` -> `listvar[idx]` + +## 5.0.0 + +- Remove `external_access_cidr_block` variable. See the README for a guide on + how to configure security groups for the bastion. +- Add `bastion_ebs_optimized` variable. + +## 4.0.0 + +- Make use of standalone `aws_network_interface_sg_attachment` vs. the + `vpc_security_group_ids` attribute of the `aws_instance` resource. +- Add output for `bastion_network_interface_id`, which is the ID of the primary + network interface for the bastion instance. + +## 3.1.1 + +- Make use of standalone `aws_route` vs. the `route` attributes of the + `aws_route_table` resource. + +## 3.1.0 + +- Add output for `nat_gateway_ips`, which are the Elastic IPs bound to NAT + Gateways. + +## 3.0.0 + +- Add support for Terraform 0.7. +- Convert comma-delimited variables with lists types. + +## 2.0.1 + +- 2.0.0 release was botched; includes contents of that release. + +## 2.0.0 + +- Remove security group rules from bastion security group. +- Add module attributes for `project` and `environment`. +- Remove `create_before_destroy` lifecycle resources from subnets. + +## 1.1.0 + +- Associate route tables for private subnets to S3 VPC endpoint. + +## 1.0.0 + +- Use the `aws_security_group_rule` resource to define security group rules + internally. +- Output the `bastion_security_group_id`. + +## 0.4.0 + +- Replace manual NAT setup for VPC with AWS managed NAT Gateways. + +## 0.3.0 + +- Output `nat_security_group_id` so additional rules can be created +- Add `nat_egress_ports` parameter to set up NAT instance egress ports + +## 0.2.0 + +- Add `create_before_destroy` behavior to VPC subnets. + +## 0.1.1 + +- Remove hardcoded security group identifiers and let Terraform assign unique + names. + +## 0.1.0 + +- Initial release. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2b5026a --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + 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 2020 Azavea Inc. + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..9031c2c --- /dev/null +++ b/README.md @@ -0,0 +1,109 @@ +# terraform-aws-vpc + +[![CircleCI](https://circleci.com/gh/azavea/terraform-aws-vpc.svg?style=svg)](https://circleci.com/gh/azavea/terraform-aws-vpc) + +A Terraform module to create an Amazon Web Services (AWS) Virtual Private Cloud (VPC). + +## Usage + +This module creates a VPC alongside a variety of related resources, including: + +- Public and private subnets +- Public and private route tables +- Elastic IPs +- Network Interfaces +- NAT Gateways +- An Internet Gateway +- A VPC Endpoint +- A bastion EC2 instance + +Example usage: + +```hcl +module "vpc" { + source = "github.com/azavea/terraform-aws-vpc" + + name = "Default" + region = "us-east-1" + key_name = "hector" + cidr_block = "10.0.0.0/16" + private_subnet_cidr_blocks = ["10.0.1.0/24", "10.0.3.0/24"] + public_subnet_cidr_blocks = ["10.0.0.0/24", "10.0.2.0/24"] + availability_zones = ["us-east-1a", "us-east-1b"] + bastion_ami = "ami-6869aa05" + bastion_ebs_optimized = true + bastion_instance_type = "t3.micro" + + project = "Something" + environment = "Staging" +} +``` + +### Configuring security rules + +By default, this module adds no security rules to the bastion instance, meaning +that all traffic will be blocked. + +In order to configure security rules for the bastion, use the +`bastion_security_group_id` output. For example: + +```hcl +resource "aws_security_group_rule" "ssh_ingress" { + security_group_id = module.vpc.bastion_security_group_id + type = "ingress" + from_port = 22 + to_port = 22 + protocol = "tcp" + cidr_blocks = [var.bastion_inbound_cidr_block] +} +``` + +There is a limit to the number of rules you can add to a security group. If you +have exceeded this limit, you can add additional security groups to the bastion +using the `bastion_network_interface_id` output and an +`aws_network_interface_sg_attachment` resource. For example: + +```hcl +resource "aws_security_group" "ssh_ingress" { + vpc_id = module.vpc.id + + ingress { + from_port = 22 + to_port = 22 + protocol = "tcp" + cidr_blocks = [var.bastion_inbound_cidr_block] + } +} + +resource "aws_network_interface_sg_attachment" "sg_attachment" { + security_group_id = aws_security_group.ssh_ingress.id + network_interface_id = module.vpc.bastion_network_interface_id +} +``` + +## Variables + +- `name` - Name of the VPC (default: `Default`) +- `project` - Name of project this VPC is meant to house (default: `Unknown`) +- `environment` - Name of environment this VPC is targeting (default: `Unknown`) +- `region` - Region of the VPC (default: `us-east-1`) +- `key_name` - EC2 Key pair name for the bastion +- `cidr_block` - CIDR block for the VPC (default: `10.0.0.0/16`) +- `public_subnet_cidr_blocks` - List of public subnet CIDR blocks (default: `["10.0.0.0/24","10.0.2.0/24"]`) +- `private_subnet_cidr_blocks` - List of private subnet CIDR blocks (default: `["10.0.1.0/24", "10.0.3.0/24"]`) +- `availability_zones` - List of availability zones (default: `["us-east-1a", "us-east-1b"]`) +- `bastion_ami` - Bastion Amazon Machine Image (AMI) ID +- `bastion_ebs_optimized` - If true, the bastion instance will be EBS-optimized (default: `false`) +- `bastion_instance_type` - Instance type for bastion instance (default: `t3.nano`) +- `tags` - Extra tags to attach to the VPC resources (default: `{}`) + +## Outputs + +- `id` - VPC ID +- `public_subnet_ids` - List of public subnet IDs +- `private_subnets_ids` - List of private subnet IDs +- `bastion_hostname` - Public DNS name for bastion instance +- `bastion_security_group_id` - Security group ID tied to bastion instance +- `bastion_network_interface_id` - Elastic Network Interface (ENI) ID of the Bastion instance's primary network interface +- `cidr_block` - The CIDR block associated with the VPC +- `nat_gateway_ips` - List of Elastic IPs associated with NAT gateways diff --git a/main.tf b/main.tf new file mode 100644 index 0000000..77865d7 --- /dev/null +++ b/main.tf @@ -0,0 +1,207 @@ +# +# VPC resources +# +resource "aws_vpc" "default" { + cidr_block = var.cidr_block + enable_dns_support = true + enable_dns_hostnames = true + + tags = merge( + { + Name = var.name, + Project = var.project, + Environment = var.environment + }, + var.tags + ) +} + +resource "aws_internet_gateway" "default" { + vpc_id = aws_vpc.default.id + + tags = merge( + { + Name = "gwInternet", + Project = var.project, + Environment = var.environment + }, + var.tags + ) +} + +resource "aws_route_table" "private" { + count = length(var.private_subnet_cidr_blocks) + + vpc_id = aws_vpc.default.id + + tags = merge( + { + Name = "PrivateRouteTable", + Project = var.project, + Environment = var.environment + }, + var.tags + ) +} + +resource "aws_route" "private" { + count = length(var.private_subnet_cidr_blocks) + + route_table_id = aws_route_table.private[count.index].id + destination_cidr_block = "0.0.0.0/0" + nat_gateway_id = aws_nat_gateway.default[count.index].id +} + +resource "aws_route_table" "public" { + vpc_id = aws_vpc.default.id + + tags = merge( + { + Name = "PublicRouteTable", + Project = var.project, + Environment = var.environment + }, + var.tags + ) +} + +resource "aws_route" "public" { + route_table_id = aws_route_table.public.id + destination_cidr_block = "0.0.0.0/0" + gateway_id = aws_internet_gateway.default.id +} + +resource "aws_subnet" "private" { + count = length(var.private_subnet_cidr_blocks) + + vpc_id = aws_vpc.default.id + cidr_block = var.private_subnet_cidr_blocks[count.index] + availability_zone = var.availability_zones[count.index] + + tags = merge( + { + Name = "PrivateSubnet", + Project = var.project, + Environment = var.environment + }, + var.tags + ) +} + +resource "aws_subnet" "public" { + count = length(var.public_subnet_cidr_blocks) + + vpc_id = aws_vpc.default.id + cidr_block = var.public_subnet_cidr_blocks[count.index] + availability_zone = var.availability_zones[count.index] + map_public_ip_on_launch = true + + tags = merge( + { + Name = "PublicSubnet", + Project = var.project, + Environment = var.environment + }, + var.tags + ) +} + +resource "aws_route_table_association" "private" { + count = length(var.private_subnet_cidr_blocks) + + subnet_id = aws_subnet.private[count.index].id + route_table_id = aws_route_table.private[count.index].id +} + +resource "aws_route_table_association" "public" { + count = length(var.public_subnet_cidr_blocks) + + subnet_id = aws_subnet.public[count.index].id + route_table_id = aws_route_table.public.id +} + +resource "aws_vpc_endpoint" "s3" { + vpc_id = aws_vpc.default.id + service_name = "com.amazonaws.${var.region}.s3" + route_table_ids = flatten([ + aws_route_table.public.id, + aws_route_table.private.*.id + ]) + + tags = merge( + { + Name = "endpointS3", + Project = var.project, + Environment = var.environment + }, + var.tags + ) +} + +# +# NAT resources +# +resource "aws_eip" "nat" { + count = length(var.public_subnet_cidr_blocks) + + vpc = true +} + +resource "aws_nat_gateway" "default" { + depends_on = [aws_internet_gateway.default] + + count = length(var.public_subnet_cidr_blocks) + + allocation_id = aws_eip.nat[count.index].id + subnet_id = aws_subnet.public[count.index].id + + tags = merge( + { + Name = "gwNAT", + Project = var.project, + Environment = var.environment + }, + var.tags + ) +} + +# +# Bastion resources +# +resource "aws_security_group" "bastion" { + vpc_id = aws_vpc.default.id + + tags = merge( + { + Name = "sgBastion", + Project = var.project, + Environment = var.environment + }, + var.tags + ) +} + +resource "aws_network_interface_sg_attachment" "bastion" { + security_group_id = aws_security_group.bastion.id + network_interface_id = aws_instance.bastion.primary_network_interface_id +} + +resource "aws_instance" "bastion" { + ami = var.bastion_ami + availability_zone = var.availability_zones[0] + ebs_optimized = var.bastion_ebs_optimized + instance_type = var.bastion_instance_type + key_name = var.key_name + monitoring = true + subnet_id = aws_subnet.public[0].id + associate_public_ip_address = true + + tags = merge( + { + Name = "Bastion", + Project = var.project, + Environment = var.environment + }, + var.tags + ) +} diff --git a/outputs.tf b/outputs.tf new file mode 100644 index 0000000..e306a46 --- /dev/null +++ b/outputs.tf @@ -0,0 +1,39 @@ +output "id" { + value = aws_vpc.default.id + description = "VPC ID" +} + +output "public_subnet_ids" { + value = aws_subnet.public.*.id + description = "List of public subnet IDs" +} + +output "private_subnet_ids" { + value = aws_subnet.private.*.id + description = "List of private subnet IDs" +} + +output "bastion_hostname" { + value = aws_instance.bastion.public_dns + description = "Public DNS name for bastion instance" +} + +output "bastion_security_group_id" { + value = aws_security_group.bastion.id + description = "Security group ID tied to bastion instance" +} + +output "bastion_network_interface_id" { + value = aws_instance.bastion.primary_network_interface_id + description = "Elastic Network Interface (ENI) ID of the Bastion instance's primary network interface" +} + +output "cidr_block" { + value = var.cidr_block + description = "The CIDR block associated with the VPC" +} + +output "nat_gateway_ips" { + value = aws_eip.nat.*.public_ip + description = "List of Elastic IPs associated with NAT gateways" +} diff --git a/scripts/cibuild b/scripts/cibuild new file mode 100755 index 0000000..b86deca --- /dev/null +++ b/scripts/cibuild @@ -0,0 +1,22 @@ +#!/bin/bash + +set -e + +if [[ -n "${CI_DEBUG}" ]]; then + set -x +fi + +function usage() { + echo -n \ + "Usage: $(basename "$0") +Ensure the Terraform source code is properly formatted. +" +} + +if [ "${BASH_SOURCE[0]}" = "${0}" ]; then + if [ "${1:-}" = "--help" ]; then + usage + else + terraform fmt -check + fi +fi diff --git a/variables.tf b/variables.tf new file mode 100644 index 0000000..e61dd25 --- /dev/null +++ b/variables.tf @@ -0,0 +1,73 @@ +variable "name" { + default = "Default" + type = string + description = "Name of the VPC" +} + +variable "project" { + type = string + description = "Name of project this VPC is meant to house" +} + +variable "environment" { + type = string + description = "Name of environment this VPC is targeting" +} + +variable "region" { + default = "us-east-1" + type = string + description = "Region of the VPC" +} + +variable "key_name" { + type = string + description = "EC2 Key pair name for the bastion" +} + +variable "cidr_block" { + default = "10.0.0.0/16" + type = string + description = "CIDR block for the VPC" +} + +variable "public_subnet_cidr_blocks" { + default = ["10.0.0.0/24", "10.0.2.0/24"] + type = list + description = "List of public subnet CIDR blocks" +} + +variable "private_subnet_cidr_blocks" { + default = ["10.0.1.0/24", "10.0.3.0/24"] + type = list + description = "List of private subnet CIDR blocks" +} + +variable "availability_zones" { + default = ["us-east-1a", "us-east-1b"] + type = list + description = "List of availability zones" +} + +variable "bastion_ami" { + type = string + description = "Bastion Amazon Machine Image (AMI) ID" +} + +variable "bastion_ebs_optimized" { + default = false + type = bool + description = "If true, the bastion instance will be EBS-optimized" +} + +variable "bastion_instance_type" { + default = "t3.nano" + type = string + description = "Instance type for bastion instance" +} + +variable "tags" { + default = {} + type = map(string) + description = "Extra tags to attach to the VPC resources" +} diff --git a/versions.tf b/versions.tf new file mode 100644 index 0000000..4921750 --- /dev/null +++ b/versions.tf @@ -0,0 +1,6 @@ +terraform { + required_version = ">= 0.12" + required_providers { + aws = ">= 2.33.0" + } +}