ELCCR-1702 Add documentation to the Enea Getting Started Manual

- Add documentation for NFVi Backup

Change-Id: I782d4946def16b23864419369b885a42c69124ab
Signed-off-by: Toma Bilius <toma.bilius@enea.com>

1 files changed, 173 insertions, 47 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 3366a43..cc6ea9d 100644
--- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml
+++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml
@@ -414,62 +414,186 @@ 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;uCPEM-installerdir&gt;</literal>.</para>
+      </listitem>
+
+      <listitem>
+        <para>Enter <literal>&lt;uCPEM-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 ucpemanager &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 acessing 
+          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 in the
+      <literal>/var/odm/backup/</literal> folder.</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 and change <literal>/opt/ems</literal>
-          to the location where the Enea Edge Management application is installed:</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 (accesible 
+        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>
+    </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 (from the 
+        <literal>/var/odm/backup/</literal> folder), and the table will be
+      updated.</para>
+    </section>
   </section>
 
   <section condition="hidden" id="high_availability_ig">
@@ -520,8 +644,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>
 
@@ -541,7 +665,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>
 
@@ -1043,17 +1167,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
@@ -1164,4 +1290,4 @@ Configuration complete.</programlisting>
       </orderedlist>
     </section>
   </section>
-</chapter>
+</chapter>
\ No newline at end of file