Skip to main content

Ecs Tasks Ops

Project description

PyPI Python Version License

Read the documentation at https://ecs-tasks-ops.readthedocs.io/ Tests Codecov

pre-commit Black

Features

  • Application GUI to manage ECS resources

  • Use your home aws credentials from ~/.aws/credentials

  • Get information and attributes for each task, service or instance container

  • Connect through SSH to container instances or docker container

  • Show logs for each docker container

  • Show ECS events for a service

  • Force restart for a service

Requirements

Installation

You can install Ecs Tasks Ops via pip from PyPI:

$ pip install ecs-tasks-ops

Configuration

AWS Access

This application uses your aws credentials to connect to your ECS, so you need to configure your credentials.

Set up credentials (in e.g. ~/.aws/credentials)

[default]
aws_access_key_id = YOUR_KEY
aws_secret_access_key = YOUR_SECRET

Then, you set up a default region (in e.g. ~/.aws/config)

[default]
region=us-east-1

You can read more about it in boto3

ssh over ssm

If you want to access to containers instances or docker container through ssh, you must configurate ssm in your EC2 machines. That’s because ecs-tasks-ops use its instance id as machine identifier on ssh command. For example, ssh i-0123456789ABCDE. I use ssh-over-ssm tool to configure ssh over ssm to connect to instances.

GUI Usage

You can open the qt5 application, using the following command

ecs-tasks-ops-qt5

CLI Usage

You can open the command line with ecs-tasks-ops command. This is the help menu:

Usage: ecs-tasks-ops [OPTIONS] COMMAND [ARGS]...

   Ecs Tasks Ops.

Options:
   -x, --debug / --no-debug
   -j, --output-json
   --version                 Show the version and exit.
   --help                    Show this message and exit.

Commands:
   clusters             Clusters information.
   container-instances  Container instances defined in a cluster.
   containers           Get docker containers defined in a cluster.
   services             Services defined in a cluster.
   tasks                Set tasks defined in a cluster.

By default, the output format is in a table, but you can get original json format with -j option. You can filter json output with jq tool:

$ ecs-tasks-ops -j clusters | jq "."

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Ecs Tasks Ops is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz’s Hypermodern Python Cookiecutter template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ecs-tasks-ops-0.1.0.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

ecs_tasks_ops-0.1.0-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file ecs-tasks-ops-0.1.0.tar.gz.

File metadata

  • Download URL: ecs-tasks-ops-0.1.0.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.7 Linux/5.14.14-arch1-1

File hashes

Hashes for ecs-tasks-ops-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2adc9c113ccb335f36a154c79377af0339cd0b64462eee95fa77c1dd195045f0
MD5 2b51af9ff262e7150b49257faf5d6c6a
BLAKE2b-256 da4f1cbe4c70faf89138a2ab1cbcca4ba2a102d23e95f936ca6e3ef63cfb0354

See more details on using hashes here.

File details

Details for the file ecs_tasks_ops-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ecs_tasks_ops-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.7 Linux/5.14.14-arch1-1

File hashes

Hashes for ecs_tasks_ops-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 014371e8df78fb855e4d572494121d823fcc9eb2fcbfcebf4a57d8e4026178ef
MD5 735d506bd8e978fddf30278e623df768
BLAKE2b-256 f2f11dbeffdef7c094dde3866e4e0b136328efb1b8614336940a4ebfe7a4d604

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page