Skip to main content

Deployment tool for Amazon ECS

Project description

ecs-deplojo

Deployment tool for Amazon ECS.

Installation

pip install ecs-deplojo

.. start-no-pypi

Status

.. image:: https://readthedocs.org/projects/ecs-deplojo/badge/?version=latest :target: https://readthedocs.org/projects/ecs-deplojo/

.. image:: https://github.com/labd/ecs-deplojo/workflows/Python%20Tests/badge.svg :target: https://github.com/labd/ecs-deplojo/actions?query=workflow%3A%22Python+Tests%22

.. image:: http://codecov.io/github/LabD/ecs-deplojo/coverage.svg?branch=master :target: http://codecov.io/github/LabD/ecs-deplojo?branch=master

.. image:: https://img.shields.io/pypi/v/ecs-deplojo.svg :target: https://pypi.python.org/pypi/ecs-deplojo/

.. end-no-pypi

Usage

.. code-block:: console

Usage: ecs-deplojo [OPTIONS]

Options:
  --config FILENAME   [required]
  --var VAR
  --dry-run
  --output-path PATH
  --role-arn <optional arn>
  --help              Show this message and exit.

Example configuration

.. code-block:: yaml

---
cluster_name: example

environment:
    DATABASE_URL: postgresql://

task_definitions:
  web:
    template: task_definitions/web.json
    overrides:
      uwsgi:
        memory: 512
        portMappings:
          - hostPort: 0
            containerPort: 8080
            protocol: tcp
  manage:
    template: task_definitions/manage.json

services:
  web:
    task_definition: web

before_deploy:
  - task_definition: manage
    container: uwsgi
    command: manage.py migrate --noinput

after_deploy:
  - task_definition: manage
    container: uwsgi
    command: manage.py clearsessions

Using SSM secrets

Warning secrets will become visible in the container's environent, use with caution

When you want to use the AWS SSM secrets in your configuration you can use the secrets section, however this needs some additional configuration within AWS

At first you need an AWS IAM role to use as the ECS execution role, this role needs access to the secrets in Secrets Manager or Parameter store and will only be used during the startup of your Docker container.

Example configuration:

.. code-block:: yaml

--
cluster_name: example

environment:
  NORMAL_ENV_VAR: value_of_variable

secrets:
  DATABASE_URL: /path/to/secret/DATABASE_URL

task_definitions:
  web:
    execution_role_arn: arn:aws:iam::<account_id>:role/execution_role_name
    template: task_definitions/web.json

services:
  web:
    task_definition: web

When the container is started the secrets are available as environment variables and hidden in the AWS ECS console, this is not recommended in production.

AWS Default VPC

When running your servers in the AWS default VPC you need networkMode="awsvpc" in your task definition JSON file, this will ensure that no hostnames are set for the containers, since this isn't supported by AWS.

AWS Fargate

Unlike EC2 based clusters AWS Fargate needs a execution_role_arn to work, this can be set in your service definition in the YAML file.

Example log output

.. code-block:: console

Starting deploy on cluster example (1 services)
Registered new task definition web:10
Starting one-off task 'manage.py migrate --noinput' via manage:10 (uwsgi)
Updating service web with task defintion web:10
Waiting for deployments
Waiting for services: web (0/2)
Waiting for services: web (1/2)
Waiting for services: web (2/2)
Deployment finished: web (2/2)
Starting one-off task 'manage.py clearsessions' via manage:10 (uwsgi)

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_deplojo-0.10.1.tar.gz (59.4 kB view details)

Uploaded Source

Built Distribution

ecs_deplojo-0.10.1-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file ecs_deplojo-0.10.1.tar.gz.

File metadata

  • Download URL: ecs_deplojo-0.10.1.tar.gz
  • Upload date:
  • Size: 59.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.21

File hashes

Hashes for ecs_deplojo-0.10.1.tar.gz
Algorithm Hash digest
SHA256 1757246305139a68a9037702fde937777190d34ca0f0f22267d1e3802e5d2b63
MD5 09d2784e78058834c37176df8023c988
BLAKE2b-256 98381cccae41ad55ec7fcf0b29b7c989a0ec0a342f42ce1c17072c8806e73f8e

See more details on using hashes here.

File details

Details for the file ecs_deplojo-0.10.1-py3-none-any.whl.

File metadata

  • Download URL: ecs_deplojo-0.10.1-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.21

File hashes

Hashes for ecs_deplojo-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5136347a2f675000075e9b264af9aea4f237a97a5c5af061f01c4c79bd3042c7
MD5 26ec117dd37f407c06af5a9fa88a963f
BLAKE2b-256 b7c2728d067354d214fb6d145fd5a5dbc63676faf7fc36bc0026158e0187c796

See more details on using hashes here.

Supported by

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