Merge pull request #9 from clouddrove/CD-147

fix labels managedby variables
clouddrove · Mar 24, 2020 · 8504ae7 · 8504ae7
2 parents 43c2a34 + ddfaee3
commit 8504ae7
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
     Terraform AWS VPC
 </h1>
 
-<p align="center" style="font-size: 1.2rem;">
+<p align="center" style="font-size: 1.2rem;"> 
     Terraform module to create VPC resource on AWS.
      </p>
 
@@ -38,7 +38,7 @@
 <hr>
 
 
-We eat, drink, sleep and most importantly love **DevOps**. We are working towards stratergies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure.
+We eat, drink, sleep and most importantly love **DevOps**. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy <b>Bigger problems are always solved by breaking them into smaller manageable problems</b>. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller <b>connected yet manageable pieces</b> within the infrastructure. 
 
 This module is basically combination of [Terraform open source](https://www.terraform.io/) and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself.
 
@@ -49,7 +49,7 @@ We have [*fifty plus terraform modules*][terraform_modules]. A few of them are c
 
 ## Prerequisites
 
-This module has a few dependencies:
+This module has a few dependencies: 
 
 - [Terraform 0.12](https://learn.hashicorp.com/terraform/getting-started/install.html)
 - [Go](https://golang.org/doc/install)
@@ -61,16 +61,18 @@ This module has a few dependencies:
 
 
 
+
 ## Examples
 
+
 **IMPORTANT:** Since the `master` branch used in `source` varies based on new modifications, we suggest that you use the release versions [here](https://github.com/clouddrove/terraform-aws-vpc/releases).
 
 
 ### Simple Example
 Here is an example of how you can use this module in your inventory structure:
   ```hcl
   module "vpc" {
-      source      = "git::https://github.com/clouddrove/terraform-aws-vpc.git?ref=tags/0.12.4"
+      source      = "git::https://github.com/clouddrove/terraform-aws-vpc.git?ref=tags/0.12.5"
       name        = "vpc"
       application = "clouddrove"
       environment = "test"
@@ -81,47 +83,51 @@ Here is an example of how you can use this module in your inventory structure:
 
 
 
+
+
+
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| application | Application (e.g. `cd` or `clouddrove`). | string | `` | no |
-| attributes | Additional attributes (e.g. `1`). | list | `<list>` | no |
-| cidr_block | CIDR for the VPC. | string | `` | no |
-| enable_classiclink | A boolean flag to enable/disable ClassicLink for the VPC. | bool | `false` | no |
-| enable_classiclink_dns_support | A boolean flag to enable/disable ClassicLink DNS Support for the VPC. | bool | `false` | no |
-| enable_dns_hostnames | A boolean flag to enable/disable DNS hostnames in the VPC. | bool | `true` | no |
-| enable_dns_support | A boolean flag to enable/disable DNS support in the VPC. | bool | `true` | no |
-| enable_flow_log | Enable vpc_flow_log logs. | bool | `false` | no |
-| environment | Environment (e.g. `prod`, `dev`, `staging`). | string | `` | no |
-| instance_tenancy | A tenancy option for instances launched into the VPC. | string | `default` | no |
-| label_order | Label order, e.g. `name`,`application`. | list | `<list>` | no |
-| name | Name  (e.g. `app` or `cluster`). | string | `` | no |
-| s3_bucket_arn | S3 ARN for vpc logs. | string | `` | no |
-| tags | Additional tags (e.g. map(`BusinessUnit`,`XYZ`). | map | `<map>` | no |
-| traffic_type | Type of traffic to capture. Valid values: ACCEPT,REJECT, ALL. | string | `ALL` | no |
-| vpc_enabled | Flag to control the vpc creation. | bool | `true` | no |
+| application | Application \(e.g. `cd` or `clouddrove`\). | string | `""` | no |
+| attributes | Additional attributes \(e.g. `1`\). | list | `<list>` | no |
+| cidr\_block | CIDR for the VPC. | string | `""` | no |
+| enable\_classiclink | A boolean flag to enable/disable ClassicLink for the VPC. | bool | `"false"` | no |
+| enable\_classiclink\_dns\_support | A boolean flag to enable/disable ClassicLink DNS Support for the VPC. | bool | `"false"` | no |
+| enable\_dns\_hostnames | A boolean flag to enable/disable DNS hostnames in the VPC. | bool | `"true"` | no |
+| enable\_dns\_support | A boolean flag to enable/disable DNS support in the VPC. | bool | `"true"` | no |
+| enable\_flow\_log | Enable vpc\_flow\_log logs. | bool | `"false"` | no |
+| environment | Environment \(e.g. `prod`, `dev`, `staging`\). | string | `""` | no |
+| instance\_tenancy | A tenancy option for instances launched into the VPC. | string | `"default"` | no |
+| label\_order | Label order, e.g. `name`,`application`. | list | `<list>` | no |
+| managedby | ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'. | string | `"anmol@clouddrove.com"` | no |
+| name | Name  \(e.g. `app` or `cluster`\). | string | `""` | no |
+| s3\_bucket\_arn | S3 ARN for vpc logs. | string | `""` | no |
+| tags | Additional tags \(e.g. map\(`BusinessUnit`,`XYZ`\). | map | `<map>` | no |
+| traffic\_type | Type of traffic to capture. Valid values: ACCEPT,REJECT, ALL. | string | `"ALL"` | no |
+| vpc\_enabled | Flag to control the vpc creation. | bool | `"true"` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| igw_id | The ID of the Internet Gateway. |
-| ipv6_cidr_block | The IPv6 CIDR block. |
+| igw\_id | The ID of the Internet Gateway. |
+| ipv6\_cidr\_block | The IPv6 CIDR block. |
 | tags | A mapping of tags to assign to the resource. |
-| vpc_cidr_block | The CIDR block of the VPC. |
-| vpc_default_network_acl_id | The ID of the network ACL created by default on VPC creation. |
-| vpc_default_route_table_id | The ID of the route table created by default on VPC creation. |
-| vpc_default_security_group_id | The ID of the security group created by default on VPC creation. |
-| vpc_id | The ID of the VPC. |
-| vpc_ipv6_association_id | The association ID for the IPv6 CIDR block. |
-| vpc_main_route_table_id | The ID of the main route table associated with this VPC. |
+| vpc\_cidr\_block | The CIDR block of the VPC. |
+| vpc\_default\_network\_acl\_id | The ID of the network ACL created by default on VPC creation. |
+| vpc\_default\_route\_table\_id | The ID of the route table created by default on VPC creation. |
+| vpc\_default\_security\_group\_id | The ID of the security group created by default on VPC creation. |
+| vpc\_id | The ID of the VPC. |
+| vpc\_ipv6\_association\_id | The association ID for the IPv6 CIDR block. |
+| vpc\_main\_route\_table\_id | The ID of the main route table associated with this VPC. |
 
 
 
-## Testing
 
-In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system.
+## Testing
+In this module testing is performed with [terratest](https://github.com/gruntwork-io/terratest) and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a [GO environment](https://golang.org/doc/install) in your system. 
 
 You need to run the following command in the testing folder:
 ```hcl
@@ -130,10 +136,10 @@ You need to run the following command in the testing folder:
 
 
 
-## Feedback
+## Feedback 
 If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/terraform-aws-vpc/issues), or feel free to drop us an email at [hello@clouddrove.com](mailto:hello@clouddrove.com).
 
-If you have found it worth your time, go ahead and give us a * on [our GitHub](https://github.com/clouddrove/terraform-aws-vpc)!
+If you have found it worth your time, go ahead and give us a ★ on [our GitHub](https://github.com/clouddrove/terraform-aws-vpc)!
 
 ## About us
 
@@ -148,4 +154,4 @@ At [CloudDrove][website], we offer expert guidance, implementation support and s
   [linkedin]: https://cpco.io/linkedin
   [twitter]: https://twitter.com/clouddrove/
   [email]: https://clouddrove.com/contact-us.html
-  [terraform_modules]: https://github.com/clouddrove?utf8=%E2%9C%93&q=terraform-&type=&language=
+  [terraform_modules]: https://github.com/clouddrove?utf8=%E2%9C%93&q=terraform-&type=&language=
diff --git a/README.yaml b/README.yaml
@@ -37,7 +37,7 @@ usage : |-
   Here is an example of how you can use this module in your inventory structure:
     ```hcl
     module "vpc" {
-        source      = "git::https://github.com/clouddrove/terraform-aws-vpc.git?ref=tags/0.12.4"
+        source      = "git::https://github.com/clouddrove/terraform-aws-vpc.git?ref=tags/0.12.5"
         name        = "vpc"
         application = "clouddrove"
         environment = "test"

diff --git a/main.tf b/main.tf
@@ -12,6 +12,7 @@ module "labels" {
   name        = var.name
   application = var.application
   environment = var.environment
+  managedby   = var.managedby
   label_order = var.label_order
 }
 

diff --git a/variables.tf b/variables.tf
@@ -24,6 +24,13 @@ variable "label_order" {
   description = "Label order, e.g. `name`,`application`."
 }
 
+
+variable "managedby" {
+  type        = string
+  default     = "anmol@clouddrove.com"
+  description = "ManagedBy, eg 'CloudDrove' or 'AnmolNagpal'."
+}
+
 variable "attributes" {
   type        = list
   default     = []