Fix releng-tox Jenkins job

Many reStructuredText issues

Signed-off-by: Patrice Buriez <patrice.buriez@chenapan.org>
Change-Id: I07e6af54d2ea15fa1ab1a08ad3c0b22643e7462e

10 files changed, 47 insertions, 38 deletions

diff --git a/docs/testing/user/userguide/01-introduction.rst b/docs/testing/user/userguide/01-introduction.rst
index 4ddde201..4ddde201 100755..100644
--- a/docs/testing/user/userguide/01-introduction.rst
+++ b/docs/testing/user/userguide/01-introduction.rst
diff --git a/docs/testing/user/userguide/01-prox_documentation.rst b/docs/testing/user/userguide/01-prox_documentation.rst
index 0fbee344..12c740da 100644
--- a/docs/testing/user/userguide/01-prox_documentation.rst
+++ b/docs/testing/user/userguide/01-prox_documentation.rst
@@ -1,4 +1,4 @@
 Testing with PROX
 =================
-The PROX documentation can be found in `Prox - Packet pROcessing eXecution engine <https://wiki.opnfv.org/x/AAa9>`_
-How to use PROX with the rapid pyton scripts can be found in `Rapid scripting <https://wiki.opnfv.org/x/OwM-Ag>`_
+The PROX documentation can be found in `Prox - Packet pROcessing eXecution engine <https://wiki-old.opnfv.org/x/AAa9>`_
+How to use PROX with the rapid pyton scripts can be found in `Rapid scripting <https://wiki-old.opnfv.org/x/OwM-Ag>`_
diff --git a/docs/testing/user/userguide/03-architecture.rst b/docs/testing/user/userguide/03-architecture.rst
index 08e1b2f2..bdc51d3f 100755..100644
--- a/docs/testing/user/userguide/03-architecture.rst
+++ b/docs/testing/user/userguide/03-architecture.rst
@@ -37,8 +37,8 @@ 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:
-----------------------
+Supported deployment
+--------------------
 * Bare-Metal - All VNFs can run on a Bare-Metal DUT
 * Standalone Virtualization(SV): All VNFs can run on SV like VPP as switch, ovs,
   ovs-dpdk, srioc
@@ -47,7 +47,6 @@ Supported deployment:
 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
@@ -55,23 +54,19 @@ VNF supported
       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
@@ -142,14 +137,15 @@ The following features were verified by SampleVNF test cases:
 Test Framework
 --------------
 
-.. _Yardstick_NSB: http://artifacts.opnfv.org/yardstick/docs/testing_user_userguide/index.html#document-13-nsb-overview
+.. _Yardstick_NSB: http://artifacts.opnfv.org/yardstick/docs/testing_user_userguide/index.html#document-11-nsb-overview
+.. _ETSI GS NFV-TST 001: https://portal.etsi.org/webapp/workprogram/Report_WorkItem.asp?WKI_ID=46009
 
 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_
+Network Service Benchmarking in yardstick framework follows `ETSI GS NFV-TST 001`_
 to verify/characterize both :term:`NFVI` & :term:`VNF`
 
 For more inforamtion refer, Yardstick_NSB_
diff --git a/docs/testing/user/userguide/03-installation.rst b/docs/testing/user/userguide/03-installation.rst
index 8fb89744..4407b276 100644
--- a/docs/testing/user/userguide/03-installation.rst
+++ b/docs/testing/user/userguide/03-installation.rst
@@ -30,15 +30,17 @@ Prerequisites
 -------------
 
 Supported Test setup
-^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^
 The device under test (DUT) is an NFVI instance on which we can deploy PROX instances.
-A PROX instance is a machine that
+A PROX instance is a machine that:
+
   * has a management interface that can be reached from the test container
   * has one or more data plane interfaces on a dataplane network.
   * can be a container, a VM or a bare metal machine. We just need to be able to ssh into the
     PROX machine from the test container.
   * is optimized for data plane traffic.
   * will measure the throughput that is offered through its dataplane interface(s)
+
 There are no requirements on the NFVI instance itself. Of course, the measured throughput will
 depend heavily on the NFVI characteristics.
 In this release, we are supporting an automated deployment of the PROX instance on an NFVI that
diff --git a/docs/testing/user/userguide/04-running_the_test.rst b/docs/testing/user/userguide/04-running_the_test.rst
index 5ffa58ca..3d3a1e6c 100644
--- a/docs/testing/user/userguide/04-running_the_test.rst
+++ b/docs/testing/user/userguide/04-running_the_test.rst
@@ -7,7 +7,7 @@
 Running the test
 ================
 .. _NFV-TST009: https://docbox.etsi.org/ISG/NFV/open/Publications_pdf/Specs-Reports/NFV-TST%20009v3.2.1%20-%20GS%20-%20NFVI_Benchmarks.pdf
-.. _TST009_Throughput_64B_64F.test: https://github.com/opnfv/samplevnf/blob/master/VNFs/DPPD-PROX/helper-scripts/rapid/TST009_Throughput_64B_64F.test
+.. _TST009_Throughput_64B_64F.test: https://github.com/opnfv/samplevnf/blob/master/VNFs/DPPD-PROX/helper-scripts/rapid/tests/TST009_Throughput_64B_64F.test
 .. _rapid_location: https://github.com/opnfv/samplevnf/blob/master/VNFs/DPPD-PROX/helper-scripts/rapid/
 
 Overview
@@ -124,6 +124,7 @@ not something to start with.
      gencores = [1]
      latcores = [3]
      #bucket_size_exp = 12
+
 testy
 ^^^^^
 In the testy sections, where y denotes the index of the test, the test that will
diff --git a/docs/testing/user/userguide/05-How_to_run_SampleVNFs.rst b/docs/testing/user/userguide/05-How_to_run_SampleVNFs.rst
index 7ba25fe1..28da0ebd 100644
--- a/docs/testing/user/userguide/05-How_to_run_SampleVNFs.rst
+++ b/docs/testing/user/userguide/05-How_to_run_SampleVNFs.rst
@@ -17,6 +17,7 @@ The device under test (DUT) consists of a system following;
   * Specific Intel Network Interface Cards (NICs)
   * BIOS settings noting those that updated from the basic settings
   * DPDK build configuration settings, and commands used for tests
+
 Connected to the DUT is an IXIA* or Software Traffic generator like pktgen or TRex,
 simulation platform to generate packet traffic to the DUT ports and
 determine the throughput/latency at the tester side.
@@ -103,17 +104,16 @@ The connectivity could be
      (TG_2(UDP_Replay) reflects all the traffic on the given port)
 
  * Bare-Metal
-   Refer: http://fast.dpdk.org/doc/pdf-guides/ to setup the DUT for VNF to run
+     Refer: http://fast.dpdk.org/doc/pdf-guides/ to setup the DUT for VNF to run
 
  * Standalone Virtualization - PHY-VM-PHY
+
    * SRIOV
-     Refer below link to setup sriov
-     https://software.intel.com/en-us/articles/using-sr-iov-to-share-an-ethernet-port-among-multiple-vms
+       https://software.intel.com/en-us/articles/using-sr-iov-to-share-an-ethernet-port-among-multiple-vms
 
    * OVS_DPDK
-     Refer below link to setup ovs-dpdk
-     http://docs.openvswitch.org/en/latest/intro/install/general/
-     http://docs.openvswitch.org/en/latest/intro/install/dpdk/
+       http://docs.openvswitch.org/en/latest/intro/install/general/
+       http://docs.openvswitch.org/en/latest/intro/install/dpdk/
 
  * Openstack
      Use any OPNFV installer to deploy the openstack.
@@ -132,19 +132,21 @@ Step 0: Preparing hardware connection
 Step 1: Setting up Traffic generator (TRex)
 
     TRex Software preparations
-    **************************
      * Install the OS (Bare metal Linux, not VM!)
      * Obtain the latest TRex package: wget https://trex-tgn.cisco.com/trex/release/latest
      * Untar the package: tar -xzf latest
      * Change dir to unzipped TRex
      * Create config file using command: sudo python dpdk_setup_ports.py -i
+
        In case of Ubuntu 16 need python3
+
        See paragraph config creation for detailed step-by-step
+
     (Refer: https://trex-tgn.cisco.com/trex/doc/trex_stateless_bench.html)
 
 
 Build SampleVNFs
------------------
+----------------
 
 Step 2: Procedure to build SampleVNFs
 
@@ -487,7 +489,7 @@ step 4: Run Test using traffic geneator
 
 
 UDP_Replay - How to run
-----------------------------------------
+-----------------------
 
 Step 3: Bind the datapath ports to DPDK
 
@@ -532,7 +534,7 @@ step 4: Run Test using traffic geneator
     For more details refer: https://trex-tgn.cisco.com/trex/doc/trex_stateless_bench.html
 
 PROX - How to run
-------------------
+-----------------
 
 Description
 ^^^^^^^^^^^
@@ -654,7 +656,7 @@ PROX COMMANDS AND SCREENS
   +----------------------------------------------+---------------------------------------------------------------------------+----------------------------+
   | version                                      | Show version                                                              |                            |
   +----------------------------------------------+---------------------------------------------------------------------------+----------------------------+
-  | port_stats <port id>                         |  Print rate for no_mbufs, ierrors, rx_bytes, tx_bytes, rx_pkts,           |                            |
+  | port_stats <port id>                         | Print rate for no_mbufs, ierrors, rx_bytes, tx_bytes, rx_pkts,            |                            |
   |                                              | tx_pkts and totals for RX, TX, no_mbufs ierrors for port <port id>        |                            |
   +----------------------------------------------+---------------------------------------------------------------------------+----------------------------+
 
@@ -941,7 +943,7 @@ PROX Compiation installation
 * cd samplevnf
 * export RTE_SDK=`pwd`/dpdk
 * export RTE_TARGET=x86_64-native-linuxapp-gcc
-* git clone http://dpdk.org/git/dpdk
+* git clone git://dpdk.org/dpdk
 * cd dpdk
 * git checkout v17.05
 * make install T=$RTE_TARGET
diff --git a/docs/testing/user/userguide/06-How_to_use_REST_api.rst b/docs/testing/user/userguide/06-How_to_use_REST_api.rst
index b8c0cbea..ba768d78 100644
--- a/docs/testing/user/userguide/06-How_to_use_REST_api.rst
+++ b/docs/testing/user/userguide/06-How_to_use_REST_api.rst
@@ -3,12 +3,12 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) opnfv, national center of scientific research "demokritos" and others.
 
-========================================================
+========
 REST API
-========================================================
+========
 
 Introduction
----------------
+------------
 As the internet industry progresses creating REST API becomes more concrete
 with emerging best Practices. RESTful web services don’t follow a prescribed
 standard except fpr the protocol that is used which is HTTP, its important
@@ -26,7 +26,7 @@ Here are important points to be considered:
    always same no matter how many times these operations are invoked.
  * PUT and POST operation are nearly same with the difference lying
    only in the result where PUT operation is idempotent and POST
-    operation can cause different result.
+   operation can cause different result.
 
 
 REST API in SampleVNF
@@ -45,7 +45,7 @@ REST api on VNF’s will help adapting with the new automation techniques
 being adapted in yardstick.
 
 Web server integration with VNF’s
-----------------------------------
+---------------------------------
 
 In order to implement REST api’s in VNF one of the first task is to
 identify a simple web server that needs to be integrated with VNF’s.
@@ -150,7 +150,7 @@ API Usage
 ---------
 
 Run time Usage
-^^^^^^^^^^^^^^
+==============
 
 An application(say vFW) with REST API support is run as follows
 with just PORT MASK as input. The following environment variables
@@ -182,6 +182,7 @@ samplevnf directory).
 
 2. Check the Link IP's using the REST API (vCGNAPT/vACL/vFW)
    ::
+
      e.g curl <IP>/vnf/config/link
 
      This would indicate the number of links enabled. You should enable all the links
@@ -194,6 +195,7 @@ samplevnf directory).
 
 3. Now that links are enabled we can configure IP's using link method as follows (vCGNAPT/vACL/vFW)
    ::
+
      e.g  curl -X POST -H "Content-Type:application/json" -d '{"ipv4":"<IP to be configured>","depth":"24"}'
      http://<IP>/vnf/config/link/0
      curl -X POST -H "Content-Type:application/json" -d '{"ipv4":"IP to be configured","depth":"24"}'
@@ -207,6 +209,7 @@ samplevnf directory).
 
 4. Adding arp entries we can use this method (vCGNAPT/vACL/vFW)
    ::
+
      /vnf/config/arp
 
      e.g
@@ -220,15 +223,17 @@ samplevnf directory).
 
 5. Adding route entries we can use this method (vCGNAPT/vACL/vFW)
    ::
+
      /vnf/config/route
 
      e.g curl -X POST -H "Content-Type:application/json" -d '{"type":"net", "depth":"8", "nhipv4":"202.16.100.20",
-                  "portid":"0"}' http://10.223.166.240/vnf/config/route
+                 "portid":"0"}' http://10.223.166.240/vnf/config/route
      curl -X POST -H "Content-Type:application/json" -d '{"type":"net", "depth":8", "nhipv4":"172.16.100.20",
                  "portid":"1"}' http://10.223.166.240/vnf/config/route
 
 5. In order to load the rules a script file needs to be posting a script.(vACL/vFW)
    ::
+
      /vnf/config/rules/load
 
      Typical example for loading a script file is shown below
@@ -239,12 +244,14 @@ samplevnf directory).
 
 6. The following REST api's for runtime configuring through a script (vCGNAPT Only)
    ::
+
      /vnf/config/rules/clear
      /vnf/config/nat
      /vnf/config/nat/load
 
 7. For debug purpose following REST API's could be used as described above.(vCGNAPT/vACL/vFW)
    ::
+
      /vnf/dbg
      e.g curl http://10.223.166.240/vnf/config/dbg
 
@@ -258,10 +265,12 @@ samplevnf directory).
 
 8. For stats we can use the following method (vCGNAPT/vACL/vFW)
    ::
+
      /vnf/stats
      e.g curl <IP>/vnf/stats
 
 9. For quittiong the application (vCGNAPT/vACL/vFW)
    ::
+
      /vnf/quit
      e.g curl <IP>/vnf/quit
diff --git a/docs/testing/user/userguide/07-Config_files.rst b/docs/testing/user/userguide/07-Config_files.rst
index d5564e8d..f96462e1 100644
--- a/docs/testing/user/userguide/07-Config_files.rst
+++ b/docs/testing/user/userguide/07-Config_files.rst
@@ -380,7 +380,7 @@ This configuration doesn't require LOADB and TXRX pipelines
 
 
 vACL Config files
-----------------
+-----------------
 
 The reference configuration files explained here are for Software and Hardware
 loadbalancing with IPv4 traffic type and single port pair.
diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst
index 64b01b88..5cc2c5e1 100644
--- a/docs/testing/user/userguide/index.rst
+++ b/docs/testing/user/userguide/index.rst
@@ -10,7 +10,6 @@ SampleVNF User Guide
 
 .. toctree::
    :maxdepth: 4
-   :numbered:
 
    01-introduction.rst
    02-methodology.rst
diff --git a/docs/testing/user/userguide/references.rst b/docs/testing/user/userguide/references.rst
index 30f6e604..f00a872c 100644
--- a/docs/testing/user/userguide/references.rst
+++ b/docs/testing/user/userguide/references.rst
@@ -11,8 +11,8 @@ References
 OPNFV
 =====
 
-* Yardstick wiki: https://wiki.opnfv.org/yardstick
-* SampleVNF wiki: https://wiki.opnfv.org/samplevnf
+* Yardstick wiki: https://wiki-old.opnfv.org/display/yardstick
+* SampleVNF wiki: https://wiki-old.opnfv.org/display/SAM
 
 References used in Test Cases
 =============================
@@ -22,7 +22,7 @@ References used in Test Cases
 * DPDK: http://dpdk.org
 * DPDK supported NICs: http://dpdk.org/doc/nics
 * fdisk: http://www.tldp.org/HOWTO/Partition/fdisk_partitioning.html
-* fio: http://www.bluestop.org/fio/HOWTO.txt
+* fio: https://github.com/axboe/fio
 * free: http://manpages.ubuntu.com/manpages/trusty/en/man1/free.1.html
 * iperf3: https://iperf.fr/
 * Lmbench man-pages: http://manpages.ubuntu.com/manpages/trusty/lat_mem_rd.8.html