Skip to content

Commit bf9ad7c

Browse files
esacteksabesacteksab
authored
Merge pull request #101 from trussworks/barry-update-validate-yml
ci: fixing README, and validate.yml
2 parents 15a570b + 519999c commit bf9ad7c

File tree

2 files changed

+23
-80
lines changed

2 files changed

+23
-80
lines changed

‎.github/workflows/validate.yml‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,3 @@ on:
1111
jobs:
1212
validate-tf:
1313
uses: trussworks/shared-actions/.github/workflows/validate-tf.yml@main
14-
with:
15-
go-version: 1.19

‎README.md‎

Lines changed: 23 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -26,26 +26,26 @@ module "bootstrap" {
2626
}
2727
```
2828

29-
<!--- BEGIN_TF_DOCS --->
29+
<!-- BEGIN_TF_DOCS -->
3030
## Requirements
3131

3232
| Name | Version |
3333
|------|---------|
34-
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13.0 |
35-
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.0, < 4.0 |
34+
| terraform | >= 0.13.0 |
35+
| aws | >= 3.75.0 |
3636

3737
## Providers
3838

3939
| Name | Version |
4040
|------|---------|
41-
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.0, < 4.0 |
41+
| aws | >= 3.75.0 |
4242

4343
## Modules
4444

4545
| Name | Source | Version |
4646
|------|--------|---------|
47-
| <a name="module_terraform_state_bucket"></a> [terraform\_state\_bucket](#module\_terraform\_state\_bucket) | trussworks/s3-private-bucket/aws | ~> 3.6.0 |
48-
| <a name="module_terraform_state_bucket_logs"></a> [terraform\_state\_bucket\_logs](#module\_terraform\_state\_bucket\_logs) | trussworks/logs/aws | ~> 10.3.0 |
47+
| terraform\_state\_bucket | trussworks/s3-private-bucket/aws | ~> 4.3.0 |
48+
| terraform\_state\_bucket\_logs | trussworks/logs/aws | ~> 14.2.0 |
4949

5050
## Resources
5151

@@ -58,28 +58,28 @@ module "bootstrap" {
5858

5959
| Name | Description | Type | Default | Required |
6060
|------|-------------|------|---------|:--------:|
61-
| <a name="input_account_alias"></a> [account\_alias](#input\_account\_alias) | The desired AWS account alias. | `string` | n/a | yes |
62-
| <a name="input_bucket_purpose"></a> [bucket\_purpose](#input\_bucket\_purpose) | Name to identify the bucket's purpose | `string` | `"tf-state"` | no |
63-
| <a name="input_dynamodb_point_in_time_recovery"></a> [dynamodb\_point\_in\_time\_recovery](#input\_dynamodb\_point\_in\_time\_recovery) | Point-in-time recovery options | `bool` | `false` | no |
64-
| <a name="input_dynamodb_table_name"></a> [dynamodb\_table\_name](#input\_dynamodb\_table\_name) | Name of the DynamoDB Table for locking Terraform state. | `string` | `"terraform-state-lock"` | no |
65-
| <a name="input_dynamodb_table_tags"></a> [dynamodb\_table\_tags](#input\_dynamodb\_table\_tags) | Tags of the DynamoDB Table for locking Terraform state. | `map(string)` | <pre>{<br> "Automation": "Terraform",<br> "Name": "terraform-state-lock"<br>}</pre> | no |
66-
| <a name="input_enable_s3_public_access_block"></a> [enable\_s3\_public\_access\_block](#input\_enable\_s3\_public\_access\_block) | Bool for toggling whether the s3 public access block resource should be enabled. | `bool` | `true` | no |
67-
| <a name="input_log_bucket_versioning"></a> [log\_bucket\_versioning](#input\_log\_bucket\_versioning) | Bool for toggling versioning for log bucket | `bool` | `false` | no |
68-
| <a name="input_log_name"></a> [log\_name](#input\_log\_name) | Log name (for backwards compatibility this can be modified to logs) | `string` | `"log"` | no |
69-
| <a name="input_log_retention"></a> [log\_retention](#input\_log\_retention) | Log retention of access logs of state bucket. | `number` | `90` | no |
70-
| <a name="input_manage_account_alias"></a> [manage\_account\_alias](#input\_manage\_account\_alias) | Manage the account alias as a resource. Set to 'false' if this behavior is not desired. | `bool` | `true` | no |
71-
| <a name="input_region"></a> [region](#input\_region) | AWS region. | `string` | n/a | yes |
72-
| <a name="input_state_bucket_tags"></a> [state\_bucket\_tags](#input\_state\_bucket\_tags) | Tags to associate with the bucket storing the Terraform state files | `map(string)` | <pre>{<br> "Automation": "Terraform"<br>}</pre> | no |
61+
| account\_alias | The desired AWS account alias. | `string` | n/a | yes |
62+
| bucket\_purpose | Name to identify the bucket's purpose | `string` | `"tf-state"` | no |
63+
| dynamodb\_point\_in\_time\_recovery | Point-in-time recovery options | `bool` | `false` | no |
64+
| dynamodb\_table\_name | Name of the DynamoDB Table for locking Terraform state. | `string` | `"terraform-state-lock"` | no |
65+
| dynamodb\_table\_tags | Tags of the DynamoDB Table for locking Terraform state. | `map(string)` | ```{ "Automation": "Terraform", "Name": "terraform-state-lock" }``` | no |
66+
| enable\_s3\_public\_access\_block | Bool for toggling whether the s3 public access block resource should be enabled. | `bool` | `true` | no |
67+
| log\_bucket\_tags | Tags to associate with the bucket storing the Terraform state bucket logs | `map(string)` | ```{ "Automation": "Terraform" }``` | no |
68+
| log\_bucket\_versioning | A string that indicates the versioning status for the log bucket. | `string` | `"Disabled"` | no |
69+
| log\_name | Log name (for backwards compatibility this can be modified to logs) | `string` | `"log"` | no |
70+
| log\_retention | Log retention of access logs of state bucket. | `number` | `90` | no |
71+
| manage\_account\_alias | Manage the account alias as a resource. Set to 'false' if this behavior is not desired. | `bool` | `true` | no |
72+
| region | AWS region. | `string` | n/a | yes |
73+
| state\_bucket\_tags | Tags to associate with the bucket storing the Terraform state files | `map(string)` | ```{ "Automation": "Terraform" }``` | no |
7374

7475
## Outputs
7576

7677
| Name | Description |
7778
|------|-------------|
78-
| <a name="output_dynamodb_table"></a> [dynamodb\_table](#output\_dynamodb\_table) | The name of the dynamo db table |
79-
| <a name="output_logging_bucket"></a> [logging\_bucket](#output\_logging\_bucket) | The logging\_bucket name |
80-
| <a name="output_state_bucket"></a> [state\_bucket](#output\_state\_bucket) | The state\_bucket name |
81-
82-
<!--- END_TF_DOCS --->
79+
| dynamodb\_table | The name of the dynamo db table |
80+
| logging\_bucket | The logging\_bucket name |
81+
| state\_bucket | The state\_bucket name |
82+
<!-- END_TF_DOCS -->
8383

8484
## Bootstrapping
8585

@@ -281,58 +281,3 @@ actions need to be performed.
281281
git checkout -b update_bootstrap_for_<ORG>_<NAME>
282282
git commit -am"Update the bootstrap stack to use the bootstrap terraform module"
283283
```
284-
285-
<!-- BEGIN_TF_DOCS -->
286-
## Requirements
287-
288-
| Name | Version |
289-
|------|---------|
290-
| terraform | >= 0.13.0 |
291-
| aws | >= 3.75.0 |
292-
293-
## Providers
294-
295-
| Name | Version |
296-
|------|---------|
297-
| aws | >= 3.75.0 |
298-
299-
## Modules
300-
301-
| Name | Source | Version |
302-
|------|--------|---------|
303-
| terraform\_state\_bucket | trussworks/s3-private-bucket/aws | ~> 4.3.0 |
304-
| terraform\_state\_bucket\_logs | trussworks/logs/aws | ~> 14.2.0 |
305-
306-
## Resources
307-
308-
| Name | Type |
309-
|------|------|
310-
| [aws_dynamodb_table.terraform_state_lock](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/dynamodb_table) | resource |
311-
| [aws_iam_account_alias.alias](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_account_alias) | resource |
312-
313-
## Inputs
314-
315-
| Name | Description | Type | Default | Required |
316-
|------|-------------|------|---------|:--------:|
317-
| account\_alias | The desired AWS account alias. | `string` | n/a | yes |
318-
| bucket\_purpose | Name to identify the bucket's purpose | `string` | `"tf-state"` | no |
319-
| dynamodb\_point\_in\_time\_recovery | Point-in-time recovery options | `bool` | `false` | no |
320-
| dynamodb\_table\_name | Name of the DynamoDB Table for locking Terraform state. | `string` | `"terraform-state-lock"` | no |
321-
| dynamodb\_table\_tags | Tags of the DynamoDB Table for locking Terraform state. | `map(string)` | ```{ "Automation": "Terraform", "Name": "terraform-state-lock" }``` | no |
322-
| enable\_s3\_public\_access\_block | Bool for toggling whether the s3 public access block resource should be enabled. | `bool` | `true` | no |
323-
| log\_bucket\_tags | Tags to associate with the bucket storing the Terraform state bucket logs | `map(string)` | ```{ "Automation": "Terraform" }``` | no |
324-
| log\_bucket\_versioning | A string that indicates the versioning status for the log bucket. | `string` | `"Disabled"` | no |
325-
| log\_name | Log name (for backwards compatibility this can be modified to logs) | `string` | `"log"` | no |
326-
| log\_retention | Log retention of access logs of state bucket. | `number` | `90` | no |
327-
| manage\_account\_alias | Manage the account alias as a resource. Set to 'false' if this behavior is not desired. | `bool` | `true` | no |
328-
| region | AWS region. | `string` | n/a | yes |
329-
| state\_bucket\_tags | Tags to associate with the bucket storing the Terraform state files | `map(string)` | ```{ "Automation": "Terraform" }``` | no |
330-
331-
## Outputs
332-
333-
| Name | Description |
334-
|------|-------------|
335-
| dynamodb\_table | The name of the dynamo db table |
336-
| logging\_bucket | The logging\_bucket name |
337-
| state\_bucket | The state\_bucket name |
338-
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)