1 files changed, 355 insertions, 63 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 c596735..5f20c7f 100644
--- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml
+++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml
@@ -120,14 +120,14 @@
           <listitem>
             <para><literal>prompt_user</literal> (optional). If the parameter
             is set to "yes", the installer will ask for confirmation before
-            formatting and partitioning the drive. The default behaviour is to
+            formatting and partitioning the drive. The default behavior is to
             proceed automatically without any user interaction.</para>
           </listitem>
         </itemizedlist>
 
         <para>Installation Configuration File Example:</para>
 
-        <programlisting>image_url = http://192.168.1.100/enea-nfv-access-xeon-d.hddimg.gz
+        <programlisting>image_url = http://192.168.1.100/enea-edge-runtime-xeon-d.hddimg.gz
 install_drive = /dev/sda</programlisting>
 
         <note>
@@ -144,9 +144,9 @@ install_drive = /dev/sda</programlisting>
         <literal>/var/lib/tftpboot/pxelinux.cfg/default</literal>). The PXE
         entry should have the following settings:</para>
 
-        <programlisting>default nfv_access
-label nfv_access
-menu label ^NFV_ACCESS_INSTALLER
+        <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; \
@@ -300,7 +300,7 @@ ipmitool -U &lt;user&gt; -P &lt;password&gt; -H &lt;uCPE device IPMI IP address&
       <title>Customizing Automatic Hugepage Reservation</title>
 
       <para>Configuration of Hugepage reservation is done in
-      <literal>/etc/enea-nfv-access/hugepages.cfg</literal>.</para>
+      <literal>/etc/enea/hugepages.cfg</literal>.</para>
 
       <para><emphasis role="bold">Parameters used by the automatic algorithm:
       </emphasis></para>
@@ -414,61 +414,351 @@ node0.1048576kB = 3 </programlisting>
   <section id="create_certificate">
     <title>Tomcat Certificate Generation</title>
 
-    <para>The self-signed Tomcat Certificate the Enea Edge
-    Management application uses is generated at installation time. It can
-    be regenerated anytime after installation by using the
+    <para>The self-signed Tomcat Certificate the Enea Edge Management
+    application uses is generated at installation time. It can be regenerated
+    anytime after installation by using the
     <filename>createCertificate.sh</filename> script.</para>
 
     <para>On the CentOS 7 server open a terminal, log into a bash shell with
     the root account and perform the following:</para>
 
     <orderedlist>
+      <listitem>
+        <para>Extract
+        <literal>Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</literal></para>
+
+        <para>The directory in which the archive has been unpacked will be
+        denoted as: <literal>&lt;EEMg-installerdir&gt;</literal>.</para>
+      </listitem>
+
+      <listitem>
+        <para>Enter <literal>&lt;EEMg-installerdir&gt;/dist</literal>.</para>
+      </listitem>
+
+      <listitem>
+        <para>Run the following command and change <literal>/opt/ems</literal>
+        to the location where the Enea Edge Management application is
+        installed:</para>
+
+        <programlisting>./createCertificate.sh EneaEdgeManagement &lt;IP_or_domain&gt; \
+            /opt/ems [&lt;service_username&gt;]</programlisting>
+
+        <para>Where the following need to be included:</para>
+
+        <itemizedlist>
+          <listitem>
+            <para>The IP or domain name of the server the Enea Edge Management
+            application is running on.</para>
+          </listitem>
+
+          <listitem>
+            <para>The service username, which is the one set when installing
+            the Enea Edge Management application. For more details see <olink
+            targetdoc="book_enea_edge_getting_started"
+            targetptr="fresh_ucpemg_install">Fresh Installation of the Enea
+            Edge Management application in the <ns:include
+            href="../../s_docbuild/olinkdb/pardoc-names.xml"
+            xmlns:ns="http://www.w3.org/2001/XInclude"
+            xpointer="element(book_enea_edge_getting_started/1)" /></olink>
+            Manual. Providing the service username is optional. If it is not
+            provided, the default value will be used.</para>
+          </listitem>
+        </itemizedlist>
+      </listitem>
+
+      <listitem>
+        <para>Restart the Enea Edge Management service:</para>
+
+        <programlisting>service ucpemanager restart</programlisting>
+      </listitem>
+    </orderedlist>
+  </section>
+
+  <section id="nfvi_backup">
+    <title>NFV Infrastructure Backup Operations</title>
+
+    <para>In the following sections are described the operations that can be
+    performed in order to backup and restore the NFV Infrastructure (NFVi)
+    configuration. This allows for recovery from unintended configuration
+    errors.</para>
+
+    <section id="nfvi_snapshot">
+      <title>NFVi Snapshotting</title>
+
+      <para>To perform a snapshot (a backup of the current state) of the NFVi,
+      perform the following steps in the Enea Edge Management
+      application:</para>
+
+      <orderedlist>
         <listitem>
-          <para>Extract <literal>Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</literal></para>
+          <para>Select the uCPE device, access the <emphasis
+          role="bold">Configuration</emphasis> menu, and select <emphasis
+          role="bold">NFVI Backup</emphasis>. The <emphasis role="bold">NFVI
+          Config Archive Table</emphasis> will be shown.</para>
+        </listitem>
 
-          <para>The directory in which the archive has been unpacked will be
-          denoted as: <literal>&lt;uCPEM-installerdir&gt;</literal>.</para>
+        <listitem>
+          <para>Press the <emphasis role="bold">Create</emphasis>
+          button.</para>
         </listitem>
 
         <listitem>
-          <para>Enter <literal>&lt;uCPEM-installerdir&gt;/dist</literal>.</para>
+          <para>Edit the default file name, if needed, and press the <emphasis
+          role="bold">Create</emphasis> button. The current window will close
+          and the success message <emphasis role="bold">Created
+          successfully</emphasis> will be shown.</para>
         </listitem>
+      </orderedlist>
+
+      <para>A new entry will be added in the <emphasis role="bold">NFVI Config
+      Archive Table</emphasis> and the <emphasis
+      role="bold">BackupArchiveCreated</emphasis> event can be seen by
+      accessing the <emphasis role="bold">Fault</emphasis> menu and triggering
+      the <emphasis role="bold">Events</emphasis> window. The backup file will
+      be created on the uCPE device.</para>
+    </section>
+
+    <section id="restore_nfvi_backup">
+      <title>Restoring an NFVi backup</title>
+
+      <para>When needed, an NFVi backup can be restored in the following
+      way:</para>
 
+      <orderedlist>
         <listitem>
-          <para>Run the following command:</para>
+          <para>Select the uCPE device, access the <emphasis
+          role="bold">Configuration</emphasis> menu and select <emphasis
+          role="bold">NFVI Backup</emphasis>. The <emphasis role="bold">NFVI
+          Config Archive Table</emphasis> will be shown.</para>
+        </listitem>
 
-          <programlisting>./createCertificate.sh ucpemanager &lt;IP_or_domain&gt; \
-            /opt/ems [&lt;service_username&gt;]</programlisting>
+        <listitem>
+          <para>Select an existing backup from the NFVI Config Archive
+          Table.</para>
+        </listitem>
 
-          <para>Where the following need to be included:</para>
+        <listitem>
+          <para>Press the <emphasis role="bold">Restore</emphasis> button and
+          <emphasis role="bold">Confirm</emphasis> the action.</para>
+        </listitem>
+      </orderedlist>
 
-          <itemizedlist>
-            <listitem>
-              <para>The IP or domain name of the server the Enea Edge
-              Management application is running on.</para>
-            </listitem>
+      <para>A success message will be shown in the same window: <emphasis
+      role="bold">Restored NFVI configuration</emphasis>. Two events will
+      appear in the <emphasis role="bold">Events</emphasis> window (accessible
+      through the <emphasis role="bold">Fault</emphasis> menu): <emphasis
+      role="bold">Restore started</emphasis> and <emphasis role="bold">Restore
+      complete</emphasis>.</para>
 
-            <listitem>
-              <para>The service username, which is the one set when installing the
-              Enea Edge Management application. For more details
-                see <olink targetdoc="book_enea_edge_getting_started"
-              targetptr="fresh_ucpemg_install">Fresh Installation of the Enea
-              Edge Management application in the <ns:include
-              href="../../s_docbuild/olinkdb/pardoc-names.xml"
-              xmlns:ns="http://www.w3.org/2001/XInclude"
-              xpointer="element(book_enea_edge_getting_started/1)" /></olink> Manual.
-              Providing the service username is optional. If it is not provided, the default
-              value will be used.</para>
-            </listitem>
-          </itemizedlist>
+      <note>
+        <para>When restoring an NFVi backup, connectivity with the uCPE device
+        may be lost for a period of time. After a successful restoration the
+        connection with the device will be restored. Any saved custom scripts
+        of type <filename>once-before-startup</filename> or
+        <filename>once-after-startup</filename> will be re-executed as part of
+        the NFVi restore process.</para>
+      </note>
+
+      <para>When restoring an NFVi backup all VNF instances will be removed.
+      Instances that were present at the moment the backup was taken will be
+      restored to their initial state, as if newly created. All snapshots
+      associated with previously instantiated VNFs will be deleted.</para>
+
+      <note>
+        <para>VNF instances will not be recreated if their associated VNF
+        descriptor has been deleted prior to restoring the NFVi backup.</para>
+      </note>
+    </section>
+
+    <section id="delete_nfvi_backup">
+      <title>Deleting an NFVi backup</title>
+
+      <para>Deleting an older NFVi backup can be performed in the following
+      way:</para>
+
+      <orderedlist>
+        <listitem>
+          <para>Select the uCPE device, access the <emphasis
+          role="bold">Configuration</emphasis> menu, and select <emphasis
+          role="bold">NFVI Backup</emphasis>. The <emphasis role="bold">NFVI
+          Config Archive Table</emphasis> will be shown.</para>
         </listitem>
 
         <listitem>
-          <para>Restart the Enea Edge Management service:</para>
+          <para>Select an existing backup from the NFVI Config Archive
+          Table.</para>
+        </listitem>
 
-          <programlisting>service ucpemanager restart</programlisting>
+        <listitem>
+          <para>Press the <emphasis role="bold">Delete</emphasis>
+          button.</para>
         </listitem>
       </orderedlist>
+
+      <para>A success message will be shown in the same window: <emphasis
+      role="bold">NFVI configuration backup deleted</emphasis>. The backup
+      file will be deleted from the uCPE device and the table will be
+      updated.</para>
+    </section>
+  </section>
+
+  <section id="mgmt_db_backup">
+    <title>Database backup for the Enea Edge Management application</title>
+
+    <para>The following handles advanced configuration for a database backup.
+    A backup can be used to restore the database in case of corruption.</para>
+
+    <section id="db_backup_once">
+      <title>One-time backup of the database</title>
+
+      <para>The following steps are used to perform a database backup from the
+      Enea Edge Management application:</para>
+
+      <orderedlist>
+        <listitem>
+          <para>In the <emphasis role="bold">System Backup</emphasis> window,
+          select the <emphasis role="bold">Backups</emphasis> tab.</para>
+        </listitem>
+
+        <listitem>
+          <para>Press the <emphasis role="bold">Backup Now</emphasis> button
+          in the <emphasis role="bold">Backups</emphasis> tab.</para>
+        </listitem>
+
+        <listitem>
+          <para>In the new window select the <emphasis role="bold">Database
+          Export</emphasis> option from the <emphasis role="bold">Backup
+          Type</emphasis> drop-down.</para>
+        </listitem>
+
+        <listitem>
+          <para>Set the <emphasis role="bold">Execution</emphasis> option to
+          <emphasis role="bold">Now</emphasis>.</para>
+        </listitem>
+
+        <listitem>
+          <para>Press the <emphasis role="bold">Execute</emphasis> button and
+          wait until the Status message shows: <emphasis role="bold">System
+          Backup Completed</emphasis>.</para>
+        </listitem>
+      </orderedlist>
+
+      <para>Once the backup is successfully executed it will be visible in the
+      <emphasis role="bold">System Backup</emphasis> window with a name that
+      respects the following format:
+      <literal>DatabaseExport_[date]_[timestamp].zip</literal>.</para>
+    </section>
+
+    <section id="db_backup_restore">
+      <title>Restoring the database from a backup</title>
+
+      <para>The following steps are used to perform a database restore from
+      the Enea Edge Management application:</para>
+
+      <orderedlist>
+        <listitem>
+          <para>In the <emphasis role="bold">System Backup</emphasis> window,
+          select the <emphasis role="bold">Backups</emphasis> tab.</para>
+        </listitem>
+
+        <listitem>
+          <para>Select the backup you want to restore from the list.</para>
+
+          <note>
+            <para>Database backups follow the naming convention:
+            <literal>DatabaseExport_[date]_[timestamp].zip</literal>.</para>
+          </note>
+        </listitem>
+
+        <listitem>
+          <para>Click the <emphasis role="bold">Restore</emphasis>
+          button.</para>
+        </listitem>
+
+        <listitem>
+          <para>In the window that appears, click <emphasis
+          role="bold">OK</emphasis> to proceed with the restore
+          operation.</para>
+        </listitem>
+
+        <listitem>
+          <para>Follow the instructions in the pop-up window to restart the
+          server using the CentOS 7 command:</para>
+
+          <programlisting>sudo systemctl restart ucpemanager.service</programlisting>
+        </listitem>
+      </orderedlist>
+    </section>
+
+    <section id="db_scheduled_backup">
+      <title>Scheduled backup of the database</title>
+
+      <para>The following steps are used to perform a scheduled database
+      backup from the Enea Edge Management application:</para>
+
+      <orderedlist>
+        <listitem>
+          <para>In the <emphasis role="bold">System Backup</emphasis> window,
+          select the <emphasis role="bold">Backups</emphasis> tab.</para>
+        </listitem>
+
+        <listitem>
+          <para>Press the <emphasis role="bold">Backup Now</emphasis> button
+          in the <emphasis role="bold">Backups</emphasis> tab.</para>
+        </listitem>
+
+        <listitem>
+          <para>In the new window select the <emphasis role="bold">Database
+          Export</emphasis> option from the <emphasis role="bold">Backup
+          Type</emphasis> drop-down.</para>
+        </listitem>
+
+        <listitem>
+          <para>Set the <emphasis role="bold">Execution</emphasis> option to
+          <emphasis role="bold">Scheduled</emphasis>.</para>
+        </listitem>
+
+        <listitem>
+          <para>Fill in the <emphasis role="bold">Description</emphasis>
+          field.</para>
+        </listitem>
+
+        <listitem>
+          <para>Set the <emphasis role="bold">Begin Date</emphasis>.</para>
+        </listitem>
+
+        <listitem>
+          <para>Fill in the non-mandatory fields accordingly.</para>
+
+          <note>
+            <para>The <emphasis role="bold">End Date</emphasis> field becomes
+            available once the <emphasis role="bold">Periodicity</emphasis>
+            option is set to something other than <emphasis
+            role="bold">Once</emphasis>.</para>
+          </note>
+        </listitem>
+
+        <listitem>
+          <para>Click the <emphasis role="bold">Schedule</emphasis> button to
+          schedule the backup.</para>
+        </listitem>
+      </orderedlist>
+
+      <figure>
+        <title>Scheduled Backup Configuration Example</title>
+
+        <mediaobject>
+          <imageobject>
+            <imagedata align="center" contentwidth="615"
+                       fileref="images/scheduled_backup.png" />
+          </imageobject>
+        </mediaobject>
+      </figure>
+
+      <para>The backups created will be visible in the <emphasis
+      role="bold">System Backup</emphasis> window with a name following the
+      format: <literal>DatabaseExport_[date]_[timestamp].zip</literal>.</para>
+    </section>
   </section>
 
   <section condition="hidden" id="high_availability_ig">
@@ -476,7 +766,7 @@ node0.1048576kB = 3 </programlisting>
     Availability Mode</title>
 
     <para>The following describes the setup needed for running the Enea Edge
-    Management application in High Availabilty (HA) mode, with a MariaDB
+    Management application in High Availability (HA) mode, with a MariaDB
     database cluster. A setup example is illustrated in the diagram
     below.</para>
 
@@ -500,7 +790,7 @@ node0.1048576kB = 3 </programlisting>
     single Virtual IP (VIP). The cluster can be reached either from the
     primary server IP or via VIP (recommended), since the VIP interface is
     spawned on the primary server. In case of a primary failure, a newly
-    elected primary (from one of the backups) will respawn the VIP interface.
+    elected primary (from one of the backups) will re-spawn the VIP interface.
     The firewall in this scenario will allocate a public IP for the outside
     world that will be translated into the VIP. Also in this example, the
     traffic towards the cluster from outside the firewall is done through
@@ -519,8 +809,8 @@ node0.1048576kB = 3 </programlisting>
     Limitations</emphasis></para>
 
     <para>Enea's solution for Edge Management High-Availability is designed to
-    maximize resiliency of the management function. However, the current design 
-      does not provide guaranteed consistency across all Enea Edge
+    maximize resiliency of the management function. However, the current
+    design does not provide guaranteed consistency across all Enea Edge
     Management instances, i.e. some information might become out-of-sync in
     certain conditions.</para>
 
@@ -540,7 +830,7 @@ node0.1048576kB = 3 </programlisting>
     and filesystem have been synchronized. If a Backup instance becomes the
     active one before synchronization takes place, this would result in an
     out-of-sync state.</para>
-    
+
     <section id="ha_reqs">
       <title>Requirements for High Availability</title>
 
@@ -840,7 +1130,7 @@ galera-4-26.4.6-1.el7.centos.x86_64</programlisting>
 #wsrep_provider_options=
 
 # Logical cluster name. Should be the same for all nodes.
-<emphasis role="bold">wsrep_cluster_name="ucpemanager"</emphasis>
+<emphasis role="bold">wsrep_cluster_name="EneaEdgeManagement"</emphasis>
 
 # Group communication system handle
 <emphasis role="bold">wsrep_cluster_address="gcomm://192.168.10.11,192.168.10.12,..,192.168.10.16"</emphasis>
@@ -945,11 +1235,11 @@ Thanks for using MariaDB!</programlisting>
             <para>Create the initial database and grant access to it:</para>
 
             <programlisting>[root@localhost application]# mysql --host=localhost --user=root -p
-MariaDB [(none)]&gt; CREATE DATABASE ucpemanager CHARACTER SET='utf8' \
+MariaDB [(none)]&gt; CREATE DATABASE EneaEdgeManagement CHARACTER SET='utf8' \
 COLLATE='utf8_bin';
 Query OK, 1 row affected (0.004 sec)
 
-MariaDB [(none)]&gt; GRANT ALL PRIVILEGES ON ucpemanager.* \
+MariaDB [(none)]&gt; GRANT ALL PRIVILEGES ON EneaEdgeManagement.* \
 TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION;</programlisting>
           </listitem>
         </orderedlist>
@@ -978,7 +1268,7 @@ TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION;</programlisting>
 
       <section id="ha_ucpe_mg">
         <title>Installing the Enea Edge Management application in High
-        Availabilty mode</title>
+        Availability mode</title>
 
         <para>These steps must be taken on each of the CentOS 7 machines that
         will host the Enea Edge Management application. It will be installed
@@ -989,7 +1279,7 @@ TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION;</programlisting>
         Management application, and run:</para>
 
         <programlisting>[root@localhost distro]#./install.sh /opt/ \
-Enea_NFV_Access_uCPEManager_2.3.0-build23.tar.gz
+Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz
 This will install the Enea Edge Management application into the /opt/ucpemanager folder.
 Select the following options, while asked by the installation script:
 Are you using the embedded PostgreSQL database? [Y/N]: <emphasis role="bold">N</emphasis>
@@ -1008,12 +1298,12 @@ Creating database configuration file \
 Done .
 …
 Installing ucpemanager service ..
-Specify service username [ucpemanager]: 
-Specify service password [ucpemanager]: somepassword
+Specify service username [EneaEdgeManagement]: 
+Specify service password [EneaEdgeManagement]: somepassword
 …
 Specify the IP address of the local interface: <emphasis role="bold">192.168.10.11</emphasis>
 Is this server part of a cluster? [Y/N]: <emphasis role="bold">Y</emphasis>
-Specify the name of the cluster [ucpemanager]: 
+Specify the name of the cluster [EneaEdgeManagement]: 
 Specify the shared (virtual) cluster IP address: <emphasis role="bold">192.168.10.10</emphasis>
 Specify the netmask for the cluster IP address [255.255.255.0]: 
 Specify the IP address of the (optional) arbiter: <emphasis role="bold">192.168.10.13</emphasis>
@@ -1042,17 +1332,19 @@ Configuration complete.</programlisting>
         role="bold">System</emphasis> and select <emphasis role="bold">Cluster
         View</emphasis>. The list of Enea Edge Management servers should be
         displayed, with one listed as Primary and the rest as Backup.</para>
-        
-        <note><para>To avoid split-brain (network-partitioning) scenarios, it is possible 
-          for the user to specify an IP:port tuple for a system that acts as an 
-          Arbiter. In case both Primary and Backup servers cannot reach the Arbiter, 
-          there will be no Primary system to connect to and the management services 
-          will be unavailable.</para>
-        
-        <para>This can be manually remedied by either fixing the network situation 
-          that caused the partitioning or modifying Arbiter information in the 
-          configuration file on the server that the user decides should be the 
-          (one and only) Primary server.</para></note>
+
+        <note>
+          <para>To avoid split-brain (network-partitioning) scenarios, it is
+          possible for the user to specify an IP:port tuple for a system that
+          acts as an Arbiter. In case both Primary and Backup servers cannot
+          reach the Arbiter, there will be no Primary system to connect to and
+          the management services will be unavailable.</para>
+
+          <para>This can be manually remedied by either fixing the network
+          situation that caused the partitioning or modifying Arbiter
+          information in the configuration file on the server that the user
+          decides should be the (one and only) Primary server.</para>
+        </note>
 
         <para><remark>ELCCR-907</remark>At times the VIP address is not
         acquired by any of the backup nodes if a power failure happens on
@@ -1070,7 +1362,7 @@ Configuration complete.</programlisting>
     <section id="ha_upgrade">
       <title>Upgrading a High Availability Deployment</title>
 
-      <para>Upgrading a High Availabilty deployment is a highly complex,
+      <para>Upgrading a High Availability deployment is a highly complex,
       multi-step process that requires care to ensure both consistency and
       high-availability. Some steps need to be done manually.</para>
 
@@ -1163,4 +1455,4 @@ Configuration complete.</programlisting>
       </orderedlist>
     </section>
   </section>
-</chapter>
+</chapter>
\ No newline at end of file