Merge "GettingStarted: update Getting Started NFV Access" into rocko

3 files changed, 65 insertions, 77 deletions

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 6d9e8c4..7b29ef9 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
@@ -7,9 +7,17 @@
   <section id="access_installer">
     <title>Enea NFV Access Run Time Platform Installer</title>
 
-    <para>The current release supports one primary method of installation,
-    using the installer, which guarantees a clean installation of NFV Access
-    on a uCPE device.</para>
+    <para>The current release supports two methods of installation:</para>
+    
+    <itemizedlist>
+      <listitem><para>Manual installation using the Enea Installer, which 
+        guarantees a clean installation of NFV Access on a uCPE device.</para></listitem>
+      <listitem><para>Mass installation and automated deployment using
+        Bare Metal Provisioning.</para></listitem>
+    </itemizedlist>
+      
+      <para>For more information about Bare Metal Provisioning please refer 
+        to <xref linkend="bare_meta_prov">5.3, Bare Metal Provisioning"</xref>.</para>
 
     <section id="prereq">
       <title>Prerequisites</title>
@@ -22,7 +30,7 @@
 
       <itemizedlist spacing="compact">
         <listitem>
-          <para>EFI and virtualization support</para>
+          <para>EFI and virtualization support.</para>
         </listitem>
 
         <listitem>
@@ -34,15 +42,11 @@
         </listitem>
 
         <listitem>
-          <para>Stoarge Device (SSD recommended)</para>
-        </listitem>
-
-        <listitem>
-          <para>2 physical interfaces</para>
+          <para>Storage Device (SSD recommended).</para>
         </listitem>
       </itemizedlist>
 
-      <para>Following BIOS settings to be enabled:</para>
+      <para>BIOS settings that need to be enabled:</para>
 
       <itemizedlist spacing="compact">
         <listitem>
@@ -50,7 +54,7 @@
         </listitem>
 
         <listitem>
-          <para>Intel Virtualization Technology (VT-x )</para>
+          <para>Intel Virtualization Technology (VT-x)</para>
         </listitem>
 
         <listitem>
@@ -198,9 +202,9 @@ rootfs_destination=</programlisting></para>
     <section id="auto_installer">
       <title>Creating a bootable USB stick</title>
 
-      <para>In order to install Enea NFV Access Run Time Platform, you must
+      <para>In order to install the Enea NFV Access Run Time Platform, you must
       first create a bootable USB stick with the image you intend to
-      install.</para>
+      install. Follow the example below to proceed.</para>
 
       <para><emphasis role="bold">Create a bootable USB stick
       image</emphasis></para>
@@ -208,38 +212,46 @@ rootfs_destination=</programlisting></para>
       <orderedlist>
         <listitem>
           <para>Copy the HDDIMG image file provided by Enea, onto a
-          development machine (Linux or Windows with Cygwin support).</para>
+          development machine.</para>
         </listitem>
 
         <listitem>
           <para>Connect the USB stick to the development machine and identify
           the device name given by the system with
-          <command>lsblk</command>:<programlisting>NAME         MAJ:MIN          RM    SIZE    RO TYPE MOUNTPOINT
+          <command>lsblk</command>:
+            <programlisting>NAME         MAJ:MIN          RM    SIZE    RO TYPE MOUNTPOINT
 sda            8:0            1     28.7G   0  disk
 sdb            8:0            0     111.8G  0  disk
 |-sdb1         8:1            0     111.8G  0  part</programlisting></para>
         </listitem>
 
         <listitem>
-          <para>Copy the HDDIMG image to the USB stick, e.g:<programlisting>sudo dd if=./enea-nfv-access-&lt;machine&gt;.hddimg \
+          <para>Copy the HDDIMG image onto the USB stick, e.g:
+            <programlisting>sudo dd if=./enea-nfv-access-&lt;machine&gt;.hddimg \
 of=/dev/sdb bs=4M conv=fsync</programlisting></para>
         </listitem>
       </orderedlist>
 
       <para>Where <filename>enea-nfv-access-&lt;machine&gt;.hddimg
-      </filename>is the .hddimg file and <literal>sdb</literal> is the
+      </filename>is the <literal>.hddimg</literal> file and <literal>sdb</literal> is the
       assigned USB device name.</para>
     </section>
 
     <section id="install_ena_stick">
       <title>Installing Enea NFV Access</title>
 
-      <para><emphasis role="bold">How to install Enea NFV Access Run Time
+      <para>Installing the Run Time Platform can be done in two ways: 
+        Automatic and Manual, depending on the features you wish to enable. 
+        Please note that in order to enable features such as Zero Touch 
+        Provisioning or Automatic Addition of uCPE devices in the Enea uCPE 
+        Manager, Manual installation must be used.</para>
+      
+      <para><emphasis role="bold">How to install the Enea NFV Access Run Time
       Platform using a bootable USB stick image</emphasis></para>
 
       <orderedlist>
         <listitem>
-          <para>Plug the USB stick into the reference uCPE device. Make sure
+          <para>Plug the USB stick into the uCPE device. Make sure
           you are connected to the serial port.</para>
         </listitem>
 
@@ -254,18 +266,18 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para>
 
           <itemizedlist spacing="compact">
             <listitem>
-              <para>live-boot. Boots NFV Access Run Time Platform directly
+              <para><emphasis role="bold">live-boot</emphasis>. Boots the Run Time Platform directly
               from the USB stick.</para>
             </listitem>
 
             <listitem>
-              <para>installer. Launches the NFV Access Run Time Platform
+              <para><emphasis role="bold">installer</emphasis>. Launches the Run Time Platform
               installer and uses the serial port for output.</para>
             </listitem>
           </itemizedlist>
 
           <note>
-            <para>The graphical console requires that a display is connected
+            <para>The graphical console requires a display to be connected
             to the uCPE device.</para>
           </note>
         </listitem>
@@ -276,16 +288,15 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para>
         </listitem>
 
         <listitem>
-          <para>Once the installation has commenced two options are
-          displayed:</para>
+          <para>Once the installation has commenced two options are displayed:</para>
 
           <itemizedlist>
             <listitem>
               <para><emphasis role="bold">Automatic install</emphasis>. This
-              option will partition a user-defined drive and install NFV
+              option will partition a user-defined drive and install the Enea NFV
               Access Run Time Platform. You can create 2 or 4 partitions, and
               choosing either of these two options will prompt you for a drive
-              on which to install NFV Access Run Time Platform. The
+              on which to install the Run Time Platform. The
               2-partition scheme divides the disk into one GPT partition
               containing the GRUB binary and configuration, leaving the rest
               of the disk for the root filesystem. The 4-partition scheme
@@ -302,13 +313,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para>
             <listitem>
               <para><emphasis role="bold">Manual install</emphasis>. Gives the
               user the possibility of choosing where GRUB and NFV Access will
-              be installed and what parameters can be set.</para>
-
-              <note>
-                <para>This option is <emphasis role="bold">only</emphasis>
-                recommended for advanced use and should otherwise not be
-                used.</para>
-              </note>
+              be installed and what parameters can be set. Features like ZT Provisioning etc.
+              can be enabled as well.</para>
 
               <para>Kernel parameters can be customized by selecting the
               <literal>Customize kernel parameters</literal> option and
@@ -331,15 +337,29 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para>
                 <listitem>
                   <para>2M huge page count. The number of 2M huge pages to
                   allocate at boot time.</para>
+
+                  <note>
+                    <para>In case the number of hugepages is not specified during
+                    this step, hugepages will be allocated by the NFV Access
+                    Hugepage Reservation Service, based on an algoritm which
+                    takes into consideration the size of RAM memory. For further
+                    information, please see section 
+                      <olink targetdoc="book_enea_nfv_access_getting_started"
+  targetptr="hugepage_reservation">Hugepage Reservation Service in the
+  <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
+  xmlns:xi="http://www.w3.org/2001/XInclude"
+  xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> Manual.</para>
+                  </note>
                 </listitem>
 
                 <listitem>
-                  <para>uCPE Manager IP address. The IP address needed for
-                  contacting the machine running the uCPE Manager.</para>
+                  <para>uCPE Manager IP address. The IP address used to connect
+                    to the uCPE Manager during Automatic Addition.</para>
                 </listitem>
 
                 <listitem>
-                  <para>Device ID. A unique UUID format string.</para>
+                  <para>Device ID. A unique UUID format string used for device
+                  identification during Zero Touch Provisioning.</para>
                 </listitem>
               </itemizedlist>
 
@@ -372,7 +392,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para>
           <note>
             <para>The boot log will always be displayed on the serial port.
             Modify the console parameter if you want the boot log to be shown
-            on something else than the serial port.</para>
+            on something else other than the serial port.</para>
           </note>
         </listitem>
       </orderedlist>
@@ -387,22 +407,18 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para>
       BIOS/UEFI) to boot the system from the media storage device where NFV
       Access was installed.</para>
 
+      <para>If the uCPE Manager uses the Automatic Addition method for enrolling
+      the uCPE devices, the uCPE Manager IP address has to be configured in NFV
+      Access, by setting <literal>vcpemgr=&lt;IP&gt;</literal> as a kernel
+      boot parameter in the GRUB configuration file. This step is not required
+      if configuration has been made during Manual Installation.</para>
+
       <para>Once set, GRUB will start automatically and a menu will appear to
       let the user select one of the boot options:</para>
 
-      <figure>
-        <title>Booting NFV Access</title>
-
-        <mediaobject>
-          <imageobject>
-            <imagedata align="center" fileref="images/boot_ena.png" scale="75" />
-          </imageobject>
-        </mediaobject>
-      </figure>
-
       <itemizedlist>
         <listitem>
-          <para><literal>Enea NFV Access 2.2 (rocko) (ostre:0)</literal>: The
+          <para><literal>Enea NFV Access 2.2.1 (ostree:0)</literal>: The
           recommended configuration boot commands.</para>
         </listitem>
 
@@ -449,34 +465,6 @@ run</programlisting>
         </listitem>
       </itemizedlist>
     </section>
-
-    <section id="troubleshooting">
-      <title>Troubleshooting</title>
-
-      <para>Use-case: When booting from UEFI, GRUB from the installer storage
-      on the USB stick previously set up, is always selected by
-      default.</para>
-
-      <para>Workaround: If both a USB stick with the Enea NFV Access installer
-      set up (e.g FS0) and an another media storage device (e.g. FS1), are
-      connected to a uCPE device, in order to select the former, the count
-      down must be stopped with the default <literal>startup.nsh</literal>
-      script by pressing <command>ESC</command> and then starting GRUB
-      manually:</para>
-
-      <figure>
-        <mediaobject>
-          <imageobject>
-            <imagedata align="center" fileref="images/efi_menu.png" scale="60" />
-          </imageobject>
-        </mediaobject>
-      </figure>
-
-      <para>The default setting will try to boot GRUB from the FS0 device, in
-      this case a USB stick. To boot from the newly installed media storage
-      device instead (e.g FS1), run following command in the EFI
-      shell:<programlisting>Shell&gt; FS1:EFI\boot\bootx64.efi</programlisting></para>
-    </section>
   </section>
 
   <section condition="hidden" id="release-content">
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 5d980fc..9d5eecc 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
@@ -10,7 +10,7 @@
 
     <itemizedlist>
       <listitem>
-        <para>A device that supports NFV Access.</para>
+        <para>A uCPE device with Enea NFV Access Run Time Platform installed.</para>
       </listitem>
 
       <listitem>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.png b/doc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.png
index 42188a5..8fdea95 100755
--- a/doc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.png
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/host_interface_caps.png