refactor: remove existing vpc endpoint configurations from base module and move into sub-module #635
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 |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Upgrade from v2.x to v3.x | ||
|
|
||
| If you have any questions regarding this upgrade process, please consult the `examples` directory: | ||
|
|
||
| - [Complete-VPC](https://github.com/terraform-aws-modules/terraform-aws-vpc/tree/master/examples/complete-vpc) | ||
|
|
||
| If you find a bug, please open an issue with supporting configuration to reproduce. | ||
|
|
||
| ## List of backwards incompatible changes | ||
|
|
||
| Previously, VPC endpoints were configured as standalone resources with their own set of variables and attributes. Now, this functionality is provided via a module which loops over a map of maps using `for_each` to generate the desired VPC endpoints. Therefore, to maintain the existing set of functionality while upgrading, you will need to perform the following changes: | ||
|
|
||
| 1. Move the endpoint resource from the main module to the sub-module. The example state move below is valid for all endpoints you might have configured (reference [`complete-vpc`](https://github.com/terraform-aws-modules/terraform-aws-vpc/tree/master/examples/complete-vpc) example for reference), where `ssmmessages` should be updated for and state move performed for each endpoint configured: | ||
|
|
||
| ``` | ||
| terraform state mv 'module.vpc.aws_vpc_endpoint.ssm[0]' 'module.vpc_endpoints.aws_vpc_endpoint.this["ssm"]' | ||
| terraform state mv 'module.vpc.aws_vpc_endpoint.ssmmessages[0]' 'module.vpc_endpoints.aws_vpc_endpoint.this["ssmmessages"]' | ||
| terraform state mv 'module.vpc.aws_vpc_endpoint.ec2[0]' 'module.vpc_endpoints.aws_vpc_endpoint.this["ec2"]' | ||
| ... | ||
| ``` | ||
|
|
||
| 2. Remove the gateway endpoint route table association separate resources. The route table associations are now managed in the VPC endpoint resource itself via the map of maps provided to the VPC endpoint sub-module. Perform the necessary removals for each route table association and for S3 and/or DynamoDB depending on your configuration: | ||
|
|
||
| ``` | ||
| terraform state rm 'module.vpc.aws_vpc_endpoint_route_table_association.intra_dynamodb[0]' | ||
| terraform state rm 'module.vpc.aws_vpc_endpoint_route_table_association.private_dynamodb[0]' | ||
| terraform state rm 'module.vpc.aws_vpc_endpoint_route_table_association.public_dynamodb[0]' | ||
| ... | ||
| ``` | ||
|
|
||
| ### Variable and output changes | ||
|
|
||
| 1. Removed variables: | ||
|
|
||
| - `enable_*_endpoint` | ||
| - `*_endpoint_type` | ||
| - `*_endpoint_security_group_ids` | ||
| - `*_endpoint_subnet_ids` | ||
| - `*_endpoint_private_dns_enabled` | ||
| - `*_endpoint_policy` | ||
|
|
||
| 2. Renamed variables: | ||
|
|
||
| See the [VPC endpoint sub-module](modules/vpc-endpoints) for the more information on the variables to utilize for VPC endpoints | ||
|
|
||
| 3. Removed outputs: | ||
|
|
||
| - `vpc_endpoint_*` | ||
|
|
||
| 4. Renamed outputs: | ||
|
|
||
| VPC endpoint outputs are now provided via the VPC endpoint sub-module and can be accessed via lookups. See [`complete-vpc`](https://github.com/terraform-aws-modules/terraform-aws-vpc/tree/master/examples/complete-vpc) for further examples of how to access VPC endpoint attributes from outputs | ||
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
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,20 +1,28 @@ | ||
| provider "aws" { | ||
| region = local.region | ||
|
There was a problem hiding this comment. I just hit this issue when using Terraform 0.15.0 - hashicorp/terraform-provider-aws#8040 (comment) Works well when I put a value there as a string: |
||
| } | ||
|
|
||
| locals { | ||
| name = "complete-example" | ||
| region = "eu-west-1" | ||
| tags = { | ||
| Owner = "user" | ||
| Environment = "staging" | ||
| Name = "complete" | ||
| } | ||
| } | ||
|
|
||
| ################################################################################ | ||
bryantbiggs marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| # VPC Module | ||
| ################################################################################ | ||
|
|
||
| module "vpc" { | ||
| source = "../../" | ||
|
|
||
| name = local.name | ||
| cidr = "20.10.0.0/16" # 10.0.0.0/8 is reserved for EC2-Classic | ||
|
|
||
| azs = ["${local.region}a", "${local.region}b", "${local.region}c"] | ||
| private_subnets = ["20.10.1.0/24", "20.10.2.0/24", "20.10.3.0/24"] | ||
| public_subnets = ["20.10.11.0/24", "20.10.12.0/24", "20.10.13.0/24"] | ||
| database_subnets = ["20.10.21.0/24", "20.10.22.0/24", "20.10.23.0/24"] | ||
|
|
@@ -53,80 +61,6 @@ module "vpc" { | |
| dhcp_options_domain_name = "service.consul" | ||
| dhcp_options_domain_name_servers = ["127.0.0.1", "10.10.0.2"] | ||
|
|
||
| # Default security group - ingress/egress rules cleared to deny all | ||
| manage_default_security_group = true | ||
| default_security_group_ingress = [] | ||
|
|
@@ -138,22 +72,124 @@ module "vpc" { | |
| create_flow_log_cloudwatch_iam_role = true | ||
| flow_log_max_aggregation_interval = 60 | ||
|
|
||
| tags = local.tags | ||
| } | ||
|
|
||
| ################################################################################ | ||
| # VPC Endpoints Module | ||
| ################################################################################ | ||
|
|
||
| module "vpc_endpoints" { | ||
| source = "../../modules/vpc-endpoints" | ||
|
|
||
| vpc_id = module.vpc.vpc_id | ||
| security_group_ids = [data.aws_security_group.default.id] | ||
|
|
||
| endpoints = { | ||
| s3 = { | ||
| service = "s3" | ||
| tags = { Name = "s3-vpc-endpoint" } | ||
| }, | ||
| dynamodb = { | ||
| service = "dynamodb" | ||
| service_type = "Gateway" | ||
| route_table_ids = flatten([module.vpc.intra_route_table_ids, module.vpc.private_route_table_ids, module.vpc.public_route_table_ids]) | ||
| policy = data.aws_iam_policy_document.dynamodb_endpoint_policy.json | ||
| tags = { Name = "dynamodb-vpc-endpoint" } | ||
| }, | ||
| ssm = { | ||
| service = "ssm" | ||
| private_dns_enabled = true | ||
| subnet_ids = module.vpc.private_subnets | ||
| }, | ||
| ssmmessages = { | ||
| service = "ssmmessages" | ||
| private_dns_enabled = true | ||
| subnet_ids = module.vpc.private_subnets | ||
| }, | ||
| lambda = { | ||
| service = "lambda" | ||
| private_dns_enabled = true | ||
| subnet_ids = module.vpc.private_subnets | ||
| }, | ||
| ecs = { | ||
| service = "ecs" | ||
| private_dns_enabled = true | ||
| subnet_ids = module.vpc.private_subnets | ||
| }, | ||
| ecs_telemetry = { | ||
| service = "ecs-telemetry" | ||
| private_dns_enabled = true | ||
| subnet_ids = module.vpc.private_subnets | ||
| }, | ||
| ec2 = { | ||
| service = "ec2" | ||
| private_dns_enabled = true | ||
| subnet_ids = module.vpc.private_subnets | ||
| }, | ||
| ec2messages = { | ||
| service = "ec2messages" | ||
| private_dns_enabled = true | ||
| subnet_ids = module.vpc.private_subnets | ||
| }, | ||
| ecr_api = { | ||
| service = "ecr.api" | ||
| private_dns_enabled = true | ||
| subnet_ids = module.vpc.private_subnets | ||
| policy = data.aws_iam_policy_document.generic_endpoint_policy.json | ||
| }, | ||
| ecr_dkr = { | ||
| service = "ecr.dkr" | ||
| private_dns_enabled = true | ||
| subnet_ids = module.vpc.private_subnets | ||
| policy = data.aws_iam_policy_document.generic_endpoint_policy.json | ||
| }, | ||
| kms = { | ||
| service = "kms" | ||
| private_dns_enabled = true | ||
| subnet_ids = module.vpc.private_subnets | ||
| }, | ||
| codedeploy = { | ||
| service = "codedeploy" | ||
| private_dns_enabled = true | ||
| subnet_ids = module.vpc.private_subnets | ||
| }, | ||
| codedeploy_commands_secure = { | ||
| service = "codedeploy-commands-secure" | ||
| private_dns_enabled = true | ||
| subnet_ids = module.vpc.private_subnets | ||
| }, | ||
| } | ||
|
|
||
| tags = merge(local.tags, { | ||
| Project = "Secret" | ||
| Endpoint = "true" | ||
| }) | ||
| } | ||
|
|
||
| module "vpc_endpoints_nocreate" { | ||
| source = "../../modules/vpc-endpoints" | ||
|
|
||
| create = false | ||
| } | ||
|
|
||
| ################################################################################ | ||
| # Supporting Resources | ||
| ################################################################################ | ||
|
|
||
| data "aws_security_group" "default" { | ||
| name = "default" | ||
| vpc_id = module.vpc.vpc_id | ||
| } | ||
|
|
||
| # Data source used to avoid race condition | ||
| data "aws_vpc_endpoint_service" "dynamodb" { | ||
| service = "dynamodb" | ||
|
|
||
| filter { | ||
| name = "service-type" | ||
| values = ["Gateway"] | ||
| } | ||
| } | ||
|
|
||
| data "aws_iam_policy_document" "dynamodb_endpoint_policy" { | ||
|
|
@@ -171,7 +207,7 @@ data "aws_iam_policy_document" "dynamodb_endpoint_policy" { | |
| test = "StringNotEquals" | ||
| variable = "aws:sourceVpce" | ||
|
|
||
| values = [data.aws_vpc_endpoint_service.dynamodb.id] | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -191,7 +227,7 @@ data "aws_iam_policy_document" "generic_endpoint_policy" { | |
| test = "StringNotEquals" | ||
| variable = "aws:sourceVpce" | ||
|
|
||
| values = [data.aws_vpc_endpoint_service.dynamodb.id] | ||
| } | ||
| } | ||
| } | ||
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also verified all these
terraform statecommands. Works as expected.