Write documentation for the Web-installer

Update book-enea-nfv-access-getting-started.pdf chapters
3.1.3 Installing Enea NFV Access
3.1.4 Booting NFV Access

Change-Id: I94ccfda84c2bf35adf5ea75e3ad8965bab0380d7
Signed-off-by: Andreas Wellving <andreas.wellving@enea.com>

1 files changed, 75 insertions, 147 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 29b6dbb..8c907fc 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
@@ -239,195 +239,123 @@ of=/dev/sdb bs=4M conv=fsync</programlisting></para>
 
     <section id="install_ena_stick">
       <title>Installing Enea NFV Access</title>
-
-      <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 Device Call Home Connection 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 uCPE device. Make sure
-          you are connected to the serial port.</para>
+          <para>To install and configure a device using the Web-installer,
+          the user must first connect a laptop directly into one of the LAN ports.
+          No other ports should be connected.</para>
         </listitem>
 
         <listitem>
-          <para>Power up the uCPE device and boot the USB stick. Verify the
+          <para>Power up the uCPE device and boot the USB stick. Verify that the
           USB stick is selected from the BIOS boot menu.</para>
         </listitem>
 
         <listitem>
-          <para>Once the USB stick is properly booted, a GRUB menu appears on
-          the serial console. The following options are available:</para>
+          <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).
+          A DHCP Server is started on the device to serve the connected LAN port, in order to give
+            the laptop an IP-address.</para>
+          
+          <para>From there, the user can configure the device with things such as:</para>
 
-          <itemizedlist spacing="compact">
+          <itemizedlist>
             <listitem>
-              <para><emphasis role="bold">live-boot</emphasis>. Boots the Run Time Platform directly
-              from the USB stick.</para>
+              <para><emphasis role="bold">The uCPE Manager IP Address</emphasis>.</para>
             </listitem>
 
             <listitem>
-              <para><emphasis role="bold">installer</emphasis>. Launches the Run Time Platform
-              installer and uses the serial port for output.</para>
+              <para><emphasis role="bold">The Device ID</emphasis>. The device must be previously 
+                added to the uCPE Manager with a unique ID. The Device ID must be the same as the one 
+                previously added in the uCPE Manager for he device.</para>
+
+              <note>
+                <para>To be able to connect, the same Device ID must first be added for the device
+                in uCPE Manager.</para>
+              </note>         
             </listitem>
-          </itemizedlist>
-
-          <note>
-            <para>The graphical console requires a display to be connected
-            to the uCPE device.</para>
-          </note>
-        </listitem>
 
-        <listitem>
-          <para>Select <command>Install NFV Access</command> from the menu to
-          proceed with the installation.</para>
-        </listitem>
-
-        <listitem>
-          <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 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 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
-              creates: a GPT partition for GRUB (similar to the one in the
-              2-partition scheme), two 20 GB partitions, and one containing
-              the remaining free disk space.</para>
-
-              <para>After choosing the Automatic install option and one of the
-              predefined partitioning actions, the <literal>install
-              steps</literal> detailing what will be installed and where are
-              updated by the installer.</para>
+              <para><emphasis role="bold">Customer Tags</emphasis>. They can be left empty.</para>
             </listitem>
 
             <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. Features like ZTP Provisioning etc.
-              can be enabled as well.</para>
-
-              <para>Kernel parameters can be customized by selecting the
-              <literal>Customize kernel parameters</literal> option and
-              altering any of the parameters below.</para>
-
-              <para><emphasis role="bold">Default
-              Parameters</emphasis>:</para>
-
-              <itemizedlist>
-                <listitem>
-                  <para>Core isolation. Isolates the selected range of cores
-                  from the kernel scheduler.</para>
-                </listitem>
-
-                <listitem>
-                  <para>1G huge page count. The number of 1GB huge pages to
-                  allocate at boot time.</para>
-                </listitem>
-
-                <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 algorithm 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 used to connect
-                    to the uCPE Manager during Device Call Home Connection.</para>
-                </listitem>
-
-                <listitem>
-                  <para>Device ID. A unique UUID format string used for device
-                  identification during Zero Touch Provisioning.</para>
-                </listitem>
-              </itemizedlist>
-
-              <note>
-                <para>Modifying any of the Default parameters (e.g Core
-                isolation, 1G huge page count, etc.) will automatically update
-                the kernel parameters string. Updating the Custom parameters
-                within the kernel string directly will override any values set
-                previously for the Default parameters.</para>
-              </note>
+              <para><emphasis role="bold">The Layer 3 configuration of WAN Interface(s)</emphasis>. 
+                Static or Dynamic IP must be specified.</para>
+              
+              <para>During network configuration, WAN cables will be plugged into the device
+              in order to identify the ports and make them available for configuration. Each 
+                connected port will automatically be set as a WAN port and must be configured 
+                (DHCP is the default setting).</para>
+
+              <note>
+                <para>A WAN cable must first be added to the device, otherwise the port used to 
+                  access the Web-installer from the laptop will not be shown and cannot be 
+                  configured as a WAN port.</para>
+              </note>      
             </listitem>
+
+            <listitem>
+              <para><emphasis role="bold">The Management Interface</emphasis>. The interface that 
+                will be used by the uCPE Manager to communicate with the device.</para>
+              
+              <para>The IP address of this interface will be listed for the device in the uCPE 
+                Manager. The WAN and management interfaces will be marked as such in the 
+                <literal>capabilities</literal> view and are restricted in use. The user can change 
+                the Layer 3 configuration of WAN interfaces and add new ones from the uCPE manager 
+                as needed.</para>
+            </listitem>
           </itemizedlist>
         </listitem>
 
         <listitem>
-          <para>Once all settings are in place, select <command>Start
-          install</command> to install NFV Access.</para>
-
-          <note>
-            <para>It is recommended to perform a dry run with the
-            <command>Start install (dry run)</command> option before
-            proceeding with actually modifying the drive.</para>
-          </note>
+          <para>The Web-installer stores the user provided configuration in a json metadata file located
+          in <filename>/boot/enea/install_data.json</filename>. There is also a command line tool that can
+          be used to access metadata entries: <literal>nfva-cfgtool</literal>.</para>
         </listitem>
 
         <listitem>
-          <para>At the end of the installation process, you can choose between
-          running the installer again or rebooting the uCPE device.</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 other than the serial port.</para>
-          </note>
+          <para>When the user has completed the configuration steps in the Web-installer, NFV Access
+          is installed on the hard drive. The largest drive found on the device will be used for
+          installation.</para>
         </listitem>
+        
       </orderedlist>
     </section>
 
     <section id="boot_ena">
       <title>Booting NFV Access</title>
 
-      <para>After installing Enea NFV Access on a media storage device (e.g.
-      eMMC, HDD or SSD), the uCPE device must be reset so that Enea NFV Access
-      can boot. The user must configure the first stage bootloader (e.g.
-      BIOS/UEFI) to boot the system from the media storage device where NFV
-      Access was installed.</para>
-
-      <para>If the uCPE Manager uses the Device Call Home Connection 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>When the installation has finished successfully, the user should remove the USB stick 
+        and ensure that BIOS is configured to boot from the hard drive.</para>
 
-      <para>Once set, GRUB will start automatically and a menu will appear to
-      let the user select one of the boot options:</para>
+      <para>When the NFV Access installation is booted from the hard drive, it will first check 
+        that the configuration metadata is complete. If any mandatory information is missing, the 
+        Web-installer will be launched on port 82 for post-installation configuration: <literal>
+        http://192.168.1.1:82</literal>. The WAN cable needs to be removed and the device rebooted,
+        enabling the device's DHCP server to give the laptop an IP address over the LAN connection.</para>
+      
+      <para>When all mandatory fields have been filled in, the new configuration is saved, stored 
+        and the device will be rebooted.</para>
 
-      <itemizedlist>
-        <listitem>
-          <para><literal>Enea NFV Access 2.2.1 (ostree:0)</literal>: The
-          recommended configuration boot commands.</para>
-        </listitem>
+      <note>
+        <para>If NFV Access was installed by some other means, such as a PXE mass installation or by
+        simply writing an image to a partition, no <filename>/boot/enea/install_data.json</filename>
+        metadata file will exist and the Web-installer will launch at start-up expecting the
+        user to provide the post-installation configuration.</para>
+      </note>
+      
+      <para>Once the configuration is complete, the system proceeds to launch the ODM/vCPE which will
+      configure the interfaces accordingly and try to register the device in the uCPE manager. If
+      connectivity is established with the uCPE manager server and a device with a matching Device ID is
+      found, the configuration is marked as successful, and the connection is established. In case of
+      failure, the Web-installer will be launched for reconfiguration.
+      </para>
 
-        <listitem>
-          <para><literal>Advanced</literal>: The Advanced option is a submenu
-          which can be used for other booting options. The default value is
-          minimal boot.</para>
-        </listitem>
-      </itemizedlist>
     </section>
 
     <section condition="hidden" id="examples">