Skip to content

T
terraform-aws-vpc
Commit 57604d2e authored by Anton Babenko's avatar Anton Babenko
Browse files
Options

Updated pre-commit version with new terraform-docs script

parent 7c29b247
Expand all Show whitespace changes
Inline Side-by-side
Showing with 167 additions and 177 deletions
.pre-commit-config.yaml
View file @ 57604d2e
repos: repos:
- repo: git://github.com/antonbabenko/pre-commit-terraform - repo: git://github.com/antonbabenko/pre-commit-terraform
rev: v1.7.2 rev: v1.7.4
hooks: hooks:
- id: terraform_fmt - id: terraform_fmt
- id: terraform_docs - id: terraform_docs
- repo: git://github.com/pre-commit/pre-commit-hooks - repo: git://github.com/pre-commit/pre-commit-hooks
rev: v1.2.3 rev: v2.0.0
hooks: hooks:
- id: check-merge-conflict - id: check-merge-conflict
README.md
View file @ 57604d2e
This diff is collapsed.
examples/complete-vpc/README.md
View file @ 57604d2e
...@@ -17,18 +17,17 @@ $ terraform apply ...@@ -17,18 +17,17 @@ $ terraform apply
Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources. Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| database_subnets | List of IDs of database subnets | | database\_subnets | List of IDs of database subnets |
| elasticache_subnets | List of IDs of elasticache subnets | | elasticache\_subnets | List of IDs of elasticache subnets |
| intra_subnets | List of IDs of intra subnets | | intra\_subnets | List of IDs of intra subnets |
| nat_public_ips | NAT gateways | | nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
| private_subnets | Subnets | | private\_subnets | List of IDs of private subnets |
| public_subnets | List of IDs of public subnets | | public\_subnets | List of IDs of public subnets |
| redshift_subnets | List of IDs of redshift subnets | | redshift\_subnets | List of IDs of redshift subnets |
| vpc_id | VPC | | vpc\_id | The ID of the VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
examples/issue-108-route-already-exists/README.md
View file @ 57604d2e
...@@ -19,16 +19,15 @@ $ terraform apply ...@@ -19,16 +19,15 @@ $ terraform apply
Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources. Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| database_subnets | List of IDs of database subnets | | database\_subnets | List of IDs of database subnets |
| elasticache_subnets | List of IDs of elasticache subnets | | elasticache\_subnets | List of IDs of elasticache subnets |
| nat_public_ips | NAT gateways | | nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
| private_subnets | Subnets | | private\_subnets | List of IDs of private subnets |
| public_subnets | List of IDs of public subnets | | public\_subnets | List of IDs of public subnets |
| vpc_id | VPC | | vpc\_id | The ID of the VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
examples/issue-44-asymmetric-private-subnets/README.md
View file @ 57604d2e
...@@ -17,16 +17,15 @@ $ terraform apply ...@@ -17,16 +17,15 @@ $ terraform apply
Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources. Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| database_subnets | List of IDs of database subnets | | database\_subnets | List of IDs of database subnets |
| elasticache_subnets | List of IDs of elasticache subnets | | elasticache\_subnets | List of IDs of elasticache subnets |
| nat_public_ips | NAT gateways | | nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
| private_subnets | Subnets | | private\_subnets | List of IDs of private subnets |
| public_subnets | List of IDs of public subnets | | public\_subnets | List of IDs of public subnets |
| vpc_id | VPC | | vpc\_id | The ID of the VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
examples/issue-46-no-private-subnets/README.md
View file @ 57604d2e
...@@ -17,16 +17,15 @@ $ terraform apply ...@@ -17,16 +17,15 @@ $ terraform apply
Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources. Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| database_subnets | List of IDs of database subnets | | database\_subnets | List of IDs of database subnets |
| elasticache_subnets | List of IDs of elasticache subnets | | elasticache\_subnets | List of IDs of elasticache subnets |
| nat_public_ips | NAT gateways | | nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
| private_subnets | Subnets | | private\_subnets | List of IDs of private subnets |
| public_subnets | List of IDs of public subnets | | public\_subnets | List of IDs of public subnets |
| vpc_id | VPC | | vpc\_id | The ID of the VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
examples/manage-default-vpc/README.md
View file @ 57604d2e
...@@ -17,12 +17,11 @@ $ terraform apply ...@@ -17,12 +17,11 @@ $ terraform apply
Run `terraform destroy` when you don't need these resources. Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| default_vpc_cidr_block | The CIDR block of the VPC | | default\_vpc\_cidr\_block | The CIDR block of the VPC |
| default_vpc_id | Default VPC | | default\_vpc\_id | The ID of the Default VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
examples/secondary-cidr-blocks/README.md
View file @ 57604d2e
...@@ -17,16 +17,15 @@ $ terraform apply ...@@ -17,16 +17,15 @@ $ terraform apply
Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources. Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| nat_public_ips | NAT gateways | | nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
| private_subnets | Subnets | | private\_subnets | List of IDs of private subnets |
| public_subnets | List of IDs of public subnets | | public\_subnets | List of IDs of public subnets |
| vpc_cidr_block | CIDR blocks | | vpc\_cidr\_block | The CIDR block of the VPC |
| vpc_id | VPC | | vpc\_id | The ID of the VPC |
| vpc_secondary_cidr_blocks | List of secondary CIDR blocks of the VPC | | vpc\_secondary\_cidr\_blocks | List of secondary CIDR blocks of the VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
examples/simple-vpc/README.md
View file @ 57604d2e
...@@ -17,15 +17,14 @@ $ terraform apply ...@@ -17,15 +17,14 @@ $ terraform apply
Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources. Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| nat_public_ips | NAT gateways | | nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
| private_subnets | Subnets | | private\_subnets | List of IDs of private subnets |
| public_subnets | List of IDs of public subnets | | public\_subnets | List of IDs of public subnets |
| vpc_cidr_block | CIDR blocks | | vpc\_cidr\_block | The CIDR block of the VPC |
| vpc_id | VPC | | vpc\_id | The ID of the VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
examples/test_fixture/README.md
View file @ 57604d2e
...@@ -21,12 +21,11 @@ Finished in 4.25 seconds (files took 2.75 seconds to load) ...@@ -21,12 +21,11 @@ Finished in 4.25 seconds (files took 2.75 seconds to load)
This will destroy any existing test resources, create the resources afresh, run the tests, report back, and destroy the resources. This will destroy any existing test resources, create the resources afresh, run the tests, report back, and destroy the resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Inputs ## Inputs
| Name | Description | Type | Default | Required | | Name | Description | Type | Default | Required |
|------|-------------|:----:|:-----:|:-----:| |------|-------------|:----:|:-----:|:-----:|
| region | | string | `eu-west-1` | no | | region | - | string | `eu-west-1` | no |
## Outputs ## Outputs
......
examples/vpc-separate-private-route-tables/README.md
View file @ 57604d2e
...@@ -17,17 +17,16 @@ $ terraform apply ...@@ -17,17 +17,16 @@ $ terraform apply
Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources. Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Outputs ## Outputs
| Name | Description | | Name | Description |
|------|-------------| |------|-------------|
| database_subnets | List of IDs of database subnets | | database\_subnets | List of IDs of database subnets |
| elasticache_subnets | List of IDs of elasticache subnets | | elasticache\_subnets | List of IDs of elasticache subnets |
| nat_public_ips | NAT gateways | | nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
| private_subnets | Subnets | | private\_subnets | List of IDs of private subnets |
| public_subnets | List of IDs of public subnets | | public\_subnets | List of IDs of public subnets |
| redshift_subnets | List of IDs of elasticache subnets | | redshift\_subnets | List of IDs of elasticache subnets |
| vpc_id | VPC | | vpc\_id | The ID of the VPC |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment