From 107fd7acf24ed91edca042689d090f24a440fd9f Mon Sep 17 00:00:00 2001 From: lukegleeson Date: Mon, 27 Sep 2021 13:59:25 +0100 Subject: Update Architecture Section of Documentation Add new interfaces Update CPS Architecture Diagram Issue-ID: CPS-684 Signed-off-by: lukegleeson Change-Id: I010da2e7e13c7371c71bd9de11335baa8547a65e --- docs/_static/cps-r8-arch-diagram.png | Bin 62879 -> 0 bytes docs/_static/cps-r9-arch-diagram.png | Bin 0 -> 61907 bytes docs/_static/star.png | Bin 0 -> 486 bytes docs/architecture.rst | 30 +++++++++++++++++++++++------- 4 files changed, 23 insertions(+), 7 deletions(-) delete mode 100644 docs/_static/cps-r8-arch-diagram.png create mode 100644 docs/_static/cps-r9-arch-diagram.png create mode 100644 docs/_static/star.png diff --git a/docs/_static/cps-r8-arch-diagram.png b/docs/_static/cps-r8-arch-diagram.png deleted file mode 100644 index f5a90a6ea1..0000000000 Binary files a/docs/_static/cps-r8-arch-diagram.png and /dev/null differ diff --git a/docs/_static/cps-r9-arch-diagram.png b/docs/_static/cps-r9-arch-diagram.png new file mode 100644 index 0000000000..181804139b Binary files /dev/null and b/docs/_static/cps-r9-arch-diagram.png differ diff --git a/docs/_static/star.png b/docs/_static/star.png new file mode 100644 index 0000000000..570345c77f Binary files /dev/null and b/docs/_static/star.png differ diff --git a/docs/architecture.rst b/docs/architecture.rst index b703cfa535..12a51e222b 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -6,8 +6,6 @@ CPS Architecture ################ -.. warning:: draft - .. toctree:: :maxdepth: 1 @@ -25,12 +23,17 @@ Project page describing eventual scope and ambition is here: This page reflects the state for Istanbul-R9 release. -.. image:: _static/cps-r8-arch-diagram.png +.. image:: _static/star.png + :class: float-left + +**Note:** SDC and AAI interfaces have not yet been implemented. + +.. image:: _static/cps-r9-arch-diagram.png API definitions =============== -Configuration Persistence Service provides following interfaces. +Configuration Persistence Service provides the following interfaces. .. list-table:: :header-rows: 1 @@ -41,7 +44,7 @@ Configuration Persistence Service provides following interfaces. - Protocol * - CPS-E-01 - Administrative Data Management - - - create/delete dataspace + - - create dataspace - create/delete schema set - create/delete anchor - REST @@ -57,12 +60,25 @@ Configuration Persistence Service provides following interfaces. - REST * - CPS-E-04 - Change Notification - - *Not available in Honolulu-R8* - - *N/A* + - - Kafka is used as the event messaging system + - running instance is supplied independently from ONAP DMaaP component or any Kafka instance deployed from ONAP + - published events contain Timestamp, Dataspace, Schema set, Anchor and JSON Data Payload + - DMaaP * - CPS-E-05 - xNF Data Access - - read xNF data - query xNF data - REST + * - CPS-E-06 + - Temporal Data Access + - - data storage and access + - REST + * - CPS-E-07 + - Admin + - - logging levels and configuration + - monitoring + - health including liveliness state and readiness state + - metrics through Prometheus + - Various The CPS Basic Concepts are described in :doc:`modeling`. -- cgit 1.2.3-korg