Merge "UserGuide: Update In-band management chapter"

3 files changed, 132 insertions, 9 deletions

diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement.png b/doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement.png
new file mode 100755
index 0000000..5d3a505
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement.png
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement2.png b/doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement2.png
new file mode 100755
index 0000000..b6ea8b3
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/In-bandManagement2.png
diff --git a/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml b/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml
index fa5a2a8..67a8a5a 100755
--- a/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml
@@ -14,28 +14,151 @@
   In other cases, In-Band Management is the only option available to both
   control and configure the device, while also allowing for data-path traffic
   to pass over the same physical interface. This use-case is required on a
-  setup with a poor infrastructure configuration. The main requirement for this
-  use-case solution is to have all traffic pass through a defined WAN physical
-  port. Three types of traffic are mentioned:</para>
+  setup with a poor infrastructure configuration. The main requirement for
+  this use-case solution is to have all traffic pass through a defined WAN
+  physical port. Three types of traffic are mentioned:</para>
 
   <itemizedlist>
     <listitem>
-      <para>Device management - e.g.: firmware upgrades done by the uCPE Manager.</para>
+      <para>Device management - e.g.: device configuration, firmware upgrades
+      done by the uCPE Manager.</para>
     </listitem>
 
     <listitem>
-      <para>VNFs configuration - like enabling or disabling the firewall, the
-      VPN or other features.</para>
+      <para>VNFs configuration - like enabling or disabling features of VNF
+      like enabling/disabling firewall or VPN setup.</para>
     </listitem>
 
     <listitem>
-      <para>Data-path - all the other traffic that needs to reach a LAN
-      network. <remark>This is not ever clear, it needs to be a explain a
-      little bit better.</remark></para>
+      <para>Data-path - all the other traffic that is not used in control
+      plane and needs to reach a LAN network. </para>
     </listitem>
   </itemizedlist>
 
   <para>For use-cases where latency is very important, it is recommended to
   use out-of-band management with a dedicated physical interface for the
   data-path.</para>
+
+  <para>Enea solution for in-band management is based on Open vSwitch bridge
+  which controll all the traffic passing the WAN physical port. NFV Access
+  assume that the activate connection with uCPE Manager is the one to be used
+  for in-band management. Physical port used by activate connection willbe
+  attached to the in-band management WAN bridge. The communication with uCPE
+  Manager should not be affected in the sense it is re-stablished
+  automatically after in-band management activation.</para>
+
+  <para>All network traffic except the one from uCPE Manager will be sent
+  towards VNF or dropped in case there is no VNF instantiated on the NFV
+  Access device. The VNF connected to WAN bridge must be configured for
+  in-band management since the traffic from VNF manager and data-path will be
+  sent to only one port(WAN) of the VNF. Only one VNF must be connected to the
+  in-band management WAN bridge. Please make sure the VNF accept in-band
+  management.</para>
+
+  <figure>
+    <title>Enea In-band Management solution</title>
+
+    <mediaobject>
+      <imageobject>
+        <imagedata align="center" fileref="images/In-bandManagement2.png"
+                   scale="60" />
+      </imageobject>
+    </mediaobject>
+  </figure>
+
+  <table>
+    <title>Setup Prerequisites:</title>
+
+    <tgroup cols="2">
+      <colspec align="left" colwidth="2*" />
+      <colspec align="left" colwidth="4*" />
+
+      <tbody>
+        <row>
+          <entry>WAN port</entry>
+
+          <entry>physical port supported by DPDK</entry>
+        </row>
+
+        <row>
+          <entry>Dynamic IP on WAN port</entry>
+
+          <entry>DHCP server configured to distribute same IP address for same
+          MAC</entry>
+        </row>
+
+        <row>
+          <entry>uCPE Manager</entry>
+
+          <entry>uCPE Manager IP address must be public(accesible for targets)
+          and static</entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </table>
+
+  <para>In order to activate in-band management from uCPE Manager follow the
+  next steps: &lt;select the device&gt; -&gt; Configuration -&gt; OpenVSwitch
+  -&gt; Bridges -&gt; Add</para>
+
+  <table>
+    <title>In-band management WAN DPDK bridge configuration</title>
+
+    <tgroup cols="2">
+     <colspec align="left" colwidth="2*" />
+     <colspec align="left" colwidth="4*" />
+
+      <tbody>
+        <row>
+          <entry>name</entry>
+
+          <entry>&lt;provide a name for the WAN bridge ex:
+          "ibm-wan-br"&gt;</entry>
+        </row>
+
+        <row>
+          <entry>ovs-bridge-type</entry>
+
+          <entry>dpdkWan</entry>
+        </row>
+
+        <row>
+          <entry>mgmt-address</entry>
+
+          <entry>IPv4 &lt;add IP address of uCPE Manager machine&gt;</entry>
+        </row>
+
+        <row>
+          <entry>mgmt-port</entry>
+
+          <entry>4334</entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </table>
+
+  <para>At this point the connection between device and uCPE Manager will be
+  re-created and all traffic pass through the new bridge(ibm-wan-br). User
+  should be able to continue device configuration. The WAN port of the very
+  first instantiated VNF must be connected to the ibm-wan-br and it should
+  receive the same IP address with the WAN interfaces of the device. </para>
+
+  <figure>
+    <title>Enea In-band Management solution</title>
+
+    <mediaobject>
+      <imageobject>
+        <imagedata align="center" fileref="images/In-bandManagement.png"
+                   scale="70" />
+      </imageobject>
+    </mediaobject>
+  </figure>
+
+  <para>The VNF can be reached on the same IP as of the device(ex.
+  https://&lt;WAN_IP&gt;).</para>
+
+  <note>
+    <para>In-band management bridge must be re-created in case uCPE Manager IP
+    is changed!</para>
+  </note>
 </chapter>