From 12295edf71f18acd64a3216c4421fc2f5af50bfc Mon Sep 17 00:00:00 2001 From: Oleg Avdeev Date: Tue, 21 Feb 2023 10:57:21 -0800 Subject: [PATCH] update docs and remove the default for with_public_ip (#49) --- README.md | 2 +- examples/minimal/minimal_example.tf | 4 ++-- modules/metadata-service/README.md | 2 +- modules/metadata-service/variables.tf | 1 - variables.tf | 1 - 5 files changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index afb7f4c..ac91649 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,7 @@ You can find a more complete example that uses this module but also includes set | [ui\_static\_container\_image](#input\_ui\_static\_container\_image) | Container image for the UI frontend app | `string` | `""` | no | | [vpc\_cidr\_blocks](#input\_vpc\_cidr\_blocks) | The VPC CIDR blocks that we'll access list on our Metadata Service API to allow all internal communications | `list(string)` | n/a | yes | | [vpc\_id](#input\_vpc\_id) | The id of the single VPC we stood up for all Metaflow resources to exist in. | `string` | n/a | yes | -| [with\_public\_ip](#input\_with\_public\_ip) | Enable public IP assignment for the Metadata Service. Typically you want this to be set to true if using public subnets as subnet1\_id and subnet2\_id, and false otherwise | `bool` | `false` | no | +| [with\_public\_ip](#input\_with\_public\_ip) | Enable public IP assignment for the Metadata Service. Typically you want this to be set to true if using public subnets as subnet1\_id and subnet2\_id, and false otherwise | `bool` | n/a | yes | ## Outputs diff --git a/examples/minimal/minimal_example.tf b/examples/minimal/minimal_example.tf index 00c47c2..37e5adb 100644 --- a/examples/minimal/minimal_example.tf +++ b/examples/minimal/minimal_example.tf @@ -38,7 +38,7 @@ module "vpc" { module "metaflow" { source = "outerbounds/metaflow/aws" - version = "0.8.0" + version = "0.9.0" resource_prefix = local.resource_prefix resource_suffix = local.resource_suffix @@ -48,7 +48,7 @@ module "metaflow" { subnet2_id = module.vpc.public_subnets[1] vpc_cidr_blocks = [module.vpc.vpc_cidr_block] vpc_id = module.vpc.vpc_id - with_public_ip = var.with_public_ip + with_public_ip = true tags = { "managedBy" = "terraform" diff --git a/modules/metadata-service/README.md b/modules/metadata-service/README.md index 8f68903..fa337ac 100644 --- a/modules/metadata-service/README.md +++ b/modules/metadata-service/README.md @@ -37,7 +37,7 @@ If the `access_list_cidr_blocks` variable is set, only traffic originating from | [subnet1\_id](#input\_subnet1\_id) | First private subnet used for availability zone redundancy | `string` | n/a | yes | | [subnet2\_id](#input\_subnet2\_id) | Second private subnet used for availability zone redundancy | `string` | n/a | yes | | [vpc\_cidr\_blocks](#input\_vpc\_cidr\_blocks) | The VPC CIDR blocks that we'll access list on our Metadata Service API to allow all internal communications | `list(string)` | n/a | yes | -| [with\_public\_ip](#input\_with\_public\_ip) | Enable public IP assignment for the Metadata Service. Typically you want this to be set to true if using public subnets as subnet1\_id and subnet2\_id, and false otherwise | `bool` | `false` | no | +| [with\_public\_ip](#input\_with\_public\_ip) | Enable public IP assignment for the Metadata Service. Typically you want this to be set to true if using public subnets as subnet1\_id and subnet2\_id, and false otherwise | `bool` | n/a | yes | ## Outputs diff --git a/modules/metadata-service/variables.tf b/modules/metadata-service/variables.tf index 78b073d..a0aae1b 100644 --- a/modules/metadata-service/variables.tf +++ b/modules/metadata-service/variables.tf @@ -118,6 +118,5 @@ variable "vpc_cidr_blocks" { variable "with_public_ip" { type = bool - default = false description = "Enable public IP assignment for the Metadata Service. Typically you want this to be set to true if using public subnets as subnet1_id and subnet2_id, and false otherwise" } diff --git a/variables.tf b/variables.tf index 7e922c5..88bdfce 100644 --- a/variables.tf +++ b/variables.tf @@ -168,6 +168,5 @@ variable "extra_ui_static_env_vars" { variable "with_public_ip" { type = bool - default = false description = "Enable public IP assignment for the Metadata Service. Typically you want this to be set to true if using public subnets as subnet1_id and subnet2_id, and false otherwise" }