django-ecsmanage 0.0.0

Run any Django management command on an AWS Elastic Container Service(ECS) cluster.

django-ecsmanage

A Django app that provides a management command allowing you to run any other management command on an AWS Elastic Container Service (ECS) cluster.

Useful for running migrations and other one-off commands in staging and production environments. With django-ecsmanage, you can easily run migrations on a remote cluster from the command line:

$ django-admin ecsmanage migrate

Contents

• Installation
• Configuration
  • Environments
  • AWS Resources
• Developing

Installation

Install from GitHub using pip:

$ pip install git+https://github.com/azavea/django-ecsmanage.git

Update INSTALLED_APPS in your Django settings to install the app:

INSTALLED_APPS = (
    ...
    'ecsmanage',
)

Configuration

Settings for the management command are kept in a single configuration dictionary in your Django settings named ECSMANAGE_ENVIRONMENTS. Each entry in ECSMANAGE_ENVIRONMENTS should be a key-value pair corresponding to a named environment (like default or production) and a set of AWS resources in that environment. For example:

ECSMANAGE_ENVIRONMENTS = {
    'default': {
        'TASK_DEFINITION_NAME': 'StagingAppCLI',
        'CLUSTER_NAME': 'ecsStagingCluster',
        'LAUNCH_TYPE': 'FARGATE',
        'SECURITY_GROUP_TAGS': {
            'Name': 'sgAppEcsService',
            'Environment': 'Staging',
            'Project': 'ProjectName'
        },
        'SUBNET_TAGS': {
            'Name': 'PrivateSubnet',
            'Environment': 'Staging',
            'Project': 'ProjectName'
        },
        'AWS_REGION': 'us-east-1',
    },
}

Environments

The key name for an environment can be any string. You can use this name with the --env flag when running the command to run a command on a different environment. Take this ECSMANAGE_ENVIRONMENTS variable as an example:

ECSMANAGE_ENVIRONMENTS = {
    'default': {
        'TASK_DEFINITION_NAME': 'StagingAppCLI',
        'CLUSTER_NAME': 'ecsStagingCluster',
        'SECURITY_GROUP_TAGS': {
            'Name': 'sgStagingAppEcsService',
        },
        'SUBNET_TAGS': {
            'Name': 'StagingPrivateSubnet',
        },
    },
    'production': {
        'TASK_DEFINITION_NAME': 'ProductionAppCLI',
        'CLUSTER_NAME': 'ecsProductionCluster',
        'SECURITY_GROUP_TAGS': {
            'Name': 'sgProductionAppEcsService',
        },
        'SUBNET_TAGS': {
            'Name': 'ProductionPrivateSubnet',
        },
    },
}

Using the above settings, you could run production migrations with the following command:

$ django-admin ecsmanage --env production migrate

If the --env argument is not present, the command will default to the environment named default.

AWS Resources

The following keys in an environment help the management command locate the appropriate AWS resources for your cluster:

key name	description	default
TASK_DEFINITION_NAME	The name of your ECS task definition. The command will automatically retrieve the latest definition.
CLUSTER_NAME	The name of your ECS cluster.
SECURITY_GROUP_TAGS	A dictionary of tags to use to identify a security group for your task.
SUBNET_TAGS	A dictionary of tags to use to identify a subnet for your task.
LAUNCH_TYPE	The ECS launch type for your task.	FARGATE
AWS_REGION	The AWS region to run your task.	us-east-1

Developing

Local development is managed with Python virtual environments. Make sure that you have Python 3.4+ and pip installed before starting.

Install the development package in a virtual environment:

$ ./scripts/update

Run the tests:

$ ./scripts/test