|
1 | 1 | # Module - Runner binaries syncer
|
2 | 2 |
|
3 |
| -This module creates a lambda that will sync GitHub action binary to a S3 bucket, the lambda will be triggered via a CloudWatch event. The distribution is cached to avoid the latency of downloading the distribution during the setup. |
| 3 | +This module creates a lambda that will sync GitHub action binary to a S3 bucket, the lambda will be triggered via a CloudWatch event. The distribution is cached to avoid the latency of downloading the distribution during the setup. After deployment the lambda will be triggered via an S3 object created at deployment time. |
4 | 4 |
|
5 | 5 | ## Usages
|
6 | 6 |
|
@@ -41,31 +41,31 @@ No requirements.
|
41 | 41 | ## Providers
|
42 | 42 |
|
43 | 43 | | Name | Version |
|
44 |
| -|------|---------| |
45 |
| -| aws | n/a | |
| 44 | +| ---- | ------- | |
| 45 | +| aws | n/a | |
46 | 46 |
|
47 | 47 | ## Inputs
|
48 | 48 |
|
49 |
| -| Name | Description | Type | Default | Required | |
50 |
| -|------|-------------|------|---------|:--------:| |
51 |
| -| aws\_region | AWS region. | `string` | n/a | yes | |
52 |
| -| distribution\_bucket\_name | Bucket for storing the action runner distribution. | `string` | n/a | yes | |
53 |
| -| environment | A name that identifies the environment, used as prefix and for tagging. | `string` | n/a | yes | |
54 |
| -| lambda\_schedule\_expression | Scheduler expression for action runner binary syncer. | `string` | `"cron(27 * * * ? *)"` | no | |
55 |
| -| lambda\_timeout | Time out of the lambda in seconds. | `number` | `300` | no | |
56 |
| -| lambda\_zip | File location of the lambda zip file. | `string` | `null` | no | |
57 |
| -| role\_path | The path that will be added to the role, if not set the environment name will be used. | `string` | `null` | no | |
58 |
| -| role\_permissions\_boundary | Permissions boundary that will be added to the created role for the lambda. | `string` | `null` | no | |
59 |
| -| tags | Map of tags that will be added to created resources. By default resources will be tagged with name and environment. | `map(string)` | `{}` | no | |
| 49 | +| Name | Description | Type | Default | Required | |
| 50 | +| ---------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------- | ---------------------- | :------: | |
| 51 | +| aws\_region | AWS region. | `string` | n/a | yes | |
| 52 | +| distribution\_bucket\_name | Bucket for storing the action runner distribution. | `string` | n/a | yes | |
| 53 | +| environment | A name that identifies the environment, used as prefix and for tagging. | `string` | n/a | yes | |
| 54 | +| lambda\_schedule\_expression | Scheduler expression for action runner binary syncer. | `string` | `"cron(27 * * * ? *)"` | no | |
| 55 | +| lambda\_timeout | Time out of the lambda in seconds. | `number` | `300` | no | |
| 56 | +| lambda\_zip | File location of the lambda zip file. | `string` | `null` | no | |
| 57 | +| role\_path | The path that will be added to the role, if not set the environment name will be used. | `string` | `null` | no | |
| 58 | +| role\_permissions\_boundary | Permissions boundary that will be added to the created role for the lambda. | `string` | `null` | no | |
| 59 | +| tags | Map of tags that will be added to created resources. By default resources will be tagged with name and environment. | `map(string)` | `{}` | no | |
60 | 60 |
|
61 | 61 | ## Outputs
|
62 | 62 |
|
63 |
| -| Name | Description | |
64 |
| -|------|-------------| |
65 |
| -| bucket | n/a | |
66 |
| -| lambda | n/a | |
67 |
| -| lambda\_role | n/a | |
68 |
| -| runner\_distribution\_object\_key | n/a | |
| 63 | +| Name | Description | |
| 64 | +| --------------------------------- | ----------- | |
| 65 | +| bucket | n/a | |
| 66 | +| lambda | n/a | |
| 67 | +| lambda\_role | n/a | |
| 68 | +| runner\_distribution\_object\_key | n/a | |
69 | 69 |
|
70 | 70 | <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
|
71 | 71 |
|
|
0 commit comments