Interfaces configuration from uCPE Manager_V1 changes

have been added to the manual.

Change-Id: Id85ccff847e5324371369db3d728a50cd60254c1
Signed-off-by: mrpa <miruna.paun@enea.com>

8 files changed, 228 insertions, 44 deletions

diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml
index 609da64..4651698 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml
@@ -93,29 +93,41 @@
       <orderedlist>
         <listitem>
           <para>Install Java:</para>
-        
-          <orderedlist>
-            <listitem><para>Install OpenJDK 11:</para>
-                <programlisting>sudo yum install java-11-openjdk-devel</programlisting>
-                </listitem>
-            <listitem><para>Verify the installation:</para>
-<programlisting>java -version
+
+          <orderedlist>
+            <listitem>
+              <para>Install OpenJDK 11:</para>
+
+              <programlisting>sudo yum install java-11-openjdk-devel</programlisting>
+            </listitem>
+
+            <listitem>
+              <para>Verify the installation:</para>
+
+              <programlisting>java -version
 
 openjdk version "11.0.3" 2019-04-16 LTS
 OpenJDK Runtime Environment 18.9 (build 11.0.3+7-LTS)
-OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing)</programlisting></listitem>
-            
-            <listitem><para>The following system variables need to point to the OpenJDK 11 installation:</para>
-<programlisting>export JAVA_HOME=$(dirname $(dirname $(readlink $(readlink $(which javac)))))
+OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing)</programlisting>
+            </listitem>
+
+            <listitem>
+              <para>The following system variables need to point to the
+              OpenJDK 11 installation:</para>
+
+              <programlisting>export JAVA_HOME=$(dirname $(dirname $(readlink $(readlink $(which javac)))))
 export PATH=$PATH:$JAVA_HOME/bin
 export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
 </programlisting>
             </listitem>
-           </orderedlist>
-          
-           <note><para>If there are multiple java versions installed, switch between them using the 
-             following command:</para>
-                <programlisting>alternatives --config java</programlisting></note>
+          </orderedlist>
+
+          <note>
+            <para>If there are multiple java versions installed, switch
+            between them using the following command:</para>
+
+            <programlisting>alternatives --config java</programlisting>
+          </note>
         </listitem>
 
         <listitem>
@@ -629,6 +641,177 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
         <section id="configure_interfaces">
           <title>Configuring Interfaces</title>
 
+          <para>After networking interfaces have been added to the uCPE
+          Manager, the user can change the interface type (DPDK, SR-IOV,
+          Standard) and the address assignment of the network interfaces
+          (DHCP, Static).</para>
+
+          <para><emphasis role="bold">How to Edit the Configuration of an
+          Interface</emphasis></para>
+
+          <orderedlist>
+            <listitem>
+              <figure>
+                <title>Configuration of External Interfaces</title>
+
+                <mediaobject>
+                  <imageobject>
+                    <imagedata align="center" contentwidth="500"
+                               fileref="images/edit_inter_config.png" />
+                  </imageobject>
+                </mediaobject>
+              </figure>
+
+              <para>To edit an interface configuration type from the uCPE
+              Manager, select the uCPE device, then from the top toolbar
+              select the <literal>Configuration</literal> menu then
+              <literal>External Interfaces -&gt; Configuration</literal>. The
+              already configured interfaces are displayed here, as can be seen
+              in the figure above.</para>
+            </listitem>
+
+            <listitem>
+              <para>In order to edit an already configured interface, double
+              click on the desired one and a popup will appear as shown in the
+              figure below. From the Host Interface window, a user can change
+              the networking type and the IP address assignment:</para>
+
+              <figure>
+                <title>Editing an Interface</title>
+
+                <mediaobject>
+                  <imageobject>
+                    <imagedata align="center" contentwidth="500"
+                               fileref="images/edit_inter.png" />
+                  </imageobject>
+                </mediaobject>
+              </figure>
+            </listitem>
+          </orderedlist>
+
+          <para><emphasis role="bold">Set the IP address assignment of the
+          Management Interface to static</emphasis></para>
+
+          <orderedlist>
+            <listitem>
+              <para>To change an interface type from the uCPE Manager, select
+              the uCPE device, then from the top toolbar select
+              <literal>Configuration</literal> and then <literal>External
+              Interfaces -&gt; Configuration</literal>. The already configured
+              interfaces are displayed here.</para>
+            </listitem>
+
+            <listitem>
+              <para>From the interfaces' list, edit the interface which has
+              the "Management" flag set to "true", by double clicking on it,
+              triggering a popup window:</para>
+
+              <figure>
+                <title>Editing the Management Interface</title>
+
+                <mediaobject>
+                  <imageobject>
+                    <imagedata align="center" contentwidth="500"
+                               fileref="images/edit_mg_inter.png" />
+                  </imageobject>
+                </mediaobject>
+              </figure>
+            </listitem>
+
+            <listitem>
+              <para>From the Host Interface window, change the <literal>IP
+              address-assignment</literal> to "static". After the address
+              assignment is set, the user needs to set the <literal>IP
+              address</literal>, <literal>netmask</literal> and the
+              <literal>gateway</literal> of the interface. The user can use
+              the dropdown list to set the type of the IP version:
+              <literal>IPv4</literal> or <literal>IPv6</literal>
+              address:</para>
+
+              <figure>
+                <title>Setting the IP version</title>
+
+                <mediaobject>
+                  <imageobject>
+                    <imagedata align="center" contentwidth="500"
+                               fileref="images/setting_ip_version.png" />
+                  </imageobject>
+                </mediaobject>
+              </figure>
+            </listitem>
+          </orderedlist>
+
+          <para><emphasis role="bold">Set the IP address assignment of the
+          Management Interface to DHCP</emphasis></para>
+
+          <orderedlist>
+            <listitem>
+              <para>To change an interface type from the uCPE Manager, select
+              the uCPE device, then from the top toolbar select
+              <literal>Configuration</literal> and then <literal>External
+              Interfaces -&gt; Configuration</literal>. The already configured
+              interfaces are displayed here.</para>
+            </listitem>
+
+            <listitem>
+              <para>From the interfaces' list, edit the interface which has
+              the "Management" flag set to "true", by double clicking on it,
+              triggering a popup window. Within the Host Interface window
+              change the <literal>IP address assignment</literal> to
+              "dhcp".</para>
+
+              <figure>
+                <title>Editing the Management Interface to DHCP</title>
+
+                <mediaobject>
+                  <imageobject>
+                    <imagedata align="center" contentwidth="500"
+                               fileref="images/setting_ip_version_dhcp.png" />
+                  </imageobject>
+                </mediaobject>
+              </figure>
+            </listitem>
+          </orderedlist>
+
+          <para><emphasis role="bold">Changing the static IP of the Management
+          Interface</emphasis></para>
+
+          <orderedlist>
+            <listitem>
+              <para>To change an interface type from the uCPE Manager, select
+              the uCPE device, then from the top toolbar select
+              <literal>Configuration</literal> and then <literal>External
+              Interfaces -&gt; Configuration</literal>. The already configured
+              interfaces are displayed here.</para>
+            </listitem>
+
+            <listitem>
+              <para>From the interfaces' list, edit the interface which has
+              the "Management" flag set to "true", by double clicking on it,
+              triggering a popup window. Within the Host Interface window
+              change the "static" <literal>IP address</literal> as well as the
+              <literal>netmask</literal> and the
+              <literal>gateway</literal>.</para>
+
+              <figure>
+                <title>Changing the Static, Netmask and Gateway IPs</title>
+
+                <mediaobject>
+                  <imageobject>
+                    <imagedata align="center" contentwidth="500"
+                               fileref="images/changing_ips.png" />
+                  </imageobject>
+                </mediaobject>
+              </figure>
+
+              <note>
+                <para>The user can use the dropdown list to set the type of
+                the IP version: <literal>IPv4</literal> or
+                <literal>IPv6</literal> address.</para>
+              </note>
+            </listitem>
+          </orderedlist>
+
           <para>In order to make physical network interfaces available to the
           virtualization infrastructure and VNFs, they must be configured into
           the management system.</para>
@@ -963,28 +1146,29 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
           device, to be wiped out. Selecting <literal>Replace</literal> will
           set the entire device configuration to match values in the offline
           configuration.</para>
-                
-          <para>When a device connects to the uCPE Manager for the first time, it checks the 
-          device to see if it has been Zero Touch Provisioned (ZTP). If not, it looks for 
-          an offline configuration that matches these values, in the following order:</para>
-
-          <itemizedlist>
-            <listitem>
-              <para>The Device ID.</para>
-            </listitem>       
-            
-            <listitem>
-              <para>The set of tags.</para>
-            </listitem>
-            
-            <listitem>
-              <para>A "*" for Device ID (wildcard).</para>
-            </listitem>         
-          </itemizedlist>
-              
-          <para>If a match is found, the offline configuration is sent to the device as part 
-          of Zero-Touch-Provisioning.</para>
-          
+
+          <para>When a device connects to the uCPE Manager for the first time,
+          it checks the device to see if it has been Zero Touch Provisioned
+          (ZTP). If not, it looks for an offline configuration that matches
+          these values, in the following order:</para>
+
+          <itemizedlist>
+            <listitem>
+              <para>The Device ID.</para>
+            </listitem>
+
+            <listitem>
+              <para>The set of tags.</para>
+            </listitem>
+
+            <listitem>
+              <para>A "*" for Device ID (wildcard).</para>
+            </listitem>
+          </itemizedlist>
+
+          <para>If a match is found, the offline configuration is sent to the
+          device as part of Zero-Touch-Provisioning.</para>
+
           <para>After creating the Offline Config Store, access the device
           through <literal>Applications</literal> -&gt; <literal>offline
           config</literal> -&gt; <literal>Config App</literal> and provision
@@ -1744,11 +1928,11 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
             <literal>Path</literal>. When a user uses the uCPE Manager to
             create an instance for multiple VNFs, they will be prompted to
             provide a data file for each entry in this table. Each type of VNF
-            will require different cloud-init files, e.g.: a license
-            file. The data files will be added to the cloud-init image that the user 
-            provides at the instantiation of the VNF. If the cloud-init image is not 
-              provided, no Cloud-Init Data Source will be created for that VNF
-            and there will be no warning.</para>
+            will require different cloud-init files, e.g.: a license file. The
+            data files will be added to the cloud-init image that the user
+            provides at the instantiation of the VNF. If the cloud-init image
+            is not provided, no Cloud-Init Data Source will be created for
+            that VNF and there will be no warning.</para>
           </listitem>
         </orderedlist>
 
@@ -1913,4 +2097,4 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
       </orderedlist>
     </section>
   </section>
-</chapter>
+</chapter>
\ No newline at end of file
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/changing_ips.png b/doc/book-enea-nfv-access-getting-started/doc/images/changing_ips.png
new file mode 100755
index 0000000..504fe13
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/changing_ips.png
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter.png b/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter.png
new file mode 100755
index 0000000..fddde37
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter.png
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.png b/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.png
new file mode 100755
index 0000000..211984c
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.png
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/edit_mg_inter.png b/doc/book-enea-nfv-access-getting-started/doc/images/edit_mg_inter.png
new file mode 100755
index 0000000..70fd050
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/edit_mg_inter.png
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/setting_ip_version.png b/doc/book-enea-nfv-access-getting-started/doc/images/setting_ip_version.png
new file mode 100755
index 0000000..97eb19c
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/setting_ip_version.png
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/setting_ip_version_dhcp.png b/doc/book-enea-nfv-access-getting-started/doc/images/setting_ip_version_dhcp.png
new file mode 100755
index 0000000..ab4ad6f
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/setting_ip_version_dhcp.png
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/setting_static.png b/doc/book-enea-nfv-access-getting-started/doc/images/setting_static.png
new file mode 100755
index 0000000..97eb19c
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/setting_static.png