SMS Compose

A set of Dockerfiles and a docker-compose yml file to facilitate the running of the VIP SMS tool.

Requires docker-compose 1.3 or higher.

Running

The default docker-compose.yml file assumes that sms-web and sms-worker are cloned into sibling directories to this one.

Create a .env file with the following values set appropriately:

ACCESS_KEY_ID
SECRET_ACCESS_KEY
ENVIRONMENT
QUEUE_PREFIX
DB_PREFIX
CIVIC_API_KEY
CIVIC_API_ELECTION_ID
CIVIC_API_OFFICIAL_ONLY
TWILIO_SID
TWILIO_TOKEN
TWILIO_NUMBER
PROCS
ROUTINES
LOGGLY_TOKEN
NEWRELIC_TOKEN

Build the projects: docker-compose build.

Then run them: docker-compose up.

You can simulate a user sending a text message to the SMS tool by sending a message to the running web app. Check the output of docker ps to find the exposed port for the web app and make a POST request like the following:

curl -X POST -d "From=+15555555555" -d "Body=HELP" -d "AccountSid=AC7..." http://localdocker:32775

This assumes that the docker host is aliased as localdocker, but if you're running on Linux, this can probably just be localhost. Be sure to set the same Twilio AccountSid as in the .env file. And use a real phone number so you can receive the message(s).

Running the released versions

To run the versions of sms-web and sms-worker that are pushed to quay.io without having the projects cloned locally, you can use the docker-compose.yml file in the release directory.

Create the .env file as above in the release directory, and run as usual:

docker-compose up

Deploying

Preparing an image for deployment

The deployed containers of SMS Worker and SMS Web come from images pushed to a docker repository (Quay). To deploy a new version of either one, you'll need to build an apporpriately tagged image and push it to the repository.

For example, if you wanted to deploy a new version of SMS Worker, from the SMS Worker directory, you would prepare and push a new image like so:

$ docker build -t quay.io/votinginfoproject/sms-worker:master .
$ docker push quay.io/votinginfoproject/sms-worker:master

Connecting to the Docker Swarm

The SMS apps are deployed on a Docker Swarm cluster. In order to deploy to it, you'll need to set three environment variables so that your Docker client communicates with the swarm: DOCKER_HOST, DOCKER_CERT_PATH, and DOCKER_TLS_VERIFY.

• DOCKER_HOST should include the protocol tcp, and the port. (e.g.: tcp://123.456.789.101:3376)
• DOCKER_CERT_PATH is a path to a directory containing the certificates for authentication with that server.
• DOCKER_TLS_VERIFY should be 1.

Deploying a new container

With those Docker environment variables set, cd into the "release" directory.

Create a .env file with the production values.

Any usual docker or docker-compose commands will run in the context of the Swarm.

To deploy a new version of SMS Worker, for example, you need to pull the image to the Swarm, then replace the existing containers with new ones:

$ docker pull quay.io/votinginfoproject/sms-worker:master
$ docker-compose up --no-deps -d worker

Replace "worker" with "web" above for a SMS Web deploy.

Don't forget to unset DOCKER_HOST and DOCKER_CERT_PATH when you finish (or close the terminal).