Updating user guide

[samplevnf.git] / docs / testing / user / userguide / 03-architecture.rst

diff --git a/docs/testing/user/userguide/03-architecture.rst b/docs/testing/user/userguide/03-architecture.rst
index 4c4b7e6..62a1734 100755 (executable)
--- a/docs/testing/user/userguide/03-architecture.rst
+++ b/docs/testing/user/userguide/03-architecture.rst
@@ -9,7 +9,7 @@ Architecture
 
 Abstract
 ========
-This chapter describes the samplevnf  software architecture.
+This chapter describes the samplevnf software architecture.
 we will introduce it VNFs. More technical details will be introduced in this chapter.
 
 Overview
@@ -30,8 +30,8 @@ of Sample† Traffic Flows.
  * Not a commercial product. Encourage the community to contribute and close the feature gaps.
  † No Vendor/Proprietary Workloads
 
-t helps to facilitate deterministic & repeatable bench-marking on Industry
-standard high volume Servers. It augments well with a Test Infrastructure to
+It helps to facilitate deterministic & repeatable bench-marking on Industry
+standard high volume Servers. It augments well with a Test infrastructure to
 help facilitate consistent/repeatable methodologies for characterizing &
 validating the sample VNFs through OPEN SOURCE VNF approximations and test tools.
 The VNFs belongs to this project are never meant for field deployment.
@@ -40,7 +40,7 @@ All the VNF source code part of this project requires Apache License Version 2.0
 Supported deployment:
 ----------------------
 * Bare-Metal - All VNFs can run on a Bare-Metal DUT
-* Standalone Virtualization: All VNFs can run on SV like VPP as switch, ovs,
+* Standalone Virtualization(SV): All VNFs can run on SV like VPP as switch, ovs,
   ovs-dpdk, srioc
 * Openstack: Latest Openstack supported
 
@@ -75,17 +75,18 @@ VNF supported
       Packet pROcessing eXecution Engine (PROX) which is a DPDK application.
       PROX can do operations on packets in a highly configurable manner.
       The PROX application is also displaying performance statistics that can
-      be used for performance investigations. 
+      be used for performance investigations.
       Intel® DPPD - PROX is an application built on top of DPDK which allows
       creating software architectures, such as the one depicted below, through
       small and readable configuration files.
+      This VNF can act as L2FWD, L3FWD, BNG etc.
 
 Test Framework
 --------------
 
 .. _Yardstick_NSB: http://artifacts.opnfv.org/yardstick/docs/testing_user_userguide/index.html#document-13-nsb-overview
 
-SampleVNF Test Infrastructure (NSB (Yardstick_NSB_))in yardstick helps to facilitate
+SampleVNF Test Infrastructure (NSB (Yardstick_NSB_)) in yardstick helps to facilitate
 consistent/repeatable methodologies for characterizing & validating the
 sample VNFs (:term:`VNF`) through OPEN SOURCE VNF approximations.
 
@@ -93,7 +94,7 @@ sample VNFs (:term:`VNF`) through OPEN SOURCE VNF approximations.
 Network Service Benchmarking in yardstick framework follows ETSI GS NFV-TST001_
 to verify/characterize both :term:`NFVI` & :term:`VNF`
 
-For more inforamtion refer, 
+For more inforamtion refer, Yardstick_NSB_
 
 SampleVNF Directory structure
 =============================
@@ -106,8 +107,10 @@ SampleVNF Directory structure
           user guides and SampleVNF descriptions.
 
 *tools/* - Currently contains tools to build image for VMs which are deployed
-           by Heat. Currently contains helper scripts like install, setup env 
+           by Heat. Currently contains helper scripts like install, setup env
 
 *VNFs/* - all VNF source code directory.
 
 *VNF_Catalogue/* - Collection of all  Open Source VNFs
+
+*heat_template/* - Sample HEAT templates for VNFs