From eafe5381d0eaf7a18597688c4961bc4a872f0b72 Mon Sep 17 00:00:00 2001
From: Elton Stoneman <elton@sixeyed.com>
Date: Tue, 21 Nov 2017 11:06:41 +0000
Subject: [PATCH] Add readme & Grafana setup

---
 README.md                           | 94 +++++++++++++++++++++++++++++
 bulletin-board-dashboard/Dockerfile |  5 ++
 docker-compose.yml                  |  5 +-
 3 files changed, 103 insertions(+), 1 deletion(-)
 create mode 100644 README.md
 create mode 100644 bulletin-board-dashboard/Dockerfile

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..abd6524
--- /dev/null
+++ b/README.md
@@ -0,0 +1,94 @@
+
+# Node Bulletin Board
+
+A Node.js sample app which shows an event bulletin board, using Vue.js for the front-end and SQL Server for storage. The app runs in containers and the only pre-requisite for building and running the whole stack is Docker.
+
+![Bulletin Board app](img/bulletin-board.jpg)
+
+### Credits
+
+The original app is from [Vue Events Bulletin Board](https://github.com/chenkie/vue-events-bulletin) and the Prometheus integration comes from [Example Prometheus Monitoring](https://github.com/RisingStack/example-prometheus-nodejs).
+
+## Tech Stack
+
+The entrypoint to the app is an Nginx container, which acts as a reverse proxy to the Node.js application container. The application container stores data in the SQL Server container, and it also exposes instrumentation metrics which are scraped by a Prometheus container. The Prometheus metrics are exposed in a dashboard from the Grafana container. 
+
+## Usage
+
+The [Docker Compose](docker-compose.yml) file uses an environment variable for your Docker ID, so you can build the images and push to Docker Hub. Start by capturing your Docker ID in an environment variable:
+
+```
+export dockerId='<your-docker-id>'
+```
+
+### Build Docker images
+
+Build the application and database images using Docker Compose:
+
+```
+docker-compose build
+```
+
+### Run the app
+
+You can run the app using the same compose file:
+
+```
+docker-compose up -d
+```
+
+Browse to [localhost](http://localhost) to use the app.
+
+### Configure Grafana
+
+The compose file runs Prometheus to collect metrics and Grafana to show an application dashbaord. Grfana needs some additional setup.
+
+Browse to [localhost:3000](http://localhost:3000) and log in to Grafana with the credentials `admin` / `admin`. 
+
+Add a new data source with the following details:
+
+- Name: **prometheus**
+
+- Type: **Prometheus**
+
+- URL: **http://bb-metrics:9090**
+
+![Grafana data source](img/grafana-data-source.jpg)
+
+From the Grafana icon, click _Dashboards... Import_ and load the JSON dashboard file from [bulletin-board-dashboard/dashboard.json](bulletin-board-dashboard/dashboard.json). Select the Prometheus data store.
+
+You'll now see the application dashboard - send some load into the app by refreshing the browser, and the graphs will be populated:
+
+![Grafana dashboard](img/grafana-dashboard.jpg)
+
+> You can save the configured Grafana container as an image, which persists all the setup changes.
+
+```
+docker container commit nodebulletinboard_bb-dashboard_1 $dockerId/bulletin-board-dashboard
+```
+
+### Running in swarm mode
+
+You can deploy the app to a Docker swarm for high availability and scale. A single-node swarm is fine for testing.
+
+If you're running the app from compose, first remove all the containers:
+
+```
+docker-compose down
+```
+
+Switch to swarm mode:
+
+```
+docker swarm init
+```
+
+> If your Docker host has multiple IP addresses, you'll need to specify the local network IP in the `advertise-addr` option.
+
+Then deploy the application as a stack:
+
+```
+docker stack deploy -c docker-stack.yml bb
+```
+
+You can browse to the app at the server address, and to the configured Grafana instance at port 3000.
\ No newline at end of file
diff --git a/bulletin-board-dashboard/Dockerfile b/bulletin-board-dashboard/Dockerfile
new file mode 100644
index 0000000..f93f9f8
--- /dev/null
+++ b/bulletin-board-dashboard/Dockerfile
@@ -0,0 +1,5 @@
+FROM grafana/grafana:4.6.2
+
+ENV GF_PATHS_DATA='/data'
+
+WORKDIR /data
diff --git a/docker-compose.yml b/docker-compose.yml
index 2a8bb5a..40e18e8 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -15,6 +15,7 @@ services:
       context: ./bulletin-board-app
     depends_on:
       - bb-db
+    restart: on-failure
     networks:
       - bb-net
 
@@ -39,7 +40,9 @@ services:
       - bb-net
 
   bb-dashboard:
-    image: grafana/grafana
+    image: ${dockerId}/bulletin-board-dashboard
+    build:
+      context: ./bulletin-board-dashboard
     ports:
       - "3000:3000"
     depends_on: