{"id":18930035,"url":"https://github.com/labd/ecs-deplojo","last_synced_at":"2025-04-15T15:31:15.120Z","repository":{"id":55116934,"uuid":"45192816","full_name":"labd/ecs-deplojo","owner":"labd","description":"Deployment tool for Amazon ECS","archived":false,"fork":false,"pushed_at":"2025-01-20T15:00:23.000Z","size":165,"stargazers_count":19,"open_issues_count":5,"forks_count":6,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-08T07:41:46.374Z","etag":null,"topics":["amazon-web-services","aws","ecs"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/labd.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-10-29T15:37:24.000Z","updated_at":"2025-01-20T15:00:25.000Z","dependencies_parsed_at":"2024-11-08T11:41:31.347Z","dependency_job_id":"8c038075-7ffe-41e2-ade7-da0c7c4bafe8","html_url":"https://github.com/labd/ecs-deplojo","commit_stats":{"total_commits":126,"total_committers":9,"mean_commits":14.0,"dds":0.2936507936507936,"last_synced_commit":"0b53dea28ae72939a0ca9873b5046a66ccaf284e"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/labd%2Fecs-deplojo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/labd%2Fecs-deplojo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/labd%2Fecs-deplojo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/labd%2Fecs-deplojo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/labd","download_url":"https://codeload.github.com/labd/ecs-deplojo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249097891,"owners_count":21212371,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["amazon-web-services","aws","ecs"],"created_at":"2024-11-08T11:36:20.115Z","updated_at":"2025-04-15T15:31:14.749Z","avatar_url":"https://github.com/labd.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"ecs-deplojo\n===========\n\nDeployment tool for Amazon ECS.\n\nInstallation\n------------\n\n`pip install ecs-deplojo`\n\n.. start-no-pypi\n\nStatus\n------\n\n.. image:: https://readthedocs.org/projects/ecs-deplojo/badge/?version=latest\n    :target: https://readthedocs.org/projects/ecs-deplojo/\n\n.. image:: https://github.com/labd/ecs-deplojo/workflows/Python%20Tests/badge.svg\n    :target: https://github.com/labd/ecs-deplojo/actions?query=workflow%3A%22Python+Tests%22\n\n.. image:: http://codecov.io/github/LabD/ecs-deplojo/coverage.svg?branch=master\n    :target: http://codecov.io/github/LabD/ecs-deplojo?branch=master\n\n.. image:: https://img.shields.io/pypi/v/ecs-deplojo.svg\n    :target: https://pypi.python.org/pypi/ecs-deplojo/\n\n.. end-no-pypi\n\n\nUsage\n-----\n\n.. code-block:: console\n\n    Usage: ecs-deplojo [OPTIONS]\n\n    Options:\n      --config FILENAME   [required]\n      --var VAR\n      --dry-run\n      --output-path PATH\n      --role-arn \u003coptional arn\u003e\n      --help              Show this message and exit.\n\n\nExample configuration\n---------------------\n\n.. code-block:: yaml\n\n    ---\n    cluster_name: example\n\n    environment:\n        DATABASE_URL: postgresql://\n\n    task_definitions:\n      web:\n        template: task_definitions/web.json\n        overrides:\n          uwsgi:\n            memory: 512\n            portMappings:\n              - hostPort: 0\n                containerPort: 8080\n                protocol: tcp\n      manage:\n        template: task_definitions/manage.json\n\n    services:\n      web:\n        task_definition: web\n\n    before_deploy:\n      - task_definition: manage\n        container: uwsgi\n        command: manage.py migrate --noinput\n\n    after_deploy:\n      - task_definition: manage\n        container: uwsgi\n        command: manage.py clearsessions\n\n\nUsing SSM secrets\n-----------------\n\n**Warning secrets will become visible in the container's environent, use with caution**\n\nWhen you want to use the AWS SSM secrets in your configuration you can use the `secrets`\nsection, however this needs some additional configuration within AWS\n\nAt first you need an AWS IAM role to use as the ECS execution role, this role needs\naccess to the secrets in Secrets Manager or Parameter store and will only be used during\nthe startup of your Docker container.\n\n**Example configuration:**\n\n.. code-block:: yaml\n\n    --\n    cluster_name: example\n\n    environment:\n      NORMAL_ENV_VAR: value_of_variable\n\n    secrets:\n      DATABASE_URL: /path/to/secret/DATABASE_URL\n\n    task_definitions:\n      web:\n        execution_role_arn: arn:aws:iam::\u003caccount_id\u003e:role/execution_role_name\n        template: task_definitions/web.json\n\n    services:\n      web:\n        task_definition: web\n\n\nWhen the container is started the secrets are available as environment variables and\nhidden in the AWS ECS console, this is not recommended in production.\n\n\nAWS Default VPC\n---------------\n\nWhen running your servers in the AWS default VPC you need ``networkMode=\"awsvpc\"`` in\nyour task definition JSON file, this will ensure that no hostnames are set for the\ncontainers, since this isn't supported by AWS.\n\n\nAWS Fargate\n-----------\n\nUnlike EC2 based clusters AWS Fargate needs a ``execution_role_arn`` to work, this can be\nset in your service definition in the YAML file.\n\n\nExample log output\n------------------\n\n.. code-block:: console\n\n    Starting deploy on cluster example (1 services)\n    Registered new task definition web:10\n    Starting one-off task 'manage.py migrate --noinput' via manage:10 (uwsgi)\n    Updating service web with task defintion web:10\n    Waiting for deployments\n    Waiting for services: web (0/2)\n    Waiting for services: web (1/2)\n    Waiting for services: web (2/2)\n    Deployment finished: web (2/2)\n    Starting one-off task 'manage.py clearsessions' via manage:10 (uwsgi)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flabd%2Fecs-deplojo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flabd%2Fecs-deplojo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flabd%2Fecs-deplojo/lists"}