Skip to content

Commit

Permalink
update usage
Browse files Browse the repository at this point in the history
  • Loading branch information
badra001 committed Jun 28, 2019
1 parent eb5d267 commit 4c527eb
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 2 deletions.
41 changes: 41 additions & 0 deletions ois-scanner/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# About

This describes how to use the aws-common-securit-grous 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

```code
module "ois-scanner" {
source = "git::https://vc1.csvd.census.gov/terraform-modules/aws-common-security-groups.git/ois-scanner"
vpc_id = "${var.vpc_id}"
tags = { }
# Name, CostAllocation, and Environment are pre-set
}
```

## 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):

### tags

Description: Extra security group tags

Type: `map`

Default: `<map>`

13 changes: 11 additions & 2 deletions ois-scanner/main.tf
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
/**
* Usage:
* # About
*
* This describes how to use the aws-common-securit-grous 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
*
* ```code
* module "ois-scanner" {
* source = "aws-common-security-groups/ois-scanner"
* source = "git::https://vc1.csvd.census.gov/terraform-modules/aws-common-security-groups.git/ois-scanner"
*
* vpc_id = "${var.vpc_id}"
* tags = { }
* # Name, CostAllocation, and Environment are pre-set
* }
* ```
*/

locals {
Expand Down

0 comments on commit 4c527eb

Please sign in to comment.