LXCR-11018 - Improve PXE installfeature_CPDX-3552

- Providing parameters to generate a json configuration:
      - Edge Management IP/FQDN
      - device id autogenerated from hardware identifier script
      - Management interface = the PXE boot interface (configured as DHCP)

- Storing files on the device file system, for example to preprovision
VNF images

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

1 files changed, 34 insertions, 11 deletions

diff --git a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml
index 5f20c7f..889ab98 100644
--- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml
+++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml
@@ -47,9 +47,10 @@
 
         <listitem>
           <para>An HTTP server must be available and accessible from the uCPE
-          devices in the provisioning network. Note that the installer will
-          use the same interface that the uCPE device is PXE-booted from, to
-          obtain an IP address using DHCP and access the HTTP server.</para>
+          devices in the provisioning network if HTTP download is prefered.
+          Note that the installer will use the same interface that the uCPE
+          device is PXE-booted from, to obtain an IP address using DHCP and
+          access the HTTP server.</para>
         </listitem>
 
         <listitem>
@@ -92,7 +93,7 @@
           <para>Compress the Enea Edge Runtime <literal>.hddimg</literal>
           image for the uCPE device architecture using <literal>gzip</literal>
           and copy the resulting <literal>hddimg.gz</literal> file to the HTTP
-          server.</para>
+          server or to the TFTP directory on the PXE server.</para>
         </listitem>
       </orderedlist>
 
@@ -100,9 +101,9 @@
         <title>Installation Configuration File</title>
 
         <para>An installation configuration file needs to be prepared on the
-        HTTP server. The format of the configuration file is a list of
-        "<literal>name = value</literal>" pairs and the available parameters
-        are described below:</para>
+        HTTP server or on the TFTP directory on the PXE server. The format of
+        the configuration file is a list of "<literal>name = value</literal>"
+        pairs and the available parameters are described below:</para>
 
         <itemizedlist>
           <listitem>
@@ -123,13 +124,34 @@
             formatting and partitioning the drive. The default behavior is to
             proceed automatically without any user interaction.</para>
           </listitem>
+
+          <listitem>
+            <para><literal>staging_archive</literal> (optional). A tar.gz file
+            including files to be pre-staged on the device.</para>
+          </listitem>
+
+          <listitem>
+            <para><literal>edge_management_address</literal> (optional). Edge
+            Management IP/FQDN.</para>
+          </listitem>
+
+          <listitem>
+            <para><literal>deviceid_script</literal> (optional). Shell script that
+            the installer will run returning the DeviceId matching Edge Managment
+            settings. E.g. the script would return a HW identifier.</para>
+          </listitem>
         </itemizedlist>
 
-        <para>Installation Configuration File Example:</para>
+        <para>Installation Configuration File Examples:</para>
 
         <programlisting>image_url = http://192.168.1.100/enea-edge-runtime-xeon-d.hddimg.gz
 install_drive = /dev/sda</programlisting>
 
+        <programlisting>image_url = tftp://&lt;Server IP&gt;/enea_edge/enea-edge-runtime-xeon-d.hddimg.gz
+staging_archive = tftp://&lt;Server IP&gt;/enea_edge/conf_files.tar.gz
+edge_management_address = manager1.enea.com
+deviceid_script = tftp://&lt;Server IP&gt;/enea_edge/deviceId</programlisting>
+
         <note>
           <para>The installation configuration file needs to use the Linux
           end-of-line format (\n), not the Windows format (\r\n).</para>
@@ -142,14 +164,15 @@ install_drive = /dev/sda</programlisting>
         <para>A PXE entry for the Enea Edge installation needs to be added as
         the default boot selection in the pxelinux configuration file (e.g
         <literal>/var/lib/tftpboot/pxelinux.cfg/default</literal>). The PXE
-        entry should have the following settings:</para>
+        entry should have the following settings, where &lt;protocol&gt; could
+        be either of http or tftp:</para>
 
         <programlisting>default enea_edge_runtime
 label enea_edge_runtime
 menu label ^ENEA_EDGE_INSTALLER
 kernel &lt;Path to kernel&gt;
 append root=/dev/ram0 initrd=&lt;Path to initramfs&gt; LABEL=pxe-installer \
-   INSTALL_CFG=http://&lt;Server IP&gt;/&lt;Path to install config file&gt; \
+   INSTALL_CFG=&lt;protocol&gt;://&lt;Server IP&gt;/&lt;Path to install config file&gt; \
    console=ttyS0,115200 earlyprintk=ttyS0,115200
 ipappend 2</programlisting>
       </section>
@@ -1455,4 +1478,4 @@ Configuration complete.</programlisting>
       </orderedlist>
     </section>
   </section>
-</chapter>
\ No newline at end of file
+</chapter>