Update with_public_ip description and examples (#44)

* Fix linting error

* Change description, example

* Change description for metadata service

* Change minimal example

* Change other 2 examples

* Bump version

Author: ob-uk

README.md

@@ -63,6 +63,7 @@ module "metaflow" {
   subnet2_id            = module.vpc.public_subnets[1]
   vpc_cidr_blocks       = module.vpc.vpc_cidr_blocks
   vpc_id                = module.vpc.vpc_id
+  with_public_ip        = var.with_public_ip
 
   tags = {
       "managedBy" = "terraform"
@@ -122,7 +123,7 @@ You can find a more complete example that uses this module but also includes set
 | <a name="input_ui_static_container_image"></a> [ui\_static\_container\_image](#input\_ui\_static\_container\_image) | Container image for the UI frontend app | `string` | `""` | no |
 | <a name="input_vpc_cidr_blocks"></a> [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 |
 | <a name="input_vpc_id"></a> [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 |
-| <a name="with_public_ip"></a> [with\_public\_ip](#input\_with\_public\_ip) | Use public IP in case if Metadata Service uses public subnets (by defualt private subnets are used). | `bool` | `false` | no |
+| <a name="input_with_public_ip"></a> [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 |
 
 ## Outputs
 

examples/eks_airflow/metaflow.tf

@@ -20,7 +20,7 @@ data "aws_availability_zones" "available" {
 
 module "metaflow-datastore" {
   source  = "outerbounds/metaflow/aws//modules/datastore"
-  version = "0.7.1"
+  version = "0.8.0"
 
   force_destroy_s3_bucket = true
 
@@ -37,12 +37,12 @@ module "metaflow-datastore" {
 
 module "metaflow-common" {
   source  = "outerbounds/metaflow/aws//modules/common"
-  version = "0.7.1"
+  version = "0.8.0"
 }
 
 module "metaflow-metadata-service" {
   source  = "outerbounds/metaflow/aws//modules/metadata-service"
-  version = "0.7.1"
+  version = "0.8.0"
 
   resource_prefix = local.resource_prefix
   resource_suffix = local.resource_suffix
@@ -61,6 +61,7 @@ module "metaflow-metadata-service" {
   subnet1_id                       = module.vpc.private_subnets[0]
   subnet2_id                       = module.vpc.private_subnets[1]
   vpc_cidr_blocks                  = [module.vpc.vpc_cidr_block]
+  with_public_ip                   = var.with_public_ip
 
   standard_tags = local.tags
 }

examples/eks_argo/metaflow.tf

@@ -20,7 +20,7 @@ data "aws_availability_zones" "available" {
 
 module "metaflow-datastore" {
   source  = "outerbounds/metaflow/aws//modules/datastore"
-  version = "0.7.1"
+  version = "0.8.0"
 
   force_destroy_s3_bucket = true
 
@@ -37,12 +37,12 @@ module "metaflow-datastore" {
 
 module "metaflow-common" {
   source  = "outerbounds/metaflow/aws//modules/common"
-  version = "0.7.1"
+  version = "0.8.0"
 }
 
 module "metaflow-metadata-service" {
   source  = "outerbounds/metaflow/aws//modules/metadata-service"
-  version = "0.7.1"
+  version = "0.8.0"
 
   resource_prefix = local.resource_prefix
   resource_suffix = local.resource_suffix
@@ -61,6 +61,7 @@ module "metaflow-metadata-service" {
   subnet1_id                       = module.vpc.private_subnets[0]
   subnet2_id                       = module.vpc.private_subnets[1]
   vpc_cidr_blocks                  = [module.vpc.vpc_cidr_block]
+  with_public_ip                   = var.with_public_ip
 
   standard_tags = local.tags
 }

examples/minimal/minimal_example.tf

@@ -38,7 +38,7 @@ module "vpc" {
 
 module "metaflow" {
   source  = "outerbounds/metaflow/aws"
-  version = "0.7.0"
+  version = "0.8.0"
 
   resource_prefix = local.resource_prefix
   resource_suffix = local.resource_suffix
@@ -48,6 +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
 
   tags = {
     "managedBy" = "terraform"

modules/metadata-service/README.md

@@ -36,7 +36,7 @@ If the `access_list_cidr_blocks` variable is set, only traffic originating from
 | <a name="input_subnet1_id"></a> [subnet1\_id](#input\_subnet1\_id) | First private subnet used for availability zone redundancy | `string` | n/a | yes |
 | <a name="input_subnet2_id"></a> [subnet2\_id](#input\_subnet2\_id) | Second private subnet used for availability zone redundancy | `string` | n/a | yes |
 | <a name="input_vpc_cidr_blocks"></a> [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 |
-| <a name="input_with_public_ip"></a> [with\_public\_ip](#input\_with\_public\_ip) | Enable private IP by default | `bool` | `false` | no |
+| <a name="input_with_public_ip"></a> [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 |
 
 ## Outputs
 

modules/metadata-service/variables.tf

@@ -113,5 +113,5 @@ variable "vpc_cidr_blocks" {
 variable "with_public_ip" {
   type        = bool
   default     = false
-  description = "Enable private IP by default"
+  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"
 }

variables.tf

@@ -163,5 +163,5 @@ variable "extra_ui_static_env_vars" {
 variable "with_public_ip" {
   type        = bool
   default     = false
-  description = "Enable public IP assignment for the Metadata Service"
+  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"
 }