Skip to content

Commit 95e33aa

Browse files
author
Heming Han
authored
Update ECS_RESERVED_MEMORY description in README (#3363)
1 parent adc4015 commit 95e33aa

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ additional details on each available environment variable.
142142
| `ECS_POLL_METRICS` | <true | false> | Whether to poll or stream when gathering metrics for tasks. Setting this value to `true` can help reduce the CPU usage of dockerd and containerd on the ECS container instance. See also ECS_POLL_METRICS_WAIT_DURATION for setting the poll interval. | `false` | `false` |
143143
| `ECS_POLLING_METRICS_WAIT_DURATION` | 10s | Time to wait between polling for metrics for a task. Not used when ECS_POLL_METRICS is false. Maximum value is 20s and minimum value is 5s. If user sets above maximum it will be set to max, and if below minimum it will be set to min. | 10s | 10s |
144144
| `ECS_PULL_DEPENDENT_CONTAINERS_UPFRONT` | <true | false> | Whether to pull images for containers with dependencies before the dependsOn condition has been satisfied. | false | false |
145-
| `ECS_RESERVED_MEMORY` | 32 | Memory, in MiB, to reserve for use by things other than containers managed by Amazon ECS. | 0 | 0 |
145+
| `ECS_RESERVED_MEMORY` | 32 | Reduction, in MiB, of the memory capacity of the instance that is reported to Amazon ECS. Used by Amazon ECS when placing tasks on container instances. This doesn't reserve memory usage on the instance. | 0 | 0 |
146146
| `ECS_AVAILABLE_LOGGING_DRIVERS` | `["awslogs","fluentd","gelf","json-file","journald","logentries","splunk","syslog"]` | Which logging drivers are available on the container instance. | `["json-file","none"]` | `["json-file","none"]` |
147147
| `ECS_DISABLE_PRIVILEGED` | `true` | Whether launching privileged containers is disabled on the container instance. | `false` | `false` |
148148
| `ECS_SELINUX_CAPABLE` | `true` | Whether SELinux is available on the container instance. | `false` | `false` |

agent/config/types.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,9 @@ type Config struct {
101101
// on the instance
102102
DisableDockerHealthCheck BooleanDefaultFalse
103103

104-
// ReservedMemory specifies the amount of memory (in MB) to reserve for things
105-
// other than containers managed by ECS
104+
// ReservedMemory specifies Reduction, in MiB, of the memory capacity of the instance
105+
// that is reported to Amazon ECS. Used by Amazon ECS when placing tasks on container instances.
106+
// This doesn't reserve memory usage on the instance
106107
ReservedMemory uint16
107108

108109
// DockerStopTimeout specifies the amount of time before a SIGKILL is issued to

0 commit comments

Comments
 (0)