From f8016f150d475ff7abc620df86f1d1b71c83cf53 Mon Sep 17 00:00:00 2001 From: "Bozawglanian, Hagop (hb755d)" Date: Tue, 1 May 2018 23:53:39 +0000 Subject: VVP - Documentation cleaning escape characters Cleaning the new line character '\r' from all files Change-Id: I16e5a6483a30599fe3d96774db46abbe74b2f91f Issue-ID: VVP-35 Signed-off-by: Bozawglanian, Hagop (hb755d) --- docs/administration.rst | 54 ++++++++++----------- docs/architecture.rst | 124 +++++++++++++++++++++++------------------------ docs/configuration.rst | 18 +++---- docs/delivery.rst | 22 ++++----- docs/humaninterfaces.rst | 22 ++++----- docs/index.rst | 48 +++++++++--------- docs/installation.rst | 28 +++++------ docs/logging.rst | 28 +++++------ docs/offeredapis.rst | 60 +++++++++++------------ 9 files changed, 203 insertions(+), 201 deletions(-) (limited to 'docs') diff --git a/docs/administration.rst b/docs/administration.rst index 11e2c7b..0fb3fe5 100644 --- a/docs/administration.rst +++ b/docs/administration.rst @@ -1,27 +1,27 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - -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. - -Processes ------------ - - -Actions ---------- +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +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. + +Processes +----------- + + +Actions +--------- diff --git a/docs/architecture.rst b/docs/architecture.rst index 404fd89..e8c6b1e 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -1,62 +1,62 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - - -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 - -Interactions -------------------- - -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 +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +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 + +Interactions +------------------- + +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 diff --git a/docs/configuration.rst b/docs/configuration.rst index ea100b6..03a4ae4 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -1,9 +1,9 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - -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. +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +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 index 603ca1f..e722662 100644 --- a/docs/delivery.rst +++ b/docs/delivery.rst @@ -1,11 +1,11 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - -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. +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +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. diff --git a/docs/humaninterfaces.rst b/docs/humaninterfaces.rst index 34e8349..8f609f1 100644 --- a/docs/humaninterfaces.rst +++ b/docs/humaninterfaces.rst @@ -1,11 +1,11 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - -Human Interfaces -====================== - -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. +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +Human Interfaces +====================== + +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. diff --git a/docs/index.rst b/docs/index.rst index 5a85c79..1c510e1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,23 +1,25 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - -VVP Documentation -==================== -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 - - administration.rst - architecture.rst - configuration.rst - delivery.rst - humaninterfaces.rst - installation.rst - logging.rst - offeredapis.rst - release-notes.rst +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +VVP Documentation +==================== + +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 + + administration.rst + architecture.rst + configuration.rst + delivery.rst + humaninterfaces.rst + installation.rst + logging.rst + offeredapis.rst + release-notes.rst diff --git a/docs/installation.rst b/docs/installation.rst index 8331058..0353ec4 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,14 +1,14 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - -Installation -================== - -Installation happens through the vvp-devkit project. - -Environment --------------- - -Steps ----------- +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +Installation +================== + +Installation happens through the vvp-devkit project. + +Environment +-------------- + +Steps +---------- diff --git a/docs/logging.rst b/docs/logging.rst index 05284ed..4c795b2 100644 --- a/docs/logging.rst +++ b/docs/logging.rst @@ -1,14 +1,14 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - -Logging -========== -Login into portal/em admin/cms admin - -Where to Access Information --------------------------------- - - -Error / Warning Messages ----------------------------- +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +Logging +========== +Login into portal/em admin/cms admin + +Where to Access Information +-------------------------------- + + +Error / Warning Messages +---------------------------- diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst index 4e7cc0d..ec96ae6 100644 --- a/docs/offeredapis.rst +++ b/docs/offeredapis.rst @@ -1,30 +1,30 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property. All rights reserved. - - -Offered APIs -============== - - -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 ``_ - - -Word Document Converted to RST using Pandocs ------------------------------------------------ - -.. toctree:: - :maxdepth: 1 - - ../../submodules/appc.git/docs/APPC API Guide/APPC API Guide +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +Offered APIs +============== + + +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 ``_ + + +Word Document Converted to RST using Pandocs +----------------------------------------------- + +.. toctree:: + :maxdepth: 1 + + ../../submodules/appc.git/docs/APPC API Guide/APPC API Guide -- cgit 1.2.3-korg