From 3fedb8c66614bfd4a99e5b3457839dbbd36fa4ac Mon Sep 17 00:00:00 2001
From: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
Date: Wed, 24 Feb 2021 15:03:43 +0200
Subject: Install guide: web-installer: requirements, logs

Add information about recent web-installer changes/improvements:
- web-installer has a new (first) page for requirement validation;
- web-installer has a new "Force" checkbox for ignoring requirements
  that are not met and/or errors reported during installation on that
  new (first) page;
- web-installer now displays full logs if errors are reported;

Change-Id: Ibcb1b9490ad430d81da3ac18aed0a2a67862afe8
Signed-off-by: Alexandru Avadanii <Alexandru.Avadanii@enea.com>
---
 .../doc/installation_guide.xml                     | 88 +++++++++++++++++++---
 1 file changed, 79 insertions(+), 9 deletions(-)

diff --git a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml
index 10fe8f6..0ce5d16 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml
@@ -782,15 +782,81 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
         </listitem>
 
         <listitem>
-          <para>On the first page of the Web-installer, the user must fill
-          in:</para>
+          <para>On the <emphasis role="bold">Requirements</emphasis> page of the
+          Web-installer, the user must confirm the current state of
+          installation prerequisites is inline with the desired state:</para>
+
+          <itemizedlist>
+            <listitem>
+              <para>Requirements table. Minimum values apply to the
+              installation process only. For runtime operations, additional
+              resources should be available depending on the specific
+              workload. Requirements are color coded (green when met, red when
+              mandatory and not met, orange when optional and not met). 
+              The Requirements table has the following fields:</para>
+
+              <itemizedlist spacing="compact">
+                <listitem>
+                  <para>Disk size (mandatory). 2GB or more are required for
+                  the installation.</para>
+                </listitem>
+
+                <listitem>
+                  <para>CPU cores (mandatory). 2 cores or more are required
+                  for the installation.</para>
+                </listitem>
+
+                <listitem>
+                  <para>RAM (mandatory). 2GB or more are required for the
+                  installation.</para>
+                </listitem>
+
+                <listitem>
+                  <para>VT-x (mandatory). Intel Virtualization Technology must
+                  be enabled.</para>
+                </listitem>
+
+                <listitem>
+                  <para>VT-d (optional, recommended). Intel Virtualization
+                  Technology for Directed I/O should be enabled.</para>
+                </listitem>
+
+                <listitem>
+                  <para>IOMMU Group separation (optional). If the hardware
+                  does not support IOMMU Group separation, there are certain
+                  limitations regarding how the
+                  <literal>vfio-pci</literal> driver can be used.
+                  For more details, see the <olink
+                  targetdoc="book_enea_nfv_access_release_info"
+                  targetptr="bugs-limitations">Known Issues and Limitations in
+                  this Release 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_release_info/1)"/></olink> 
+                  Manual.</para>
+                </listitem>
+              </itemizedlist>
+            </listitem>
+
+            <listitem>
+              <para>Force installation checkbox. When enabled, the installation
+              can be performed even if some of the mandatory requirements are
+              not met or if non-fatal problems are detected during the
+              process.</para>
+            </listitem>
+          </itemizedlist>
+        </listitem>
+
+        <listitem>
+          <para>On the Enea <emphasis role="bold">uCPE Manager settings</emphasis>
+          page of the Web-installer, the user must fill in:</para>
 
           <itemizedlist>
             <listitem>
               <para>The static Enea uCPE Manager IP Address. This can be
               either:</para>
 
-              <itemizedlist>
+              <itemizedlist spacing="compact">
                 <listitem>
                   <para>The IP address of the Enea uCPE Manager host machine,
                   if the device can directly access it.</para>
@@ -828,8 +894,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
         </listitem>
 
         <listitem>
-          <para>On the second page of the Web-installer, the user must do the
-          following:</para>
+          <para>On the <emphasis role="bold">Network Setup</emphasis> page of
+          the Web-installer, the user must do the following:</para>
 
           <itemizedlist>
             <listitem>
@@ -850,16 +916,20 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
       Web-installer, Enea NFV Access is installed on the hard drive. At this
       stage, the user should remove the USB stick and the LAN cable, and
       shutdown the uCPE device. It will be started after necessary
-      configurations are done on the Enea uCPE Manager, as described
+      configurations are done in the Enea uCPE Manager, as described
       below.</para>
 
       <note>
-        <para>If the USB stick was booted in UEFI mode, an UEFI boot entry is
+        <para>If errors are detected during installation, full logs will be
+        available on the last page of the Web-installer. Please contact Enea
+        for log analysis.</para>
+
+        <para>If the USB stick was booted in UEFI mode, a UEFI boot entry is
         automatically created and the system will start booting from the hard
         drive without further user configuration.</para>
       </note>
     </section>
-
+    
     <section id="prep_phys_exec">
       <title>Preparing Physical Deployment for Execution</title>
 
@@ -1109,4 +1179,4 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
       </note>
     </section>
   </section>
-</chapter>
\ No newline at end of file
+</chapter>
-- 
cgit v1.2.3-54-g00ecf