From 4d96e8e6de0ebd74131ed043e65102ef5de2adb1 Mon Sep 17 00:00:00 2001
From: Stefan Chiripuci <stci@enea.se>
Date: Wed, 4 Aug 2021 15:37:34 +0300
Subject: Add additional documentation on backup/restore Postgres database

Change-Id: Iabd09a48c594165bcbbb7c6a3292785d88ba32c5
---
 .../doc/advanced_configurations.xml                | 159 +++++++++++++++++++++
 .../doc/images/scheduled_backup.png                | Bin 0 -> 49672 bytes
 2 files changed, 159 insertions(+)
 create mode 100644 doc/book-enea-edge-getting-started/doc/images/scheduled_backup.png

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 992a629..518d9ec 100644
--- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml
+++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml
@@ -597,6 +597,165 @@ node0.1048576kB = 3 </programlisting>
     </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">
     <title>Installing the Enea Edge Management application in High
     Availability Mode</title>
diff --git a/doc/book-enea-edge-getting-started/doc/images/scheduled_backup.png b/doc/book-enea-edge-getting-started/doc/images/scheduled_backup.png
new file mode 100644
index 0000000..bf66b99
Binary files /dev/null and b/doc/book-enea-edge-getting-started/doc/images/scheduled_backup.png differ
-- 
cgit v1.2.3-54-g00ecf