Skip to content

Commit

Permalink
add readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
badra001 committed Mar 1, 2021
1 parent c723101 commit a4a5651
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 0 deletions.
54 changes: 54 additions & 0 deletions it-linux-base/.x/README.md
Original file line number Diff line number Diff line change
@@ -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` | <pre>{<br> "CostAllocation": "csvd:infrastructure",<br> "Environment": "csvd-infrastructure"<br>}</pre> | 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 |
57 changes: 57 additions & 0 deletions rds-oracle/README.md
Original file line number Diff line number Diff line change
@@ -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)` | <pre>[<br> "0.0.0.0/0"<br>]</pre> | no |
| name | Security group Name | `string` | `"m-oracle-db"` | no |
| networks | List of ingress networks (applies to all ports) | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]</pre> | no |
| tags | Extra security group tags | `map` | <pre>{<br> "CostAllocation": "csvd:infrastructure",<br> "Environment": "csvd-infrastructure"<br>}</pre> | 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 |

0 comments on commit a4a5651

Please sign in to comment.