From d1cc451f841f995028d57677e897a39229a065a2 Mon Sep 17 00:00:00 2001 From: opensource-tnbt Date: Tue, 1 Dec 2020 09:17:56 +0530 Subject: Docs: Overview Document. This patch adds overview document. Signed-off-by: Sridhar K. N. Rao Change-Id: I1504c297d0b51a71c1a20f7b9d7c1853e61291c9 --- docs/release/overview/index.rst | 49 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 docs/release/overview/index.rst (limited to 'docs/release/overview/index.rst') diff --git a/docs/release/overview/index.rst b/docs/release/overview/index.rst new file mode 100644 index 0000000..d5dce9c --- /dev/null +++ b/docs/release/overview/index.rst @@ -0,0 +1,49 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Spirent Communications and others + +**************************************** +OPNFV CIRV - Sofware Delivery Validation +**************************************** + +CIRV-SDV is an umbrella term used for collection of software validation tools. The term Software in SDV, refers to mainly two things: + +* Installer Manifests +* Infrastructure Configuration + +CIRV-SDV aims to perfom the validation of the software configuration, against the design and requirements, that are preferably defined in a unified machine-readable format. Hence, the whole project relies heavily on an implementation of PDF 2.0 defined in CNTT. + +======= +PDF 2.0 +======= + +The platform description is defined in CNTT RI-1 Chapter-6. CIRV-SDV includes a JSON-based implementation of this platform description. In *sdv/pdf/template*, user will find the template file, which can be used to customize for their environment. Alternatively, user can use a GUI tool in *sdv/pdf/site* folder. + +=============== +The Big Picture +=============== + +The below figure summarizes the applicability of CIRV-SDV, and it role in overall cloud deployment. + +.. image:: ./cirv-bigpicture.png + :width: 600 + +===================== +CIRV-SDV Architecture +===================== + +The below figure provides architecture (containerized version) of CIRV-SDV. CIRV-SDV will also include non-containerized version in future. + + +.. image:: ./cirv-archi.png + :width: 600 + +====================== +CIRV-SDV Control Flow +====================== + +The below figure summarizes the control-flow among different components. From the below figure, user can see the importance of PDF. + + +.. image:: ./cirv-cf.png + :width: 600 -- cgit 1.2.3-korg