update comments

terraform-modules · Jul 31, 2020 · e9da126 · e9da126
1 parent e110bdf
commit e9da126
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 40 deletions.
diff --git a/it-windows-base/README.md b/it-windows-base/README.md
@@ -11,7 +11,7 @@ monit, munin, iperf, netperf, NetBackup and Opsware.
 module "it-windows-base" {
   source = "git@github.e.it.census.gov:terraform-modules/aws-common-security-groups.git//it-windows-base"
 
-  # name = "m-it-windows-base"
+  # name = "it-windows-base"
   vpc_id = var.vpc_id
   # Name, CostAllocation, and Environment are pre-set, but they can be overriden
   # tags = { }

diff --git a/it-windows-base/main.tf b/it-windows-base/main.tf
@@ -12,7 +12,7 @@
 * module "it-windows-base" {
 *   source = "git@github.e.it.census.gov:terraform-modules/aws-common-security-groups.git//it-windows-base"
 *
-*   # name = "m-it-windows-base"
+*   # name = "it-windows-base"
 *   vpc_id = var.vpc_id
 *   # Name, CostAllocation, and Environment are pre-set, but they can be overriden
 *   # tags = { }

diff --git a/ois-scanner/README.md b/ois-scanner/README.md
@@ -1,8 +1,8 @@
 # About
 
-This describes how to use the aws-common-security-groups submodule for ois-scanner. This sets up
-a module for a security group in the respective VPC.  When construting a new VPC, we want to include
-this module.  This should be in each VPC we have, in production.  We probably need a similar one
+This describes how to use the aws-common-security-groups submodule for ois-scanner. This sets up  
+a module for a security group in the respective VPC.  When construting a new VPC, we want to include  
+this module.  This should be in each VPC we have, in production.  We probably need a similar one  
 for the CAT environment, but we'll tackle that when we get to it.
 
 # Usage
@@ -18,45 +18,30 @@ module "ois-scanner" {
 }
 ```
 
-## Required Inputs
+## Requirements
 
-The following input variables are required:
+| Name | Version |
+|------|---------|
+| terraform | >= 0.12 |
 
-### vpc\_id
+## Providers
 
-Description: VPC ID Number
+| Name | Version |
+|------|---------|
+| aws | n/a |
 
-Type: `string`
+## Inputs
 
-## Optional Inputs
-
-The following input variables are optional (have default values):
-
-### name
-
-Description: Security group Name
-
-Type: `string`
-
-Default: `"ois-scanner"`
-
-### tags
-
-Description: Extra security group tags
-
-Type: `map`
-
-Default: `<map>`
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| \_module\_version | Module version number | `string` | `"1.16"` | no |
+| name | Security group Name | `string` | `"ois-scanner"` | no |
+| tags | Extra security group tags | `map(string)` | <pre>{<br>  "CostAllocation": "csvd:infrastructure",<br>  "Environment": "csvd-infrastructure"<br>}</pre> | no |
+| vpc\_id | VPC ID Number | `any` | n/a | yes |
 
 ## Outputs
 
-The following outputs are exported:
-
-### this\_security\_group\_arn
-
-Description: Created security group ARN
-
-### this\_security\_group\_id
-
-Description: Created security group ID
-
+| Name | Description |
+|------|-------------|
+| this\_security\_group\_arn | Created security group ARN |
+| this\_security\_group\_id | Created security group ID |
diff --git a/ois-scanner/versions.tf b/ois-scanner/versions.tf
@@ -1,4 +1,3 @@
-
 terraform {
   required_version = ">= 0.12"
 }