Updating the structuring and pictures of ENA example-usecases.

Change-Id: If2026f111c8004e31f329df56c63d9d7e0ad5eab

1 files changed, 98 insertions, 76 deletions

diff --git a/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml b/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml
index 570ea7a..f8ac57d 100644
--- a/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml
+++ b/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml
@@ -2,6 +2,9 @@
 <chapter id="clav_vnf_example">
   <title>Clavister VNF Example Use-cases</title>
 
+  <para>The Clavister VNF is a telco-ready, carrier-grade virtual next
+  generation firewall.</para>
+
   <section id="prere_clav_vnf">
     <title>Prerequisites</title>
 
@@ -33,7 +36,7 @@
     Open vSwitch bridge, while uCPE device 2 will run two iPerf VNFs.</para>
 
     <figure>
-      <title>Clavister VNF Example Overview</title>
+      <title>Clavister VNF using Open vSwitch Bridge Overview</title>
 
       <mediaobject>
         <imageobject>
@@ -44,9 +47,9 @@
     </figure>
 
     <section id="clav_vnf_setup_1">
-      <title>uCPE device Setup</title>
+      <title>Use-case Setup</title>
 
-      <para><emphasis role="bold">Configure Network interfaces on the uCPE
+      <para><emphasis role="bold">Configuring Network Interfaces on uCPE
       devices:</emphasis></para>
 
       <orderedlist>
@@ -80,10 +83,8 @@
           interface and creating another OVS bridge.</para>
         </listitem>
       </orderedlist>
-    </section>
 
-    <section id="onboard_vnf_clav">
-      <title>Onboard the VNFs</title>
+      <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para>
 
       <orderedlist>
         <listitem>
@@ -121,63 +122,70 @@
           </itemizedlist>
         </listitem>
       </orderedlist>
-    </section>
 
-    <section id="instance_vnfs_clav">
-      <title>Instantiate the VNFs</title>
+      <para><emphasis role="bold">Instantiating the VNFs:</emphasis></para>
 
-      <para><emphasis role="bold">A) Instantiate the Clavister VNF on uCPE
-      device 1:</emphasis></para>
-
-      <orderedlist>
+      <itemizedlist>
         <listitem>
-          <para>Select uCPE device 1, then from the top toolbar:
-          <literal>VNF</literal> -&gt; <literal>Instances</literal> -&gt;
-          <literal>Add</literal>.</para>
+          <para><emphasis role="bold">A) Instantiate the Clavister VNF on uCPE
+          device 1:</emphasis></para>
+
+          <orderedlist>
+            <listitem>
+              <para>Select uCPE device 1, then from the top toolbar:
+              <literal>VNF</literal> -&gt; <literal>Instances</literal> -&gt;
+              <literal>Add</literal>.</para>
+            </listitem>
+
+            <listitem>
+              <para>Fill in the required information about the Clavister VNF,
+              (the default network configuration can be used) and select
+              <literal>Create</literal>.</para>
+            </listitem>
+          </orderedlist>
         </listitem>
 
         <listitem>
-          <para>Fill in the required information about the Clavister VNF, (the
-          default network configuration can be used) and select
-          <literal>Create</literal>.</para>
-        </listitem>
-      </orderedlist>
+          <para><emphasis role="bold">B) Instantiate two Enea VNFs (one as the
+          client and one as the server) on uCPE device 2:</emphasis></para>
 
-      <para><emphasis role="bold">B) Instantiate two Enea VNFs (one as the
-      client and one as the server) on uCPE device 2:</emphasis></para>
+          <orderedlist>
+            <listitem>
+              <para>Select uCPE device 2, then from the top toolbar:
+              <literal>VNF</literal> -&gt; <literal>Instances</literal> -&gt;
+              <literal>Add</literal>.</para>
+            </listitem>
 
-      <orderedlist>
-        <listitem>
-          <para>Select uCPE device 2, then from the top toolbar:
-          <literal>VNF</literal> -&gt; <literal>Instances</literal> -&gt;
-          <literal>Add</literal>.</para>
-        </listitem>
+            <listitem>
+              <para>In the new <literal>VNF Instance</literal> window, select
+              the Enea VNF from the dropdown menu, configure it to act as a
+              server by unchecking the <literal>Client mode IPerf</literal>
+              box, and then click <literal>Create</literal>.</para>
+            </listitem>
 
-        <listitem>
-          <para>In the new <literal>VNF Instance</literal> window, select the
-          Enea VNF from the dropdown menu, configure it to act as a server by
-          unchecking the <literal>Client mode IPerf</literal> box, and then
-          click <literal>Create</literal>.</para>
+            <listitem>
+              <para>Select <literal>Add</literal> once more, enable the
+              <literal>Client mode IPerf</literal> checkbox this time, and
+              click <literal>Create</literal> to instantiate the second
+              <literal>iPerf VNF</literal> as a client, and to run it in
+              client mode.</para>
+            </listitem>
+          </orderedlist>
         </listitem>
+      </itemizedlist>
+    </section>
 
-        <listitem>
-          <para>Select <literal>Add</literal> once more, enable the
-          <literal>Client mode IPerf</literal> checkbox this time, and click
-          <literal>Create</literal> to instantiate the second <literal>iPerf
-          VNF</literal> as a client, and to run it in client mode.</para>
-        </listitem>
+    <section id="test_clav_uc_1">
+      <title>Testing the Use-case</title>
 
-        <listitem>
-          <para>In order to check that traffic is forwarded between the two
-          VNFs, connect to the iPerf VNF client console:
-          <literal>SSH</literal> -&gt; <literal>user</literal> (root) -&gt;
-          <literal>Connect</literal> and run the following:</para>
+      <para>In order to check that traffic is forwarded between the two VNFs,
+      connect to the iPerf VNF client console: <literal>SSH</literal> -&gt;
+      <literal>user</literal> (root) -&gt; <literal>Connect</literal> and run
+      the following:</para>
 
-          <programlisting>virsh list
+      <programlisting>virsh list
 virsh console
 root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting>
-        </listitem>
-      </orderedlist>
     </section>
   </section>
 
@@ -189,7 +197,7 @@ root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting>
     using SR-IOV with two virtual functions (vf1 and vf2):</para>
 
     <figure>
-      <title>Example Overview</title>
+      <title>Clavister VNF using SR-IOV Overview</title>
 
       <mediaobject>
         <imageobject>
@@ -200,16 +208,19 @@ root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting>
     </figure>
 
     <section id="clav_vnf_setup_2">
-      <title>Example Setup</title>
+      <title>Use-case Setup</title>
+
+      <para><emphasis role="bold">Configuring Network Interfaces on uCPE
+      devices:</emphasis></para>
 
       <orderedlist>
         <listitem>
           <para>On uCPE device 2, create an SR-IOV configuration with 2
           virtual functions by selecting <literal>Configuration</literal>
           -&gt; <literal>OpenVSwitch</literal> -&gt; <literal>Host
-          Interfaces</literal> -&gt; <literal>Add</literal>:</para>
+          Interfaces</literal> -&gt; <literal>Add</literal>.</para>
 
-          <figure>
+          <figure condition="hidden">
             <title>SR-IOV configuration with 2 virtual functions</title>
 
             <mediaobject>
@@ -222,6 +233,30 @@ root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting>
         </listitem>
 
         <listitem>
+          <para>On uCPE device 1, create an SR-IOV interface as done in step
+          1.</para>
+        </listitem>
+
+        <listitem>
+          <para>Create the iPerf server on uCPE device 1 and select
+          <literal>SrIovAdapterPool</literal> as an Interface type.</para>
+        </listitem>
+
+        <listitem>
+          <para>Create the iPerf client on uCPE device 1. Select
+          <literal>SrIovAdapterPool</literal> as an Interface type and tick
+          the <literal>Client mode IPerf</literal> checkbox.</para>
+        </listitem>
+      </orderedlist>
+
+      <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para>
+
+      <para>????</para>
+
+      <para><emphasis role="bold">Instantiating the VNFs:</emphasis></para>
+
+      <orderedlist>
+        <listitem>
           <para>Instantiate the Clavister VNF on uCPE device 2:
           <literal>VNF</literal> -&gt; <literal>Instances</literal> -&gt;
           <literal>Add</literal>.</para>
@@ -232,7 +267,7 @@ root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting>
           type for both Interface 1 type and 2 type, before clicking
           <literal>Create</literal>.</para>
 
-          <figure>
+          <figure condition="hidden">
             <title>Instantiating the Clavister VNF on uCPE device 2</title>
 
             <mediaobject>
@@ -243,33 +278,20 @@ root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting>
             </mediaobject>
           </figure>
         </listitem>
+      </orderedlist>
+    </section>
 
-        <listitem>
-          <para>On uCPE device 1, create an SR-IOV interface as done in step
-          1.</para>
-        </listitem>
-
-        <listitem>
-          <para>Create the iPerf server on uCPE device 1 and select
-          <literal>SrIovAdapterPool</literal> as an Interface type.</para>
-        </listitem>
+    <section id="test_clav_uc_2">
+      <title>Testing the Use-case</title>
 
-        <listitem>
-          <para>Create the iPerf client on uCPE device 1. Select
-          <literal>SrIovAdapterPool</literal> as an Interface type and tick
-          the <literal>Client mode IPerf</literal> checkbox.</para>
-        </listitem>
+      <para>In order to check that traffic is forwarded between the VNFs,
+      connect to the iPerf VNF client console by using: <literal>SSH</literal>
+      -&gt; <literal>user</literal> (root) -&gt;<literal>Connect</literal> and
+      run the following commands:</para>
 
-        <listitem>
-          <para>In order to check that traffic is forwarded between the VNFs,
-          connect to the iPerf VNF client console by using:
-          <literal>SSH</literal> -&gt; <literal>user</literal> (root)
-          -&gt;<literal>Connect</literal> and run the following commands:
-          <programlisting>virsh list
+      <programlisting>virsh list
 virsh console
-root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting></para>
-        </listitem>
-      </orderedlist>
+root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting>
     </section>
   </section>
 </chapter>
\ No newline at end of file