SampleVNF Jerma documentation update

Some more documentation updates for the Jerma release.

Change-Id: I0626ae2ac18dd858f6d1e5fa341371aca6ec639d
Signed-off-by: Luc Provoost <luc.provoost@intel.com>

diff --git a/docs/testing/user/userguide/01-introduction.rst b/docs/testing/user/userguide/01-introduction.rst
index c2d28d0..eaac485 100755 (executable)
--- a/docs/testing/user/userguide/01-introduction.rst
+++ b/docs/testing/user/userguide/01-introduction.rst
@@ -10,7 +10,11 @@ Introduction
 **Welcome to SampleVNF's documentation !**
 
 .. _Pharos: https://wiki.opnfv.org/display/pharos
+<<<<<<< HEAD
 .. _SampleVNF: https://wiki.opnfv.org/samplevnf
+=======
+.. _SampleVNF: https://wiki.opnfv.org/display/SAM
+>>>>>>> Jerma documentation rewrite
 
 SampleVNF_ is an OPNFV Project.
 
@@ -24,7 +28,11 @@ to perform Network Function Virtualization Infrastructure
 
 *SampleVNF* is used in OPNFV for characterization of NFVI on OPNFV infrastructure.
 
+<<<<<<< HEAD
 .. seealso:: Pharos_ for information on OPNFV community labs
+=======
+.. seealso:: 'Pharos'_ for information on OPNFV community labs
+>>>>>>> Jerma documentation rewrite
 
 
 About This Document
@@ -37,16 +45,19 @@ This document consists of the following chapters:
 
 * Chapter :doc:`02-methodology` describes the methodology implemented by the
   *SampleVNF* Project for :term:`NFVI` verification.
+<<<<<<< HEAD
 
 * Chapter :doc:`03-installation` provides instructions to install *SampleVNF*.
 
 * Chapter :doc:`05-How_to_run_SampleVNFs` provides example on how installing and running *SampleVNF*.
 
 * Chapter :doc:`06-How_to_use_REST_api` provides info on how to run REST API *SampleVNF*.
+=======
+>>>>>>> Jerma documentation rewrite
 
-* Chapter :doc:`07-Config_files` provides info *SampleVNF* configuration.
+* Chapter :doc:`03-installation` provides instructions to install *SampleVNF*.
 
-* Chapter :doc:`08-CLI_Commands_Reference` provides info on CLI commands supported by *SampleVNF*
+* Chapter :doc:`04-running_the_test` shows how to run the dataplane testing.
 
 Contact SampleVNF
 =================

diff --git a/docs/testing/user/userguide/03-installation.rst b/docs/testing/user/userguide/03-installation.rst
index dc40e8e..2ce4ced 100644 (file)
--- a/docs/testing/user/userguide/03-installation.rst
+++ b/docs/testing/user/userguide/03-installation.rst
@@ -83,8 +83,15 @@ this will involve some manual file copying.
 
 Step 2: Clone the samplevnf project on that machine
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+<<<<<<< HEAD
   ::
      git clone https://git.opnfv.org/samplevnf
+=======
+.. code-block:: console
+
+     git clone https://git.opnfv.org/samplevnf
+
+>>>>>>> Jerma documentation rewrite
 Go to the relevant directory in this repository: samplevnf/VNFs/DPPD-PROX/helper-scripts/rapid/
 
 Step 3: Deploy the testing VMs
@@ -95,6 +102,7 @@ will have all information needed to run the actual test. You can do this step ma
 platforms (OpenStack, VMWare, K8s, bare metal, ...), but the automation tools described in the rest of this
 paragraph will using OpenStack Heat yaml files.
 First, a PROX qcow2 image needs to be downloaded.
+<<<<<<< HEAD
   ::
      wget http://artifacts.opnfv.org/samplevnf/jerma/prox_jerma.qcow2
 This image can also be created mannualy by following instructions in https://wiki.opnfv.org/display/SAM/Rapid+scripting,
@@ -106,6 +114,25 @@ Now run createrapid.sh to create the stack. This process takes the config_file a
 https://wiki.opnfv.org/display/SAM/Rapid+scripting, in the section "Deploying the VMs"
   ::
      ./createrapid.sh
+=======
+.. code-block:: console
+
+     wget http://artifacts.opnfv.org/samplevnf/jerma/prox_jerma.qcow2
+
+This image can also be created mannualy by following instructions in https://wiki.opnfv.org/display/SAM/Rapid+scripting,
+in the section "Creating an image" 
+Now upload this image to Openstack:
+.. code-block:: console
+
+     openstack image` create  --disk-format qcow2 --container-format bare --file prox_jerma.qcow2 rapidVM
+
+Now run createrapid.sh to create the stack. This process takes the config_file as input. Details can be found in
+https://wiki.opnfv.org/display/SAM/Rapid+scripting, in the section "Deploying the VMs"
+.. code-block:: console
+
+     ./createrapid.sh
+
+>>>>>>> Jerma documentation rewrite
 At the end of this step, VMs should be running and the rapid.env and rapid_key.pem files should be available.
 
 Step 4: Deploy your own Xtesting toolchain
@@ -113,7 +140,12 @@ Step 4: Deploy your own Xtesting toolchain
 Install Xtesting as described in https://xtesting.readthedocs.io/en/latest/
 First goto the xtesting directory in samplevnf/VNFs/DPPD-PROX/helper-scripts/rapid/xtesting (this was cloned
 in step 2)
+<<<<<<< HEAD
   ::
+=======
+.. code-block:: console
+
+>>>>>>> Jerma documentation rewrite
      virtualenv xtesting
      . xtesting/bin/activate
      pip install ansible
@@ -124,12 +156,28 @@ in step 2)
 
 Step 5: Build the test container that will drive the TST009 testing
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+<<<<<<< HEAD
   ::
+=======
+Go to the directory samplevnf/VNFs/DPPD-PROX/helper-scripts/rapid/xtesting
+While building this container, some files will be copied into the container image. Two of these files
+are generated by Step 3: rapid.env and rapid_key.pem and reside in the samplevnf/VNFs/DPPD-PROX/helper-scripts/rapid/.
+PLease copy them into the xtesting directory.
+The 3rd file that will be copied is testcases.yaml. You might want to modify this file according to the testing you would 
+like to execute.
+.. code-block:: console
+
+>>>>>>> Jerma documentation rewrite
      docker build -t 127.0.0.1:5000/rapidxt .
 
 Step 6: Publish your container on your local repository
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+<<<<<<< HEAD
   ::
+=======
+.. code-block:: console
+
+>>>>>>> Jerma documentation rewrite
      docker push  127.0.0.1:5000/rapidxt
 
 You are now ready to execute the testing