Skip to content

Commit 013320e

Browse files
bryantbiggsbryantbiggs
authored
chore: update documentation and pin terraform_docs version to avoid future changes (#142)
1 parent e968c2a commit 013320e

File tree

23 files changed

+490
-470
lines changed

23 files changed

+490
-470
lines changed

‎.github/workflows/pre-commit.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ jobs:
9494
- name: Install pre-commit dependencies
9595
run: |
9696
pip install pre-commit
97-
curl -L "$(curl -s https://api.github.com/repos/terraform-docs/terraform-docs/releases/latest | grep -o -E "https://.+?-linux-amd64" | head -n1)" > terraform-docs && chmod +x terraform-docs && sudo mv terraform-docs /usr/bin/
97+
curl -L "$(curl -s https://api.github.com/repos/terraform-docs/terraform-docs/releases/latest | grep -o -E "https://.+?-v0.12.0-linux-amd64" | head -n1)" > terraform-docs && chmod +x terraform-docs && sudo mv terraform-docs /usr/bin/
9898
curl -L "$(curl -s https://api.github.com/repos/terraform-linters/tflint/releases/latest | grep -o -E "https://.+?_linux_amd64.zip")" > tflint.zip && unzip tflint.zip && rm tflint.zip && sudo mv tflint /usr/bin/
9999
- name: Execute pre-commit
100100
# Run all pre-commit checks on max version supported

‎.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
repos:
22
- repo: git://github.com/antonbabenko/pre-commit-terraform
3-
rev: v1.47.0
3+
rev: v1.48.0
44
hooks:
55
- id: terraform_fmt
66
- id: terraform_validate

‎examples/iam-account/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,31 +19,31 @@ Run `terraform destroy` when you don't need these resources.
1919

2020
| Name | Version |
2121
|------|---------|
22-
| terraform | >= 0.12.6 |
23-
| aws | >= 2.23 |
22+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.6 |
23+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.23 |
2424

2525
## Providers
2626

27-
No provider.
27+
No providers.
2828

2929
## Modules
3030

3131
| Name | Source | Version |
3232
|------|--------|---------|
33-
| iam_account | ../../modules/iam-account | |
33+
| <a name="module_iam_account"></a> [iam\_account](#module\_iam\_account) | ../../modules/iam-account | |
3434

3535
## Resources
3636

3737
No resources.
3838

3939
## Inputs
4040

41-
No input.
41+
No inputs.
4242

4343
## Outputs
4444

4545
| Name | Description |
4646
|------|-------------|
47-
| this\_caller\_identity\_account\_id | The ID of the AWS account |
48-
| this\_iam\_account\_password\_policy\_expire\_passwords | Indicates whether passwords in the account expire. Returns true if max\_password\_age contains a value greater than 0. Returns false if it is 0 or not present. |
47+
| <a name="output_this_caller_identity_account_id"></a> [this\_caller\_identity\_account\_id](#output\_this\_caller\_identity\_account\_id) | The ID of the AWS account |
48+
| <a name="output_this_iam_account_password_policy_expire_passwords"></a> [this\_iam\_account\_password\_policy\_expire\_passwords](#output\_this\_iam\_account\_password\_policy\_expire\_passwords) | Indicates whether passwords in the account expire. Returns true if max\_password\_age contains a value greater than 0. Returns false if it is 0 or not present. |
4949
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/iam-assumable-role-with-oidc/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,32 +19,32 @@ Run `terraform destroy` when you don't need these resources.
1919

2020
| Name | Version |
2121
|------|---------|
22-
| terraform | >= 0.12.6 |
23-
| aws | >= 2.23 |
22+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.6 |
23+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.23 |
2424

2525
## Providers
2626

27-
No provider.
27+
No providers.
2828

2929
## Modules
3030

3131
| Name | Source | Version |
3232
|------|--------|---------|
33-
| iam_assumable_role_admin | ../../modules/iam-assumable-role-with-oidc | |
33+
| <a name="module_iam_assumable_role_admin"></a> [iam\_assumable\_role\_admin](#module\_iam\_assumable\_role\_admin) | ../../modules/iam-assumable-role-with-oidc | |
3434

3535
## Resources
3636

3737
No resources.
3838

3939
## Inputs
4040

41-
No input.
41+
No inputs.
4242

4343
## Outputs
4444

4545
| Name | Description |
4646
|------|-------------|
47-
| this\_iam\_role\_arn | ARN of IAM role |
48-
| this\_iam\_role\_name | Name of IAM role |
49-
| this\_iam\_role\_path | Path of IAM role |
47+
| <a name="output_this_iam_role_arn"></a> [this\_iam\_role\_arn](#output\_this\_iam\_role\_arn) | ARN of IAM role |
48+
| <a name="output_this_iam_role_name"></a> [this\_iam\_role\_name](#output\_this\_iam\_role\_name) | Name of IAM role |
49+
| <a name="output_this_iam_role_path"></a> [this\_iam\_role\_path](#output\_this\_iam\_role\_path) | Path of IAM role |
5050
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/iam-assumable-role-with-saml/README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,36 +19,37 @@ Run `terraform destroy` when you don't need these resources.
1919

2020
| Name | Version |
2121
|------|---------|
22-
| terraform | >= 0.12.6 |
23-
| aws | >= 2.23 |
22+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.6 |
23+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.23 |
2424

2525
## Providers
2626

2727
| Name | Version |
2828
|------|---------|
29-
| aws | >= 2.23 |
29+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 2.23 |
3030

3131
## Modules
3232

3333
| Name | Source | Version |
3434
|------|--------|---------|
35-
| iam_assumable_role_admin | ../../modules/iam-assumable-role-with-saml | |
35+
| <a name="module_iam_assumable_role_admin"></a> [iam\_assumable\_role\_admin](#module\_iam\_assumable\_role\_admin) | ../../modules/iam-assumable-role-with-saml | |
3636

3737
## Resources
3838

39-
| Name |
40-
|------|
41-
| [aws_iam_saml_provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_saml_provider) |
39+
| Name | Type |
40+
|------|------|
41+
| [aws_iam_saml_provider.idp_saml](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_saml_provider) | resource |
42+
| [aws_iam_saml_provider.second_idp_saml](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_saml_provider) | resource |
4243

4344
## Inputs
4445

45-
No input.
46+
No inputs.
4647

4748
## Outputs
4849

4950
| Name | Description |
5051
|------|-------------|
51-
| this\_iam\_role\_arn | ARN of IAM role |
52-
| this\_iam\_role\_name | Name of IAM role |
53-
| this\_iam\_role\_path | Path of IAM role |
52+
| <a name="output_this_iam_role_arn"></a> [this\_iam\_role\_arn](#output\_this\_iam\_role\_arn) | ARN of IAM role |
53+
| <a name="output_this_iam_role_name"></a> [this\_iam\_role\_name](#output\_this\_iam\_role\_name) | Name of IAM role |
54+
| <a name="output_this_iam_role_path"></a> [this\_iam\_role\_path](#output\_this\_iam\_role\_path) | Path of IAM role |
5455
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/iam-assumable-role/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,36 +21,36 @@ Run `terraform destroy` when you don't need these resources.
2121

2222
| Name | Version |
2323
|------|---------|
24-
| terraform | >= 0.12.6 |
25-
| aws | >= 2.23 |
24+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.6 |
25+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.23 |
2626

2727
## Providers
2828

29-
No provider.
29+
No providers.
3030

3131
## Modules
3232

3333
| Name | Source | Version |
3434
|------|--------|---------|
35-
| iam_assumable_role_admin | ../../modules/iam-assumable-role | |
36-
| iam_assumable_role_custom | ../../modules/iam-assumable-role | |
37-
| iam_assumable_role_sts | ../../modules/iam-assumable-role | |
38-
| iam_policy | ../../modules/iam-policy | |
35+
| <a name="module_iam_assumable_role_admin"></a> [iam\_assumable\_role\_admin](#module\_iam\_assumable\_role\_admin) | ../../modules/iam-assumable-role | |
36+
| <a name="module_iam_assumable_role_custom"></a> [iam\_assumable\_role\_custom](#module\_iam\_assumable\_role\_custom) | ../../modules/iam-assumable-role | |
37+
| <a name="module_iam_assumable_role_sts"></a> [iam\_assumable\_role\_sts](#module\_iam\_assumable\_role\_sts) | ../../modules/iam-assumable-role | |
38+
| <a name="module_iam_policy"></a> [iam\_policy](#module\_iam\_policy) | ../../modules/iam-policy | |
3939

4040
## Resources
4141

4242
No resources.
4343

4444
## Inputs
4545

46-
No input.
46+
No inputs.
4747

4848
## Outputs
4949

5050
| Name | Description |
5151
|------|-------------|
52-
| role\_requires\_mfa | Whether admin IAM role requires MFA |
53-
| this\_iam\_role\_arn | ARN of IAM role |
54-
| this\_iam\_role\_name | Name of IAM role |
55-
| this\_iam\_role\_path | Path of IAM role |
52+
| <a name="output_role_requires_mfa"></a> [role\_requires\_mfa](#output\_role\_requires\_mfa) | Whether admin IAM role requires MFA |
53+
| <a name="output_this_iam_role_arn"></a> [this\_iam\_role\_arn](#output\_this\_iam\_role\_arn) | ARN of IAM role |
54+
| <a name="output_this_iam_role_name"></a> [this\_iam\_role\_name](#output\_this\_iam\_role\_name) | Name of IAM role |
55+
| <a name="output_this_iam_role_path"></a> [this\_iam\_role\_path](#output\_this\_iam\_role\_path) | Path of IAM role |
5656
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/iam-assumable-roles-with-saml/README.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,44 +19,45 @@ Run `terraform destroy` when you don't need these resources.
1919

2020
| Name | Version |
2121
|------|---------|
22-
| terraform | >= 0.12.6 |
23-
| aws | >= 2.23 |
22+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.6 |
23+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.23 |
2424

2525
## Providers
2626

2727
| Name | Version |
2828
|------|---------|
29-
| aws | >= 2.23 |
29+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 2.23 |
3030

3131
## Modules
3232

3333
| Name | Source | Version |
3434
|------|--------|---------|
35-
| iam_assumable_roles_with_saml | ../../modules/iam-assumable-roles-with-saml | |
36-
| iam_assumable_roles_with_saml_custom | ../../modules/iam-assumable-roles-with-saml | |
37-
| iam_assumable_roles_with_saml_second_provider | ../../modules/iam-assumable-roles-with-saml | |
35+
| <a name="module_iam_assumable_roles_with_saml"></a> [iam\_assumable\_roles\_with\_saml](#module\_iam\_assumable\_roles\_with\_saml) | ../../modules/iam-assumable-roles-with-saml | |
36+
| <a name="module_iam_assumable_roles_with_saml_custom"></a> [iam\_assumable\_roles\_with\_saml\_custom](#module\_iam\_assumable\_roles\_with\_saml\_custom) | ../../modules/iam-assumable-roles-with-saml | |
37+
| <a name="module_iam_assumable_roles_with_saml_second_provider"></a> [iam\_assumable\_roles\_with\_saml\_second\_provider](#module\_iam\_assumable\_roles\_with\_saml\_second\_provider) | ../../modules/iam-assumable-roles-with-saml | |
3838

3939
## Resources
4040

41-
| Name |
42-
|------|
43-
| [aws_iam_saml_provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_saml_provider) |
41+
| Name | Type |
42+
|------|------|
43+
| [aws_iam_saml_provider.idp_saml](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_saml_provider) | resource |
44+
| [aws_iam_saml_provider.second_idp_saml](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_saml_provider) | resource |
4445

4546
## Inputs
4647

47-
No input.
48+
No inputs.
4849

4950
## Outputs
5051

5152
| Name | Description |
5253
|------|-------------|
53-
| admin\_iam\_role\_arn | ARN of admin IAM role |
54-
| admin\_iam\_role\_name | Name of admin IAM role |
55-
| admin\_iam\_role\_path | Path of admin IAM role |
56-
| poweruser\_iam\_role\_arn | ARN of poweruser IAM role |
57-
| poweruser\_iam\_role\_name | Name of poweruser IAM role |
58-
| poweruser\_iam\_role\_path | Path of poweruser IAM role |
59-
| readonly\_iam\_role\_arn | ARN of readonly IAM role |
60-
| readonly\_iam\_role\_name | Name of readonly IAM role |
61-
| readonly\_iam\_role\_path | Path of readonly IAM role |
54+
| <a name="output_admin_iam_role_arn"></a> [admin\_iam\_role\_arn](#output\_admin\_iam\_role\_arn) | ARN of admin IAM role |
55+
| <a name="output_admin_iam_role_name"></a> [admin\_iam\_role\_name](#output\_admin\_iam\_role\_name) | Name of admin IAM role |
56+
| <a name="output_admin_iam_role_path"></a> [admin\_iam\_role\_path](#output\_admin\_iam\_role\_path) | Path of admin IAM role |
57+
| <a name="output_poweruser_iam_role_arn"></a> [poweruser\_iam\_role\_arn](#output\_poweruser\_iam\_role\_arn) | ARN of poweruser IAM role |
58+
| <a name="output_poweruser_iam_role_name"></a> [poweruser\_iam\_role\_name](#output\_poweruser\_iam\_role\_name) | Name of poweruser IAM role |
59+
| <a name="output_poweruser_iam_role_path"></a> [poweruser\_iam\_role\_path](#output\_poweruser\_iam\_role\_path) | Path of poweruser IAM role |
60+
| <a name="output_readonly_iam_role_arn"></a> [readonly\_iam\_role\_arn](#output\_readonly\_iam\_role\_arn) | ARN of readonly IAM role |
61+
| <a name="output_readonly_iam_role_name"></a> [readonly\_iam\_role\_name](#output\_readonly\_iam\_role\_name) | Name of readonly IAM role |
62+
| <a name="output_readonly_iam_role_path"></a> [readonly\_iam\_role\_path](#output\_readonly\_iam\_role\_path) | Path of readonly IAM role |
6263
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/iam-assumable-roles/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,41 +19,41 @@ Run `terraform destroy` when you don't need these resources.
1919

2020
| Name | Version |
2121
|------|---------|
22-
| terraform | >= 0.12.6 |
23-
| aws | >= 2.23 |
22+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.6 |
23+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.23 |
2424

2525
## Providers
2626

27-
No provider.
27+
No providers.
2828

2929
## Modules
3030

3131
| Name | Source | Version |
3232
|------|--------|---------|
33-
| iam_assumable_roles | ../../modules/iam-assumable-roles | |
33+
| <a name="module_iam_assumable_roles"></a> [iam\_assumable\_roles](#module\_iam\_assumable\_roles) | ../../modules/iam-assumable-roles | |
3434

3535
## Resources
3636

3737
No resources.
3838

3939
## Inputs
4040

41-
No input.
41+
No inputs.
4242

4343
## Outputs
4444

4545
| Name | Description |
4646
|------|-------------|
47-
| admin\_iam\_role\_arn | ARN of admin IAM role |
48-
| admin\_iam\_role\_name | Name of admin IAM role |
49-
| admin\_iam\_role\_path | Path of admin IAM role |
50-
| admin\_iam\_role\_requires\_mfa | Whether admin IAM role requires MFA |
51-
| poweruser\_iam\_role\_arn | ARN of poweruser IAM role |
52-
| poweruser\_iam\_role\_name | Name of poweruser IAM role |
53-
| poweruser\_iam\_role\_path | Path of poweruser IAM role |
54-
| poweruser\_iam\_role\_requires\_mfa | Whether poweruser IAM role requires MFA |
55-
| readonly\_iam\_role\_arn | ARN of readonly IAM role |
56-
| readonly\_iam\_role\_name | Name of readonly IAM role |
57-
| readonly\_iam\_role\_path | Path of readonly IAM role |
58-
| readonly\_iam\_role\_requires\_mfa | Whether readonly IAM role requires MFA |
47+
| <a name="output_admin_iam_role_arn"></a> [admin\_iam\_role\_arn](#output\_admin\_iam\_role\_arn) | ARN of admin IAM role |
48+
| <a name="output_admin_iam_role_name"></a> [admin\_iam\_role\_name](#output\_admin\_iam\_role\_name) | Name of admin IAM role |
49+
| <a name="output_admin_iam_role_path"></a> [admin\_iam\_role\_path](#output\_admin\_iam\_role\_path) | Path of admin IAM role |
50+
| <a name="output_admin_iam_role_requires_mfa"></a> [admin\_iam\_role\_requires\_mfa](#output\_admin\_iam\_role\_requires\_mfa) | Whether admin IAM role requires MFA |
51+
| <a name="output_poweruser_iam_role_arn"></a> [poweruser\_iam\_role\_arn](#output\_poweruser\_iam\_role\_arn) | ARN of poweruser IAM role |
52+
| <a name="output_poweruser_iam_role_name"></a> [poweruser\_iam\_role\_name](#output\_poweruser\_iam\_role\_name) | Name of poweruser IAM role |
53+
| <a name="output_poweruser_iam_role_path"></a> [poweruser\_iam\_role\_path](#output\_poweruser\_iam\_role\_path) | Path of poweruser IAM role |
54+
| <a name="output_poweruser_iam_role_requires_mfa"></a> [poweruser\_iam\_role\_requires\_mfa](#output\_poweruser\_iam\_role\_requires\_mfa) | Whether poweruser IAM role requires MFA |
55+
| <a name="output_readonly_iam_role_arn"></a> [readonly\_iam\_role\_arn](#output\_readonly\_iam\_role\_arn) | ARN of readonly IAM role |
56+
| <a name="output_readonly_iam_role_name"></a> [readonly\_iam\_role\_name](#output\_readonly\_iam\_role\_name) | Name of readonly IAM role |
57+
| <a name="output_readonly_iam_role_path"></a> [readonly\_iam\_role\_path](#output\_readonly\_iam\_role\_path) | Path of readonly IAM role |
58+
| <a name="output_readonly_iam_role_requires_mfa"></a> [readonly\_iam\_role\_requires\_mfa](#output\_readonly\_iam\_role\_requires\_mfa) | Whether readonly IAM role requires MFA |
5959
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/iam-group-complete/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,35 +21,35 @@ Run `terraform destroy` when you don't need these resources.
2121

2222
| Name | Version |
2323
|------|---------|
24-
| terraform | >= 0.12.6 |
25-
| aws | >= 2.23 |
24+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.6 |
25+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.23 |
2626

2727
## Providers
2828

29-
No provider.
29+
No providers.
3030

3131
## Modules
3232

3333
| Name | Source | Version |
3434
|------|--------|---------|
35-
| iam_group_complete | ../../modules/iam-group-with-assumable-roles-policy | |
36-
| iam_group_complete_with_custom_policy | ../../modules/iam-group-with-policies | |
37-
| iam_user1 | ../../modules/iam-user | |
38-
| iam_user2 | ../../modules/iam-user | |
35+
| <a name="module_iam_group_complete"></a> [iam\_group\_complete](#module\_iam\_group\_complete) | ../../modules/iam-group-with-assumable-roles-policy | |
36+
| <a name="module_iam_group_complete_with_custom_policy"></a> [iam\_group\_complete\_with\_custom\_policy](#module\_iam\_group\_complete\_with\_custom\_policy) | ../../modules/iam-group-with-policies | |
37+
| <a name="module_iam_user1"></a> [iam\_user1](#module\_iam\_user1) | ../../modules/iam-user | |
38+
| <a name="module_iam_user2"></a> [iam\_user2](#module\_iam\_user2) | ../../modules/iam-user | |
3939

4040
## Resources
4141

4242
No resources.
4343

4444
## Inputs
4545

46-
No input.
46+
No inputs.
4747

4848
## Outputs
4949

5050
| Name | Description |
5151
|------|-------------|
52-
| this\_assumable\_roles | List of ARNs of IAM roles which members of IAM group can assume |
53-
| this\_group\_users | List of IAM users in IAM group |
54-
| this\_policy\_arn | Assume role policy ARN for IAM group |
52+
| <a name="output_this_assumable_roles"></a> [this\_assumable\_roles](#output\_this\_assumable\_roles) | List of ARNs of IAM roles which members of IAM group can assume |
53+
| <a name="output_this_group_users"></a> [this\_group\_users](#output\_this\_group\_users) | List of IAM users in IAM group |
54+
| <a name="output_this_policy_arn"></a> [this\_policy\_arn](#output\_this\_policy\_arn) | Assume role policy ARN for IAM group |
5555
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 commit comments

Comments
 (0)