Skip to content

Commit f73832c

Browse files
committed
updated pre-commit terraform hook
1 parent 011f04f commit f73832c

File tree

3 files changed

+22
-12
lines changed

3 files changed

+22
-12
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ repos:
33
- id: terraform_docs
44
- id: terraform_fmt
55
repo: https://github.com/antonbabenko/pre-commit-terraform.git
6-
rev: v1.14.0
6+
rev: v1.46.0
77

88
- hooks:
99
- id: go-fmt

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,12 @@ Invoking the commands defined below creates an ECS task definition with the foll
107107
By default, this module creates a task definition with a single container definition. To create a task definition with multiple container definitions, refer to the documentation of the [`merge`](modules/merge) module.
108108

109109
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
110+
## Requirements
111+
112+
| Name | Version |
113+
|------|---------|
114+
| terraform | >= 0.12 |
115+
110116
## Providers
111117

112118
| Name | Version |
@@ -117,9 +123,9 @@ By default, this module creates a task definition with a single container defini
117123
## Inputs
118124

119125
| Name | Description | Type | Default | Required |
120-
|------|-------------|------|---------|:-----:|
126+
|------|-------------|------|---------|:--------:|
121127
| command | The command that is passed to the container | `list(string)` | `[]` | no |
122-
| cpu | The number of cpu units reserved for the container | `number` | `0` | no |
128+
| cpu | The number of cpu units reserved for the container | `number` | `256` | no |
123129
| disableNetworking | When this parameter is true, networking is disabled within the container | `bool` | `false` | no |
124130
| dnsSearchDomains | A list of DNS search domains that are presented to the container | `list(string)` | `[]` | no |
125131
| dnsServers | A list of DNS servers that are presented to the container | `list(string)` | `[]` | no |
@@ -129,24 +135,24 @@ By default, this module creates a task definition with a single container defini
129135
| environment | The environment variables to pass to a container | `list(map(string))` | `[]` | no |
130136
| essential | If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped | `bool` | `true` | no |
131137
| execution\_role\_arn | The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume | `string` | `""` | no |
132-
| extraHosts | A list of hostnames and IP address mappings to append to the /etc/hosts file on the container | `list(string)` | `[]` | no |
138+
| extraHosts | A list of hostnames and IP address mappings to append to the /etc/hosts file on the container | <pre>list(object({<br> ipAddress = string<br> hostname = string<br> }))</pre> | `[]` | no |
133139
| family | You must specify a family for a task definition, which allows you to track multiple versions of the same task definition | `any` | n/a | yes |
140+
| firelensConfiguration | The FireLens configuration for the container | `any` | `{}` | no |
134141
| healthCheck | The health check command and associated configuration parameters for the container | `any` | `{}` | no |
135142
| hostname | The hostname to use for your container | `string` | `""` | no |
136143
| image | The image used to start a container | `string` | `""` | no |
137144
| interactive | When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated | `bool` | `false` | no |
138-
| ipc\_mode | The IPC resource namespace to use for the containers in the task | `string` | `"host"` | no |
145+
| ipc\_mode | The IPC resource namespace to use for the containers in the task | `any` | `null` | no |
139146
| links | The link parameter allows containers to communicate with each other without the need for port mappings | `list(string)` | `[]` | no |
140147
| linuxParameters | Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities | `any` | `{}` | no |
141148
| logConfiguration | The log configuration specification for the container | `any` | `{}` | no |
142-
| firelensConfiguration | The FireLens configuration for the container | `any` | `{}` | no |
143-
| memory | The hard limit (in MiB) of memory to present to the container | `number` | `0` | no |
149+
| memory | The hard limit (in MiB) of memory to present to the container | `number` | `512` | no |
144150
| memoryReservation | The soft limit (in MiB) of memory to reserve for the container | `number` | `0` | no |
145151
| mountPoints | The mount points for data volumes in your container | `list(any)` | `[]` | no |
146152
| name | The name of a container | `string` | `""` | no |
147153
| network\_mode | The Docker networking mode to use for the containers in the task | `string` | `"bridge"` | no |
148-
| pid\_mode | The process namespace to use for the containers in the task | `string` | `"host"` | no |
149-
| placement\_constraints | An array of placement constraint objects to use for the task | `list(string)` | `[]` | no |
154+
| pid\_mode | The process namespace to use for the containers in the task | `any` | `null` | no |
155+
| placement\_constraints | An array of placement constraint objects to use for the task | <pre>list(object({<br> type = string<br> expression = string<br> }))</pre> | `[]` | no |
150156
| portMappings | The list of port mappings for the container | `list(any)` | `[]` | no |
151157
| privileged | When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user) | `bool` | `false` | no |
152158
| pseudoTerminal | When this parameter is true, a TTY is allocated | `bool` | `false` | no |
@@ -155,14 +161,14 @@ By default, this module creates a task definition with a single container defini
155161
| repositoryCredentials | The private repository authentication credentials to use | `map(string)` | `{}` | no |
156162
| requires\_compatibilities | The launch type required by the task | `list(string)` | `[]` | no |
157163
| resourceRequirements | The type and amount of a resource to assign to a container | `list(string)` | `[]` | no |
158-
| secrets | The secrets to pass to the container | `list(string)` | `[]` | no |
164+
| secrets | The secrets to pass to the container | `list(map(string))` | `[]` | no |
159165
| systemControls | A list of namespaced kernel parameters to set in the container | `list(string)` | `[]` | no |
160166
| tags | The metadata that you apply to the task definition to help you categorize and organize them | `map(string)` | `{}` | no |
161167
| task\_role\_arn | The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume | `string` | `""` | no |
162168
| ulimits | A list of ulimits to set in the container | `list(any)` | `[]` | no |
163169
| user | The user name to use inside the container | `string` | `""` | no |
164170
| volumes | A list of volume definitions in JSON format that containers in your task may use | `list(any)` | `[]` | no |
165-
| volumesFrom | Data volumes to mount from another container | `list(string)` | `[]` | no |
171+
| volumesFrom | Data volumes to mount from another container | <pre>list(object({<br> readOnly = bool<br> sourceContainer = string<br> }))</pre> | `[]` | no |
166172
| workingDirectory | The working directory in which to run commands inside the container | `string` | `""` | no |
167173

168174
## Outputs

modules/merge/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,14 +115,18 @@ resource "aws_ecs_task_definition" "hello_world" {
115115
**Note:** The `register_task_definition` flag for both task definitions is required; otherwise a task definition containing a single container definition is registered created for both the `wordpress` and `mysql` services.
116116

117117
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
118+
## Requirements
119+
120+
No requirements.
121+
118122
## Providers
119123

120124
No provider.
121125

122126
## Inputs
123127

124128
| Name | Description | Type | Default | Required |
125-
|------|-------------|------|---------|:-----:|
129+
|------|-------------|------|---------|:--------:|
126130
| container\_definitions | A list of container definitions in JSON format that describe the different containers that make up your task | `list` | `[]` | no |
127131

128132
## Outputs

0 commit comments

Comments
 (0)