Merge pull request #3 from HusseinKabbout/master

Update docker documentation, remove pg_service file and also added probe tests for kubernetes

Author: pka

Dockerfile

@@ -9,8 +9,3 @@ RUN apk add --no-cache --update postgresql-dev gcc python3-dev musl-dev git
 
 ADD . /srv/qwc_service
 RUN pip3 install --no-cache-dir -r /srv/qwc_service/requirements.txt
-
-ADD pg_service.conf /var/www/.pg_service.conf
-ARG DB_USER=qwc_service
-ARG DB_PASSWORD=qwc_service
-RUN sed -i -e "s/^user=qwc_service/user=$DB_USER/" -e "s/^password=qwc_service/password=$DB_PASSWORD/" /var/www/.pg_service.conf

README.md

@@ -38,6 +38,29 @@ API documentation:
 
     http://localhost:5018/api/
 
+
+Docker usage
+------------
+
+To run this docker image you will need a configuration database. For testing purposes you can use the demo DB.
+
+The following steps explain how to download the demo DB docker image and how to run the `qwc-permalink-service` with `docker-compose`.
+
+**Step 1: Clone qwc-docker**
+
+    git clone https://github.com/qwc-services/qwc-docker
+    cd qwc-docker
+
+**Step 2: Create docker-compose.yml file**
+
+    cp docker-compose-example.yml docker-compose.yml
+
+**Step 3: Start docker containers**
+
+    docker-compose up qwc-permalink-service
+
+For more information please visit: https://github.com/qwc-services/qwc-docker
+
 Development
 -----------
 

pg_service.conf

@@ -1,4 +1,4 @@
-from flask import Flask, request, jsonify
+from flask import Flask, request, jsonify, make_response
 from flask_restplus import Api, Resource, reqparse
 from flask_jwt_extended import jwt_optional, get_jwt_identity
 import datetime
@@ -172,6 +172,26 @@ def post(self):
 
         return jsonify({"success": True})
 
+
+""" readyness probe endpoint """
+@app.route("/ready", methods=['GET'])
+def ready():
+    return jsonify({"status": "OK"})
+
+
+""" liveness probe endpoint """
+@app.route("/healthz", methods=['GET'])
+def healthz():
+    try:
+        configdb.connect()
+    except Exception as e:
+        return make_response(jsonify(
+            {"status": "FAIL", "cause":
+                str(e)}), 500)
+
+    return jsonify({"status": "OK"})
+
+
 if __name__ == "__main__":
     print("Starting Permalink service...")
     from flask_cors import CORS