You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+50-50Lines changed: 50 additions & 50 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,72 +54,72 @@ This software is released under the MIT License (see `LICENSE`).
54
54
55
55
| Name | Description | Type | Default | Required |
56
56
|------|-------------|:----:|:-----:|:-----:|
57
-
| acm\_cert\_domain | Domain name of ACM-managed certificate | string | `` | no |
58
-
| app\_port | Numeric port on which application listens (unnecessary if neither lb_enable_https or lb_enable_http are true) | string | `` | no |
57
+
| acm\_cert\_domain | Domain name of ACM-managed certificate | string |`""`| no |
58
+
| app\_port | Numeric port on which application listens (unnecessary if neither lb_enable_https or lb_enable_http are true) | string |`""`| no |
59
59
| attributes | Suffix name with additional attributes (policy, role, etc.) | list |`<list>`| no |
60
-
| container\_definition | Container definition when not using module default definition | string | `` | no |
61
-
| container\_definition\_additional | Additional parameters to add to container definition. This is a json substring | string | `` | no |
62
-
| delimiter | Delimiter to be used between `name`, `namespaces`, `attributes`, etc. | string |`-`| no |
60
+
| container\_definition | Container definition when not using module default definition | string |`""`| no |
61
+
| container\_definition\_additional | Additional parameters to add to container definition. This is a json substring | string |`""`| no |
62
+
| delimiter | Delimiter to be used between `name`, `namespaces`, `attributes`, etc. | string |`"-"`| no |
63
63
| dns\_aliases | Additional DNS names | list |`<list>`| no |
64
-
| dns\_parent\_zone\_name | DNS name of the parent zone to put this in | string | `` | no |
65
-
| docker\_command | String to override CMD in Docker container (default "") | string | `` | no |
64
+
| dns\_parent\_zone\_name | DNS name of the parent zone to put this in | string |`""`| no |
65
+
| docker\_command | String to override CMD in Docker container (default "") | string |`""`| no |
66
66
| docker\_environment | List of environment maps of format { "name" = "var_name", "value" = "var_value" } | list |`<list>`| no |
67
-
| docker\_image | Docker image to use for task | string | `` | no |
68
-
| docker\_memory | Hard limit on memory use for task container (default 256) | string |`256`| no |
69
-
| docker\_memory\_reservation | Soft limit on memory use for task container (default 128) | string |`128`| no |
67
+
| docker\_image | Docker image to use for task | string |`""`| no |
68
+
| docker\_memory | Hard limit on memory use for task container (default 256) | string |`"256"`| no |
69
+
| docker\_memory\_reservation | Soft limit on memory use for task container (default 128) | string |`"128"`| no |
70
70
| docker\_mount\_points | List of mount point maps of format { "sourceVolume" = "vol_name", "containerPath" = "path", ["readOnly" = "true or false" ] } | list |`<list>`| no |
71
71
| docker\_port\_mappings | List of port mapping maps of format { "containerPort" = integer, [ "hostPort" = integer, "protocol" = "tcp or udp" ] } | list |`<list>`| no |
72
-
| docker\_registry | Docker register for image | string | `` | no |
72
+
| docker\_registry | Docker register for image | string |`""`| no |
73
73
| docker\_volumes | List of volume maps of format { "name" = "var_name", "host_path" = "var_value" } | list |`<list>`| no |
74
-
| ecs\_cluster\_arn | ARN of ECS cluster in which the service will be deployed | string |-| yes |
75
-
| ecs\_data\_volume\_path | Path to volume on ECS node to be defined as a "data" volume (default "/opt/data") | string |`/opt/data`| no |
76
-
| ecs\_deployment\_maximum\_percent | Upper limit in percentage of tasks that can be running during a deployment (default 200) | string |`200`| no |
77
-
| ecs\_deployment\_minimum\_healthy\_percent | Lower limit in percentage of tasks that must remain healthy during a deployment (default 100) | string |`100`| no |
78
-
| ecs\_desired\_count | Desired number of containers in the task (default 1) | string |`1`| no |
79
-
| ecs\_log\_retention | Number of days of ECS task logs to retain (default 3) | string |`3`| no |
74
+
| ecs\_cluster\_arn | ARN of ECS cluster in which the service will be deployed | string |n/a| yes |
75
+
| ecs\_data\_volume\_path | Path to volume on ECS node to be defined as a "data" volume (default "/opt/data") | string |`"/opt/data"`| no |
76
+
| ecs\_deployment\_maximum\_percent | Upper limit in percentage of tasks that can be running during a deployment (default 200) | string |`"200"`| no |
77
+
| ecs\_deployment\_minimum\_healthy\_percent | Lower limit in percentage of tasks that must remain healthy during a deployment (default 100) | string |`"100"`| no |
78
+
| ecs\_desired\_count | Desired number of containers in the task (default 1) | string |`"1"`| no |
79
+
| ecs\_log\_retention | Number of days of ECS task logs to retain (default 3) | string |`"3"`| no |
80
80
| ecs\_placement\_constraints | Placement contraints to use when distributing tasks | list |`<list>`| no |
81
-
| ecs\_placement\_strategy\_field | Container metadata field to use when distributing tasks (default memory) | string |`memory`| no |
82
-
| ecs\_placement\_strategy\_type | Placement strategy to use when distributing tasks (default binpack) | string |`binpack`| no |
83
-
| ecs\_security\_group\_id | Security group ID of ECS cluster in which the service will be deployed | string |-| yes |
84
-
| enable\_lb | Set to false to prevent the module from creating a Load Balancer | string |`true`| no |
85
-
| enabled | Set to false to prevent the module from creating anything | string |`true`| no |
86
-
| environment | Environment (ex: `dev`, `qa`, `stage`, `prod`). (Second or top level namespace. Depending on namespacing options) | string |-| yes |
81
+
| ecs\_placement\_strategy\_field | Container metadata field to use when distributing tasks (default memory) | string |`"memory"`| no |
82
+
| ecs\_placement\_strategy\_type | Placement strategy to use when distributing tasks (default binpack) | string |`"binpack"`| no |
83
+
| ecs\_security\_group\_id | Security group ID of ECS cluster in which the service will be deployed | string |n/a| yes |
84
+
| enable\_lb | Set to false to prevent the module from creating a Load Balancer | string |`"true"`| no |
85
+
| enabled | Set to false to prevent the module from creating anything | string |`"true"`| no |
86
+
| environment | Environment (ex: `dev`, `qa`, `stage`, `prod`). (Second or top level namespace. Depending on namespacing options) | string |n/a| yes |
87
87
| extra\_task\_policy\_arns | List of ARNs of IAM policies to be attached to the ECS task role (in addition to the default policy, so cannot be more than 9 ARNs) | list |`<list>`| no |
88
-
| lb\_cookie\_duration | Duration of LB session stickiness cookie in seconds (default 86400) | string |`86400`| no |
89
-
| lb\_enable\_http | Enable HTTP listener in LB (http or https MUST be enabled) | string |`true`| no |
90
-
| lb\_enable\_https | Enable HTTPS listener in LB (http or https MUST be enabled) | string |`false`| no |
91
-
| lb\_healthcheck\_healthy\_threshold | Number of consecutive successful health checks before marking service as healthy (default 5) | string |`5`| no |
92
-
| lb\_healthcheck\_interval | Time in seconds between LB health checks (default 30) | string |`30`| no |
93
-
| lb\_healthcheck\_matcher | HTTP response codes to accept as healthy (default 200) | string |`200-399`| no |
94
-
| lb\_healthcheck\_path | URI path for LB health checks (default /) | string |`/`| no |
95
-
| lb\_healthcheck\_port | Port for LB to use when connecting health checks (default same as application traffic) | string |`traffic-port`| no |
96
-
| lb\_healthcheck\_protocol | Protocol for LB to use when connecting health checks (default HTTP) | string |`HTTP`| no |
97
-
| lb\_healthcheck\_timeout | Timeout in seconds for LB to use when connecting health checks (default 5) | string |`5`| no |
98
-
| lb\_healthcheck\_unhealthy\_threshold | Number of consecutive failed health checks before marking service as unhealthy (default 2) | string |`5`| no |
99
-
| lb\_https\_ports | HTTPS ports load balancer should listen on | string |`443`| no |
88
+
| lb\_cookie\_duration | Duration of LB session stickiness cookie in seconds (default 86400) | string |`"86400"`| no |
89
+
| lb\_enable\_http | Enable HTTP listener in LB (http or https MUST be enabled) | string |`"true"`| no |
90
+
| lb\_enable\_https | Enable HTTPS listener in LB (http or https MUST be enabled) | string |`"false"`| no |
91
+
| lb\_healthcheck\_healthy\_threshold | Number of consecutive successful health checks before marking service as healthy (default 5) | string |`"5"`| no |
92
+
| lb\_healthcheck\_interval | Time in seconds between LB health checks (default 30) | string |`"30"`| no |
93
+
| lb\_healthcheck\_matcher | HTTP response codes to accept as healthy (default 200) | string |`"200-399"`| no |
94
+
| lb\_healthcheck\_path | URI path for LB health checks (default /) | string |`"/"`| no |
95
+
| lb\_healthcheck\_port | Port for LB to use when connecting health checks (default same as application traffic) | string |`"traffic-port"`| no |
96
+
| lb\_healthcheck\_protocol | Protocol for LB to use when connecting health checks (default HTTP) | string |`"HTTP"`| no |
97
+
| lb\_healthcheck\_timeout | Timeout in seconds for LB to use when connecting health checks (default 5) | string |`"5"`| no |
98
+
| lb\_healthcheck\_unhealthy\_threshold | Number of consecutive failed health checks before marking service as unhealthy (default 2) | string |`"5"`| no |
99
+
| lb\_https\_ports | HTTPS ports load balancer should listen on | string |`"443"`| no |
100
100
| lb\_ingress\_cidr\_blocks | List of ingress CIDR blocks for load balancer | list |`<list>`| no |
101
-
| lb\_internal | Configure LB as internal-only | string |`true`| no |
102
-
| lb\_ports | Ports load balancer should listen on | string |`80`| no |
| lb\_subnet\_ids | VPC subnet IDs in which to create the LB (unnecessary if neither lb_enable_https or lb_enable_http are true) | list |`<list>`| no |
105
-
| lb\_type | Type of LB to create: application, network | string |`application`| no |
106
-
| log\_group\_name | Name for CloudWatch Log Group that will receive collector logs (must be unique, default is created from service_identifier and task_identifier) | string | `` | no |
107
-
| name | Base name for resources | string |-| yes |
108
-
| namespace-env | Prefix name with the environment. If true, format is: <env>-<name> | string |`true`| no |
109
-
| namespace-org | Prefix name with the organization. If true, format is: <org>-<envnamespacedname>. If both env and org namespaces are used, format will be <org>-<env>-<name> | string |`false`| no |
110
-
| network\_mode | Docker network mode for task (default "bridge") | string |`bridge`| no |
111
-
| organization | Organization name (Top level namespace). | string | `` | no |
112
-
| region | AWS region in which ECS cluster is located (default is 'us-east-1') | string |`us-east-1`| no |
113
-
| service\_identifier | Unique identifier for this pganalyze service (used in log prefix, service name etc.) | string |`service`| no |
105
+
| lb\_type | Type of LB to create: application, network | string |`"application"`| no |
106
+
| log\_group\_name | Name for CloudWatch Log Group that will receive collector logs (must be unique, default is created from service_identifier and task_identifier) | string |`""`| no |
107
+
| name | Base name for resources | string |n/a| yes |
108
+
| namespace-env | Prefix name with the environment. If true, format is: <env>-<name> | string |`"true"`| no |
109
+
| namespace-org | Prefix name with the organization. If true, format is: <org>-<envnamespacedname>. If both env and org namespaces are used, format will be <org>-<env>-<name> | string |`"false"`| no |
110
+
| network\_mode | Docker network mode for task (default "bridge") | string |`"bridge"`| no |
111
+
| organization | Organization name (Top level namespace). | string |`""`| no |
112
+
| region | AWS region in which ECS cluster is located (default is 'us-east-1') | string |`"us-east-1"`| no |
113
+
| service\_identifier | Unique identifier for this pganalyze service (used in log prefix, service name etc.) | string |`"service"`| no |
114
114
| tags | A map of additional tags | map |`<map>`| no |
115
-
| task\_identifier | Unique identifier for this pganalyze task (used in log prefix, service name etc.) | string |`task`| no |
116
-
| vpc\_id | ID of VPC in which ECS cluster is located | string |-| yes |
115
+
| task\_identifier | Unique identifier for this pganalyze task (used in log prefix, service name etc.) | string |`"task"`| no |
116
+
| vpc\_id | ID of VPC in which ECS cluster is located | string |n/a| yes |
117
117
118
118
## Outputs
119
119
120
120
| Name | Description |
121
121
|------|-------------|
122
-
| container\_json |-|
122
+
| container\_json ||
123
123
| lb\_dns\_aliases | List of DNS aliases add for ALB |
124
124
| lb\_dns\_name | FQDN of ALB provisioned for service (if present) |
125
125
| lb\_zone\_id | Route 53 zone ID of ALB provisioned for service (if present) |
0 commit comments