From f2dd8c9da6e09519ff00e79f5ca545e3665ab821 Mon Sep 17 00:00:00 2001 From: badra001 Date: Wed, 10 Nov 2021 12:26:42 -0500 Subject: [PATCH] add readmes --- examples/typical/.off/README.md | 29 +++++++++++++++ .../typical/apps/test-instances/README.md | 37 +++++++++++++++++++ 2 files changed, 66 insertions(+) create mode 100644 examples/typical/.off/README.md create mode 100644 examples/typical/apps/test-instances/README.md diff --git a/examples/typical/.off/README.md b/examples/typical/.off/README.md new file mode 100644 index 0000000..24843cc --- /dev/null +++ b/examples/typical/.off/README.md @@ -0,0 +1,29 @@ +## Requirements + +No requirements. + +## Providers + +| Name | Version | +|------|---------| +| [aws.do2-govcloud\_west\_vpc3-dev](#provider\_aws.do2-govcloud\_west\_vpc3-dev) | n/a | + +## Modules + +| Name | Source | Version | +|------|--------|---------| +| [do2-govcloud\_west\_vpc3-dev](#module\_do2-govcloud\_west\_vpc3-dev) | git@github.e.it.census.gov:terraform-modules/aws-vpc-setup.git//peer | n/a | + +## Resources + +| Name | Type | +|------|------| +| [aws_vpc.do2-govcloud_west_vpc3-dev](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source | + +## Inputs + +No inputs. + +## Outputs + +No outputs. diff --git a/examples/typical/apps/test-instances/README.md b/examples/typical/apps/test-instances/README.md new file mode 100644 index 0000000..085d2a2 --- /dev/null +++ b/examples/typical/apps/test-instances/README.md @@ -0,0 +1,37 @@ + +## Requirements + +No requirements. + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | n/a | +| [null](#provider\_null) | n/a | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [aws_instance.test](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/instance) | resource | +| [aws_key_pair.keypair](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/key_pair) | resource | +| [null_resource.generate_keypair](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource | +| [aws_ami.test](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | data source | +| [aws_security_groups.test](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/security_groups) | data source | + +## Inputs + +No inputs. + +## Outputs + +| Name | Description | +|------|-------------| +| [keypair](#output\_keypair) | EC2 keypair for test instances | +| [test\_instances](#output\_test\_instances) | Details about test instances | + \ No newline at end of file