Adding a docs folder under sms repo

WORK IN PROGRESS
Adding a docs folder under sms

Issue-ID: AAF-185
Change-Id: I5ee3560cfda2100ad5207bb7e98d5cb9472e1325
Signed-off-by: Girish Havaldar <hg0071052@techmahindra.com>

1 files changed, 37 insertions, 0 deletions

diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..5f17a04
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,37 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2018 Intel Corporation, Inc
+
+SMS-Secret Management Service
+==================================
+
+.. toctree::
+   :maxdepth: 1
+
+   installation
+   usage
+   apiswagger
+
+
+Introduction
+------------
+
+This project aims at the Storage of sensitive information such as passwords.
+
+**Current state and gaps**
+
+Many services in ONAP use password based authentication. Eg: Database servers, publish/subscribe brokers etc.
+Passwords are stored in plain text files in many services.
+With multiple instances of these services, the attach surface area becomes very big.
+Hence there is a need to ensure that attack surface related to password exposure is reduced.
+
+**Requirement:**
+
+Need for secure secret management. Services are expected to get the secret only on needed basis using secret reference and remove the secrets once they are used up.
+
+**Secret Service High Level Flow Diagram**
+
+.. image:: sms_high_level.png
+   :width: 4555550px
+   :height: 300px
+   :alt: SMS Flow Diagram