AWS ECS Exec command cli tool is aimed to :
- connect to your container instance running under ECS Fargate.
- tail the log from cloudwatch logs (if you configure a logconfiguration in your task definition)
- update secret value into secret manager
The aws ecs execute-command command is quite complicated to remember and the tool give you the ability to parse and retrieve:
- your clusters
- your services
- your tasks
- your container
To let you choose which one you want to connect into.
Enhancements 😎 You can now connect to ECS and tail your logs from an EC2 instance or AWS CloudShell without the need of aws cli and aws credentials file.
At start, you are asked what kind of credentials you want to use and which default region.
You can now also update your secret directly from the command line.
❯ ecs-connect-cli update-secret your-secret-nameI also add the possibility to run directly with pipx
❯ pipx run ecs-connect-cli --help
Requirements
-
Install awscli via [https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html] (not necessary if you are connected to an EC2 instance)
-
Install ssm tools via [https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html]
To install you have several options:
- Install it globally with your pip:
❯ pip install ecs-connect-cli- Install it into a virtualenv (after creating a virtualenv with the tool of your choice):
❯ source .venv_3.11.0/bin/activate
❯ pip install ecs-connect-cli- Run the cli directly with pipx
❯ pipx run ecs-connect-cli --help
if it is the first time you connect to aws-cli, you have to get credentials key from your aws administrator.
If you use it with with pip, you can call the CLI as below or directly call it with pipx
❯ ecs-connect-cli --help
Welcome in AWS ECS Exec command Cli !
Usage: ecs_connect_cli [OPTIONS] COMMAND [ARGS]...
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --version -v Show the application's version and exit. │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ connect Connect to an ECS Fargate container │
│ exec-command Execute manage.py command with args │
│ list-cluster List cluster into an AWS account │
│ list-service List service(s) into a cluster │
│ list-task List task(s) into a service into a cluster │
│ tail Tail logs of a selected ECS container │
| update-secret Update secret from secret manager |
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
Thanks to Typer from @tiangolo
Thanks to @kraymer for echoprompt 😎