summaryrefslogtreecommitdiffstats
path: root/docs/architecture.rst
diff options
context:
space:
mode:
authorRuslan Kashapov <ruslan.kashapov@pantheon.tech>2021-03-02 16:48:41 +0200
committerRuslan Kashapov <ruslan.kashapov@pantheon.tech>2021-03-16 17:26:10 +0200
commit55dc654964942aa67c48f09b0ba56059be8e923b (patch)
treef5191e02b3a29335b541480894dc87863e18ad95 /docs/architecture.rst
parent344434b68c2418c6e901e7acab02886be6e6b1cb (diff)
Docs: overview, architecture, design, modeling
Issue-ID: CPS-268 Change-Id: I31480a9a6186af0ddedae4f0eca06a744a2e2d64 Signed-off-by: Ruslan Kashapov <ruslan.kashapov@pantheon.tech>
Diffstat (limited to 'docs/architecture.rst')
-rw-r--r--docs/architecture.rst65
1 files changed, 62 insertions, 3 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst
index c613e4ff95..51acf66f0e 100644
--- a/docs/architecture.rst
+++ b/docs/architecture.rst
@@ -1,5 +1,64 @@
-.. Copyright (C) 2021 Nordix Foundation
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (C) 2021 Nordix Foundation, Pantheon.tech
.. _architecture:
-CPS in ONAP Architecture
--------------------------- \ No newline at end of file
+CPS Architecture
+################
+
+.. toctree::
+ :maxdepth: 1
+
+
+High Level Component Definition and Architectural Relationships
+===============================================================
+
+The Configuration Persistence Service (CPS) provides storage for run-time configuration and operational
+parameters that need to be used by ONAP.
+
+In this release the CPS is a stand-alone component. Project page describing eventual scope and ambition is here:
+`Configuration Persistence Service Project <https://wiki.onap.org/display/DW/Configuration+Persistence+Service+Project>`_
+
+This page reflects the state for Honolulu-R8 release.
+
+.. image:: _static/cps-r8-arch-diagram.png
+
+API definitions
+===============
+
+Configuration Persistence Service provides following interfaces.
+
+.. list-table::
+ :header-rows: 1
+
+ * - Interface name
+ - Interface definition
+ - Interface capabilities
+ - Protocol
+ * - CPS-E-01
+ - Administrative Data Management
+ - - create/delete dataspace
+ - create/delete schema set
+ - create/delete anchor
+ - REST
+ * - CPS-E-02
+ - Generic Data Access
+ - - create data node
+ - read data node by xpath with or without descendants
+ - update data node by xpath with or without descendants
+ - REST
+ * - CPS-E-03
+ - Generic Data Search
+ - - query data nodes by xpath prefix and attribute value
+ - REST
+ * - CPS-E-04
+ - Change Notification
+ - *Not available in Honolulu-R8*
+ - *N/A*
+ * - CPS-E-05
+ - xNF Data Access
+ - - read xNF data
+ - query xNF data
+ - REST
+
+The CPS Basic Concepts are described in :doc:`modeling`.