Merge "doc: getting-started - updates" into rocko

3 files changed, 56 insertions, 98 deletions

diff --git a/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml b/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
index 160190f..afcdec6 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
@@ -346,33 +346,11 @@ node0.1048576kB = 3 </programlisting>
           </listitem>
         </itemizedlist>
 
-        <para>Optional parameters for sending status notifications to a
-        server. All three must be provided if used:</para>
-
-        <itemizedlist>
-          <listitem>
-            <para><literal>notify_user</literal>. Server SSH username.</para>
-          </listitem>
-
-          <listitem>
-            <para><literal>notify_pass</literal>. Server SSH password.</para>
-          </listitem>
-
-          <listitem>
-            <para><literal>notify_path</literal>. Location where notification
-            files will be placed, specified in <literal>Server
-            IP:directory</literal> format.</para>
-          </listitem>
-        </itemizedlist>
-
         <para>Installation Configuration File Example:</para>
 
         <programlisting>
  image_url = http://192.168.1.100/enea-nfv-access-xeon-d.hddimg.gz
  install_drive = /dev/sda
- notify_user = username
- notify_pass = password
- notify_path = 192.168.1.100:/home/user/status_notifications
 
 </programlisting>
       </section>
@@ -415,27 +393,6 @@ node0.1048576kB = 3 </programlisting>
       <para>The uCPE devices should be configured in BIOS to boot from the
       installation drive first in order to automatically start the Enea NFV
       Access Run Time Platform when the installation is finished.</para>
-
-      <section>
-        <title>Server Notifications</title>
-
-        <para>Optionally, the uCPE devices can send a notification file to a
-        server once the installation is complete and Enea NFV Access Run Time
-        Platform has successfully booted. Notifications are enabled by
-        providing the <literal>notify_*</literal> parameters in the
-        installation configuration file.</para>
-
-        <para>Each uCPE device will push a file to the server location
-        specified in the installation configuration file. The file name will
-        be the MAC address of the PXE boot network interface in order to
-        uniquely identify the device.</para>
-
-        <note>
-          <para>Note that the status notification will only be sent on the
-          first boot after installation is done, subsequent reboots of the
-          uCPE device will not cause any new notifications to be sent.</para>
-        </note>
-      </section>
     </section>
   </section>
 </chapter>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml
index 796c386..bb488a1 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml
@@ -256,7 +256,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para>
 
         <listitem>
           <para>Once the USB stick is properly booted, the Web-installer application starts
-            automatically and can be accessed in a web browser at <literal>http://192.168.1.1</literal> (port 80).
+            automatically and can be accessed in a web browser at <literal>http://172.16.1.1</literal> (port 80).
           </para>
           
           <para>On the first page of the Web-installer, the user should fill in:</para>
@@ -332,12 +332,12 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para>
       <note>
         <para>If NFV Access was installed by Bare Metal Provisioning, the Web-installer will launch at
         start-up expecting the user to provide the post-installation configuration. The Web-installer will
-        be launched on port 82 for post-installation configuration: <literal>
-        http://192.168.1.1:82</literal>.</para>
+        be launched on port 80 for post-installation configuration: <literal>
+        http://172.168.1.1</literal>.</para>
       </note>
 
       <para>In case of failure, the user should remove all WAN cables, re-attach the laptop, reboot 
-        the device and then access the Web-installer on <literal>http://192.168.1.1:82</literal>.
+        the device and then access the Web-installer on <literal>http://172.16.1.1</literal>.
       </para>
       
       <note>      
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 733f61e..1940eb1 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
@@ -546,7 +546,7 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
 
         <itemizedlist>
           <listitem>
-            <para>IP Address. IP address of the ucPE device.</para>
+            <para>IP Address. IP address of the uCPE device.</para>
           </listitem>
         </itemizedlist>
 
@@ -580,10 +580,7 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
 
         <itemizedlist>
           <listitem>
-            <para>Device ID. The unique identifier of the uCPE device. This
-            links a device to its Day-0 configuration (stored in the offline
-            configuration system). It is a required field if you want to
-            perform Zero-Touch Provisioning.</para>
+            <para>Device ID. The unique identifier of the uCPE device.</para>
           </listitem>
         </itemizedlist>
       </section>
@@ -593,12 +590,12 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
 
         <para>Follow the same steps as described in the previous section,
         making sure that the <literal>Device Calls Home</literal> checkbox is
-        selected this time.</para>
+        selected this time. The <literal>IP Address</literal> of the uCPE device
+        is not required.</para>
 
         <para>When using this mechanism, the device will initiate a connection
         to the uCPE Manager for NETCONF traffic (over SSH), while the uCPE
-        Manager waits for a device connection. Make sure the uCPE Manager IP
-        address has been configured on the device. For more information please
+        Manager waits for a device connection. For more information please
         see section <link linkend="install_ena_stick">Installing Enea NFV
         Access</link> for more details.</para>
       </section>
@@ -612,22 +609,6 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
       networking infrastructure can be configured either manually or by using
       Zero Touch Provisioning.</para>
 
-      <para>The uCPE Manager can list network interfaces found on a device by
-      selecting the uCPE device first and then selecting
-      <literal>Configuration</literal> -&gt; <literal>OpenVSwitch
-      </literal>-&gt; <literal>Host Interface Caps</literal>:</para>
-
-      <figure>
-        <title>Host Interface Caps</title>
-
-        <mediaobject>
-          <imageobject>
-            <imagedata align="center" contentwidth="600"
-                       fileref="images/host_interface_caps.png" />
-          </imageobject>
-        </mediaobject>
-      </figure>
-
       <para>Available network interfaces can be added to the management
       system, for use by the networking virtualization infrastructure.</para>
 
@@ -636,17 +617,15 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
 
         <para>For Manual Configuration of uCPE networking, select the uCPE
         device first and then <literal>Configuration</literal> -&gt;
-        <literal>OpenVSwitch</literal>. In <literal>Host Interfaces
-        Caps</literal>, one can find a list of available network interfaces
-        and their capabilities.</para>
+        <literal>External Interfaces</literal>, where one can find a list of
+        available network interfaces and their capabilities.</para>
 
         <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>
+          Standard, wan).</para>
 
           <para><emphasis role="bold">How to Edit the Configuration of an
           Interface</emphasis></para>
@@ -860,13 +839,6 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
             </listitem>
           </itemizedlist>
 
-          <para>Create an OpenVSwitch bridge (<literal>ovsbr0</literal>) on
-          the device that uses a DPDK interface type, by selecting the uCPE
-          device, then from the top toolbar selecting
-          <literal>Configuration</literal> -&gt;
-          <literal>OpenVSwitch</literal> -&gt; <literal>Bridges</literal>
-          -&gt; <literal>Add</literal>.</para>
-
           <para><emphasis role="bold">SR-IOV Interface Type</emphasis></para>
 
           <para>SR-IOV technology allows for the creation of a number of
@@ -1141,13 +1113,34 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
 
           <para>To create an offline configuration, from the top toolbar menu
           select <literal>Applications</literal> -&gt; <literal>Offline
-          Config</literal> -&gt; <literal>Add</literal>. Specify the value of
-          the <literal>Device ID</literal> in the required field or wildcard
-          if appropriate. Choose <literal>Merge</literal> as the "Default
-          Upload Method" if you do not want any boot configuration set on the
-          device, to be wiped out. Selecting <literal>Replace</literal> will
-          set the entire device configuration to match values in the offline
-          configuration.</para>
+          Config</literal> -&gt; <literal>Add</literal>. The following fields
+          are available:</para>
+
+          <itemizedlist>
+            <listitem>
+              <para>Name: name of the device.</para>
+            </listitem>
+
+            <listitem>
+              <para>Device type: Enea universal CPE.</para>
+            </listitem>
+
+            <listitem>
+              <para>Device version: 2.2.2</para>
+            </listitem>
+
+            <listitem>
+              <para>Config Set: uCPE Config</para>
+            </listitem>
+
+            <listitem>
+              <para>Device ID: device ID or a wildcard(*).</para>
+            </listitem>
+
+            <listitem>
+              <para>Device Grouping Tags: a tag to group devices.</para>
+            </listitem>
+          </itemizedlist>
 
           <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
@@ -1420,9 +1413,9 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
 
           <listitem>
             <para>Click on <literal>Choose File</literal> to provide the path
-            to the image file. Select the target hardware platform
-            corresponding to the image being uploaded (xeon-d or
-            atomc-3000).</para>
+              to the image file (must be of type <literal>rootfs.ostree.tar.bz2</literal>).
+            Select the target hardware platform corresponding to the image
+            being uploaded (xeon-d or atomc-3000).</para>
           </listitem>
 
           <listitem>
@@ -1488,8 +1481,7 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
                 minute for when to run the upgrade.</para>
 
                 <note>
-                  <para>The time zone is set to Eastern Standard Time
-                  (EST). The hour represents the local uCPE Manager server hour.</para>
+                  <para>The hour represents the local uCPE Manager server hour.</para>
                 </note>
               </listitem>
 
@@ -1895,6 +1887,11 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
         name, and optionally a description, used only by the uCPE
         Manager.</para>
 
+        <note>
+           <para>CAUTION: The user MUST conserve the same order for the 
+             virtual interfaces during both onboarding and instantiation phases.</para>
+        </note>
+
         <para><emphasis role="bold">Cloud Init Tab</emphasis></para>
 
         <para>Click the <literal>Clout Init</literal> tab to provide the
@@ -2045,7 +2042,11 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
             </listitem>
 
             <listitem>
-              <para>Device: the uCPE device to instantiate the VNF on.</para>
+              <para>VNF Type: a list of onboarded VNFs.</para>
+            </listitem>
+
+            <listitem>
+              <para>uCPE Device: the uCPE device to instantiate the VNF on.</para>
             </listitem>
 
             <listitem>
@@ -2101,8 +2102,8 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
       <orderedlist>
         <listitem>
           <para>SSH to the uCPE device from the Enea uCPE Manager
-          (<literal>Device-&gt;SSH</literal>) with default user and password:
-          <literal>root</literal>.</para>
+          (<literal>Device-&gt;SSH</literal>) using user:
+          <literal>root</literal> and no password.</para>
         </listitem>
 
         <listitem>