Skip to content

Commit 7eb24d8

Browse files
committed
Add explanations for yellow items
1 parent bbeb062 commit 7eb24d8

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -58,45 +58,48 @@ Note that it shows "SSM PrivateLink" at the bottom as a 🟑(yellow) result, but
5858

5959
[![example-result](example-result.png)](example-result.png)
6060

61-
## Reference - How to handle πŸ”΄(Red) items
61+
## Reference - How to handle πŸ”΄(Red) and 🟑(Yellow) items
6262

63-
1. **_Pre-flight check failed: `jq` command is missing_**
63+
1. **_πŸ”΄ Pre-flight check failed: `jq` command is missing_**
6464
Install the `jq` command. See [the official documentation](https://stedolan.github.io/jq/download/) for the details and how to install.
6565

66-
2. **_Pre-flight check failed: `aws` command is missing_**
66+
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

72-
4. **_Session Manager Plugin | Missing_**
72+
4. **_πŸ”΄ Session Manager Plugin | Missing_**
7373
Install the Session Manager plugin. See [the official documentation](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html) for the details and how to install.
7474

75-
5. **_Can I ExecuteCommand? | ecs:ExecuteCommand: implicitDeny_**
75+
4. **_🟑 Cluster Configuration | Audit Logging Not Configured / Disabled_**
76+
This check item won't block you to use ECS Exec, but we recommend you to enable logging and auditing for your ECS cluster from the security perspective. See [the official documentation](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html#ecs-exec-logging) for the details and how to enable them.
77+
78+
5. **_πŸ”΄ Can I ExecuteCommand? | ecs:ExecuteCommand: implicitDeny_**
7679
The IAM user/role you used for the `check-ecs-exec.sh` are not allowed to use the `ecs:ExecuteCommand` API. See the "[Using IAM policies to limit access to ECS Exec](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html#ecs-exec-best-practices-limit-access-execute-command) section in the official documenation to add the required permission to the IAM user/role.
7780
Note that the `Condition` element of the IAM policy is not currently supported to evaluate by `check-ecs-exec.sh`.
7881

79-
6. **_Can I ExecuteCommand? | kms:GenerateDataKey: implicitDeny_**
82+
6. **_πŸ”΄ Can I ExecuteCommand? | kms:GenerateDataKey: implicitDeny_**
8083
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.
8184
Note that the `Condition` element of the IAM policy is not currently supported to evaluate by `check-ecs-exec.sh`.
8285

83-
7. **_Platform Version | 1.3.0 (Required: >= 1.4.0)_**
86+
7. **_πŸ”΄ Platform Version | 1.3.0 (Required: >= 1.4.0)_**
8487
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).
8588

86-
8. **_ECS Agent Version | x.y.z (Required: >= 1.50.2)_**
89+
8. **_πŸ”΄ ECS Agent Version | x.y.z (Required: >= 1.50.2)_**
8790
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.
8891

89-
9. **_Exec Enabled for Task | NO_**
92+
9. **_πŸ”΄ Exec Enabled for Task | NO_**
9093
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.
9194

92-
10. **_Managed Agent Status | STOPPED (Reason: stopped-reason-here)_**
95+
10. **_πŸ”΄ Managed Agent Status | STOPPED (Reason: stopped-reason-here)_**
9396
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.
9497

95-
11. **_EC2 or Task Role | Not Configured"_ or _{serviceName}:{ActionName}: implicitDeny_**
98+
11. **_πŸ”΄ EC2 or Task Role | Not Configured"_ or _{serviceName}:{ActionName}: implicitDeny_**
9699
Your ECS task needs a task role or an instance role of the underlying EC2 instance with some permissions for using SSM Session Manager at least. See the [IAM permissions required for ECS Exec](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html#ecs-exec-enabling-and-using) section and the [Enabling logging and auditing in your tasks and services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html#ecs-exec-logging) section in the official documentation for the details.
97100
Note that the `Condition` element of the IAM policy is not currently supported to evaluate by `check-ecs-exec.sh`.
98101

99-
12. **_SSM PrivateLink "com.amazonaws.(region).ssmmessages" not found_**
102+
12. **_🟑 SSM PrivateLink "com.amazonaws.(region).ssmmessages" not found_**
100103
The `check-ecs-exec.sh` found one or more VPC endpoints configured in the VPC for your task, so you **may** want to add an additional SSM PrivateLink for your VPC. Make sure your ECS task has proper outbound internet connectivity, and if it doesn't, then you **need** to configure an additional SSM PrivateLink for your VPC.
101104

102105
## Security

0 commit comments

Comments
Β (0)