Skip to content

Commit 0e5434a

Browse files
github-actions[bot]github-actions[bot]
committed
docs: auto update terraform docs
1 parent bced356 commit 0e5434a

File tree

7 files changed

+296
-25
lines changed

7 files changed

+296
-25
lines changed

‎README.md

+212
Large diffs are not rendered by default.

‎examples/runner-default/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -43,18 +43,18 @@ No output.
4343

4444
| Name | Version |
4545
|------|---------|
46-
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.15 |
47-
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 3.74 |
48-
| <a name="requirement_local"></a> [local](#requirement\_local) | ~> 2.2 |
46+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1 |
47+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 4.7 |
48+
| <a name="requirement_local"></a> [local](#requirement\_local) | ~> 2 |
4949
| <a name="requirement_null"></a> [null](#requirement\_null) | ~> 3.0 |
5050
| <a name="requirement_random"></a> [random](#requirement\_random) | ~> 3.0 |
51-
| <a name="requirement_tls"></a> [tls](#requirement\_tls) | ~> 3.3 |
51+
| <a name="requirement_tls"></a> [tls](#requirement\_tls) | ~> 3 |
5252

5353
## Providers
5454

5555
| Name | Version |
5656
|------|---------|
57-
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 3.74 |
57+
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 4.7 |
5858
| <a name="provider_null"></a> [null](#provider\_null) | ~> 3.0 |
5959

6060
## Modules

‎examples/runner-docker/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -46,18 +46,18 @@ No output.
4646

4747
| Name | Version |
4848
|------|---------|
49-
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.15 |
50-
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 3.74 |
51-
| <a name="requirement_local"></a> [local](#requirement\_local) | ~> 2.2 |
49+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1 |
50+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 4.7 |
51+
| <a name="requirement_local"></a> [local](#requirement\_local) | ~> 2 |
5252
| <a name="requirement_null"></a> [null](#requirement\_null) | ~> 3.0 |
5353
| <a name="requirement_random"></a> [random](#requirement\_random) | ~> 3.0 |
54-
| <a name="requirement_tls"></a> [tls](#requirement\_tls) | ~> 3.3 |
54+
| <a name="requirement_tls"></a> [tls](#requirement\_tls) | ~> 3 |
5555

5656
## Providers
5757

5858
| Name | Version |
5959
|------|---------|
60-
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 3.74 |
60+
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 4.7 |
6161

6262
## Modules
6363

‎examples/runner-multi-region/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -88,18 +88,18 @@ No output.
8888

8989
| Name | Version |
9090
|------|---------|
91-
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.15 |
92-
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 3.74 |
93-
| <a name="requirement_local"></a> [local](#requirement\_local) | ~> 2.2 |
91+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1 |
92+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 4.7 |
93+
| <a name="requirement_local"></a> [local](#requirement\_local) | ~> 2 |
9494
| <a name="requirement_null"></a> [null](#requirement\_null) | ~> 3.0 |
9595
| <a name="requirement_random"></a> [random](#requirement\_random) | ~> 3.0 |
96-
| <a name="requirement_tls"></a> [tls](#requirement\_tls) | ~> 3.3 |
96+
| <a name="requirement_tls"></a> [tls](#requirement\_tls) | ~> 3 |
9797

9898
## Providers
9999

100100
| Name | Version |
101101
|------|---------|
102-
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 3.74 |
102+
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 4.7 |
103103

104104
## Modules
105105

‎examples/runner-pre-registered/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,18 @@ No output.
3232

3333
| Name | Version |
3434
|------|---------|
35-
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.15 |
36-
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 3.74 |
37-
| <a name="requirement_local"></a> [local](#requirement\_local) | ~> 2.2 |
35+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1 |
36+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 4.7 |
37+
| <a name="requirement_local"></a> [local](#requirement\_local) | ~> 2 |
3838
| <a name="requirement_null"></a> [null](#requirement\_null) | ~> 3.0 |
3939
| <a name="requirement_random"></a> [random](#requirement\_random) | ~> 3.0 |
40-
| <a name="requirement_tls"></a> [tls](#requirement\_tls) | ~> 3.3 |
40+
| <a name="requirement_tls"></a> [tls](#requirement\_tls) | ~> 3 |
4141

4242
## Providers
4343

4444
| Name | Version |
4545
|------|---------|
46-
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 3.74 |
46+
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 4.7 |
4747

4848
## Modules
4949

‎examples/runner-public/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -45,18 +45,18 @@ No output.
4545

4646
| Name | Version |
4747
|------|---------|
48-
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.15 |
49-
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 3.74 |
50-
| <a name="requirement_local"></a> [local](#requirement\_local) | ~> 2.2 |
48+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1 |
49+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 4.7 |
50+
| <a name="requirement_local"></a> [local](#requirement\_local) | ~> 2 |
5151
| <a name="requirement_null"></a> [null](#requirement\_null) | ~> 3.0 |
5252
| <a name="requirement_random"></a> [random](#requirement\_random) | ~> 3.0 |
53-
| <a name="requirement_tls"></a> [tls](#requirement\_tls) | ~> 3.3 |
53+
| <a name="requirement_tls"></a> [tls](#requirement\_tls) | ~> 3 |
5454

5555
## Providers
5656

5757
| Name | Version |
5858
|------|---------|
59-
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 3.74 |
59+
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 4.7 |
6060
| <a name="provider_null"></a> [null](#provider\_null) | ~> 3.0 |
6161

6262
## Modules

‎modules/cache/README.md

+59
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,62 @@ module "runner" {
2525
}
2626
```
2727
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
28+
29+
<!-- BEGIN_TF_DOCS -->
30+
## Requirements
31+
32+
| Name | Version |
33+
|------|---------|
34+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.15 |
35+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.0 |
36+
37+
## Providers
38+
39+
| Name | Version |
40+
|------|---------|
41+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.0 |
42+
| <a name="provider_random"></a> [random](#provider\_random) | n/a |
43+
44+
## Modules
45+
46+
No modules.
47+
48+
## Resources
49+
50+
| Name | Type |
51+
|------|------|
52+
| [aws_iam_policy.docker_machine_cache](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
53+
| [aws_s3_bucket.build_cache](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket) | resource |
54+
| [aws_s3_bucket_acl.build_cache_acl](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_acl) | resource |
55+
| [aws_s3_bucket_lifecycle_configuration.build_cache_versioning](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_lifecycle_configuration) | resource |
56+
| [aws_s3_bucket_public_access_block.build_cache_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_public_access_block) | resource |
57+
| [aws_s3_bucket_server_side_encryption_configuration.build_cache_encryption](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_server_side_encryption_configuration) | resource |
58+
| [aws_s3_bucket_versioning.build_cache_versioning](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/s3_bucket_versioning) | resource |
59+
| [random_string.s3_suffix](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string) | resource |
60+
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
61+
62+
## Inputs
63+
64+
| Name | Description | Type | Default | Required |
65+
|------|-------------|------|---------|:--------:|
66+
| <a name="input_arn_format"></a> [arn\_format](#input\_arn\_format) | ARN format to be used. May be changed to support deployment in GovCloud/China regions. | `string` | `"arn:aws"` | no |
67+
| <a name="input_cache_bucket_name_include_account_id"></a> [cache\_bucket\_name\_include\_account\_id](#input\_cache\_bucket\_name\_include\_account\_id) | Boolean to add current account ID to cache bucket name. | `bool` | `true` | no |
68+
| <a name="input_cache_bucket_prefix"></a> [cache\_bucket\_prefix](#input\_cache\_bucket\_prefix) | Prefix for s3 cache bucket name. | `string` | `""` | no |
69+
| <a name="input_cache_bucket_set_random_suffix"></a> [cache\_bucket\_set\_random\_suffix](#input\_cache\_bucket\_set\_random\_suffix) | Random string suffix for s3 cache bucket | `bool` | `false` | no |
70+
| <a name="input_cache_bucket_versioning"></a> [cache\_bucket\_versioning](#input\_cache\_bucket\_versioning) | Boolean used to enable versioning on the cache bucket, false by default. | `bool` | `false` | no |
71+
| <a name="input_cache_expiration_days"></a> [cache\_expiration\_days](#input\_cache\_expiration\_days) | Number of days before cache objects expires. | `number` | `1` | no |
72+
| <a name="input_cache_lifecycle_clear"></a> [cache\_lifecycle\_clear](#input\_cache\_lifecycle\_clear) | Enable the rule to cleanup the cache for expired objects. | `bool` | `true` | no |
73+
| <a name="input_cache_lifecycle_prefix"></a> [cache\_lifecycle\_prefix](#input\_cache\_lifecycle\_prefix) | Object key prefix identifying one or more objects to which the clean up rule applies. | `string` | `"runner/"` | no |
74+
| <a name="input_create_cache_bucket"></a> [create\_cache\_bucket](#input\_create\_cache\_bucket) | This module is by default included in the runner module. To disable the creation of the bucket this parameter can be disabled. | `bool` | `true` | no |
75+
| <a name="input_environment"></a> [environment](#input\_environment) | A name that identifies the environment, used as prefix and for tagging. | `string` | n/a | yes |
76+
| <a name="input_name_iam_objects"></a> [name\_iam\_objects](#input\_name\_iam\_objects) | Set the name prefix of all AWS IAM resources created by this module | `string` | `""` | no |
77+
| <a name="input_tags"></a> [tags](#input\_tags) | Map of tags that will be added to created resources. By default resources will be tagged with name and environment. | `map(string)` | `{}` | no |
78+
79+
## Outputs
80+
81+
| Name | Description |
82+
|------|-------------|
83+
| <a name="output_arn"></a> [arn](#output\_arn) | The ARN of the created bucket. |
84+
| <a name="output_bucket"></a> [bucket](#output\_bucket) | Name of the created bucket. |
85+
| <a name="output_policy_arn"></a> [policy\_arn](#output\_policy\_arn) | Policy for users of the cache (bucket). |
86+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)