1 files changed, 61 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..53bdcc4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+# policy_handler 
+## web-service for policies to be used by DCAE-Controller
+
+- GET **/policy\_latest/***\<policy-id>* -- get the latest policy from policy-engine
+- receives the **push notifications** from policy-engine through the web-socket, filters and gets the full policy-configs, and delivers that to deploy-handler
+
+## manual http API
+
+- GET **/catch_up** -- catch up with the latest state of the policy-engine 
+- GET **/policies_latest** -- get all the latest policies in policy-engine through web-service API
+- GET **/shutdown** -- shutdown the server
+
+----------
+
+## installation
+
+`virtualenv policy_venv`
+
+`cd policy_venv`
+
+`source bin/activate`
+
+`cd ../policy_handler`
+
+`pip install -r requirements.txt`
+
+----------
+
+## preparation to run
+
+`cd policy_venv`
+
+`source bin/activate`
+
+`cd ../policy_handler`
+
+----------
+
+## configure
+
+in folder `policy_handler`:
+
+    - `config.json` contains
+        - `"scope_prefixes" : ["DCAE_alex.Config_"]` - the list of policy-scope-class values
+        - `"policy_engine"` - the http connect info to ECOMP **policy-engine**
+            - headers.ClientAuth : base64(<mech-id with namespace>:<password>)
+            - headers.Authorization : base64(<policy-engine server auth>)
+        - `"deploy_handler"` - the http connect info to _policy part_ of the **deploy-handler**
+    - `policy_engine.properties` contains config info for the client lib of ECOMP **policy-engine** that receives push notifications from the ECOMP **policy-engine** server
+        - CLIENT_ID is the mech-id with the namespace - need to register with policy-engine team thru email
+        - CLIENT_KEY is the base64 of the mech-id password - separate passwords for TEST versus PROD
+
+----------
+
+## run
+
+in folder `policy_handler`:
+
+`./run_policy.sh`
+
+----------