From ada951272b7d7cc06dd0086276586d1d4032261d Mon Sep 17 00:00:00 2001 From: Deepak S Date: Fri, 18 Aug 2017 20:02:05 -0700 Subject: Added initial draft for samplevnf useguide JIRA: SAMPLEVNF-77 Change-Id: Ib537b36ae82361754762a627ae942d99b4966856 Signed-off-by: Deepak S --- docs/testing/user/userguide/03-architecture.rst | 113 ++++++++++++++++++++++++ 1 file changed, 113 insertions(+) create mode 100755 docs/testing/user/userguide/03-architecture.rst (limited to '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 new file mode 100755 index 00000000..4c4b7e61 --- /dev/null +++ b/docs/testing/user/userguide/03-architecture.rst @@ -0,0 +1,113 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Intel Corporation and others. + +============ +Architecture +============ + +Abstract +======== +This chapter describes the samplevnf software architecture. +we will introduce it VNFs. More technical details will be introduced in this chapter. + +Overview +======== + +Architecture overview +--------------------- +This project provides a placeholder for various sample VNF (Virtual Network Function) +development which includes example reference architecture and optimization methods +related to VNF/Network service for high performance VNFs. + +The sample VNFs are Open Source approximations* of Telco grade VNF’s using +optimized VNF + NFVi Infrastructure libraries, with Performance Characterization +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 +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. +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, + ovs-dpdk, srioc +* Openstack: Latest Openstack supported + +VNF supported +------------- + - Carrier Grade Network Address Translation (CG-NAT) VNF + :: + The Carrier Grade Network Address and port Translation (vCG-NAPT) is a + VNF approximation extending the life of the service providers IPv4 network + infrastructure and mitigate IPv4 address exhaustion by using address and + port translation in large scale. It processes the traffic in both the directions. + It also supports the connectivity between the IPv6 access network to + IPv4 data network using the IPv6 to IPv4 address translation and vice versa. + - Firewall (vFW) VNF + :: + The Virtual Firewall (vFW) is a VNF approximation serving as a state full + L3/L4 packet filter with connection tracking enabled for TCP, UDP and ICMP. + The VNF could be a part of Network Services (industry use-cases) deployed + to secure the enterprise network from un-trusted network. + - Access Control List (vACL) VNF + :: + The vACL vNF is implemented as a DPDK application using VNF Infrastructure + Library (VIL). The VIL implements common VNF internal, optimized for + Intel Architecture functions like load balancing between cores, IPv4/IPv6 + stack features, and interface to NFV infrastructure like OVS or SRIOV. + - UDP_Replay + :: + The UDP Replay is implemented as a DPDK application using VNF Infrastructure + Library (VIL). Performs as a refelector of all the traffic on given port. + - Prox - Packet pROcessing eXecution engine. + :: + 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. + 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. + +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 +consistent/repeatable methodologies for characterizing & validating the +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, + +SampleVNF Directory structure +============================= + +**samplevnf/** - SampleVNF main directory. + +*common/* - Common re-useable code like arp, nd, packet fwd etc + +*docs/* - All documentation is stored here, such as configuration guides, + 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 + +*VNFs/* - all VNF source code directory. + +*VNF_Catalogue/* - Collection of all Open Source VNFs -- cgit 1.2.3-korg