kubectl-style command line tool for AWS EC2 Container Service (ECS). This tool is alpha version and contains bugs and not catched exceptions. Also to usage all feature in you cluster must exist specific configuration: eg. IAM Roles, AWSS cloudwatch-agent, ecs agent configuration and much more.
I will prepare more examples and documentation when ecsctl will stable.
Big thanks for Xiuming Chen for first iteration of this project https://github.com/cxmcc/ecsctl I added much more new features (it will problematic to cerate lot of pull requests) to this project so I decide create another repository.
pip install git+https://github.com/witold-gren/ecsctl.gitA convenient command line tool to view ECS cluster status and do troubleshooting.
This tool is trying to provide similar functionality of kubectl for kubernetes.
Of course, ECS and kubernetes are so different. Many features on kubernetes are not possible here in ECS.
$ ecsctl --help
Usage: ecsctl [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
apply Create or update resources.
config Manage config file.
create Create resources.
delete Delete resources.
describe Show details of a specific resource.
drain Drain container instance.
exec Execute a command in a container.
get Display one or many resources.
logs Print the logs for a container usage CloudWatch.
run Run a particular image on the cluster.
scale Set a new size for a Service.
stop Stop service.
top Display Resource (CPU/Memory) usage.
undrain Undrain node back into active status.
update Update resources.
$ ecsctl get --help
Usage: ecsctl get [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
cluster List cluster from your account.
container-instance List container instances from your cluster.
hosted-zones List hosted zones from your account.
loadbalancer List load balancer from your account.
secret List secret group from your account.
service List services from your cluster.
service-discovery List service discovery namespace from your account.
task List task from your cluster.
task-definition List task definition from your cluster.
task-definition-family List task definition family from your cluster.Configure ^^^^^^^
Configure environment variables for usage ecscli
$ export AWS_ECS_CLUSTER_NAME=xxx
$ export AWS_ACCESS_KEY_ID=xxx
$ export AWS_SECRET_ACCESS_KEY=xxx
$ export AWS_DEFAULT_REGION=xxx
$ export AWS_SESSION_TOKEN=xxx
$ export AWS_PROFILE=xxx
$ export AWS_ECS_SSH_USER=xxx
$ export AWS_ECS_SSH_BASTION_USER=xxx
$ export AWS_ECS_SSH_BASTION_IP=xxx
$ export AWS_ECS_SSH_KEY_LOCATION=xxxCreate configuration for new cluster usage aws profile
$ ecsctl config set my-own-config-name --cluster-name my-cluster --aws-profile my-aws-profileCreate configuration for new cluster usage access-key and secret-access
$ ecsctl config set my-own-config-name --cluster-name my-cluster --aws-access-key-id XXX --aws-secret-access-key YYY --aws-region ZZZSet docker port for existing cluster
$ ecsctl config set my-own-config-name --docker-port 64646Set docker api version for existing cluster
$ ecsctl config set my-own-config-name --docker-api-version 1.30Show configuration for default cluster
$ ecsctl config showShow configuration for all configured clusters
$ ecsctl config show --show-allShow path for config file
$ ecsctl config show --show-pathSwitch default cluster:
$ ecsctl config context default2List clusters:
$ ecsctl get clusters
NAME STATUS RUNNING PENDING INSTANCE COUNT
default ACTIVE 5 0 1
$ ecsctl get cluster --sort-by "settings[0].name"
NAME STATUS RUNNING PENDING INSTANCE COUNT
default ACTIVE 5 0 1
$ ecsctl get cluster --quiet
learning-10c-ecs-localGet cluster details:
$ ecsctl describe cluster defaultCheck CPU/Memory utilization:
$ ecsctl top clusterShow avaraged usage resource from last 1h (Current we have 20 September 2019 12:35)
$ ecsctl top cluster --start-time 2019-09-20T12:35:00Show avaraged usage resource from last 1d
ecsctl top cluster --start-time 2019-09-20T12:35:00 --end-time 2019-09-19T12:35:00List nodes:
% ecsctl get nodes --cluster mycluster
INSTANCE ID EC2 INSTANCE ID STATUS RUNNING COUNT
00000000-1111-2222-3333-444444444444 i-abcdef123456abcde ACTIVE 1Get node detail:
% ecsctl describe node 00000000-1111-2222-3333-444444444444Drain/undrain node:
% ecsctl drain 00000000-1111-2222-3333-444444444444List services:
% ecsctl get servicesList services in certain order:
% ecsctl get services --sort-by "createdAt"Delete a service:
% ecsctl delete service badserviceDelete a service (even if it has desiredCount > 0):
% ecsctl delete service badservice --force% ecsctl run mycontainer --image busybox
mycontainer
% ecsctl get services
NAME TASK DEFINITION DESIRED RUNNING STATUS AGE
mycontainer-svc mycontainer:1 1 0 ACTIVE 10 seconds ago% ecsctl get tasks
TASK ID STATUS TASK DEFINITION AGE
42f052c4-80e9-411d-bea2-407b0b4a4b0b PENDING mycontainer:1 2 minutes ago