Terraform module for named subnets
provisioning.
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!
IMPORTANT: The master
branch is used in source
just as an example. In your code, do not pin to master
because there may be breaking changes between releases.
Instead pin to the release tag (e.g. ?ref=tags/x.y.z
) of one of our latest releases.
Simple example, with private and public subnets in one Availability Zone:
module "vpc" {
source = "git::https://github.com/cloudposse/terraform-aws-vpc.git?ref=master"
namespace = "eg"
name = "vpc"
stage = "dev"
cidr_block = var.cidr_block
}
locals {
public_cidr_block = cidrsubnet(module.vpc.vpc_cidr_block, 1, 0)
private_cidr_block = cidrsubnet(module.vpc.vpc_cidr_block, 1, 1)
}
module "public_subnets" {
source = "git::https://github.com/cloudposse/terraform-aws-named-subnets.git?ref=master"
namespace = "eg"
stage = "dev"
name = "app"
subnet_names = ["web1", "web2", "web3"]
vpc_id = module.vpc.vpc_id
cidr_block = local.public_cidr_block
type = "public"
igw_id = module.vpc.igw_id
availability_zone = "us-east-1a"
}
module "private_subnets" {
source = "git::https://github.com/cloudposse/terraform-aws-named-subnets.git?ref=master"
namespace = "eg"
stage = "dev"
name = "database"
subnet_names = ["kafka", "cassandra", "zookeeper"]
vpc_id = module.vpc.vpc_id
cidr_block = local.private_cidr_block
type = "private"
availability_zone = "us-east-1a"
ngw_id = module.public_subnets.ngw_id
}
Simple example, with ENI
as default route gateway for private subnets
resource "aws_network_interface" "default" {
subnet_id = module.us_east_1b_public_subnets.subnet_ids[0]
source_dest_check = false
tags = module.network_interface_label.id
}
module "us_east_1b_private_subnets" {
source = "git::https://github.com/cloudposse/terraform-aws-named-subnets.git?ref=master"
namespace = "eg"
stage = "dev"
name = "app"
subnet_names = ["charlie", "echo", "bravo"]
vpc_id = module.vpc.vpc_id
cidr_block = local.us_east_1b_private_cidr_block
type = "private"
availability_zone = "us-east-1b"
eni_id = aws_network_interface.default.id
attributes = ["us-east-1b"]
}
Full example, with private and public subnets in two Availability Zones for High Availability:
module "vpc" {
source = "git::https://github.com/cloudposse/terraform-aws-vpc.git?ref=master"
namespace = "eg"
name = "vpc"
stage = "dev"
cidr_block = var.cidr_block
}
locals {
us_east_1a_public_cidr_block = cidrsubnet(module.vpc.vpc_cidr_block, 2, 0)
us_east_1a_private_cidr_block = cidrsubnet(module.vpc.vpc_cidr_block, 2, 1)
us_east_1b_public_cidr_block = cidrsubnet(module.vpc.vpc_cidr_block, 2, 2)
us_east_1b_private_cidr_block = cidrsubnet(module.vpc.vpc_cidr_block, 2, 3)
}
module "us_east_1a_public_subnets" {
source = "git::https://github.com/cloudposse/terraform-aws-named-subnets.git?ref=master"
namespace = "eg"
stage = "dev"
name = "app"
subnet_names = ["apples", "oranges", "grapes"]
vpc_id = module.vpc.vpc_id
cidr_block = local.us_east_1a_public_cidr_block
type = "public"
igw_id = module.vpc.igw_id
availability_zone = "us-east-1a"
attributes = ["us-east-1a"]
}
module "us_east_1a_private_subnets" {
source = "git::https://github.com/cloudposse/terraform-aws-named-subnets.git?ref=master"
namespace = "eg"
stage = "dev"
name = "app"
subnet_names = ["charlie", "echo", "bravo"]
vpc_id = module.vpc.vpc_id
cidr_block = local.us_east_1a_private_cidr_block
type = "private"
availability_zone = "us-east-1a"
ngw_id = module.us_east_1a_public_subnets.ngw_id
attributes = ["us-east-1a"]
}
module "us_east_1b_public_subnets" {
source = "git::https://github.com/cloudposse/terraform-aws-named-subnets.git?ref=master"
namespace = "eg"
stage = "dev"
name = "app"
subnet_names = ["apples", "oranges", "grapes"]
vpc_id = module.vpc.vpc_id
cidr_block = local.us_east_1b_public_cidr_block
type = "public"
igw_id = module.vpc.igw_id
availability_zone = "us-east-1b"
attributes = ["us-east-1b"]
}
module "us_east_1b_private_subnets" {
source = "git::https://github.com/cloudposse/terraform-aws-named-subnets.git?ref=master"
namespace = "eg"
stage = "dev"
name = "app"
subnet_names = ["charlie", "echo", "bravo"]
vpc_id = module.vpc.vpc_id
cidr_block = local.us_east_1b_private_cidr_block
type = "private"
availability_zone = "us-east-1b"
ngw_id = module.us_east_1b_public_subnets.ngw_id
attributes = ["us-east-1b"]
}
resource "aws_network_interface" "default" {
subnet_id = module.us_east_1b_public_subnets.subnet_ids[0]
source_dest_check = false
tags = module.network_interface_label.id
}
module "us_east_1b_private_subnets" {
source = "git::https://github.com/cloudposse/terraform-aws-named-subnets.git?ref=master"
namespace = "eg"
stage = "dev"
name = "app"
subnet_names = ["charlie", "echo", "bravo"]
vpc_id = module.vpc.vpc_id
cidr_block = local.us_east_1b_private_cidr_block
type = "private"
availability_zone = "us-east-1b"
eni_id = aws_network_interface.default.id
attributes = ["us-east-1b"]
}
You must use only one type of device for a default route gateway per route table. ENI
or NGW
Given the following configuration (see the Simple example above)
locals {
public_cidr_block = cidrsubnet(var.vpc_cidr, 1, 0)
private_cidr_block = cidrsubnet(var.vpc_cidr, 1, 1)
}
module "public_subnets" {
source = "git::https://github.com/cloudposse/terraform-aws-named-subnets.git?ref=master"
namespace = "eg"
stage = "dev"
name = "app"
subnet_names = ["web1", "web2", "web3"]
vpc_id = var.vpc_id
cidr_block = local.public_cidr_block
type = "public"
availability_zone = "us-east-1a"
igw_id = var.igw_id
}
module "private_subnets" {
source = "git::https://github.com/cloudposse/terraform-aws-named-subnets.git?ref=master"
namespace = "eg"
stage = "dev"
name = "database"
subnet_names = ["kafka", "cassandra", "zookeeper"]
vpc_id = var.vpc_id
cidr_block = local.private_cidr_block
type = "private"
availability_zone = "us-east-1a"
ngw_id = module.public_subnets.ngw_id
}
output "private_named_subnet_ids" {
value = module.private_subnets.named_subnet_ids
}
output "public_named_subnet_ids" {
value = module.public_subnets.named_subnet_ids
}
the output Maps of subnet names to subnet IDs look like these
public_named_subnet_ids = {
web1 = subnet-ea58d78e
web2 = subnet-556ee131
web3 = subnet-6f54db0b
}
private_named_subnet_ids = {
cassandra = subnet-376de253
kafka = subnet-9e53dcfa
zookeeper = subnet-a86fe0cc
}
and the created subnet IDs could be found by the subnet names using map["key"]
or lookup(map, key, [default])
,
for example:
public_named_subnet_ids["web1"]
lookup(private_named_subnet_ids, "kafka")
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
Name | Description | Type | Default | Required |
---|---|---|---|---|
attributes | Additional attributes (e.g. policy or role ) |
list(string) | <list> |
no |
availability_zone | Availability Zone | string | - | yes |
cidr_block | Base CIDR block which will be divided into subnet CIDR blocks (e.g. 10.0.0.0/16 ) |
string | - | yes |
delimiter | Delimiter to be used between name , namespace , stage , attributes |
string | - |
no |
enabled | Set to false to prevent the module from creating any resources | bool | true |
no |
eni_id | An ID of a network interface which is used as a default route in private route tables (e.g. eni-9c26a123 ) |
string | `` | no |
igw_id | Internet Gateway ID which will be used as a default route in public route tables (e.g. igw-9c26a123 ). Conflicts with ngw_id |
string | `` | no |
max_subnets | Maximum number of subnets which can be created. This variable is being used for CIDR blocks calculation. Defaults to length of subnet_names argument |
number | 16 |
no |
name | Application or solution name | string | - | yes |
namespace | Namespace (e.g. eg or cp ) |
string | `` | no |
nat_enabled | Enable/disable NAT Gateway | bool | true |
no |
ngw_id | NAT Gateway ID which will be used as a default route in private route tables (e.g. igw-9c26a123 ). Conflicts with igw_id |
string | `` | no |
private_network_acl_egress | Private network egress ACL rules | object | <list> |
no |
private_network_acl_id | Network ACL ID that will be added to the subnets. If empty, a new ACL will be created | string | `` | no |
private_network_acl_ingress | Private network ingress ACL rules | object | <list> |
no |
public_network_acl_egress | Public network egress ACL rules | object | <list> |
no |
public_network_acl_id | Network ACL ID that will be added to the subnets. If empty, a new ACL will be created | string | `` | no |
public_network_acl_ingress | Public network ingress ACL rules | object | <list> |
no |
stage | Stage (e.g. prod , dev , staging ) |
string | `` | no |
subnet_names | List of subnet names (e.g. ['apples', 'oranges', 'grapes'] ) |
list(string) | - | yes |
tags | Additional tags (e.g. map(BusinessUnit ,XYZ ) |
map(string) | <map> |
no |
type | Type of subnets (private or public ) |
string | private |
no |
vpc_id | VPC ID | string | - | yes |
Name | Description |
---|---|
named_subnet_ids | Map of subnet names to subnet IDs |
ngw_id | NAT Gateway ID |
ngw_private_ip | Private IP address of the NAT Gateway |
ngw_public_ip | Public IP address of the NAT Gateway |
route_table_ids | Route table IDs |
subnet_ids | Subnet IDs |
Like this project? Please give it a ★ on our GitHub! (it helps us a lot)
Are you using this project or any of our other projects? Consider leaving a testimonial. =)
Check out these related projects.
- terraform-aws-multi-az-subnets - Terraform module for multi-AZ public and private subnets provisioning.
- terraform-aws-dynamic-subnets - Terraform module for public and private subnets provisioning in existing VPC
- terraform-aws-vpc - Terraform Module that defines a VPC with public/private subnets across multiple AZs with Internet Gateways
- terraform-aws-cloudwatch-flow-logs - Terraform module for enabling flow logs for vpc and subnets.
Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
Join our Open Source Community on Slack. It's FREE 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 totally sweet infrastructure.
Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- 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 © 2017-2020 Cloud Posse, LLC
See LICENSE for full details.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you 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
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
"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.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
Erik Osterman |
Andriy Knysh |
Sergey Vasilyev |
Vladimir |
Konstantin B |
---|