From a4a5651364c04c4d40a213e221bd0dbebf4a21bc Mon Sep 17 00:00:00 2001 From: badra001 Date: Mon, 1 Mar 2021 15:51:46 -0500 Subject: [PATCH] add readmes --- it-linux-base/.x/README.md | 54 ++++++++++++++++++++++++++++++++++++ rds-oracle/README.md | 57 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 111 insertions(+) create mode 100644 it-linux-base/.x/README.md create mode 100644 rds-oracle/README.md diff --git a/it-linux-base/.x/README.md b/it-linux-base/.x/README.md new file mode 100644 index 0000000..b406c95 --- /dev/null +++ b/it-linux-base/.x/README.md @@ -0,0 +1,54 @@ +# About + +This describes how to use the aws-common-security-groups submodule for it-linux-base + +# Usage + +```code +module "it-linux-base" { + source = "git::https://vc1.csvd.census.gov/terraform-modules/aws-common-security-groups.git//it-linux-base" + + # name = "m-it-linux-base" + vpc_id = var.vpc_id + # Name, CostAllocation, and Environment are pre-set + # tags = { } +} +``` + +## Requirements + +| Name | Version | +|------|---------| +| terraform | >= 0.12 | + +## Providers + +| Name | Version | +|------|---------| +| aws | n/a | + +## Modules + +No Modules. + +## Resources + +| Name | +|------| +| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| \_module\_version | Module version number | `string` | `"1.4"` | no | +| name | Security group Name | `string` | `"m-rds-mssql"` | no | +| tags | Extra security group tags | `map` |
{
"CostAllocation": "csvd:infrastructure",
"Environment": "csvd-infrastructure"
}
| 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 | diff --git a/rds-oracle/README.md b/rds-oracle/README.md new file mode 100644 index 0000000..9f48f1f --- /dev/null +++ b/rds-oracle/README.md @@ -0,0 +1,57 @@ +# About + +This describes how to use the aws-common-security-groups submodule for rds-oracle + +# Usage + +```code +module "rds-oracle" { + source = "git::https://vc1.csvd.census.gov/terraform-modules/aws-common-security-groups.git//rds-oracle" + + # name = "m-rds-oracle" + vpc_id = var.vpc_id + # Name, CostAllocation, and Environment are pre-set + # tags = { } +} +``` + +## Requirements + +| Name | Version | +|------|---------| +| terraform | >= 0.12 | + +## Providers + +| Name | Version | +|------|---------| +| aws | n/a | + +## Modules + +No Modules. + +## Resources + +| Name | +|------| +| [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| \_module\_version | Module version number | `string` | `"1.3"` | no | +| egress\_networks | List of egress networks (all ports) | `list(string)` |
[
"0.0.0.0/0"
]
| no | +| name | Security group Name | `string` | `"m-oracle-db"` | no | +| networks | List of ingress networks (applies to all ports) | `list(string)` |
[
"0.0.0.0/0"
]
| no | +| tags | Extra security group tags | `map` |
{
"CostAllocation": "csvd:infrastructure",
"Environment": "csvd-infrastructure"
}
| 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 |