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

Slide 1

Slide 1 text

THE TWELVE-FACTOR APP Best Practices for Modern Web Applications

Slide 2

Slide 2 text

David Zuelke

Slide 3

Slide 3 text

No content

Slide 4

Slide 4 text

dz@heroku.com

Slide 5

Slide 5 text

@dzuelke

Slide 6

Slide 6 text

“The Twelve-Factor App”

Slide 7

Slide 7 text

“The Twelve-Factor App”

Slide 8

Slide 8 text

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

Slide 9

Slide 9 text

Its goals are scalability, maintainability, portability.

Slide 10

Slide 10 text

12factor.net

Slide 11

Slide 11 text

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");

Slide 12

Slide 12 text

II. DEPENDENCIES Applications have explicitly declared dependencies.

Slide 13

Slide 13 text

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" } }

Slide 14

Slide 14 text

do not check your vendors/ directory into Git

Slide 15

Slide 15 text

III. CONFIGURATION Store conﬁg in the environment.

Slide 16

Slide 16 text

III. CONFIGURATION Store conﬁg in the environment. Assumption: same code but different conﬁguration per deployment target

Slide 17

Slide 17 text

III. CONFIGURATION Store conﬁg in the environment. $transport = Swift_SmtpTransport::newInstance(  getenv('EMAIL_HOST'), getenv('EMAIL_PORT')?:25  )  -‐>setUsername(getenv('EMAIL_USERNAME'))  -‐>setPassword(getenv('EMAIL_PASSWORD'))  ; Assumption: same code but different conﬁguration per deployment target $ heroku config:set EMAIL_HOST=smtp.blah.com EMAIL_PORT=827 \ EMAIL_USERNAME=joecool EMAIL_PASSWORD=itwasadarkandstormynight

Slide 18

Slide 18 text

four separate conﬁg vars are annoying!

Slide 19

Slide 19 text

III. CONFIGURATION Store conﬁg in the environment. $smtp = parse_url(getenv('SMTP_GATEWAY_URL')); $transport = Swift_SmtpTransport::newInstance(  $smtp['host'], $smtp['port']  )  -‐>setUsername($smtp['user'])  -‐>setPassword($smtp['pass'])  ; Assumption: same code but different conﬁguration per deployment target $ heroku config:set SMTP_GATEWAY_URL=\ smtp://joecool:itwasadarkandstormynight@smtp.blah.com:827

Slide 20

Slide 20 text

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

Slide 21

Slide 21 text

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

Slide 22

Slide 22 text

$ heroku create dz-‐php-‐test Creating dz-‐php-‐test... done, stack is cedar-‐14 http://dz-‐php-‐test.herokuapp.com/ | git@heroku.com: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

Slide 23

Slide 23 text

how did that work?

Slide 24

Slide 24 text

V. BUILD, RELEASE, RUN

Slide 25

Slide 25 text

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.

Slide 26

Slide 26 text

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.

Slide 27

Slide 27 text

X. DEV/PROD PARITY

Slide 28

Slide 28 text

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

Slide 29

Slide 29 text

X. DEV/PROD PARITY Keep dev, stage and prod envs as similar as possible. SQLite ≠ MySQL Apache ≠ Nginx File based sessions ≠ Redis based sessions

Slide 30

Slide 30 text

X. DEV/PROD PARITY Keep dev, stage and prod envs as similar as possible. SQLite ≠ MySQL Apache ≠ Nginx File based sessions ≠ Redis based sessions

Slide 31

Slide 31 text

X. DEV/PROD PARITY Keep dev, stage and prod envs as similar as possible. 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!

Slide 32

Slide 32 text

VI. PROCESSES

Slide 33

Slide 33 text

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

Slide 34

Slide 34 text

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

Slide 35

Slide 35 text

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

Slide 36

Slide 36 text

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

Slide 37

Slide 37 text

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

Slide 38

Slide 38 text

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

Slide 39

Slide 39 text

PHP needs a dedicated web server

Slide 40

Slide 40 text

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

Slide 41

Slide 41 text

RUNNING PHP APPS LOCALLY heroku-‐php $ composer require -‐-‐dev heroku/heroku-‐buildpack-‐php ./composer.json has been updated Loading composer repositories with package information 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...

Slide 42

Slide 42 text

(or you use your good old VirtualHost setup)

Slide 43

Slide 43 text

VIII. CONCURRENCY

Slide 44

Slide 44 text

VIII. CONCURRENCY Scale out via the process model.

Slide 45

Slide 45 text

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) web.2: starting 2014/11/05 20:36:39 (~ 4s ago) web.3: starting 2014/11/05 20:36:39 (~ 4s ago) web.4: starting 2014/11/05 20:36:38 (~ 4s ago) web.5: starting 2014/11/05 20:36:38 (~ 4s ago) web.6: starting 2014/11/05 20:36:39 (~ 4s ago) web.7: starting 2014/11/05 20:36:38 (~ 4s ago) web.8: starting 2014/11/05 20:36:39 (~ 4s ago) web.9: starting 2014/11/05 20:36:38 (~ 4s ago) web.10: starting 2014/11/05 20:36:39 (~ 4s ago) $ heroku ps:scale web=1 Scaling dynos... done, now running web at 1:1X.

Slide 46

Slide 46 text

XII. ADMIN PROCESSES

Slide 47

Slide 47 text

XII. ADMIN PROCESSES Management tasks like DB migrations are one-off processes.

Slide 48

Slide 48 text

XII. ADMIN PROCESSES Management tasks like DB migrations are one-off processes. They run in isolation, just like all other "dynos". With the same release: same code, same conﬁg!

Slide 49

Slide 49 text

XII. ADMIN PROCESSES Management tasks like DB migrations are one-off processes. $ 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!

Slide 50

Slide 50 text

IV. BACKING SERVICES

Slide 51

Slide 51 text

IV. BACKING SERVICES Treat backing services as attached resources.

Slide 52

Slide 52 text

$ 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:p@i8.redistogo.com:9092/

Slide 53

Slide 53 text

DEMO TIME!

Slide 54

Slide 54 text

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

Slide 55

Slide 55 text

ONE MORE THING...

Slide 56

Slide 56 text

heroku-‐php $ git rm Procfile heroku-‐php $ composer require -‐-‐ignore-‐platform-‐reqs hhvm:~3.5 ./composer.json has been updated Loading composer repositories with package information 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

Slide 57

Slide 57 text

The End

Slide 58

Slide 58 text

THE TWELVE- FACTOR APP Thanks for listening! Contact: @dzuelke & dz@heroku.com. rate my talk on joind.in!