Empire is a control layer on top of Amazon EC2 Container Service (ECS) that provides a Heroku like workflow. It conforms to a subset of the Heroku Platform API, which means you can use the same tools and processes that you use with Heroku, but with all the power of EC2 and Docker.
Empire is targeted at small to medium sized startups that are running a large number of microservices and need more flexibility than what Heroku provides. You can read the original blog post about why we built empire on the Remind engineering blog.
To use Empire, you'll need to have an ECS cluster running. See the quickstart guide for more information.
Empire aims to make it trivially easy to deploy a container based microservices architecture, without all of the complexities of managing systems like Mesos or Kubernetes. ECS takes care of much of that work, but Empire attempts to enhance the interface to ECS for deploying and maintaining applications, allowing you to deploy Docker images as easily as:
$ emp deploy remind101/acme-inc:masterEmpire supports a subset of the Heroku Platform API, which means any tool that uses the Heroku API can probably be used with Empire, if the endpoint is supported.
As an example, you can use the hk CLI with Empire like this:
$ HEROKU_API_URL=<empire_url> hk ...However, the best user experience will be by using the emp command, which is a fork of hk with Empire specific features.
Empire's routing layer is backed by internal ELBs. Any application that specifies a web process will get an internal ELB attached to its associated ECS Service. When a new version of the app is deployed, ECS manages spinning up the new versions of the process, waiting for old connections to drain, then killing the old release.
When a new internal ELB is created, an associated CNAME record will be created in Route53 under the internal TLD, which means you can use DNS for service discovery. If we deploy an app named feed then it will be available at http://feed within the ECS cluster.
Apps default to only being exposed internally, unless you add a custom domain to them. Adding a custom domain will create a new external ELB for the ECS service.
Any tagged Docker image can be deployed to Empire as an app. Empire doesn't enforce how you tag your Docker images, but we recommend tagging the image with the git sha that it was built from, and deploying that. We have a tool for performing deployments called Tugboat that supports deploying Docker images to Empire.
When you deploy a Docker image to Empire, it will extract a Procfile from the WORKDIR. Like Heroku, you can specify different process types that compose your service (e.g. web and worker), and scale them individually. Each process type in the Procfile maps directly to an ECS Service.
Caveats
Because docker run does not exec commands within a shell, commands specified within the Procfile will also not be exec'd within a shell. This means that you cannot specify environment variables in the Procfile. The following is not valid:
web: acme-inc server -port=$PORT
If you need to specify environment variables as part of the command, we recommend splitting out your Procfile commands into small bash shims instead:
web: ./bin/web
#!/bin/bash
set -e
exec acme-inc server -port=$PORTUnit tests live alongside each go file as _test.go.
There is also a tests directory that contains integration and functional tests that tests the system using the heroku-go client and the emp command.
To get started, run:
$ make bootstrapThe bootstrap command assumes you have a running postgres server. It will create a database called empire
using the postgres client connection defaults.
To run the tests:
$ make testNOTE: You may need to install libxmlsec1 for the tests to run. You can do this with:
$ brew install libxmlsec1 libxml2 pkg-configIf you want to contribute to Empire, you may end up wanting to run a local instance against an ECS cluster. Doing this is relatively easy:
-
Ensure that you have the AWS CLI installed and configured.
-
Ensure that you accepted the terms and conditions for the official ECS AMI:
Also check that the offical ECS AMI ID for US East matches with the one in cloudformation.json: https://github.com/remind101/empire/blob/master/docs/cloudformation.json#L20
-
Run docker-machine and export the environment variables so Empire can connect:
$ docker-machine start default $ eval "$(docker-machine env default)"
-
Run the bootstrap script, which will create a cloudformation stack, ecs cluster and populate a .env file:
$ ./bin/bootstrap -
Run Empire with docker-compose:
$ docker-compose up db # Only need to do this the first time, so that the db can initialize. $ docker-compose up
NOTE: You might need to run this twice the first time you start it up, to give the postgres container time to initialize.
Empire will be available at http://$(docker-machine ip default):8080 and you can point the CLI there.
$ export EMPIRE_API_URL=http://$(docker-machine ip default):8080
$ emp deploy remind101/acme-incEmpire follows Go's convention of vendoring third party dependencies. We use the Go 1.5+ vendor expirement, and manage the ./vendor/ directory via govendor.
When you add a new dependency, be sure to vendor it with govendor:
$ govendor add <package>Perform the following steps when releasing a new version:
- Create a new branch
release-VERSION. - Bump the version number with
make bump(this will add a commit to the branch). - Change
HEAD->VERSIONin CHANGELOG.md. - Open a PR to review.
- Once merged into master, wait for the Conveyor build to complete.
- Finally, tag the commit with the version as
v<VERSION>. This will trigger CircleCI to:- Tag the image in Docker Hub with the version.
- Build Linux and OS X versions of the CLI and Daemon.
- Create a new GitHub Release and upload the artifacts.
- Update the new GitHub Release to be human readable.
- Open a PR against Homebrew to update the emp CLI: https://github.com/Homebrew/homebrew-core/blob/master/Formula/emp.rb
We have a google group, empire-dev, where you can ask questions and engage with the Empire community.
You can also join our Slack team for discussions and support.