From 55dc654964942aa67c48f09b0ba56059be8e923b Mon Sep 17 00:00:00 2001 From: Ruslan Kashapov Date: Tue, 2 Mar 2021 16:48:41 +0200 Subject: Docs: overview, architecture, design, modeling Issue-ID: CPS-268 Change-Id: I31480a9a6186af0ddedae4f0eca06a744a2e2d64 Signed-off-by: Ruslan Kashapov --- docs/architecture.rst | 65 ++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 62 insertions(+), 3 deletions(-) (limited to 'docs/architecture.rst') 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 `_ + +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`. -- cgit 1.2.3-korg