From 95d46b173e2b3f42a02d57bff6c9866a3af099fa Mon Sep 17 00:00:00 2001 From: Don Badrak Date: Mon, 29 Jun 2020 12:11:55 -0400 Subject: [PATCH] add docs now that terraform-docs works with 0.12 --- it-linux-base/README.md | 190 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 190 insertions(+) create mode 100644 it-linux-base/README.md diff --git a/it-linux-base/README.md b/it-linux-base/README.md new file mode 100644 index 0000000..40f1574 --- /dev/null +++ b/it-linux-base/README.md @@ -0,0 +1,190 @@ +## Requirements + +The following requirements are needed by this module: + +- terraform (>= 0.12) + +## Providers + +The following providers are used by this module: + +- aws + +## Required Inputs + +The following input variables are required: + +### vpc\_id + +Description: VPC ID Number + +Type: `string` + +## Optional Inputs + +The following input variables are optional (have default values): + +### \_module\_version + +Description: Module version number + +Type: `string` + +Default: `"1.0.1"` + +### description + +Description: Security Group Description + +Type: `string` + +Default: `"Linux Common Base Security Group"` + +### egress\_networks + +Description: List of egress networks (all ports) + +Type: `list(string)` + +Default: + +```json +[ + "0.0.0.0/0" +] +``` + +### egress\_security\_groups + +Description: List of egress security groups (all ports) + +Type: `list(string)` + +Default: `[]` + +### enable\_self + +Description: Enable\|Disable self full access + +Type: `bool` + +Default: `false` + +### ingress\_networks + +Description: List of ingress networks for external access (not all ports) + +Type: `list(string)` + +Default: + +```json +[ + "0.0.0.0/0" +] +``` + +### ingress\_security\_groups + +Description: List of ingress security groups for all ports + +Type: `list(string)` + +Default: `[]` + +### name + +Description: Security Group Name + +Type: `string` + +Default: `"it-linux-base"` + +### short\_description + +Description: Security Group Short Description + +Type: `string` + +Default: `"Linux"` + +### tags + +Description: Extra security group tags + +Type: `map` + +Default: + +```json +{ + "CostAllocation": "csvd:infrastructure", + "Environment": "csvd-infrastructure" +} +``` + +### use\_vpc\_cidr + +Description: Enable\|Disable use of VPC CIDR block in the ingress\_networks + +Type: `bool` + +Default: `false` + +### vpc\_full\_name + +Description: VPC Name + +Type: `string` + +Default: `""` + +## Outputs + +The following outputs are exported: + +### this\_security\_group\_arn + +Description: Created security group ARN + +### this\_security\_group\_id + +Description: Created security group ID + +## Requirements + +| Name | Version | +|------|---------| +| terraform | >= 0.12 | + +## Providers + +| Name | Version | +|------|---------| +| aws | n/a | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| \_module\_version | Module version number | `string` | `"1.0.1"` | no | +| description | Security Group Description | `string` | `"Linux Common Base Security Group"` | no | +| egress\_networks | List of egress networks (all ports) | `list(string)` |
[
"0.0.0.0/0"
]
| no | +| egress\_security\_groups | List of egress security groups (all ports) | `list(string)` | `[]` | no | +| enable\_self | Enable\|Disable self full access | `bool` | `false` | no | +| ingress\_networks | List of ingress networks for external access (not all ports) | `list(string)` |
[
"0.0.0.0/0"
]
| no | +| ingress\_security\_groups | List of ingress security groups for all ports | `list(string)` | `[]` | no | +| name | Security Group Name | `string` | `"it-linux-base"` | no | +| short\_description | Security Group Short Description | `string` | `"Linux"` | no | +| tags | Extra security group tags | `map` |
{
"CostAllocation": "csvd:infrastructure",
"Environment": "csvd-infrastructure"
}
| no | +| use\_vpc\_cidr | Enable\|Disable use of VPC CIDR block in the ingress\_networks | `bool` | `false` | no | +| vpc\_full\_name | VPC Name | `string` | `""` | no | +| vpc\_id | VPC ID Number | `string` | n/a | yes | + +## Outputs + +| Name | Description | +|------|-------------| +| this\_security\_group\_arn | Created security group ARN | +| this\_security\_group\_id | Created security group ID | +