This is the interface between porter and the services it deploys.
porter favors convention over configuration where possible. This document describes conventions used in porter, followed by the minimal configuration needed, and finally some optional configuration.
The minimum required files are .porter/config and a Dockerfile.
.porter/config is a YAML file describing high-level constructs such as the
service name, container definitions, environment-region tuples, etc.
Dockerfile is the default Docker container that's built
Porter follows 12factor when it comes to logging.
Services are expected to log on STDOUT.
Logs are sent to rsyslog, which are aggregated into /var/log/porter.log.
The very first script run by an EC2 instance logs to
/var/log/cloud-init-output.log which can be useful when debugging failures
that lead to CloudFormation stacks not completing due to WaitCondition failures.
The default health check is GET /health HTTP/1.1. A newly provisioned stack
won't complete and a hotswap won't succeed if a service doesn't return a
HTTP/1.1 200 OK response.
The health check method and path are configurable.
PORTER_ENVIRONMENT # where am I?
AWS_REGION # who am I?Secrets and other service-defined config
Services can provide additional environment variables (including secrets).
See Container config for more.
For exact required fields see the Config reference
The minimum configuration includes
- the service's name
- a single environment and AWS region
- the name of an ELB in the environment-region (for elb-based topologies)
An optional CloudFormation template can be provided.
See CloudFormation customizations for details