Is your application ready to run on a container cluster? Use this checklist to find out whether you are good to deploy your application on Amazon Elastic Container Service (ECS) and AWS Fargate or any other container cluster solution.
Does your application fulfill the following five requirements?
Your application (call it a microservice if you want to) is stateless. Answering a request or processing a job does not rely on reading data stored by previous requests or jobs. This applies to data from memory as well as a local disk.
Instead of that, your application stores data in a SQL/NoSQL database (e.g., RDS or DynamoDB), an in-memory database (Elasticache), or any other fully-managed storage service (e.g., S3).
Your application writes log messages to standard output (
stdout) and standard error (
stderr). Do not write log messages to files. (see Stateless). Docker has built-in support to ship log messages from
stderr to various centralized logging solutions (e.g., CloudWatch Logs). Check out A simple way to manage log messages from containers: CloudWatch Logs to learn more.
Your application reads configuration parameters from environment variables (e.g., the database endpoint or any other service endpoint). Do not use files to store the configuration for your application.
Use a templating engine for configuration files if you are containerizing a legacy application. I prefer
envsubst to do so. Alternatively, you could have a look at Dockerizing legacy applications with confd.
Your container starts exactly one main process. If your application consists of more than one process, split them up into multiple containers. For example, if you run NGINX and PHP-FPM, create two containers.
Your container does not start an SSH daemon. Do not install or enable SSH within a container (see Processs). Use
docker attach to log into a container if needed for debugging. On top of that, optimize your logging.
Your application receives
KILL signals and shuts down gracefully. Test whether the KILL signal triggered by
docker kill leads to your application stopping to answer new requests or start new jobs and terminate after the last request or job has been completed.
- Does your Dockerfile contain
CMDin shell form? Your main process will not receive any
- Are you starting your main process from a shell script? Make sure you are using
execto do so.
When using Fargate it is necessary, that your application is able to shutdown gracefully within 2 minutes.
Checked all five requirements from the checklist? Happy you! Your application is ready for ECS and Fargate or any other container cluster solution.
Do you want to learn more about how to ship your application with Docker? Our ebook and online seminar Rapid Docker on AWS teaches you how to dockerize PHP, Ruby on Rails, Python Django, Java Spring Boot, and Node.js Express applications.