dockerize node app, mysql, and load balancer with dynamic configuration

Author: maxbeatty

.dockerignore

@@ -0,0 +1,12 @@
+.git
+node_modules
+.dockerignore
+.editorconfig
+.eslintignore
+.eslintrc
+.gitattributes
+.gitignore
+.nvmrc
+*.md
+docker-compose.yml
+Dockerfile

.nvmrc

@@ -1 +1 @@
-v4.2.1
+v5.3.0

.travis.yml

@@ -1,15 +1,5 @@
 language: node_js
-node_js:
-- 4
 env: PORT=3000
-before_install:
-- npm install -g npm@latest
 after_script:
 - npm install -g codeclimate-test-reporter
 - codeclimate-test-reporter < lcov.info || echo "Could not upload code coverage to CodeClimate"
-deploy:
-  provider: heroku
-  app:
-    master: jsperf-dev
-  api_key:
-    secure: Enbwr5BsIj6Q12tlrPytm7aoOgOBc5649NrRZaUzXbPxBMZslrs//bE2ibYE/UgUu55gzNh8a5orGVNj2i+wiisFsblF4K/GgNxlNWgTJtdd7Y27JKBGXJdXUJk6hMU4ksgNy9YM/fJAvPQOdyI7Pb+fM7oXwTvWeciSeUrev44=

Dockerfile

@@ -0,0 +1,13 @@
+FROM node
+
+RUN mkdir /code
+WORKDIR /code
+
+ADD package.json /code
+RUN npm install
+
+ADD . /code
+
+EXPOSE 3000
+
+CMD ["node", "server.js"]

Procfile

@@ -8,16 +8,44 @@
 
 ### Prerequisites
 
-You’ll need [node.js](https://nodejs.org/en/) and [MySQL](https://www.mysql.com/downloads/) installed.
-
-1. Clone the repository (`git clone https://github.com/jsperf/jsperf.com.git`).
-2. Install dependencies (`npm install`).
-3. Get a [Browserscope.org](https://www.browserscope.org/) API key by signing in and going to [the settings page](https://www.browserscope.org/user/settings). (You'll need this in the next step)
-4. Register a new OAuth GitHub development application by going to [your settings page in github](https://github.com/settings/applications/new). Take note to copy the "Client ID" and "Client Secret". The callback URL is simply the root url of the application, e.g., "http://localhost:3000"
-5. Setup database and other environment configuration (`npm run setup`).
+1. Clone the repository: `git clone https://github.com/jsperf/jsperf.com.git`
+2. Use the version of `node` for this project defined in `.nvmrc`: `nvm install` ([More on `nvm`](https://github.com/creationix/nvm))
+2. Install dependencies: `npm install`
+3. Get a [Browserscope.org](http://www.browserscope.org/) API key by signing in and going to [the settings page](http://www.browserscope.org/user/settings). (You'll need this in the last step)
+4. Register a new OAuth GitHub development application by going to [your settings page in github](https://github.com/settings/applications/new). Take note to copy the "Client ID" and "Client Secret". The callback URL is simply the root url of the application, e.g., `http://localhost:3000`
+5. Setup environment configuration: `npm run setup`
 
 ### Running the server
 
+#### Docker
+
+##### One-time Setup
+
+1. Install [Docker Toolbox](https://docs.docker.com/engine/installation/) so you have `docker` and `docker-compose`
+2. Create a Data Volume Container to persist data: `docker create -v /var/lib/mysql --name data-jsperf-mysql mysql /bin/true`
+3. Setup database tables: `docker-compose run web node /code/setup/tables`
+
+##### Compose
+
+`docker-compose.yml` orchestrates a load balancer (nginx), the app (this node project), and a database (mysql) with some additional services to help with continuous deployment. To start everything up, run: `docker-compose up`. Pressing `ctrl+c` or sending a similar interruption will stop all of the containers. To run the composed containers in the background, use the `-d` argument.
+
+You can start additional app containers by running `docker-compose scale web=3` where `3` is the total number of containers. The load balancer will automatically reconfigure itself to include the new containers. Similarly, you can scale down the containers by running `docker-compose scale web=1` and the load balancer will, again, reconfigure itself accordingly.
+
+Once you've built the images with `docker-compose`, you can manually run additional containers similar to how `docker-compose scale` would.
+
+```
+docker run -d --name jsperfcom_web_man \
+--link jsperfcom_db_1:db \
+--env-file .env \
+--env SERVICE_3000_CHECK_HTTP=/health \
+--env SERVICE_3000_CHECK_INTERVAL=1s \
+jsperfcom_web
+```
+
+#### Local
+
+You’ll need [node.js](https://nodejs.org/en/) and [MySQL](https://www.mysql.com/downloads/) installed.
+
 ```
 npm start
 ```
@@ -39,7 +67,7 @@ npm test -- test/server/web/contributors/index.js
 
 _If you'd just like to lint and save a little time, you can run `npm run lint` which skips the tests._
 
-_If you'd like an HTML report with code coverage, you can run `npm run test-cov-html` which will create `coverage.html` in the root of the project._
+_If you're missing code coverage, open `coverage.html` in the root of the project for a detailed visual report._
 
 ## Gotchas
 

README.md

@@ -45,13 +45,6 @@ var config = {
     email: process.env.ADMIN_EMAIL
   },
   browserscope: process.env.BROWSERSCOPE,
-  db: {
-    host: process.env.DB_HOST,
-    port: process.env.DB_PORT,
-    user: process.env.DB_USER,
-    pass: process.env.DB_PASS,
-    name: process.env.DB_NAME
-  },
   debug: {
     $filter: 'env',
     development: true,

config.js

@@ -0,0 +1,35 @@
+web:
+  build: .
+  env_file: .env
+  links:
+    - db
+  environment:
+    SERVICE_3000_CHECK_HTTP: '/health'
+    SERVICE_3000_CHECK_INTERVAL: '1s'
+db:
+  image: mysql
+  volumes_from:
+    - data-jsperf-mysql
+  env_file: .env
+  environment:
+    MYSQL_RANDOM_ROOT_PASSWORD: 'true'
+    MYSQL_DATABASE: jsperf
+    MYSQL_USER: jsperf
+lb:
+  build: ./docker
+  dockerfile: Dockerfile-lb
+  links:
+    - web
+    - consul
+  ports:
+    - '80:80'
+consul:
+  image: gliderlabs/consul-server:0.6
+  command: -bootstrap
+registrator:
+  image: gliderlabs/registrator:v6
+  command: -internal consul://consul:8500
+  links:
+    - consul
+  volumes:
+    - "/var/run/docker.sock:/tmp/docker.sock"

docker-compose.yml

@@ -0,0 +1,15 @@
+FROM gliderlabs/alpine
+
+RUN echo "@testing http://dl-4.alpinelinux.org/alpine/edge/testing" >> /etc/apk/repositories
+
+RUN apk-install nginx curl runit@testing
+
+RUN curl -L -o /tmp/consul-template.zip http://releases.hashicorp.com/consul-template/0.12.0/consul-template_0.12.0_linux_amd64.zip
+RUN unzip /tmp/consul-template.zip -d /usr/local/bin
+
+ADD nginx.service /etc/service/nginx/run
+ADD consul-template.service /etc/service/consul-template/run
+
+ADD nginx.conf /etc/consul-templates/nginx.conf
+
+CMD ["/sbin/runsvdir", "/etc/service"]

docker/Dockerfile-lb

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+exec consul-template \
+     -consul=consul:8500 \
+     -template "/etc/consul-templates/nginx.conf:/etc/nginx/nginx.conf:sv hup nginx"

docker/consul-template.service

@@ -0,0 +1,31 @@
+worker_processes  1;
+
+events {
+    worker_connections  1024;
+}
+
+http {
+  upstream app {
+    least_conn;
+    {{range service "jsperfcom_web"}}
+    server {{.Address}}:{{.Port}} max_fails=3 fail_timeout=60 weight=1;
+    {{else}}
+    server 127.0.0.1:65535; # force a 502
+    {{end}}
+  }
+
+  server {
+    listen 80 default_server;
+
+    location / {
+      proxy_pass http://app;
+      proxy_http_version 1.1;
+      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+      proxy_set_header X-Real-IP $remote_addr;
+      proxy_set_header Host $host;
+      proxy_set_header Upgrade $http_upgrade;
+      proxy_set_header Connection 'upgrade';
+      proxy_cache_bypass $http_upgrade;
+    }
+  }
+}

docker/nginx.conf

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+/usr/sbin/nginx -c /etc/nginx/nginx.conf -t && \
+exec /usr/sbin/nginx -c /etc/nginx/nginx.conf -g "daemon off;"

docker/nginx.service

@@ -74,6 +74,7 @@ var manifest = {
     {'./server/web/contributors': {}},
     {'./server/web/errors': {}},
     {'./server/web/faq': {}},
+    {'./server/web/health': {}},
     {'./server/web/home': {}},
     {'./server/web/popular': {}},
     {'./server/web/public': {}},

manifest.js

@@ -7,9 +7,9 @@
     "clean": "rm npm-debug.log lcov.info coverage.html",
     "lint": "lab -d -L",
     "setup": "node setup",
-    "start": "nodemon --ext js,hbs server.js",
-    "test": "lab -t 100 -c -L -r lcov -o lcov.info -r console -o stdout",
-    "test-cov-html": "lab -r html -o coverage.html && open coverage.html"
+    "start": "node server.js",
+    "test": "lab -t 100 -c -L -r lcov -o lcov.info -r console -o stdout -r html -o coverage.html",
+    "watch": "nodemon --ext js,hbs server.js"
   },
   "repository": {
     "type": "git",
@@ -57,9 +57,5 @@
     "prompt": "^0.2.14",
     "proxyquire": "^1.4.0",
     "sinon": "^1.15.4"
-  },
-  "engines": {
-    "node": "4.x.x",
-    "npm": "3.x.x"
   }
 }

package.json

@@ -7,5 +7,13 @@ composer(function (err, server) {
 
   server.start(function () {
     server.log('info', 'Server running at: ' + server.info.uri);
+
+    process.on('SIGTERM', function () {
+      server.log('info', 'Received SIGTERM. Attempting to stop server');
+      server.stop({ timeout: 10000 }, function () {
+        server.log('info', 'Server stopped. Exiting');
+        process.exit(0);
+      });
+    });
   });
 });

server.js

@@ -10,11 +10,11 @@ module.exports = {
     }
     return new Promise(function (resolve, reject) {
       var conn = mysql.createConnection({
-        host: config.get('/db/host'),
-        port: config.get('/db/port'),
-        user: config.get('/db/user'),
-        password: config.get('/db/pass'),
-        database: config.get('/db/name'),
+        host: 'db',
+        port: 3306,
+        user: process.env.DB_ENV_MYSQL_USER,
+        password: process.env.DB_ENV_MYSQL_PASSWORD,
+        database: process.env.DB_ENV_MYSQL_DATABASE,
         // query and rows will print to stdout
         debug: config.get('/debug') ? ['ComQueryPacket', 'RowDataPacket'] : false,
         charset: 'utf8mb4'

server/lib/db.js

@@ -0,0 +1,23 @@
+const db = require('../../lib/db');
+
+exports.register = function (server, options, next) {
+  server.route({
+    method: 'GET',
+    path: '/health',
+    handler: function (request, reply) {
+      db.genericQuery('SELECT 1;')
+        .then(function () {
+          reply();
+        })
+        .catch(function () {
+          reply(new Error('Unhealthy'));
+        });
+    }
+  });
+
+  return next();
+};
+
+exports.register.attributes = {
+  name: 'web/health'
+};