diff options
author | 2018-05-22 17:38:16 -0700 | |
---|---|---|
committer | 2018-05-23 06:30:48 +0000 | |
commit | 78d594b5a54dd45aebe3ac05a256ce43ca4213b7 (patch) | |
tree | 78fe13a2547763a2bf7465b7150e3a4d246d310e /docs/index.rst | |
parent | cd6ef3a93d3dae845ba0333de9caa52c99923e9b (diff) |
Add release notes and fix docs
Add release notes for SMS
Fix other docs issues in SMS
Issue-ID: AAF-185
Change-Id: Ib3860018229b61942ab8a48cfdafe0b3f21ceed1
Signed-off-by: Kiran Kamineni <kiran.k.kamineni@intel.com>
Diffstat (limited to 'docs/index.rst')
-rw-r--r-- | docs/index.rst | 38 |
1 files changed, 11 insertions, 27 deletions
diff --git a/docs/index.rst b/docs/index.rst index 5f17a04..b971e9c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,36 +2,20 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 Intel Corporation, Inc -SMS-Secret Management Service -================================== +Secret Management Service (SMS) +=============================== -.. toctree:: - :maxdepth: 1 - - installation - usage - apiswagger +.. include:: architecture.rst +.. include:: installation.rst +.. include:: usage.rst - -Introduction +Offered APIs ------------ +The full API documentation is here: -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. +.. toctree:: + :maxdepth: 1 -**Secret Service High Level Flow Diagram** + api -.. image:: sms_high_level.png - :width: 4555550px - :height: 300px - :alt: SMS Flow Diagram +.. include:: release_notes.rst
\ No newline at end of file |