9 files changed, 147 insertions, 0 deletions
diff --git a/docs/administration.rst b/docs/administration.rst
new file mode 100755
index 0000000..a39aa9b
--- /dev/null
+++ b/docs/administration.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+Administration
+--------------
+There is a functionality which part of Django framework to manage all models and tables located on our application's db.
+The django based containers are: engagement-manager, cms, ci tests
+
+Usually, the admin dashboard url is http(s)://{{domain}}/admin/
+Throght there you will see all models exists in the related application (in the shape of tables) and will be able to create/update/delete there rows.
+
+
+The VVP application allow you to login into portal as admin (usually created under admin@{{your-domain}}.com). The admin allow you to manage VVP entities, update templates and display all availiable engagements and VFs.
+You can reach the screen by clicking the user bubble on top-right of the screen, and from the drop-down menu - click the 'Admin' button.
diff --git a/docs/architecture.rst b/docs/architecture.rst
new file mode 100755
index 0000000..d1eb514
--- /dev/null
+++ b/docs/architecture.rst
@@ -0,0 +1,56 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+Architecture
+------------
+The architecture of VVP based on micro-services. Each element has dedicated container.
+VVP uses rocket and kubernetes to manage the VVP system.
+There is a devkit component which allows you to render and deploy VVP. It's render and deploy the rockets with kuberenetes management (via quay.io).
+
+We store files on Ceph distributed storage system that includes 'RADOS Gateway' which allows us to store files in AWS S3 based API (buckets etc..).
+
+Architecture Alignment:
++++++++++++++++++++++++
+How does this project fit into the rest of the ONAP Architecture?
+* The VNF Validation Program will utilize the architecture to validate VNFs against it.
+What other ONAP projects does this project depend on?
+* This project depends on SDC, VNF Validation Program, and VNF Requirements
+How does this align with external standards/specifications?
+* Are there dependencies with other open source projects?
+  * OpenStack
+
+
+This is the list of containers part of VVP application:
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+* ci-uwsgi - end-to-end flow tests based on Seleniunm
+* cms-nginx - webserver of CMS
+* cms-uwsgi - backend uwsgi server which hosts django application
+* em-nginx - webserver of engagement manager
+* em-uwsgi - backend uwsgi server which hosts django application
+* ext-haproxy - load balancer for external transport
+* int-haproxy - load balancer for internal (container to container) transport
+* gitlab - holds all customers files in repos
+* imagescanner - scan for validity and viruses on users files
+* jenkins - run validation tasks
+* portal - run the UI/UX application AKA VVP-Portal
+* postgresql - store all data of engagement manager
+* redis - in memory key-value store for all project
+* celery - task queue manager which manage all validation tasks
+
+Repo name:
+++++++++++
+* org.onap.vvp/devkit
+* org.onap.vvp/ansible-ice-bootstrap
+* org.onap.vvp/portal
+* org.onap.vvp/engagementmgr
+* org.onap.vvp/cms
+* org.onap.vvp/jenkins
+* org.onap.vvp/haproxy
+* org.onap.vvp/postgresql
+* org.onap.vvp/gitlab
+* org.onap.vvp/jeeves
+* org.onap.vvp/test-engine
+* org.onap.vvp/validation-scripts
+* org.onap.vvp/documentation
+* org.onap.vvp/image-scanner 
+\ No newline at end of file
diff --git a/docs/configuration.rst b/docs/configuration.rst
new file mode 100755
index 0000000..30fc54a
--- /dev/null
+++ b/docs/configuration.rst
@@ -0,0 +1,7 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Configuration
+-------------
+All the configuration is happening on vvp-devkit component.
+There you will define all related fields for each component in a dedicated .yaml file.
diff --git a/docs/delivery.rst b/docs/delivery.rst
new file mode 100755
index 0000000..b417dbc
--- /dev/null
+++ b/docs/delivery.rst
@@ -0,0 +1,6 @@
+Delivery
+--------
+Describe how functions are packaged into run-time components.
+For some components a block diagram may be useful.
+
+All the project deploy is under ansible files which rendered and deployed in devkit component.
+\ No newline at end of file
diff --git a/docs/humaninterfaces.rst b/docs/humaninterfaces.rst
new file mode 100755
index 0000000..2d478db
--- /dev/null
+++ b/docs/humaninterfaces.rst
@@ -0,0 +1,4 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+The project is to develop a validation program to provide assurance of VNF interoperability with ONAP. Obtaining a validation shall be a self-service activity and should be against a reference release of ONAP for use by the VNF provider & any other validation authority.
+\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100755
index 0000000..3773179
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,18 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Platform Component
+==================
+The project is to develop a validation program to provide assurance of VNF interoperability with ONAP. Obtaining a validation shall be a self-service activity and should be against a reference release of ONAP for use by the VNF provider & any other validation authority.
+
+.. toctree::
+   :maxdepth: 1
+
+   architecture.rst
+   offeredapis.rst
+   delivery.rst
+   logging.rst
+   installation.rst
+   configuration.rst
+   administration.rst
+   humaninterfaces.rst
diff --git a/docs/installation.rst b/docs/installation.rst
new file mode 100755
index 0000000..6942a9d
--- /dev/null
+++ b/docs/installation.rst
@@ -0,0 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Installation
+------------
+install happens throgth devkit.
+\ No newline at end of file
diff --git a/docs/logging.rst b/docs/logging.rst
new file mode 100755
index 0000000..3783a6c
--- /dev/null
+++ b/docs/logging.rst
@@ -0,0 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Logging & Diagnostic Information
+--------------------------------
+Login into portal/em admin/cms admin
+\ No newline at end of file
diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst
new file mode 100755
index 0000000..2b733d5
--- /dev/null
+++ b/docs/offeredapis.rst
@@ -0,0 +1,29 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+Offered APIs
+============
+List APIs offered.   One or more of the following examples may be appropriate.
+
+Example Swagger Displayed with swaggerv2doc directive
+-----------------------------------------------------
+
+.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=vfc/nfvo/lcm.git;a=blob_plain;f=lcm/swagger/vfc.nslcm.swagger.json
+
+
+Example documenting a REST interface with Sphinx httpdomain directive
+---------------------------------------------------------------------
+
+.. http:get:: path
+
+   For more information see `<https://pythonhosted.org/sphinxcontrib-httpdomain>`_
+
+
+Word Document Converted to RST using Pandocs
+--------------------------------------------
+
+.. toctree:: 
+   :maxdepth: 1
+
+   ../../submodules/appc.git/docs/APPC API Guide/APPC API Guide