Update readmes and add lightship back

waldemarnt · waldemarnt · commit 10c7e51aa02f · 2019-07-27T17:33:36.000+10:00
diff --git a/index.js b/index.js
@@ -1,17 +1,24 @@
 const log = require('./src/log');
 const { setupApp } = require('./src/app');
 const config = require('config');
-//const { createLightship } = require('lightship');
+const { createLightship } = require('lightship');
+/**
+ * Uses node cluster to make sure all CPU cores will be used
+ * https://nodejs.org/api/cluster.html
+ */
 const cluster = require('cluster');
 const CPUs = require('os').cpus().length;
 
-log.info('CPUs available', CPUs);
-
-//const ls = createLightship();
+/**
+ * Lightship adds readiness and liveness prob endpoints
+ * for kubernetes healthchecks https://github.com/gajus/lightship
+ */
+const ls = createLightship();
 
 if(config.get('App.cluster.enabled') && cluster.isMaster) {
   log.info(`Master ${process.pid} is running`);
 
+  // forks a process for each CPU core
   for(let i = 0; i < CPUs; i++) {
     cluster.fork();
   }
@@ -25,7 +32,7 @@ if(config.get('App.cluster.enabled') && cluster.isMaster) {
       log.info(`Worker ${process.pid} started`);
       return app;
     })
-    //.then(() => ls.signalReady())
+    .then(() => ls.signalReady())
     .catch(error => {
       log.error(error);
       process.exit(1); // eslint-disable-line
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -25,7 +25,7 @@
     "elastic-apm-node": "^2.12.1",
     "express": "^4.17.1",
     "fibonacci": "^1.6.7",
-    "lightship": "^4.3.0",
+    "lightship": "^4.3.1",
     "mongoose": "^4.13.19",
     "request": "^2.88.0",
     "request-promise": "^4.2.4",
