Example Use-cases: Update Enea VNF example

- Replace bundle with VNF image and update onboarding/instantiation instructions
- Add cloud-init configurations
- Remove descriptions of how to navigate the uCPE manager GUI
- Remove images that are incorrect

Change-Id: I6e8d05ae37a360e6957648049b1469a439df6981
Signed-off-by: Martin Borg <martin.borg@enea.com>

1 files changed, 141 insertions, 111 deletions

diff --git a/doc/book-enea-nfv-access-example-usecases/doc/enea_vnf_examples.xml b/doc/book-enea-nfv-access-example-usecases/doc/enea_vnf_examples.xml
index 8f11107..3cc5a18 100644
--- a/doc/book-enea-nfv-access-example-usecases/doc/enea_vnf_examples.xml
+++ b/doc/book-enea-nfv-access-example-usecases/doc/enea_vnf_examples.xml
@@ -1,30 +1,40 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <chapter id="enea_vnf_examples">
-  <title>Enea VNF Example Use-cases</title>
-
-  <para>Enea NFV Access is a complete NFV Infrastructure (NFVI) platform
-  designed for deployment on white box uCPEs at the customer premise, and
-  optimized for common Virtual Customer Premises Equipment (vCPE) and SD-WAN
-  use cases.</para>
+  <title>Enea NFV Access VNF Example Use-cases</title>
 
   <section id="prere_enea_vnf">
     <title>Prerequisites</title>
 
-    <para>The following file(s) are needed for this example use-case:
-    <literal>enea-nfv-access-vnf-qemux86-64.qcow2</literal>. This image is
-    provided with your release.</para>
+    <para>The following files are needed for this example use-case:</para>
+
+    <remark>FIXME: These filenames may need to be updated</remark>
+
+    <itemizedlist>
+      <listitem>
+        <para><literal>enea-nfv-access-vnf-qemux86-64.wic.qcow2</literal></para>
+      </listitem>
+
+      <listitem>
+        <para><literal>enea-vnf-testpmd-fwd.cfg</literal></para>
+      </listitem>
+
+      <listitem>
+        <para><literal>enea-vnf-testpmd-term.cfg</literal></para>
+      </listitem>
+    </itemizedlist>
   </section>
 
   <section id="enea_vnf">
     <title>TestPMD VNF</title>
 
-    <para>In this use-case, <literal>uCPE device 1</literal> will run pktgen
-    (the DPDK application) and <literal>uCPE device 2</literal> will onboard
-    and instantiate two VNFs. One VNF will run <literal>testpmd_fwd</literal>,
-    forwarding traffic, and the other will run <literal>testpmd_term</literal>
-    which will terminate traffic.</para>
+    <para>In this use-case, uCPE device 1 runs the pktgen DPDK application to
+    generate traffic and uCPE device 2 runs two Enea NFV Access VNFs. One VNF
+    runs the TestPMD DPDK application forwarding traffic, and the other runs
+    the TestPMD in order to terminate traffic.</para>
 
-    <figure>
+    <remark>FIXME: New image needed</remark>
+
+    <figure condition="hidden">
       <title>Enea TestPMD VNF Overview</title>
 
       <mediaobject>
@@ -38,164 +48,183 @@
     <section id="enea_vnf_setup">
       <title>Use-case Setup</title>
 
-      <para><emphasis role="bold">Configuring Network Interfaces on uCPE
-      devices:</emphasis></para>
+      <para><emphasis role="bold">Network Configuration:</emphasis></para>
 
       <orderedlist>
         <listitem>
-          <para>Bind the host interfaces to the DPDK by selecting
-          <literal>uCPE device 1</literal> first, then accessing
-          <literal>Configuration</literal> -&gt;
-          <literal>OpenVSwitch</literal> -&gt; <literal>Host
-          Interfaces</literal> -&gt; <literal>Add</literal>.</para>
+          <para>Select uCPE device 1, access <literal>Configuration</literal>,
+          add the network interface that will be used and configure it for
+          DPDK. Note the PCI address of the interface, it will be used later
+          to run the pktgen application.</para>
         </listitem>
 
         <listitem>
-          <para>Select the network interface that will be used to connect to
-          the second uCPE device and configure it for the DPDK.</para>
+          <para>Select uCPE device 2, access <literal>Configuration</literal>,
+          add the network interface that will be used and configure it for
+          DPDK.</para>
         </listitem>
 
         <listitem>
-          <para>Select the <literal>Create</literal> button to send the
-          configuration to <literal>uCPE device 1</literal>.</para>
+          <para>Create an OVS bridge on uCPE device 2 and attach the DPDK
+          interface.</para>
         </listitem>
+      </orderedlist>
 
+      <para><emphasis role="bold">Onboarding the VNF:</emphasis></para>
+
+      <para>Onboard the Enea NFV Access VNF by filling the required fields
+      with the following values:</para>
+
+      <itemizedlist spacing="compact">
         <listitem>
-          <para>Repeat these same steps on <literal>uCPE device
-          2</literal>.</para>
+          <para><emphasis role="bold">VM Image File</emphasis>: Provide the
+          path to the Enea NFV Access VNF qcow2 image.</para>
         </listitem>
 
         <listitem>
-          <para>Click the <literal>Add</literal> button from the Bridges
-          tab.</para>
+          <para><emphasis role="bold">Memory in MB</emphasis>: 2048</para>
         </listitem>
 
         <listitem>
-          <para>Create an Open vSwitch bridge (<literal>ovsbr0</literal>) on
-          <literal>uCPE device 1</literal> that uses one DPDK interface, by
-          selecting <literal>uCPE device 1</literal>, then:
-          <literal>Configuration</literal> -&gt;<literal>OpenVSwitch</literal>
-          -&gt;<literal>Bridges</literal>.</para>
+          <para><emphasis role="bold">Num of CPUs</emphasis>: 2</para>
         </listitem>
-      </orderedlist>
 
-      <para><emphasis role="bold">Onboarding the VNF:</emphasis></para>
+        <listitem>
+          <para><emphasis role="bold">Storage in GB</emphasis>: 10</para>
+        </listitem>
 
-      <orderedlist>
         <listitem>
-          <para>Select <literal>VNF</literal>
-          -&gt;<literal>Descriptor</literal> -&gt;
-          <literal>On-board</literal>.</para>
+          <para><emphasis role="bold">Interfaces</emphasis>: Add 1
+          interface.</para>
         </listitem>
 
         <listitem>
-          <para>Select the <literal>VM Image</literal> radio button.</para>
+          <para><emphasis role="bold">Cloud-init Datasource</emphasis>:
+          NoCloud</para>
         </listitem>
 
         <listitem>
-          <para>Provide the path to the qcow image by selecting
-          <literal>Browse </literal> from the <literal>VM image file</literal>
-          option.</para>
+          <para><emphasis role="bold">Cloud-init Disk Type</emphasis>:
+          disk</para>
         </listitem>
+      </itemizedlist>
 
+      <para><emphasis role="bold">Instantiating the VNFs:</emphasis></para>
+
+      <orderedlist>
         <listitem>
-          <para>Fill the required fields below and press
-          <literal>Onboard</literal>:</para>
+          <para>Instantiate the Enea NFV Access TestPMD forwarding VNF on uCPE
+          Device 2 by filling the required fields with the following
+          values:</para>
 
           <itemizedlist spacing="compact">
             <listitem>
-              <para><emphasis role="bold">Memory in MB</emphasis>: 1024</para>
+              <para><emphasis role="bold">Name</emphasis>: testpmd_fwd</para>
             </listitem>
 
             <listitem>
-              <para><emphasis role="bold">Nr. of CPUs</emphasis>: 1</para>
+              <para><emphasis role="bold">VNF Type</emphasis>: Select Enea NFV
+              Access VNF.</para>
             </listitem>
 
             <listitem>
-              <para><emphasis role="bold">Storage in GB</emphasis>: 10</para>
+              <para><emphasis role="bold">uCPE Device</emphasis>: Select uCPE
+              device 2.</para>
             </listitem>
-          </itemizedlist>
-        </listitem>
-      </orderedlist>
 
-      <para><emphasis role="bold">Instantiating two VNFs on uCPE device
-      2:</emphasis></para>
+            <listitem>
+              <para><emphasis role="bold">Cloud Init File</emphasis>: Provide
+              the path to the Enea VNF TestPMD forwarding cloud-init
+              file.</para>
+            </listitem>
 
-      <orderedlist>
-        <listitem>
-          <para>Select uCPE device 2, then access <literal>VNF</literal> -&gt;
-          <literal>Instances</literal> -&gt; <literal>Add</literal>.</para>
+            <listitem>
+              <para><emphasis role="bold">Interfaces</emphasis>: Set the
+              interface type to <literal>DPDK</literal> and select the OVS
+              bridge created above.</para>
+            </listitem>
+          </itemizedlist>
         </listitem>
 
         <listitem>
-          <para>Fill-in the required fields and click
-          <literal>Create</literal>.</para>
-        </listitem>
+          <para>Instantiate the Enea NFV Access TestPMD termination VNF on
+          uCPE Device 2 by filling the required fields with the following
+          values:</para>
 
-        <listitem>
-          <para>Configure VNF 1 to forward traffic.</para>
-        </listitem>
+          <itemizedlist spacing="compact">
+            <listitem>
+              <para><emphasis role="bold">Name</emphasis>: testpmd_term</para>
+            </listitem>
 
-        <listitem>
-          <para>Configure VNF 2 to terminate traffic.</para>
-        </listitem>
+            <listitem>
+              <para><emphasis role="bold">VNF Type</emphasis>: Select Enea NFV
+              Access VNF.</para>
+            </listitem>
 
-        <listitem>
-          <para>Add Open vSwitch flows to control this traffic:</para>
+            <listitem>
+              <para><emphasis role="bold">uCPE Device</emphasis>: Select uCPE
+              device 2.</para>
+            </listitem>
 
-          <figure>
-            <title>Configuring the FWD flow</title>
+            <listitem>
+              <para><emphasis role="bold">Cloud Init File</emphasis>: Provide
+              the path to the Enea VNF TestPMD termination cloud-init
+              file.</para>
+            </listitem>
 
-            <mediaobject>
-              <imageobject>
-                <imagedata align="center" fileref="images/flow_fwd.png"
-                           scale="90" />
-              </imageobject>
-            </mediaobject>
-          </figure>
+            <listitem>
+              <para><emphasis role="bold">Interfaces</emphasis>:  Set the
+              interface type to <literal>DPDK</literal> and select the OVS
+              bridge created above.</para>
+            </listitem>
+          </itemizedlist>
+        </listitem>
+      </orderedlist>
 
-          <figure>
-            <title>Configuring the TERM flow</title>
+      <para><emphasis role="bold">Creating OVS flow rules:</emphasis></para>
 
-            <mediaobject>
-              <imageobject>
-                <imagedata align="center" fileref="images/flow_term.png"
-                           scale="90" />
-              </imageobject>
-            </mediaobject>
-          </figure>
-        </listitem>
+      <para>Select uCPE device 2, access <literal>Configuration</literal>,
+      open the OVS bridge and add two flow rules:</para>
 
+      <itemizedlist>
         <listitem>
-          <para>Start pktgen on uCPE device 1. Connect to the device by
-          selecting it first, then access <literal>SSH</literal> -&gt;
-          <literal>user</literal> (root) and perform the following:</para>
-
-          <programlisting>cd /usr/share/apps/pktgen/
-./pktgen -c 0x7 -n 4 --proc-type auto --socket-mem 256 -w 0000:05:00.3 -- \
--P -m "[1:2].0"
-Pktgen:/&gt; start 0</programlisting>
+          <para>Source: DPDK interface, Target: testpmd_fwd</para>
+        </listitem>
 
-          <note>
-            <para>The PCI address &lt;0000:05:00.3&gt; used in this example
-            varies depending on the uCPE device. To determine the exact PCI
-            address used, look in the uCPE device specific Network
-            configuration.</para>
-          </note>
+        <listitem>
+          <para>Source: testpmd_fwd, Target: testpmd_term</para>
         </listitem>
-      </orderedlist>
+      </itemizedlist>
     </section>
 
     <section id="test_ena_vnf">
       <title>Testing the Use-case</title>
 
-      <para>Connect to the forwarder VNF in order to check the traffic
-      statistics, by selecting the uCPE device first, then accessing
-      <literal>SSH</literal> -&gt; <literal>user</literal> (root):</para>
+      <orderedlist>
+      <listitem>
+        <para>SSH to uCPE device 1 (Username: root) and start the pktgen
+      application:</para>
+
+      <programlisting>cd /usr/share/apps/pktgen/
+./pktgen -c 0x7 -n 4 --proc-type auto --socket-mem 256 -w 0000:01:00.0 -- \
+  -P -m "[1:2].0"
+
+Pktgen:/&gt; start 0</programlisting>
+
+      <note>
+        <para>Replace 0000:01:00.0 with the actual PCI address of the network
+        interface used on uCPE device 1.</para>
+      </note></listitem>
 
-      <programlisting>Virsh list
-Virsh console 1
-# Qemux86-64 login: root
+      <listitem><para>SSH to uCPE device 2 and connect to the TestPMD forwarding VNF
+      console:</para>
+
+      <programlisting>virsh list
+virsh console &lt;id of testpmd fwd&gt;</programlisting></listitem>
+
+      <listitem><para>Check the TestPMD traffic forwarding statistics:</para>
+
+      <programlisting># qemux86-64 login: root
 tail -f /var/log/testpmd-out</programlisting>
 
       <figure>
@@ -207,7 +236,8 @@ tail -f /var/log/testpmd-out</programlisting>
                        fileref="images/connection_information.png" scale="70" />
           </imageobject>
         </mediaobject>
-      </figure>
+        </figure></listitem>
+     </orderedlist>
     </section>
 
     <section condition="hidden" id="vnf_pci">