Skip to main content

A Django app that provides a command to deploy a Django app to AWS ECS based on Django settings.

Project description

# django-ecs-deploy

Make config files from Django settings variables and templates.

## Installation

From your Django app, install the module from pip:

pip install django-ecs-deploy

Then make sure it is included in your `INSTALLED_APPS` section:


## Usage

This command assumes you're using [jwilder/nginx-proxy]( for your web server setup. It also uses your Django settings as well as environment variables to configure builds. It expects the following variables:

### Settings / Environment Variables

`django-ecs-deploy` looks for the following settings in the `settings` file and from your environment. Environment variables will override `settings`:

* `PROJECT` - The name of your project for use as a basename for tasks and Docker image names. Untested with special characters.
* `TIER` - Used in conjunction with the `BUILD_ID` environment setting for Docker image versioning (`staging125`) and with `PROJECT` to define ECS task names (`myproject-staging`)
* `DOCKER_REPOSITORY` - The name of the docker repo to store images in
* `DOCKER_IMAGE` - The name of the base docker image
* `BUILD_ID` - Used along with `TIER` for the image version (`staging124`)
* `DJANGO_SETTINGS_MODULE` - The tier you use to run this command will also be set in the ECS Task's container
* `VIRTUAL_HOST` (optional) - For use with [jwilder/nginx-proxy](
* `DOCKER_APT_PACKAGES` (optional) - If set, a list of Debian package names will be installed
* `DOCKER_YUM_PACKAGES` (optional) - If set, a list of Yum package names will be installed
* `CREATE_FREETDS_CONFIG` (optional) - If set, `/etc/freetds.conf` will be created with reasonable defaults
* `COMPRESS_ENABLED` (optional) - If set, `python compress --force` will be run during image build
* `ECS_CLUSTER` (optional) - Defaults to `default`. If set, override ECS cluster name your services will be deployed to.
* `DOCKER_MAX_MEMORY` (optional) - Defaults to 256. Sets max memory in task definition.

#### Port Mapping

Mapping one port is currently supported using the following settings:

* `DOCKER_HOST_PORT` (optional) - The port to use on the host machine. No mapping will be configured if this is not set.
* `DOCKER_CONTAINER_PORT` (optional) - Defaults to `DOCKER_HOST_PORT`
* `DOCKER_PORT_PROTOCOL` (optional) - Defaults to `tcp`

#### Secure Credential Deployment

The following three keys require `awscli` to be installed via your `requirements.txt`:

* `CREDENTIALS_BUCKET` (optional) - source s3 bucket name to retrieve credentials onto Docker container
* `CREDENTIALS_KEY` (optional) - source s3 key for credentials
* `CREDENTIALS_DEST_PATH` (optional) - path to place credentials file on remote server. `pwd` is `/usr/src/app`

The basic command for the retrieval of the credentials counts on an IAM role with access to your bucket, and looks like this:


### Execution

Set the appropriate settings and environment variables, then run:

python ecsdeploy

## Possible Features

I threw this together to serve a need. It makes a lot of assumptions right now about the way you're using it, like what is required vs. optional, etc. I'm totally open to pull requests that make the system more flexible.

The system assumes you have a service created based on `PROJECT` and `TIER` in your settings, and will not create the service for you or use different names.

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

django-ecs-deploy-0.1.14.tar.gz (5.1 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page