Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update documentation based on latest terraform-docs which includes module and resource sections #181

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 29 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,29 @@
.terraform
terraform.tfstate
*.tfstate*
terraform.tfvars
# Local .terraform directories
**/.terraform/*

# Terraform lockfile
.terraform.lock.hcl

# .tfstate files
*.tfstate
*.tfstate.*

# Crash log files
crash.log

# Exclude all .tfvars files, which are likely to contain sentitive data, such as
# password, private keys, and other secrets. These should not be part of version
# control as they are data points which are potentially sensitive and subject
# to change depending on the environment.
*.tfvars

# Ignore override files as they are usually used to override resources locally and so
# are not checked in
override.tf
override.tf.json
*_override.tf
*_override.tf.json

# Ignore CLI configuration files
.terraformrc
terraform.rc
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
repos:
- repo: git://github.com/antonbabenko/pre-commit-terraform
rev: v1.44.0
rev: v1.46.0
hooks:
- id: terraform_fmt
- id: terraform_validate
Expand All @@ -21,6 +21,6 @@ repos:
- '--args=--only=terraform_standard_module_structure'
- '--args=--only=terraform_workspace_remote'
- repo: git://github.com/pre-commit/pre-commit-hooks
rev: v3.3.0
rev: v3.4.0
hooks:
- id: check-merge-conflict
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,20 @@ module "lb" {
|------|---------|
| aws | >= 2.54 |

## Modules

No Modules.

## Resources

| Name |
|------|
| [aws_lb_listener_certificate](https://registry.terraform.io/providers/hashicorp/aws/2.54/docs/resources/lb_listener_certificate) |
| [aws_lb_listener_rule](https://registry.terraform.io/providers/hashicorp/aws/2.54/docs/resources/lb_listener_rule) |
| [aws_lb_listener](https://registry.terraform.io/providers/hashicorp/aws/2.54/docs/resources/lb_listener) |
| [aws_lb_target_group](https://registry.terraform.io/providers/hashicorp/aws/2.54/docs/resources/lb_target_group) |
| [aws_lb](https://registry.terraform.io/providers/hashicorp/aws/2.54/docs/resources/lb) |

## Inputs

| Name | Description | Type | Default | Required |
Expand Down Expand Up @@ -359,7 +373,6 @@ module "lb" {
| this\_lb\_dns\_name | The DNS name of the load balancer. |
| this\_lb\_id | The ID and ARN of the load balancer we created. |
| this\_lb\_zone\_id | The zone\_id of the load balancer to assist with creating DNS records. |

<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

## Authors
Expand Down
22 changes: 21 additions & 1 deletion examples/complete-alb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,27 @@ Note that this example may create resources which cost money. Run `terraform des
| aws | >= 2.54 |
| random | >= 2.0 |

## Modules

| Name | Source | Version |
|------|--------|---------|
| acm | terraform-aws-modules/acm/aws | ~> 2.0 |
| alb | ../../ | |
| lb_disabled | ../../ | |
| security_group | terraform-aws-modules/security-group/aws | ~> 3.0 |

## Resources

| Name |
|------|
| [aws_cognito_user_pool_client](https://registry.terraform.io/providers/hashicorp/aws/2.54/docs/resources/cognito_user_pool_client) |
| [aws_cognito_user_pool_domain](https://registry.terraform.io/providers/hashicorp/aws/2.54/docs/resources/cognito_user_pool_domain) |
| [aws_cognito_user_pool](https://registry.terraform.io/providers/hashicorp/aws/2.54/docs/resources/cognito_user_pool) |
| [aws_route53_zone](https://registry.terraform.io/providers/hashicorp/aws/2.54/docs/data-sources/route53_zone) |
| [aws_subnet_ids](https://registry.terraform.io/providers/hashicorp/aws/2.54/docs/data-sources/subnet_ids) |
| [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/2.54/docs/data-sources/vpc) |
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/2.0/docs/resources/pet) |

## Inputs

No input.
Expand All @@ -50,5 +71,4 @@ No input.
| this\_lb\_dns\_name | The DNS name of the load balancer. |
| this\_lb\_id | The ID and ARN of the load balancer we created. |
| this\_lb\_zone\_id | The zone\_id of the load balancer to assist with creating DNS records. |

<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
18 changes: 17 additions & 1 deletion examples/complete-nlb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,23 @@ Note that this example may create resources which cost money. Run `terraform des
| aws | >= 2.54 |
| random | >= 2.0 |

## Modules

| Name | Source | Version |
|------|--------|---------|
| acm | terraform-aws-modules/acm/aws | ~> 2.0 |
| nlb | ../../ | |

## Resources

| Name |
|------|
| [aws_eip](https://registry.terraform.io/providers/hashicorp/aws/2.54/docs/resources/eip) |
| [aws_route53_zone](https://registry.terraform.io/providers/hashicorp/aws/2.54/docs/data-sources/route53_zone) |
| [aws_subnet_ids](https://registry.terraform.io/providers/hashicorp/aws/2.54/docs/data-sources/subnet_ids) |
| [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/2.54/docs/data-sources/vpc) |
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/2.0/docs/resources/pet) |

## Inputs

No input.
Expand All @@ -50,5 +67,4 @@ No input.
| this\_lb\_dns\_name | The DNS name of the load balancer. |
| this\_lb\_id | The ID and ARN of the load balancer we created. |
| this\_lb\_zone\_id | The zone\_id of the load balancer to assist with creating DNS records. |

<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->