Skip to content

Commit 01e421c

Browse files
authored
Merge pull request #2 from aws-containers/fix-typo
Fix typo "ECS exec" should be "ECS Exec"
2 parents 44ece83 + ceab302 commit 01e421c

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The `check-ecs-exec.sh` shows the results with three text colors, 🟢(Green),
5050

5151
1. 🟢(Green) - The configuration or the status is okay.
5252
2. 🟡(Yellow) - The configuration or the status should or would be recommended to fix, but you can use ECS Exec without fixing them.
53-
3. 🔴(Red) - You need to fix those results to use ECS exec.
53+
3. 🔴(Red) - You need to fix those results before using ECS Exec.
5454

5555
In the following screenshot for instance, we need to install the Session Manager plugin and give required permissions to the task role at least, but we can ignore the audit-logging configuration.
5656

@@ -66,7 +66,7 @@ Install the `jq` command. See [the official documentation](https://stedolan.gith
6666
2. **_Pre-flight check failed: `aws` command is missing_**
6767
Install the latest AWS CLI. See [the official documentation for the AWS CLI v2](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html) or [the official documentation for the AWS CLI v1](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html) for the details and how to install.
6868

69-
3. **_Pre-flight check failed: ECS exec requires the AWS CLI v1.19.28/v2.1.30 or later_**
69+
3. **_Pre-flight check failed: ECS Exec requires the AWS CLI v1.19.28/v2.1.30 or later_**
7070
Upgrade to the latest AWS CLI. See [the official documentation for the AWS CLI v2](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html) or [the official documentation for the AWS CLI v1](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html) for the details and how to upgrade.
7171

7272
4. **_Session Manager Plugin | Missing_**
@@ -79,13 +79,13 @@ The IAM user/role you used for the `check-ecs-exec.sh` are not allowed to use th
7979
The IAM user/role you used for the `check-ecs-exec.sh` are not allowed to use the `kms:GenerateDataKey` API with the given KMS Key ID which you're using for the logging and auditing configuration for ECS exec. See the "[IAM permissions required for encryption using your own KMS customer master key (CMK)](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html#ecs-exec-logging) section under the "Logging and Auditing using ECS Exec" section in the official documenation to add the required permission to the IAM user/role.
8080

8181
7. **_Platform Version | 1.3.0 (Required: >= 1.4.0)_**
82-
On AWS Fargate, `ECS exec` requires the Platform version 1.4.0 or newer. If your ECS task is part of an ECS service, then you can update the platform version by specifying the `PlatformVersion` parameter for the `UpdateService` API. If your ECS task is a standalone task, then you need to re-run the ECS task with the `PlatformVersion` parameter specified for the `RunTask` API. See also [the migration guide from the previous PVs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html#platform-version-migration).
82+
On AWS Fargate, `ECS Exec` requires the Platform version 1.4.0 or newer. If your ECS task is part of an ECS service, then you can update the platform version by specifying the `PlatformVersion` parameter for the `UpdateService` API. If your ECS task is a standalone task, then you need to re-run the ECS task with the `PlatformVersion` parameter specified for the `RunTask` API. See also [the migration guide from the previous PVs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html#platform-version-migration).
8383

8484
8. **_ECS Agent Version | x.y.z (Required: >= 1.50.2)_**
8585
You need to update the version of the ECS Container Agent for your EC2 instance where your ECS task runs. See [the official documentation](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) for the details and how to update.
8686

8787
9. **_Exec Enabled for Task | NO_**
88-
You need to enable the ECS exec feature for your ECS service or your ECS standalone task. If your ECS task is part of an ECS service, then you can update the ECS by specifying the `EnableExecuteCommand` parameter for the `UpdateService` API. If your ECS task is a standalone task, then you need to re-run the ECS task with the `EnableExecuteCommand` parameter specified for the `RunTask` API.
88+
You need to enable the ECS Exec feature for your ECS service or your ECS standalone task. If your ECS task is part of an ECS service, then you can update the ECS by specifying the `EnableExecuteCommand` parameter for the `UpdateService` API. If your ECS task is a standalone task, then you need to re-run the ECS task with the `EnableExecuteCommand` parameter specified for the `RunTask` API.
8989

9090
10. **_Managed Agent Status | STOPPED (Reason: stopped-reason-here)_**
9191
The managed agent for a container in your Task has stopped for some reasons. If you see this error again and again even after re-running your ECS task, then make sure you have other results from `check-ecs-exec.sh` are all green.

check-ecs-exec.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ describedTaskJson=$(${AWS_CLI_BIN} ecs describe-tasks \
131131
--output json)
132132
executeCommandEnabled=$(echo "${describedTaskJson}" | jq -r ".tasks[0].enableExecuteCommand")
133133
if [[ "x${executeCommandEnabled}" = "xnull" ]]; then
134-
printf "${COLOR_RED}Pre-flight check failed: ECS exec requires the AWS CLI v1.19.28/v2.1.30 or later.\n\
134+
printf "${COLOR_RED}Pre-flight check failed: ECS Exec requires the AWS CLI v1.19.28/v2.1.30 or later.\n\
135135
Please update the AWS CLI and try again?\n\
136136
For v2: https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html\n\
137137
For v1: https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html\n"

0 commit comments

Comments
 (0)