From beecf87fb9e9b862994e5e3e6db2b1c378c971c1 Mon Sep 17 00:00:00 2001 From: Deepak S Date: Fri, 18 Aug 2017 14:59:46 -0700 Subject: Remove unwanted files in docs folder JIRA: SAMPLEVNF-73 Change-Id: Ia147cfef9f7bcacd50477b6ea3c7d0a1c6e93952 Signed-off-by: Deepak S --- docs/INSTALL.rst | 34 --- docs/RELEASE_NOTES.rst | 32 --- docs/development/design/index.rst | 4 - docs/development/overview/index.rst | 15 -- docs/development/overview/overview.rst | 16 -- docs/development/requirements/index.rst | 4 - docs/index.rst | 13 -- docs/release/configguide/feature.configuration.rst | 28 --- docs/release/configguide/featureconfig.rst | 35 ---- docs/release/configguide/index.rst | 13 -- docs/release/configguide/postinstall.rst | 39 ---- docs/release/installation/index.rst | 10 - docs/release/userguide/feature.userguide.rst | 23 -- docs/release/userguide/index.rst | 23 -- docs/testing/user/configguide/configguide.rst | 5 - docs/testing/user/configguide/index.rst | 5 - docs/testing/user/userguide/vACL/INSTALL.rst | 233 --------------------- docs/testing/user/userguide/vACL/README.rst | 159 -------------- docs/testing/user/userguide/vACL/RELEASE_NOTES.rst | 81 ------- docs/testing/user/userguide/vACL/index.rst | 11 - docs/testing/user/userguide/vCGNAPT/INSTALL.rst | 230 -------------------- docs/testing/user/userguide/vCGNAPT/README.rst | 197 ----------------- .../user/userguide/vCGNAPT/RELEASE_NOTES.rst | 90 -------- docs/testing/user/userguide/vCGNAPT/index.rst | 11 - docs/testing/user/userguide/vFW/INSTALL.rst | 229 -------------------- docs/testing/user/userguide/vFW/README.rst | 182 ---------------- docs/testing/user/userguide/vFW/RELEASE_NOTES.rst | 92 -------- docs/testing/user/userguide/vFW/index.rst | 11 - 28 files changed, 1825 deletions(-) delete mode 100644 docs/INSTALL.rst delete mode 100644 docs/RELEASE_NOTES.rst delete mode 100644 docs/development/design/index.rst delete mode 100644 docs/development/overview/index.rst delete mode 100644 docs/development/overview/overview.rst delete mode 100644 docs/development/requirements/index.rst delete mode 100644 docs/index.rst delete mode 100644 docs/release/configguide/feature.configuration.rst delete mode 100644 docs/release/configguide/featureconfig.rst delete mode 100644 docs/release/configguide/index.rst delete mode 100644 docs/release/configguide/postinstall.rst delete mode 100644 docs/release/installation/index.rst delete mode 100644 docs/release/userguide/feature.userguide.rst delete mode 100644 docs/release/userguide/index.rst delete mode 100644 docs/testing/user/configguide/configguide.rst delete mode 100644 docs/testing/user/configguide/index.rst delete mode 100644 docs/testing/user/userguide/vACL/INSTALL.rst delete mode 100644 docs/testing/user/userguide/vACL/README.rst delete mode 100644 docs/testing/user/userguide/vACL/RELEASE_NOTES.rst delete mode 100644 docs/testing/user/userguide/vACL/index.rst delete mode 100644 docs/testing/user/userguide/vCGNAPT/INSTALL.rst delete mode 100644 docs/testing/user/userguide/vCGNAPT/README.rst delete mode 100644 docs/testing/user/userguide/vCGNAPT/RELEASE_NOTES.rst delete mode 100644 docs/testing/user/userguide/vCGNAPT/index.rst delete mode 100644 docs/testing/user/userguide/vFW/INSTALL.rst delete mode 100644 docs/testing/user/userguide/vFW/README.rst delete mode 100644 docs/testing/user/userguide/vFW/RELEASE_NOTES.rst delete mode 100644 docs/testing/user/userguide/vFW/index.rst diff --git a/docs/INSTALL.rst b/docs/INSTALL.rst deleted file mode 100644 index 6c321846..00000000 --- a/docs/INSTALL.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. this work is licensed under a creative commons attribution 4.0 international -.. license. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) opnfv, national center of scientific research "demokritos" and others. - -============================ -samplevf Installation Guide -============================ - -Introduction -============ -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 VNF - -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 - -VNF supported -============= - - - Carrier Grade Network Address Translation (CG-NAT) VNF - - Firewall (vFW) VNF - - Access Control List (vACL) VNF - -Please refer docs folder for individual VNF Installation guide. - -Note:- Each VNF should include a installation document explain the process to install and run VNF. diff --git a/docs/RELEASE_NOTES.rst b/docs/RELEASE_NOTES.rst deleted file mode 100644 index fa9ab919..00000000 --- a/docs/RELEASE_NOTES.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. this work is licensed under a creative commons attribution 4.0 international -.. license. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) opnfv, national center of scientific research "demokritos" and others. - -========================== -samplevnf Release Notes -========================== - -Introduction -============ -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 - -VNF supported -============= - - - Carrier Grade Network Address Translation (CG-NAT) VNF - - Firewall (vFW) VNF - - Access Control List (vACL) VNF - -Please refer docs folder for individual VNF release notes. diff --git a/docs/development/design/index.rst b/docs/development/design/index.rst deleted file mode 100644 index a2a90560..00000000 --- a/docs/development/design/index.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. 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. diff --git a/docs/development/overview/index.rst b/docs/development/overview/index.rst deleted file mode 100644 index 284effb7..00000000 --- a/docs/development/overview/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. 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. - -============================================= -OPNFV Overview -============================================= - -For example, the title might be "Qtip Danube Overview" - -.. toctree:: - :maxdepth: 1 - - overview diff --git a/docs/development/overview/overview.rst b/docs/development/overview/overview.rst deleted file mode 100644 index 498dc066..00000000 --- a/docs/development/overview/overview.rst +++ /dev/null @@ -1,16 +0,0 @@ -============================================== -OPNFV Overview -============================================== - -.. contents:: - :depth: 3 - :local: - -Introduction ----------------- -Describing the components and behaviours in a manner that helps people understand the platform and how to work with it - -Upgrades from ------------------------------------ - -Describe the new features diff --git a/docs/development/requirements/index.rst b/docs/development/requirements/index.rst deleted file mode 100644 index a2a90560..00000000 --- a/docs/development/requirements/index.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. 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. diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 050fa670..00000000 --- a/docs/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -#################### -samplevnf -#################### - -.. toctree:: - :numbered: - :maxdepth: 2 - - RELEASE_NOTES.rst - INSTALL.rst - vCGNAPT/index.rst - vFW/index.rst - vACL/index.rst diff --git a/docs/release/configguide/feature.configuration.rst b/docs/release/configguide/feature.configuration.rst deleted file mode 100644 index 2eb79f22..00000000 --- a/docs/release/configguide/feature.configuration.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. 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. - -Abstract -======== -This document provides information on how to install the SampleVNF -features in OPNFV. - -SampleVNF feature desciription -======================== - -Hardware requirements -===================== - -Bare metal deployment on (OPNFV) lab -------------------------------------------- - -Virtual deployment ------------------- - - -Download the installer source code and artifact ------------------------------------------------ - -Installation procedures ------------------------ - diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst deleted file mode 100644 index 45f9a5fc..00000000 --- a/docs/release/configguide/featureconfig.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. 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. - -======== -Abstract -======== -Add a brief introduction to configure OPNFV with this specific feature including -dependancies on platform components, this description should be at a level that -will apply to any installer providing the pre-requisite components. - -.. contents:: - :depth: 3 - :local: - -Pre-configuration activities -============================ -Describe specific pre-configuration activities. This should include ensuring the -right components are installed by the installation tools as required for your -feature to function. Refer to the previous installer configuration chapters, -installations guide and release notes - - -Hardware configuration -====================== -Describe the hardware configuration needed for this specific feature - - -Feature configuration -===================== -Describe the procedures to configure your feature on the platform in order -that it is ready to use according to the feature instructions in the platform -user guide. Where applicable you should add content in the postinstall.rst -to validate the feature is configured for use. -(checking components are installed correctly etc...) diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst deleted file mode 100644 index 7f7b2d9c..00000000 --- a/docs/release/configguide/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. 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. - -********************************** -SampleVNF Configuration Guide -********************************** - -.. toctree:: - :maxdepth: 1 - - featureconfig - postinstall diff --git a/docs/release/configguide/postinstall.rst b/docs/release/configguide/postinstall.rst deleted file mode 100644 index 296d3023..00000000 --- a/docs/release/configguide/postinstall.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. 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. - -************************************* - Post Installation Procedure -************************************* - -Add a brief introduction to the methods of validating the installation -according to this specific installer or feature. - -.. contents:: - :depth: 3 - :local: - - -Automated post installation activities -====================================== -Describe specific post installation activities performed by the OPNFV -deployment pipeline including testing activities and reports. Refer to -the relevant testing guides, results, and release notes. - -note: this section should be singular and derived from the test projects -once we have one test suite to run for all deploy tools. This is not the -case yet so each deploy tool will need to provide (hopefully very simillar) -documentation of this. - - - post configuration procedures -======================================= -Describe any deploy tool or feature specific scripts, tests or procedures -that should be carried out on the deployment post install and configuration -in this section. - - -Platform components validation -============================== -Describe any component specific validation procedures necessary for your -deployment tool in this section. diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst deleted file mode 100644 index f7bb1907..00000000 --- a/docs/release/installation/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. 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. - -*************************************** -SampleVNF Installation Instruction -*************************************** - -.. toctree:: - :maxdepth: 1 diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst deleted file mode 100644 index 62259c7f..00000000 --- a/docs/release/userguide/feature.userguide.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. 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. - -.. contents:: - :depth: 3 - :local: - - description -===================== -.. Describe the specific features and how it is realised in the scenario in a brief manner -.. to ensure the user understand the context for the user guide instructions to follow. - - capabilities and usage -================================ -.. Describe the specific capabilities and usage for feature. -.. Provide enough information that a user will be able to operate the feature on a deployed scenario. - - -============================================== -.. Describe with examples how to use specific features, provide API examples and details required to -.. operate the feature on the platform. - diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst deleted file mode 100644 index 8dba05e4..00000000 --- a/docs/release/userguide/index.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. 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. - -===================== -SampleVNF User Guide -===================== - -.. The feature user guide should provide an OPNFV user with enough information to -.. use the features provided by the feature project in the supported scenarios. -.. This guide should walk a user through the usage of the features once a scenario -.. has been deployed and is active according to the installation guide provided -.. by the installer project. - -.. toctree:: - :maxdepth: 1 - - feature.userguide -.. The feature.userguide.rst file should contain the text for this document -.. additional documents can be added to this directory and added in the right order -.. to this file as a list below. - - diff --git a/docs/testing/user/configguide/configguide.rst b/docs/testing/user/configguide/configguide.rst deleted file mode 100644 index e3867864..00000000 --- a/docs/testing/user/configguide/configguide.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. 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. - -.. OPNFV SAMPLEVNF Documentation configure guide file. diff --git a/docs/testing/user/configguide/index.rst b/docs/testing/user/configguide/index.rst deleted file mode 100644 index 1998be3b..00000000 --- a/docs/testing/user/configguide/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. 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. - -.. OPNFV SAMPLEVNF Documentation master file. diff --git a/docs/testing/user/userguide/vACL/INSTALL.rst b/docs/testing/user/userguide/vACL/INSTALL.rst deleted file mode 100644 index 7f21fc1f..00000000 --- a/docs/testing/user/userguide/vACL/INSTALL.rst +++ /dev/null @@ -1,233 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International -.. License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, National Center of Scientific Research "Demokritos" and others. - -============================ -vACL - Installation Guide -============================ - -vACL Compilation -=================== - -After downloading (or doing a git clone) in a directory (samplevnf) - -------------- -Dependencies -------------- - -- DPDK supported versions ($DPDK_RTE_VER = 16.04, 16.11, 17.02 or 17.05): Downloaded and installed via vnf_build.sh or manually from [here] (http://fast.dpdk.org/rel/) -- libpcap-dev -- libzmq -- libcurl - ---------------------- -Environment variables ---------------------- -Apply all the additional patches in 'patches/dpdk_custom_patch/' and build dpdk - -:: - - export RTE_SDK= - export RTE_TARGET=x86_64-native-linuxapp-gcc - -This is done by vnf_build.sh script. - -Auto Build: -=========== -$ ./tools/vnf_build.sh in samplevnf root folder - -Follow the steps in the screen from option [1] --> [9] and select option [8] -to build the vnfs. -It will automatically download selected DPDK version and any required patches -and will setup everything and build vACL VNFs. - -Following are the options for setup: - -:: - - ---------------------------------------------------------- - Step 1: Environment setup. - ---------------------------------------------------------- - [1] Check OS and network connection - [2] Select DPDK RTE version - - ---------------------------------------------------------- - Step 2: Download and Install - ---------------------------------------------------------- - [3] Agree to download - [4] Download packages - [5] Download DPDK zip - [6] Build and Install DPDK - [7] Setup hugepages - - ---------------------------------------------------------- - Step 3: Build VNFs - ---------------------------------------------------------- - [8] Build all VNFs (vACL, vCGNAPT, vFW, UDP_Replay) - - [9] Exit Script - -An vACL executable will be created at the following location -samplevnf/VNFs/vACL/build/vACL - - -Manual Build: -============= -1. Download DPDK supported version from dpdk.org - - - http://dpdk.org/browse/dpdk/snapshot/dpdk-$DPDK_RTE_VER.zip - -2. unzip dpdk-$DPDK_RTE_VER.zip and apply dpdk patches only in case of 16.04 - (Not required for other DPDK versions) - - - cd dpdk - - - patch -p1 < VNF_CORE/patches/dpdk_custom_patch/i40e-fix-link-management.patch - - patch -p1 < VNF_CORE/patches/dpdk_custom_patch/i40e-fix-Rx-hang-when-disable-LLDP.patch - - patch -p1 < VNF_CORE/patches/dpdk_custom_patch/i40e-fix-link-status-change-interrupt.patch - - patch -p1 < VNF_CORE/patches/dpdk_custom_patch/i40e-fix-VF-bonded-device-link-down.patch - - patch -p1 < $VNF_CORE/patches/dpdk_custom_patch/disable-acl-debug-logs.patch - - patch -p1 < $VNF_CORE/patches/dpdk_custom_patch/set-log-level-to-info.patch - - - build dpdk - - - make config T=x86_64-native-linuxapp-gcc O=x86_64-native-linuxapp-gcc - - cd x86_64-native-linuxapp-gcc - - make - - - Setup huge pages - - - For 1G/2M hugepage sizes, for example 1G pages, the size must be specified - explicitly and can also be optionally set as the default hugepage - size for the system. For example, to reserve 8G of hugepage memory - in the form of eight 1G pages, the following options should be passed - to the kernel: - * default_hugepagesz=1G hugepagesz=1G hugepages=8 hugepagesz=2M hugepages=2048 - - Add this to Go to /etc/default/grub configuration file. - - Append "default_hugepagesz=1G hugepagesz=1G hugepages=8 hugepagesz=2M hugepages=2048" - to the GRUB_CMDLINE_LINUX entry. - -3. Setup Environment Variable - - - export RTE_SDK=/dpdk - - export RTE_TARGET=x86_64-native-linuxapp-gcc - - export VNF_CORE= - - or using ./tools/setenv.sh - -4. Build vACL VNFs - - - cd /VNFs/vACL - - make clean - - make - -5. The vACL executable will be created at the following location - - - /VNFs/vACL/build/vACL - -Run -==== - ----------------------- -Setup Port to run VNF ----------------------- - -:: - - For DPDK versions 16.04 - 1. cd /dpdk - 2. ./tools/dpdk_nic_bind.py --status <--- List the network device - 3. ./tools/dpdk_nic_bind.py -b igb_uio - .. _More details: http://dpdk.org/doc/guides-16.04/linux_gsg/build_dpdk.html#binding-and-unbinding-network-ports-to-from-the-kernel-modules - - For DPDK versions 16.11 - 1. cd /dpdk - 2. ./tools/dpdk-devbind.py --status <--- List the network device - 3. ./tools/dpdk-devbind.py -b igb_uio - .. _More details: http://dpdk.org/doc/guides-16.11/linux_gsg/build_dpdk.html#binding-and-unbinding-network-ports-to-from-the-kernel-modules - - For DPDK versions 17.xx - 1. cd /dpdk - 2. ./usertools/dpdk-devbind.py --status <--- List the network device - 3. ./usertools/dpdk-devbind.py -b igb_uio - .. _More details: http://dpdk.org/doc/guides-17.05/linux_gsg/build_dpdk.html#binding-and-unbinding-network-ports-to-from-the-kernel-modules - - - Make the necessary changes to the config files to run the vACL VNF - eg: ports_mac_list = 00:00:00:30:21:00 00:00:00:30:21:00 - ------------------ -ACL run commands ------------------ -Update the configuration according to system configuration. - -:: - - ./build/vACL -p -f -s