Skip to content

Commit 6fcf2be

Browse files
MeNsaaHMeNsaaH
authored
docs: Add note about pgp_key when create_iam_login_profile is set (#69)
1 parent fa394da commit 6fcf2be

File tree

20 files changed

+115
-12
lines changed

20 files changed

+115
-12
lines changed

‎examples/iam-account/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ $ terraform apply
1515
Run `terraform destroy` when you don't need these resources.
1616

1717
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
18+
## Requirements
19+
20+
No requirements.
21+
1822
## Providers
1923

2024
No provider.

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

+4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ $ terraform apply
1515
Run `terraform destroy` when you don't need these resources.
1616

1717
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
18+
## Requirements
19+
20+
No requirements.
21+
1822
## Providers
1923

2024
No provider.

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

+4
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ $ terraform apply
1717
Run `terraform destroy` when you don't need these resources.
1818

1919
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
20+
## Requirements
21+
22+
No requirements.
23+
2024
## Providers
2125

2226
No provider.

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

+4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ $ terraform apply
1515
Run `terraform destroy` when you don't need these resources.
1616

1717
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
18+
## Requirements
19+
20+
No requirements.
21+
1822
## Providers
1923

2024
| Name | Version |

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

+4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ $ terraform apply
1515
Run `terraform destroy` when you don't need these resources.
1616

1717
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
18+
## Requirements
19+
20+
No requirements.
21+
1822
## Providers
1923

2024
No provider.

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

+4
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ $ terraform apply
1717
Run `terraform destroy` when you don't need these resources.
1818

1919
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
20+
## Requirements
21+
22+
No requirements.
23+
2024
## Providers
2125

2226
No provider.

‎examples/iam-group-with-assumable-roles-policy/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ $ terraform apply
1515
Run `terraform destroy` when you don't need these resources.
1616

1717
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
18+
## Requirements
19+
20+
No requirements.
21+
1822
## Providers
1923

2024
| Name | Version |

‎examples/iam-group-with-policies/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ $ terraform apply
1515
Run `terraform destroy` when you don't need these resources.
1616

1717
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
18+
## Requirements
19+
20+
No requirements.
21+
1822
## Providers
1923

2024
| Name | Version |

‎examples/iam-policy/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ $ terraform apply
1515
Run `terraform destroy` when you don't need these resources.
1616

1717
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
18+
## Requirements
19+
20+
No requirements.
21+
1822
## Providers
1923

2024
| Name | Version |

‎examples/iam-user/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ $ terraform apply
1616
Run `terraform destroy` when you don't need these resources.
1717

1818
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
19+
## Requirements
20+
21+
No requirements.
22+
1923
## Providers
2024

2125
No provider.

‎modules/iam-account/README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@ Import successful!
2222
```
2323

2424
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
25+
## Requirements
26+
27+
| Name | Version |
28+
|------|---------|
29+
| terraform | ~> 0.12.6 |
30+
| aws | ~> 2.23 |
31+
2532
## Providers
2633

2734
| Name | Version |
@@ -31,15 +38,15 @@ Import successful!
3138
## Inputs
3239

3340
| Name | Description | Type | Default | Required |
34-
|------|-------------|------|---------|:-----:|
41+
|------|-------------|------|---------|:--------:|
3542
| account\_alias | AWS IAM account alias for this account | `string` | n/a | yes |
3643
| allow\_users\_to\_change\_password | Whether to allow users to change their own password | `bool` | `true` | no |
3744
| create\_account\_password\_policy | Whether to create AWS IAM account password policy | `bool` | `true` | no |
3845
| get\_caller\_identity | Whether to get AWS account ID, User ID, and ARN in which Terraform is authorized | `bool` | `true` | no |
3946
| hard\_expiry | Whether users are prevented from setting a new password after their password has expired (i.e. require administrator reset) | `bool` | `false` | no |
4047
| max\_password\_age | The number of days that an user password is valid. | `number` | `0` | no |
4148
| minimum\_password\_length | Minimum length to require for user passwords | `number` | `8` | no |
42-
| password\_reuse\_prevention | The number of previous passwords that users are prevented from reusing | `number` | n/a | yes |
49+
| password\_reuse\_prevention | The number of previous passwords that users are prevented from reusing | `number` | `null` | no |
4350
| require\_lowercase\_characters | Whether to require lowercase characters for user passwords | `bool` | `true` | no |
4451
| require\_numbers | Whether to require numbers for user passwords | `bool` | `true` | no |
4552
| require\_symbols | Whether to require symbols for user passwords | `bool` | `true` | no |

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

+8-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ Creates single IAM role which can be assumed by trusted resources using OpenID C
77
This module supports IAM Roles for kubernetes service accounts as described in the [EKS documentation](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html).
88

99
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
10+
## Requirements
11+
12+
| Name | Version |
13+
|------|---------|
14+
| terraform | ~> 0.12.6 |
15+
| aws | ~> 2.23 |
16+
1017
## Providers
1118

1219
| Name | Version |
@@ -16,7 +23,7 @@ This module supports IAM Roles for kubernetes service accounts as described in t
1623
## Inputs
1724

1825
| Name | Description | Type | Default | Required |
19-
|------|-------------|------|---------|:-----:|
26+
|------|-------------|------|---------|:--------:|
2027
| aws\_account\_id | The AWS account ID where the OIDC provider lives, leave empty to use the account fo the AWS provider | `string` | `""` | no |
2128
| create\_role | Whether to create a role | `bool` | `false` | no |
2229
| max\_session\_duration | Maximum CLI/API session duration in seconds between 3600 and 43200 | `number` | `3600` | no |

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

+8-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ Creates single IAM role which can be assumed by trusted resources.
55
Trusted resources can be any [IAM ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) - typically, AWS accounts and users.
66

77
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
8+
## Requirements
9+
10+
| Name | Version |
11+
|------|---------|
12+
| terraform | ~> 0.12.6 |
13+
| aws | ~> 2.23 |
14+
815
## Providers
916

1017
| Name | Version |
@@ -14,7 +21,7 @@ Trusted resources can be any [IAM ARNs](https://docs.aws.amazon.com/IAM/latest/U
1421
## Inputs
1522

1623
| Name | Description | Type | Default | Required |
17-
|------|-------------|------|---------|:-----:|
24+
|------|-------------|------|---------|:--------:|
1825
| admin\_role\_policy\_arn | Policy ARN to use for admin role | `string` | `"arn:aws:iam::aws:policy/AdministratorAccess"` | no |
1926
| attach\_admin\_policy | Whether to attach an admin policy to a role | `bool` | `false` | no |
2027
| attach\_poweruser\_policy | Whether to attach a poweruser policy to a role | `bool` | `false` | no |

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

+8-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ Creates predefined IAM roles (admin, poweruser and readonly) which can be assume
77
[Enabling SAML 2.0 Federated Users to Access the AWS Management Console](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html)
88

99
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
10+
## Requirements
11+
12+
| Name | Version |
13+
|------|---------|
14+
| terraform | ~> 0.12.6 |
15+
| aws | ~> 2.23 |
16+
1017
## Providers
1118

1219
| Name | Version |
@@ -16,7 +23,7 @@ Creates predefined IAM roles (admin, poweruser and readonly) which can be assume
1623
## Inputs
1724

1825
| Name | Description | Type | Default | Required |
19-
|------|-------------|------|---------|:-----:|
26+
|------|-------------|------|---------|:--------:|
2027
| admin\_role\_name | IAM role with admin access | `string` | `"admin"` | no |
2128
| admin\_role\_path | Path of admin IAM role | `string` | `"/"` | no |
2229
| admin\_role\_permissions\_boundary\_arn | Permissions boundary ARN to use for admin role | `string` | `""` | no |

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

+8-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ Creates predefined IAM roles (admin, poweruser and readonly) which can be assume
55
Trusted resources can be any [IAM ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) - typically, AWS accounts and users.
66

77
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
8+
## Requirements
9+
10+
| Name | Version |
11+
|------|---------|
12+
| terraform | ~> 0.12.6 |
13+
| aws | ~> 2.23 |
14+
815
## Providers
916

1017
| Name | Version |
@@ -14,7 +21,7 @@ Trusted resources can be any [IAM ARNs](https://docs.aws.amazon.com/IAM/latest/U
1421
## Inputs
1522

1623
| Name | Description | Type | Default | Required |
17-
|------|-------------|------|---------|:-----:|
24+
|------|-------------|------|---------|:--------:|
1825
| admin\_role\_name | IAM role with admin access | `string` | `"admin"` | no |
1926
| admin\_role\_path | Path of admin IAM role | `string` | `"/"` | no |
2027
| admin\_role\_permissions\_boundary\_arn | Permissions boundary ARN to use for admin role | `string` | `""` | no |

‎modules/iam-group-with-assumable-roles-policy/README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
Creates IAM group with users who are allowed to assume IAM roles. This is typically done in resource AWS account where IAM users can jump into from IAM AWS account.
44

55
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
6+
## Requirements
7+
8+
| Name | Version |
9+
|------|---------|
10+
| terraform | ~> 0.12.6 |
11+
| aws | ~> 2.23 |
12+
613
## Providers
714

815
| Name | Version |
@@ -12,7 +19,7 @@ Creates IAM group with users who are allowed to assume IAM roles. This is typica
1219
## Inputs
1320

1421
| Name | Description | Type | Default | Required |
15-
|------|-------------|------|---------|:-----:|
22+
|------|-------------|------|---------|:--------:|
1623
| assumable\_roles | List of IAM roles ARNs which can be assumed by the group | `list(string)` | `[]` | no |
1724
| group\_users | List of IAM users to have in an IAM group which can assume the role | `list(string)` | `[]` | no |
1825
| name | Name of IAM policy and IAM group | `string` | n/a | yes |

‎modules/iam-group-with-policies/README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
Creates IAM group with specified IAM policies, and add users into a group.
44

55
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
6+
## Requirements
7+
8+
| Name | Version |
9+
|------|---------|
10+
| terraform | ~> 0.12.6 |
11+
| aws | ~> 2.23 |
12+
613
## Providers
714

815
| Name | Version |
@@ -12,7 +19,7 @@ Creates IAM group with specified IAM policies, and add users into a group.
1219
## Inputs
1320

1421
| Name | Description | Type | Default | Required |
15-
|------|-------------|------|---------|:-----:|
22+
|------|-------------|------|---------|:--------:|
1623
| attach\_iam\_self\_management\_policy | Whether to attach IAM policy which allows IAM users to manage their credentials and MFA | `bool` | `true` | no |
1724
| aws\_account\_id | AWS account id to use inside IAM policies. If empty, current AWS account ID will be used. | `string` | `""` | no |
1825
| create\_group | Whether to create IAM group | `bool` | `true` | no |

‎modules/iam-policy/README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
Creates IAM policy.
44

55
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
6+
## Requirements
7+
8+
| Name | Version |
9+
|------|---------|
10+
| terraform | ~> 0.12.6 |
11+
| aws | ~> 2.23 |
12+
613
## Providers
714

815
| Name | Version |
@@ -12,7 +19,7 @@ Creates IAM policy.
1219
## Inputs
1320

1421
| Name | Description | Type | Default | Required |
15-
|------|-------------|------|---------|:-----:|
22+
|------|-------------|------|---------|:--------:|
1623
| description | The description of the policy | `string` | `"IAM Policy"` | no |
1724
| name | The name of the policy | `string` | `""` | no |
1825
| path | The path of the policy in IAM | `string` | `"/"` | no |

‎modules/iam-user/README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ This module outputs commands and PGP messages which can be decrypted either usin
1919
- `keybase_secret_key_pgp_message`
2020

2121
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
22+
## Requirements
23+
24+
| Name | Version |
25+
|------|---------|
26+
| terraform | ~> 0.12.6 |
27+
| aws | ~> 2.23 |
28+
2229
## Providers
2330

2431
| Name | Version |
@@ -28,7 +35,7 @@ This module outputs commands and PGP messages which can be decrypted either usin
2835
## Inputs
2936

3037
| Name | Description | Type | Default | Required |
31-
|------|-------------|------|---------|:-----:|
38+
|------|-------------|------|---------|:--------:|
3239
| create\_iam\_access\_key | Whether to create IAM access key | `bool` | `true` | no |
3340
| create\_iam\_user\_login\_profile | Whether to create IAM user login profile | `bool` | `true` | no |
3441
| create\_user | Whether to create the IAM user | `bool` | `true` | no |
@@ -38,7 +45,7 @@ This module outputs commands and PGP messages which can be decrypted either usin
3845
| password\_reset\_required | Whether the user should be forced to reset the generated password on first login. | `bool` | `true` | no |
3946
| path | Desired path for the IAM user | `string` | `"/"` | no |
4047
| permissions\_boundary | The ARN of the policy that is used to set the permissions boundary for the user. | `string` | `""` | no |
41-
| pgp\_key | Either a base-64 encoded PGP public key, or a keybase username in the form keybase:username. Used to encrypt password and access key. | `string` | `""` | no |
48+
| pgp\_key | Either a base-64 encoded PGP public key, or a keybase username in the form `keybase:username`. Used to encrypt password and access key. `pgp_key` is required when `create_iam_user_login_profile` is set to `true` | `string` | `""` | no |
4249
| ssh\_key\_encoding | Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM | `string` | `"SSH"` | no |
4350
| ssh\_public\_key | The SSH public key. The public key must be encoded in ssh-rsa format or PEM format | `string` | `""` | no |
4451
| tags | A map of tags to add to all resources. | `map(string)` | `{}` | no |

‎modules/iam-user/variables.tf

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ variable "force_destroy" {
3434
}
3535

3636
variable "pgp_key" {
37-
description = "Either a base-64 encoded PGP public key, or a keybase username in the form keybase:username. Used to encrypt password and access key."
37+
description = "Either a base-64 encoded PGP public key, or a keybase username in the form `keybase:username`. Used to encrypt password and access key. `pgp_key` is required when `create_iam_user_login_profile` is set to `true`"
3838
type = string
3939
default = ""
4040
}

0 commit comments

Comments
 (0)