summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefan Chiripuci <stci@enea.se>2021-08-04 15:37:34 +0300
committerStefan Chiripuci <Stefan.Chiripuci@enea.com>2021-08-10 11:37:27 +0100
commit4d96e8e6de0ebd74131ed043e65102ef5de2adb1 (patch)
tree9330dd89a51dc9b2fb05b873ae00811f8e727274
parent3b972fc8c4546117b5a811fcdae407cac77722f5 (diff)
downloadnfv-access-documentation-4d96e8e6de0ebd74131ed043e65102ef5de2adb1.tar.gz
Add additional documentation on backup/restore Postgres database
Change-Id: Iabd09a48c594165bcbbb7c6a3292785d88ba32c5
-rw-r--r--doc/book-enea-edge-getting-started/doc/advanced_configurations.xml159
-rw-r--r--doc/book-enea-edge-getting-started/doc/images/scheduled_backup.pngbin0 -> 49672 bytes
2 files changed, 159 insertions, 0 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 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>
597 </section> 597 </section>
598 </section> 598 </section>
599 599
600 <section id="mgmt_db_backup">
601 <title>Database backup for the Enea Edge Management application</title>
602
603 <para>The following handles advanced configuration for a database
604 backup. A backup can be used to restore the database in case
605 of corruption.</para>
606
607 <section id="db_backup_once">
608 <title>One-time backup of the database</title>
609
610 <para>The following steps are used to perform a database backup
611 from the Enea Edge Management application:</para>
612
613 <orderedlist>
614 <listitem>
615 <para>In the <emphasis role="bold">System Backup</emphasis> window,
616 select the <emphasis role="bold">Backups</emphasis> tab.</para>
617 </listitem>
618
619 <listitem>
620 <para>Press the <emphasis role="bold">Backup Now</emphasis> button
621 in the <emphasis role="bold">Backups</emphasis> tab.</para>
622 </listitem>
623
624 <listitem>
625 <para>In the new window select the
626 <emphasis role="bold">Database Export</emphasis> option from
627 the <emphasis role="bold">Backup Type</emphasis> drop-down.</para>
628 </listitem>
629
630 <listitem>
631 <para>Set the <emphasis role="bold">Execution</emphasis> option
632 to <emphasis role="bold">Now</emphasis>.</para>
633 </listitem>
634
635 <listitem>
636 <para>Press the <emphasis role="bold">Execute</emphasis> button
637 and wait until the Status message shows:
638 <emphasis role="bold">System Backup Completed</emphasis>.</para>
639 </listitem>
640 </orderedlist>
641
642 <para>Once the backup is successfully executed it will be visible in
643 the <emphasis role="bold">System Backup</emphasis> window with a
644 name that respects the following format:
645 <literal>DatabaseExport_[date]_[timestamp].zip</literal>.</para>
646 </section>
647
648 <section id="db_backup_restore">
649 <title>Restoring the database from a backup</title>
650
651 <para>The following steps are used to perform a database restore
652 from the Enea Edge Management application:</para>
653
654 <orderedlist>
655 <listitem>
656 <para>In the <emphasis role="bold">System Backup</emphasis> window,
657 select the <emphasis role="bold">Backups</emphasis> tab.</para>
658 </listitem>
659
660 <listitem>
661 <para>Select the backup you want to restore from the list.</para>
662
663 <note>
664 <para>Database backups follow the naming convention:
665 <literal>DatabaseExport_[date]_[timestamp].zip</literal>.</para>
666 </note>
667 </listitem>
668
669 <listitem>
670 <para>Click the <emphasis role="bold">Restore</emphasis> button.</para>
671 </listitem>
672
673 <listitem>
674 <para>In the window that appears, click
675 <emphasis role="bold">OK</emphasis> to proceed with the
676 restore operation.</para>
677 </listitem>
678
679 <listitem>
680 <para>Follow the instructions in the pop-up window to restart
681 the server using the CentOS 7 command:</para>
682
683 <programlisting>sudo systemctl restart ucpemanager.service</programlisting>
684 </listitem>
685 </orderedlist>
686 </section>
687
688 <section id="db_scheduled_backup">
689 <title>Scheduled backup of the database</title>
690
691 <para>The following steps are used to perform a scheduled database backup
692 from the Enea Edge Management application:</para>
693
694 <orderedlist>
695 <listitem>
696 <para>In the <emphasis role="bold">System Backup</emphasis> window,
697 select the <emphasis role="bold">Backups</emphasis> tab.</para>
698 </listitem>
699
700 <listitem>
701 <para>Press the <emphasis role="bold">Backup Now</emphasis> button
702 in the <emphasis role="bold">Backups</emphasis> tab.</para>
703 </listitem>
704
705 <listitem>
706 <para>In the new window select the
707 <emphasis role="bold">Database Export</emphasis>
708 option from the <emphasis role="bold">Backup Type</emphasis> drop-down.</para>
709 </listitem>
710
711 <listitem>
712 <para>Set the <emphasis role="bold">Execution</emphasis> option
713 to <emphasis role="bold">Scheduled</emphasis>.</para>
714 </listitem>
715
716 <listitem>
717 <para>Fill in the <emphasis role="bold">Description</emphasis> field.</para>
718 </listitem>
719
720 <listitem>
721 <para>Set the <emphasis role="bold">Begin Date</emphasis>.</para>
722 </listitem>
723
724 <listitem>
725 <para>Fill in the non-mandatory fields accordingly.</para>
726
727 <note>
728 <para>The <emphasis role="bold">End Date</emphasis> field becomes
729 available once the <emphasis role="bold">Periodicity</emphasis> option
730 is set to something other than
731 <emphasis role="bold">Once</emphasis>.</para>
732 </note>
733 </listitem>
734
735 <listitem>
736 <para>Click the <emphasis role="bold">Schedule</emphasis> button to
737 schedule the backup.</para>
738 </listitem>
739 </orderedlist>
740
741 <figure>
742 <title>Scheduled Backup Configuration Example</title>
743
744 <mediaobject>
745 <imageobject>
746 <imagedata align="center" contentwidth="615"
747 fileref="images/scheduled_backup.png" />
748 </imageobject>
749 </mediaobject>
750 </figure>
751
752 <para>The backups created will be visible in the
753 <emphasis role="bold">System Backup</emphasis> window with a
754 name following the format:
755 <literal>DatabaseExport_[date]_[timestamp].zip</literal>.</para>
756 </section>
757 </section>
758
600 <section condition="hidden" id="high_availability_ig"> 759 <section condition="hidden" id="high_availability_ig">
601 <title>Installing the Enea Edge Management application in High 760 <title>Installing the Enea Edge Management application in High
602 Availability Mode</title> 761 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
--- /dev/null
+++ b/doc/book-enea-edge-getting-started/doc/images/scheduled_backup.png
Binary files differ