From 396c0dbb5c16adb6f241ee59b24be68c9047b80d Mon Sep 17 00:00:00 2001
From: jaar <aroosa.jamshaid@enea.com>
Date: Tue, 26 Nov 2019 09:47:00 +0100
Subject: BookExampleUseCases: added diagram and note

Added a usecase diagram for ENEA VNF example,
Updated the prerequisites,added a note about the flow rules.

Change-Id: I7ecef383da17ccc8449a2391efa4caf3c5227315
Signed-off-by: jaar <aroosa.jamshaid@enea.com>
---
 .../doc/enea_test_vnf_examples.xml                 | 36 +++++++++++++++-------
 1 file changed, 25 insertions(+), 11 deletions(-)

(limited to 'doc')

diff --git a/doc/book-enea-nfv-access-example-usecases/doc/enea_test_vnf_examples.xml b/doc/book-enea-nfv-access-example-usecases/doc/enea_test_vnf_examples.xml
index 985e299..ba42751 100644
--- a/doc/book-enea-nfv-access-example-usecases/doc/enea_test_vnf_examples.xml
+++ b/doc/book-enea-nfv-access-example-usecases/doc/enea_test_vnf_examples.xml
@@ -12,11 +12,13 @@
   <section id="prere_enea_vnf">
     <title>Prerequisites</title>
 
-    <para>System requirements for the uCPE devices:</para>
+    <para>Two uCPE devices will be required for this setup. The system
+    requirements for each uCPE device are:</para>
 
     <itemizedlist>
       <listitem>
-        <para>1 Network Interface</para>
+        <para>2 Network Interfaces. One for the uCPE manager and one for data
+        traffic.</para>
       </listitem>
 
       <listitem>
@@ -27,15 +29,11 @@
     <para>The following files are needed for this example use case:</para>
 
     <itemizedlist>
-      <para>VNF image:</para>
-
       <listitem>
-        <para>Enea Test VNF, please contact Enea to get this image.</para>
+        <para>VNF image: Enea Test VNF. Please contact Enea to get this image.</para>
       </listitem>
-    </itemizedlist>
 
-    <itemizedlist>
-      <para>VNF Configuration files, these files are provided with your Enea
+      <para>VNF Configuration files. These files are provided with your Enea
       NFV Access release:</para>
 
       <listitem>
@@ -56,6 +54,17 @@
     the TestPMD DPDK application forwarding traffic, and the other runs the
     TestPMD in order to terminate traffic.</para>
 
+    <figure>
+      <title>TestPMD VNF Overview</title>
+
+      <mediaobject>
+        <imageobject>
+          <imagedata align="center" contentwidth="600" 
+                     fileref="images/enea_test_vnf_diagram.png" />
+        </imageobject>
+      </mediaobject>
+    </figure>
+
     <section id="enea_vnf_setup">
       <title>Use-case Setup</title>
 
@@ -199,11 +208,16 @@
 
       <itemizedlist>
         <listitem>
-          <para>Source: DPDK interface, Target: testpmd_fwd</para>
+          <para>Source: DPDK interface, Target: <literal>testpmd_fwd</literal>.</para>
         </listitem>
 
         <listitem>
-          <para>Source: testpmd_fwd, Target: testpmd_term</para>
+          <para>Source: <literal>testpmd_fwd</literal>, Target: <literal>testpmd_term</literal>.</para>
+
+          <note>
+            <para>The flow rules can be described using either the uCPE
+            manager interface or the configuration files.</para>
+          </note>
         </listitem>
       </itemizedlist>
     </section>
@@ -288,4 +302,4 @@ Run: tail -f /opt/testpmd-out</programlisting>
       </orderedlist>
     </section>
   </section>
-</chapter>
+</chapter>
\ No newline at end of file
-- 
cgit v1.2.3-54-g00ecf