Docs: Overview Document.opnfv-10.0.0stable/jerma

This patch adds overview document.

Signed-off-by: Sridhar K. N. Rao <sridhar.rao@spirent.com>
Change-Id: I1504c297d0b51a71c1a20f7b9d7c1853e61291c9

8 files changed, 55 insertions, 4 deletions

diff --git a/docs/index.rst b/docs/index.rst
index d2388cd..ae0729f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -12,6 +12,7 @@ OPNFV CIRV-SDV
    :maxdepth: 3
 
    release/release-notes/index
+   release/overview/index
    pdf/userguide
    sdvconfig/developer/devguide
    sdvconfig/user/configguide
diff --git a/docs/release/overview/cirv-archi.png b/docs/release/overview/cirv-archi.png
new file mode 100755
index 0000000..3f8c763
--- /dev/null
+++ b/docs/release/overview/cirv-archi.png
diff --git a/docs/release/overview/cirv-bigpicture.png b/docs/release/overview/cirv-bigpicture.png
new file mode 100755
index 0000000..c18311d
--- /dev/null
+++ b/docs/release/overview/cirv-bigpicture.png
diff --git a/docs/release/overview/cirv-cf.png b/docs/release/overview/cirv-cf.png
new file mode 100755
index 0000000..6a2d279
--- /dev/null
+++ b/docs/release/overview/cirv-cf.png
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
diff --git a/docs/state/development/result_api.rst b/docs/state/development/result_api.rst
index 6412c7d..1ba045f 100644
--- a/docs/state/development/result_api.rst
+++ b/docs/state/development/result_api.rst
@@ -1,5 +1,5 @@
-SDVState: Result API
-====================
+SDVState Result API
+===================
 
 Table of contents
 ^^^^^^^^^^^^^^^^^
diff --git a/docs/state/development/settings.rst b/docs/state/development/settings.rst
index 806a29a..6b6396d 100644
--- a/docs/state/development/settings.rst
+++ b/docs/state/development/settings.rst
@@ -1,4 +1,4 @@
-SDVState: Program Settings handler
+SDVState Program Settings handler
 ----------------------------------
 
 ``from tools.conf import settings``
@@ -41,4 +41,4 @@ overwrite previous values. .
 Managing Settings
 ^^^^^^^^^^^^^^^^^
 - Get ``value`` of ``key`` using ``settings.getValue(key)``
-- Set ``key, value`` using ``settings.setValue(key, value)``
\ No newline at end of file
+- Set ``key, value`` using ``settings.setValue(key, value)``
diff --git a/sdv/pdf/template/pdf_template.json b/sdv/pdf/template/pdf_template.json
index c389330..5dfada5 100644
--- a/sdv/pdf/template/pdf_template.json
+++ b/sdv/pdf/template/pdf_template.json
@@ -1,4 +1,5 @@
 {

+  "_comment_head":"Maintainer - Sridhar Rao <sridhar.rao@spirent.com>",

   "_comment_head1":"User should Configure all profiles. Add new, if reqd.",

   "_comment_head2":"User should Configure the roles",

   "_comment_head3":"All infos should be filled by the user",