The Twelve-Factor App: Best Practices for Modern Web Applications

THE TWELVE-FACTOR APP
Best Practices for Modern Web Applications

View Slide

David Zuelke

View Slide

View Slide

[email protected]

View Slide

@dzuelke

View Slide

“The Twelve-Factor App”

View Slide

“The Twelve-Factor App”
is
a manifesto,
a methodology,
a condensed collection of experiences.

View Slide

Its goals are
scalability,
maintainability,
portability.

View Slide

12factor.net

View Slide

4/12 MAIN FACTORS,
CODE ACCORDINGLY
I. Codebase 
From one codebase, perform many deploys to staging, prod, ...
II. Dependencies 
Your application explicitly declares userland and platform deps.
III. Conﬁguration 
Read from $_ENV: API keys, database credentials, SMTP hosts, ...
XI. Logging 
file_put_contents("php://stderr", "Yay log");

View Slide

II. DEPENDENCIES
Applications have explicitly declared dependencies.

View Slide

II. DEPENDENCIES
Applications have explicitly declared dependencies.
$ cat composer.json
{
"require": {
"php": ">=5.3.3",
"ext-‐mcrypt": "*",
"symfony/symfony": "~2.4.6",
"twig/extensions": "~1.0",
"symfony/monolog-‐bundle": "~2.4"
}
}
$ cat package.json
{
"dependencies": {
"express": "~4.9.x",
"cool-‐ascii-‐faces": "~1.3.x"
},
"engines": {
"node": "0.10.x"
}
}

View Slide

do not check your vendors/ directory into Git

View Slide

III. CONFIGURATION
Store conﬁg in the environment.

View Slide

III. CONFIGURATION
Assumption:
same code but different conﬁguration per deployment target

View Slide

III. CONFIGURATION
$transport = Swift_SmtpTransport::newInstance( 
getenv('EMAIL_HOST'), getenv('EMAIL_PORT')?:25 
) 
-‐>setUsername(getenv('EMAIL_USERNAME')) 
-‐>setPassword(getenv('EMAIL_PASSWORD')) 
;
Assumption:
$ heroku config:set EMAIL_HOST=smtp.blah.com EMAIL_PORT=827 \
EMAIL_USERNAME=joecool EMAIL_PASSWORD=itwasadarkandstormynight

View Slide

four separate conﬁg vars are annoying!

View Slide

III. CONFIGURATION
$smtp = parse_url(getenv('SMTP_GATEWAY_URL'));
$transport = Swift_SmtpTransport::newInstance( 
$smtp['host'], $smtp['port'] 
) 
-‐>setUsername($smtp['user']) 
-‐>setPassword($smtp['pass']) 
;
Assumption:
$ heroku config:set SMTP_GATEWAY_URL=\
smtp://joecool:[email protected]:827

View Slide

do not hardcode conﬁg vars, they might change suddenly!

View Slide

TIME FOR A DEPLOY!
It's as easy as pie.

View Slide

$ heroku create dz-‐php-‐test
Creating dz-‐php-‐test... done, stack is cedar-‐14
http://dz-‐php-‐test.herokuapp.com/ | [email protected]:dz-‐php-‐….git
$ git push heroku master
-‐-‐-‐-‐-‐> PHP app detected
-‐-‐-‐-‐-‐> Setting up runtime environment...
-‐ PHP 5.5.16
-‐ Apache 2.4.10
-‐ Nginx 1.6.0
-‐-‐-‐-‐-‐> Installing PHP extensions:
-‐ opcache (automatic; bundled)
-‐ memcached (composer.json; downloaded)
-‐ intl (composer.json; bundled)
-‐-‐-‐-‐-‐> Installing dependencies...
Composer version 05d991 2014-‐10-‐28 12:36:19
Loading composer repositories with package information
Installing dependencies from lock file
-‐ Installing monolog/monolog (1.9.1)
Loading from cache
Generating optimized autoload files
-‐-‐-‐-‐-‐> Discovering process types
Procfile declares types -‐> web
-‐-‐-‐-‐-‐> Compressing... done, 57.4MB
-‐-‐-‐-‐-‐> Launching... done, v3
http://dz-‐php-‐test.herokuapp.com/ deployed to Heroku

View Slide

how did that work?

View Slide

V. BUILD, RELEASE, RUN

View Slide

V. BUILD, RELEASE, RUN
A build step vendors dependencies, prepares assets, etc.
A release step creates a package from build and conﬁg.
A runtime step executes, without special knowledge.

View Slide

X. DEV/PROD PARITY

View Slide

X. DEV/PROD PARITY
Keep dev, stage and prod envs as similar as possible.

View Slide

X. DEV/PROD PARITY
SQLite ≠ MySQL
Apache ≠ Nginx
File based sessions ≠ Redis based sessions

View Slide

X. DEV/PROD PARITY
SQLite ≠ MySQL
Apache ≠ Nginx
File based sessions ≠ Redis based sessions
If apt-‐get or brew don't get the job done on your box:
Vagrant is always your friend!

View Slide

VI. PROCESSES

View Slide

VI. PROCESSES
Execute the app as one or more stateless processes.

View Slide

VI. PROCESSES
heroku-‐python-‐app $ cat Procfile
worker: python worker.py
web: gunicorn hello:app

View Slide

VI. PROCESSES
heroku-‐node-‐app $ cat Procfile
worker: node worker.js
web: node index.js

View Slide

VI. PROCESSES
heroku-‐ruby-‐app $ cat Procfile
worker: env TERM_CHILD=1 bundle exec rake resque:work
web: bundle exec unicorn -‐p $PORT -‐c ./config/unicorn.rb

View Slide

VI. PROCESSES
heroku-‐java-‐app $ cat Procfile
worker: sh worker/target/bin/worker
web: java $JAVA_OPTS -‐jar target/dependency/jetty-‐runner.jar -‐-‐
port $PORT target/*.war

View Slide

VI. PROCESSES
heroku-‐php-‐app $ cat Procfile
worker: php background.php
web: php -‐S 0.0.0.0:$PORT

View Slide

PHP needs a dedicated web server

View Slide

VI. PROCESSES
heroku-‐php-‐app $ cat Procfile
worker: php background.php
web: vendor/bin/heroku-‐php-‐apache2 # or heroku-‐php-‐nginx
automatically injected into the app during build

View Slide

RUNNING PHP APPS LOCALLY
heroku-‐php $ composer require -‐-‐dev heroku/heroku-‐buildpack-‐php
./composer.json has been updated
Updating dependencies (including require-‐dev)
-‐ Installing heroku/heroku-‐buildpack-‐php (v43)
Loading from cache
Writing lock file
Generating autoload files
heroku-‐php $ foreman start
14:30:45 web.1 | started with pid 11175
14:30:46 web.1 | Booting on port 5000...
14:30:46 web.1 | Starting php-‐fpm...
14:30:46 web.1 | Starting nginx...

View Slide

(or you use your good old VirtualHost setup)

View Slide

VIII. CONCURRENCY

View Slide

VIII. CONCURRENCY
Scale out via the process model.

View Slide

VIII. CONCURRENCY
$ heroku ps:scale web=10
Scaling dynos... done, now running web at 10:1X.
$ heroku ps
=== web (1X): `vendor/bin/heroku-‐php-‐apache2 web/`
web.1: starting 2014/11/05 20:36:39 (~ 4s ago)
$ heroku ps:scale web=1
Scaling dynos... done, now running web at 1:1X.

View Slide

XII. ADMIN PROCESSES

View Slide

Management tasks like DB migrations are one-off processes.

View Slide

They run in isolation, just like all other "dynos".
With the same release: same code, same conﬁg!

View Slide

$ heroku run "php app/console doctrine:migrations:migrate" 
Running `php app/console…` attached to terminal... up, run.4062
Migrating up to 20100416130452 from 0
>> migrating 20100416130452
-‐> CREATE TABLE users (username VARCHAR(255) NOT NULL,
password VARCHAR(255) NOT NULL) ENGINE = InnoDB
>> migrated
They run in isolation, just like all other "dynos".
With the same release: same code, same conﬁg!

View Slide

IV. BACKING SERVICES

View Slide

IV. BACKING SERVICES
Treat backing services as attached resources.

View Slide

$ heroku addons:add heroku-‐postgresql
Adding heroku-‐postgresql on dz-‐php-‐test... done, v6 (free)
Attached as HEROKU_POSTGRESQL_AQUA_URL
Use `heroku addons:docs heroku-‐postgresql` to view documentati…
$ heroku addons:add heroku-‐postgresql
Adding heroku-‐postgresql on dz-‐php-‐test... done, v7 (free)
Attached as HEROKU_POSTGRESQL_AMBER_URL
Use `heroku addons:docs heroku-‐postgresql` to view documentati…
$ heroku addons:add redistogo
Adding redistogo on dz-‐php-‐test... done, v8 (free)
Use `heroku addons:docs redistogo` to view documentation.
$ heroku addons:add newrelic
Adding newrelic on dz-‐php-‐test... done, v9 (free)
Use `heroku addons:docs newrelic` to view documentation.
$ heroku config
=== dz-‐php-‐test Config Vars
DATABASE_URL: postgres://u:p@host12:5432/db18172
HEROKU_POSTGRESQL_AMBER_URL: postgres://u:p@host42:5198/db24438
HEROKU_POSTGRESQL_AQUA_URL: postgres://u:p@host12:5432/db18172
NEW_RELIC_LICENSE_KEY: c9eecdcf9523862f981e
REDISTOGO_URL: redis://u:[email protected]:9092/

View Slide

DEMO TIME!

View Slide

http://start.heroku.com/php
&
http://devcenter.heroku.com/categories/php

View Slide

ONE MORE THING...

View Slide

heroku-‐php $ git rm Procfile
heroku-‐php $ composer require -‐-‐ignore-‐platform-‐reqs hhvm:~3.5
./composer.json has been updated
Updating dependencies (including require-‐dev)
Nothing to install or update
Generating autoload files
heroku-‐php $ git add composer.*
heroku-‐php $ git ci -‐m 'use HHVM'
heroku-‐php $ git push heroku master
-‐-‐-‐-‐-‐> PHP app detected
-‐-‐-‐-‐-‐> Detected request for HHVM 3.5.0 in composer.json.
-‐-‐-‐-‐-‐> Setting up runtime environment...
-‐ HHVM 3.5.0
-‐ Apache 2.4.10
-‐ Nginx 1.6.0
-‐-‐-‐-‐-‐> Building runtime environment...
No Procfile, using 'web: vendor/bin/heroku-‐hhvm-‐apache2'
-‐-‐-‐-‐-‐> Compressing... done, 77.4MB
-‐-‐-‐-‐-‐> Launching... done, v3
http://dz-‐php-‐test.herokuapp.com/ deployed to Heroku

View Slide

The End

View Slide

THE TWELVE-
FACTOR APP
Thanks for listening! Contact:
@dzuelke & [email protected].
rate my talk
on joind.in!

View Slide

The Twelve-Factor App: Best Practices for Modern Web Applications

The Twelve-Factor App: Best Practices for Modern Web Applications

David Zuelke

More Decks by David Zuelke

Other Decks in Programming

Featured

Transcript