Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding subnets taggings capability when creating a VPC #14

Merged
merged 5 commits into from
Oct 24, 2019
Merged

Adding subnets taggings capability when creating a VPC #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5c63f04
Adding subnets taggings capability when creating a VPC
Oct 22, 2019
20b47cd
Running terraform fmt
Oct 22, 2019
7e0a52f
Updating README.md with new inputs
Oct 22, 2019
c963d89
Updating examples with subnets tagging
Oct 24, 2019
b122a09
Updating README.md with VPC and Subnets tagging for EKS
Oct 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 63 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,34 +36,71 @@ module "vpc" {
```
## Inputs

| Name | Description | Type | Default | Required |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | :---------: | :-------------: | :------: |
| availability\_zones | List to specify the availability zones for which subnes will be created. By default all availability zones will be used. | list | `<list>` | no |
| aws\_region | The Amazon region | string | n/a | yes |
| cidr\_block | The CIDR block used for the VPC. | string | `"10.0.0.0/16"` | no |
| create\_private\_hosted\_zone | Indicate to create a private hosted zone. | bool | `"true"` | no |
| create\_private\_subnets | Indicates to create private subnets. | bool | `"true"` | no |
| create\_s3\_vpc\_endpoint | Whether to create a VPC Endpoint for S3, so the S3 buckets can be used from within the VPC without using the NAT gateway. | bool | `"true"` | no |
| enable\_create\_defaults | Disable managing the default resources. | bool | `"true"` | no |
| environment | Environment name, will be added for resource tagging. | string | n/a | yes |
| project | Project name, will be added for resource tagging. | string | `""` | no |
| public\_subnet\_map\_public\_ip\_on\_launch | Enable public ip creaton by default on EC2 instance launch. | bool | `"false"` | no |
| tags | Map of tags to apply on the resources | map(string) | `<map>` | no |
| Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:|
| availability\_zones | List to specify the availability zones for which subnes will be created. By default all availability zones will be used. | list | `<list>` | no |
| aws\_region | The Amazon region | string | n/a | yes |
| cidr\_block | The CIDR block used for the VPC. | string | `"10.0.0.0/16"` | no |
| create\_private\_hosted\_zone | Indicate to create a private hosted zone. | bool | `"true"` | no |
| create\_private\_subnets | Indicates to create private subnets. | bool | `"true"` | no |
| create\_s3\_vpc\_endpoint | Whether to create a VPC Endpoint for S3, so the S3 buckets can be used from within the VPC without using the NAT gateway. | bool | `"true"` | no |
| enable\_create\_defaults | Disable managing the default resources. | bool | `"true"` | no |
| environment | Environment name, will be added for resource tagging. | string | n/a | yes |
| private\_subnet\_tags | Map of tags to apply on the private subnets | map(string) | `<map>` | no |
| project | Project name, will be added for resource tagging. | string | `""` | no |
| public\_subnet\_map\_public\_ip\_on\_launch | Enable public ip creaton by default on EC2 instance launch. | bool | `"false"` | no |
| public\_subnet\_tags | Map of tags to apply on the public subnets | map(string) | `<map>` | no |
| tags | Map of tags to apply on the resources | map(string) | `<map>` | no |

## Outputs

| Name | Description |
| ------------------------------ | ----------------------------------------- |
| availability\_zones | List of the availability zones. |
| nat\_gateway\_public\_ip | Public IP address of the NAT gateway. |
| private\_dns\_zone\_id | ID of the the private DNS zone, optional. |
| private\_domain\_name | Private domain name, optional. |
| private\_subnets | List of the private subnets. |
| private\_subnets\_route\_table | |
| public\_subnets | List of the public subnets. |
| public\_subnets\_route\_table | |
| vpc\_cidr | VPC CDIR. |
| vpc\_id | ID of the VPC. |
| Name | Description |
|------|-------------|
| availability\_zones | List of the availability zones. |
| nat\_gateway\_public\_ip | Public IP address of the NAT gateway. |
| private\_dns\_zone\_id | ID of the the private DNS zone, optional. |
| private\_domain\_name | Private domain name, optional. |
| private\_subnets | List of the private subnets. |
| private\_subnets\_route\_table | |
| public\_subnets | List of the public subnets. |
| public\_subnets\_route\_table | |
| vpc\_cidr | VPC CDIR. |
| vpc\_id | ID of the VPC. |

# VPC for Amazon EKS

Amazon EKS (Elastic Kubernetes Service) requires that both VPCs and Subnets (public and private) are tagged specifically with certain values according to the [aws-eks-docs].

Therefore, if the VPC created using this module is targeted for EKS, tag it with

```terraform
tags = {
"kubernetes.io/cluster/<cluster-name>" = "my-new-tag"
}
```

## Subnets Tags

As stated above, tagging the subnets is also mandatory for EKS Clusters. The tags for public and private subnets are as follows, respectively:

### Public Subnet Tags

```terraform
public_subnet_tags = {
"kubernetes.io/cluster/<cluster_name>" = "shared"
"kubernetes.io/role/elb" = "1"
}
```

### Private Subnet Tags

```terraform
private_subnet_tags = {
"kubernetes.io/cluster/<cluster_name>" = "shared"
"kubernetes.io/role/internal-elb" = "1"
}
```

## Automated checks
Currently the automated checks are limited. In CI the following checks are done for the root and each example.
- lint: `terraform validate` and `terraform fmt`
Expand Down Expand Up @@ -93,3 +130,4 @@ This module is part of the Philips Forest.
Talk to the forestkeepers in the `forest`-channel on Slack.

[![Slack](https://philips-software-slackin.now.sh/badge.svg)](https://philips-software-slackin.now.sh)
[aws-eks-docs]: https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html
11 changes: 11 additions & 0 deletions examples/vpc-public-private/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,15 @@ module "vpc" {
tags = {
my-tag = "my-new-tag"
}

// add tags on the subnets. Mostly useful when creating EKS clusters
public_subnet_tags = {
"kubernetes.io/cluster/<cluster_name>" = "shared"
"kubernetes.io/role/elb" = "1"
}

private_subnet_tags = {
"kubernetes.io/cluster/<cluster_name>" = "shared"
"kubernetes.io/role/internal-elb" = "1"
}
}
6 changes: 6 additions & 0 deletions examples/vpc-public/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,10 @@ module "vpc" {
tags = {
my-tag = "my-new-tag"
}

// add tags on the subnets. Mostly useful when creating EKS clusters
public_subnet_tags = {
"kubernetes.io/cluster/<cluster_name>" = "shared"
"kubernetes.io/role/elb" = "1"
}
}
5 changes: 3 additions & 2 deletions main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ resource "aws_vpc" "vpc" {
cidr_block = cidrsubnet(var.cidr_block, 0, 0)
enable_dns_support = true
enable_dns_hostnames = true

tags = local.tags
tags = local.tags
}

resource "aws_default_network_acl" "default" {
Expand Down Expand Up @@ -129,6 +128,7 @@ resource "aws_subnet" "public_subnet" {
"Tier" = "public"
},
local.tags_without_name,
var.public_subnet_tags
)
}

Expand Down Expand Up @@ -178,6 +178,7 @@ resource "aws_subnet" "private_subnet" {
"Tier" = "private"
},
local.tags_without_name,
var.private_subnet_tags
)
}

Expand Down
14 changes: 13 additions & 1 deletion variables.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,20 @@ variable "tags" {
default = {}
}

variable "public_subnet_tags" {
description = "Map of tags to apply on the public subnets"
type = map(string)
default = {}
}

variable "private_subnet_tags" {
description = "Map of tags to apply on the private subnets"
type = map(string)
default = {}
}

variable "enable_create_defaults" {
description = "Disable managing the default resources."
type = bool
default = true
}
}