diff options
Diffstat (limited to 'doc/book-enea-edge-getting-started/doc')
14 files changed, 1034 insertions, 193 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 @@ | |||
120 | <listitem> | 120 | <listitem> |
121 | <para><literal>prompt_user</literal> (optional). If the parameter | 121 | <para><literal>prompt_user</literal> (optional). If the parameter |
122 | is set to "yes", the installer will ask for confirmation before | 122 | is set to "yes", the installer will ask for confirmation before |
123 | formatting and partitioning the drive. The default behaviour is to | 123 | formatting and partitioning the drive. The default behavior is to |
124 | proceed automatically without any user interaction.</para> | 124 | proceed automatically without any user interaction.</para> |
125 | </listitem> | 125 | </listitem> |
126 | </itemizedlist> | 126 | </itemizedlist> |
127 | 127 | ||
128 | <para>Installation Configuration File Example:</para> | 128 | <para>Installation Configuration File Example:</para> |
129 | 129 | ||
130 | <programlisting>image_url = http://192.168.1.100/enea-nfv-access-xeon-d.hddimg.gz | 130 | <programlisting>image_url = http://192.168.1.100/enea-edge-runtime-xeon-d.hddimg.gz |
131 | install_drive = /dev/sda</programlisting> | 131 | install_drive = /dev/sda</programlisting> |
132 | 132 | ||
133 | <note> | 133 | <note> |
@@ -144,9 +144,9 @@ install_drive = /dev/sda</programlisting> | |||
144 | <literal>/var/lib/tftpboot/pxelinux.cfg/default</literal>). The PXE | 144 | <literal>/var/lib/tftpboot/pxelinux.cfg/default</literal>). The PXE |
145 | entry should have the following settings:</para> | 145 | entry should have the following settings:</para> |
146 | 146 | ||
147 | <programlisting>default nfv_access | 147 | <programlisting>default enea_edge_runtime |
148 | label nfv_access | 148 | label enea_edge_runtime |
149 | menu label ^NFV_ACCESS_INSTALLER | 149 | menu label ^ENEA_EDGE_INSTALLER |
150 | kernel <Path to kernel> | 150 | kernel <Path to kernel> |
151 | append root=/dev/ram0 initrd=<Path to initramfs> LABEL=pxe-installer \ | 151 | append root=/dev/ram0 initrd=<Path to initramfs> LABEL=pxe-installer \ |
152 | INSTALL_CFG=http://<Server IP>/<Path to install config file> \ | 152 | INSTALL_CFG=http://<Server IP>/<Path to install config file> \ |
@@ -300,7 +300,7 @@ ipmitool -U <user> -P <password> -H <uCPE device IPMI IP address& | |||
300 | <title>Customizing Automatic Hugepage Reservation</title> | 300 | <title>Customizing Automatic Hugepage Reservation</title> |
301 | 301 | ||
302 | <para>Configuration of Hugepage reservation is done in | 302 | <para>Configuration of Hugepage reservation is done in |
303 | <literal>/etc/enea-nfv-access/hugepages.cfg</literal>.</para> | 303 | <literal>/etc/enea/hugepages.cfg</literal>.</para> |
304 | 304 | ||
305 | <para><emphasis role="bold">Parameters used by the automatic algorithm: | 305 | <para><emphasis role="bold">Parameters used by the automatic algorithm: |
306 | </emphasis></para> | 306 | </emphasis></para> |
@@ -414,61 +414,351 @@ node0.1048576kB = 3 </programlisting> | |||
414 | <section id="create_certificate"> | 414 | <section id="create_certificate"> |
415 | <title>Tomcat Certificate Generation</title> | 415 | <title>Tomcat Certificate Generation</title> |
416 | 416 | ||
417 | <para>The self-signed Tomcat Certificate the Enea Edge | 417 | <para>The self-signed Tomcat Certificate the Enea Edge Management |
418 | Management application uses is generated at installation time. It can | 418 | application uses is generated at installation time. It can be regenerated |
419 | be regenerated anytime after installation by using the | 419 | anytime after installation by using the |
420 | <filename>createCertificate.sh</filename> script.</para> | 420 | <filename>createCertificate.sh</filename> script.</para> |
421 | 421 | ||
422 | <para>On the CentOS 7 server open a terminal, log into a bash shell with | 422 | <para>On the CentOS 7 server open a terminal, log into a bash shell with |
423 | the root account and perform the following:</para> | 423 | the root account and perform the following:</para> |
424 | 424 | ||
425 | <orderedlist> | 425 | <orderedlist> |
426 | <listitem> | ||
427 | <para>Extract | ||
428 | <literal>Enea_Edge_Management_<version>-build<build_number>.tar.gz</literal></para> | ||
429 | |||
430 | <para>The directory in which the archive has been unpacked will be | ||
431 | denoted as: <literal><EEMg-installerdir></literal>.</para> | ||
432 | </listitem> | ||
433 | |||
434 | <listitem> | ||
435 | <para>Enter <literal><EEMg-installerdir>/dist</literal>.</para> | ||
436 | </listitem> | ||
437 | |||
438 | <listitem> | ||
439 | <para>Run the following command and change <literal>/opt/ems</literal> | ||
440 | to the location where the Enea Edge Management application is | ||
441 | installed:</para> | ||
442 | |||
443 | <programlisting>./createCertificate.sh EneaEdgeManagement <IP_or_domain> \ | ||
444 | /opt/ems [<service_username>]</programlisting> | ||
445 | |||
446 | <para>Where the following need to be included:</para> | ||
447 | |||
448 | <itemizedlist> | ||
449 | <listitem> | ||
450 | <para>The IP or domain name of the server the Enea Edge Management | ||
451 | application is running on.</para> | ||
452 | </listitem> | ||
453 | |||
454 | <listitem> | ||
455 | <para>The service username, which is the one set when installing | ||
456 | the Enea Edge Management application. For more details see <olink | ||
457 | targetdoc="book_enea_edge_getting_started" | ||
458 | targetptr="fresh_ucpemg_install">Fresh Installation of the Enea | ||
459 | Edge Management application in the <ns:include | ||
460 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
461 | xmlns:ns="http://www.w3.org/2001/XInclude" | ||
462 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> | ||
463 | Manual. Providing the service username is optional. If it is not | ||
464 | provided, the default value will be used.</para> | ||
465 | </listitem> | ||
466 | </itemizedlist> | ||
467 | </listitem> | ||
468 | |||
469 | <listitem> | ||
470 | <para>Restart the Enea Edge Management service:</para> | ||
471 | |||
472 | <programlisting>service ucpemanager restart</programlisting> | ||
473 | </listitem> | ||
474 | </orderedlist> | ||
475 | </section> | ||
476 | |||
477 | <section id="nfvi_backup"> | ||
478 | <title>NFV Infrastructure Backup Operations</title> | ||
479 | |||
480 | <para>In the following sections are described the operations that can be | ||
481 | performed in order to backup and restore the NFV Infrastructure (NFVi) | ||
482 | configuration. This allows for recovery from unintended configuration | ||
483 | errors.</para> | ||
484 | |||
485 | <section id="nfvi_snapshot"> | ||
486 | <title>NFVi Snapshotting</title> | ||
487 | |||
488 | <para>To perform a snapshot (a backup of the current state) of the NFVi, | ||
489 | perform the following steps in the Enea Edge Management | ||
490 | application:</para> | ||
491 | |||
492 | <orderedlist> | ||
426 | <listitem> | 493 | <listitem> |
427 | <para>Extract <literal>Enea_Edge_Management_<version>-build<build_number>.tar.gz</literal></para> | 494 | <para>Select the uCPE device, access the <emphasis |
495 | role="bold">Configuration</emphasis> menu, and select <emphasis | ||
496 | role="bold">NFVI Backup</emphasis>. The <emphasis role="bold">NFVI | ||
497 | Config Archive Table</emphasis> will be shown.</para> | ||
498 | </listitem> | ||
428 | 499 | ||
429 | <para>The directory in which the archive has been unpacked will be | 500 | <listitem> |
430 | denoted as: <literal><uCPEM-installerdir></literal>.</para> | 501 | <para>Press the <emphasis role="bold">Create</emphasis> |
502 | button.</para> | ||
431 | </listitem> | 503 | </listitem> |
432 | 504 | ||
433 | <listitem> | 505 | <listitem> |
434 | <para>Enter <literal><uCPEM-installerdir>/dist</literal>.</para> | 506 | <para>Edit the default file name, if needed, and press the <emphasis |
507 | role="bold">Create</emphasis> button. The current window will close | ||
508 | and the success message <emphasis role="bold">Created | ||
509 | successfully</emphasis> will be shown.</para> | ||
435 | </listitem> | 510 | </listitem> |
511 | </orderedlist> | ||
512 | |||
513 | <para>A new entry will be added in the <emphasis role="bold">NFVI Config | ||
514 | Archive Table</emphasis> and the <emphasis | ||
515 | role="bold">BackupArchiveCreated</emphasis> event can be seen by | ||
516 | accessing the <emphasis role="bold">Fault</emphasis> menu and triggering | ||
517 | the <emphasis role="bold">Events</emphasis> window. The backup file will | ||
518 | be created on the uCPE device.</para> | ||
519 | </section> | ||
520 | |||
521 | <section id="restore_nfvi_backup"> | ||
522 | <title>Restoring an NFVi backup</title> | ||
523 | |||
524 | <para>When needed, an NFVi backup can be restored in the following | ||
525 | way:</para> | ||
436 | 526 | ||
527 | <orderedlist> | ||
437 | <listitem> | 528 | <listitem> |
438 | <para>Run the following command:</para> | 529 | <para>Select the uCPE device, access the <emphasis |
530 | role="bold">Configuration</emphasis> menu and select <emphasis | ||
531 | role="bold">NFVI Backup</emphasis>. The <emphasis role="bold">NFVI | ||
532 | Config Archive Table</emphasis> will be shown.</para> | ||
533 | </listitem> | ||
439 | 534 | ||
440 | <programlisting>./createCertificate.sh ucpemanager <IP_or_domain> \ | 535 | <listitem> |
441 | /opt/ems [<service_username>]</programlisting> | 536 | <para>Select an existing backup from the NFVI Config Archive |
537 | Table.</para> | ||
538 | </listitem> | ||
442 | 539 | ||
443 | <para>Where the following need to be included:</para> | 540 | <listitem> |
541 | <para>Press the <emphasis role="bold">Restore</emphasis> button and | ||
542 | <emphasis role="bold">Confirm</emphasis> the action.</para> | ||
543 | </listitem> | ||
544 | </orderedlist> | ||
444 | 545 | ||
445 | <itemizedlist> | 546 | <para>A success message will be shown in the same window: <emphasis |
446 | <listitem> | 547 | role="bold">Restored NFVI configuration</emphasis>. Two events will |
447 | <para>The IP or domain name of the server the Enea Edge | 548 | appear in the <emphasis role="bold">Events</emphasis> window (accessible |
448 | Management application is running on.</para> | 549 | through the <emphasis role="bold">Fault</emphasis> menu): <emphasis |
449 | </listitem> | 550 | role="bold">Restore started</emphasis> and <emphasis role="bold">Restore |
551 | complete</emphasis>.</para> | ||
450 | 552 | ||
451 | <listitem> | 553 | <note> |
452 | <para>The service username, which is the one set when installing the | 554 | <para>When restoring an NFVi backup, connectivity with the uCPE device |
453 | Enea Edge Management application. For more details | 555 | may be lost for a period of time. After a successful restoration the |
454 | see <olink targetdoc="book_enea_edge_getting_started" | 556 | connection with the device will be restored. Any saved custom scripts |
455 | targetptr="fresh_ucpemg_install">Fresh Installation of the Enea | 557 | of type <filename>once-before-startup</filename> or |
456 | Edge Management application in the <ns:include | 558 | <filename>once-after-startup</filename> will be re-executed as part of |
457 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 559 | the NFVi restore process.</para> |
458 | xmlns:ns="http://www.w3.org/2001/XInclude" | 560 | </note> |
459 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> Manual. | 561 | |
460 | Providing the service username is optional. If it is not provided, the default | 562 | <para>When restoring an NFVi backup all VNF instances will be removed. |
461 | value will be used.</para> | 563 | Instances that were present at the moment the backup was taken will be |
462 | </listitem> | 564 | restored to their initial state, as if newly created. All snapshots |
463 | </itemizedlist> | 565 | associated with previously instantiated VNFs will be deleted.</para> |
566 | |||
567 | <note> | ||
568 | <para>VNF instances will not be recreated if their associated VNF | ||
569 | descriptor has been deleted prior to restoring the NFVi backup.</para> | ||
570 | </note> | ||
571 | </section> | ||
572 | |||
573 | <section id="delete_nfvi_backup"> | ||
574 | <title>Deleting an NFVi backup</title> | ||
575 | |||
576 | <para>Deleting an older NFVi backup can be performed in the following | ||
577 | way:</para> | ||
578 | |||
579 | <orderedlist> | ||
580 | <listitem> | ||
581 | <para>Select the uCPE device, access the <emphasis | ||
582 | role="bold">Configuration</emphasis> menu, and select <emphasis | ||
583 | role="bold">NFVI Backup</emphasis>. The <emphasis role="bold">NFVI | ||
584 | Config Archive Table</emphasis> will be shown.</para> | ||
464 | </listitem> | 585 | </listitem> |
465 | 586 | ||
466 | <listitem> | 587 | <listitem> |
467 | <para>Restart the Enea Edge Management service:</para> | 588 | <para>Select an existing backup from the NFVI Config Archive |
589 | Table.</para> | ||
590 | </listitem> | ||
468 | 591 | ||
469 | <programlisting>service ucpemanager restart</programlisting> | 592 | <listitem> |
593 | <para>Press the <emphasis role="bold">Delete</emphasis> | ||
594 | button.</para> | ||
470 | </listitem> | 595 | </listitem> |
471 | </orderedlist> | 596 | </orderedlist> |
597 | |||
598 | <para>A success message will be shown in the same window: <emphasis | ||
599 | role="bold">NFVI configuration backup deleted</emphasis>. The backup | ||
600 | file will be deleted from the uCPE device and the table will be | ||
601 | updated.</para> | ||
602 | </section> | ||
603 | </section> | ||
604 | |||
605 | <section id="mgmt_db_backup"> | ||
606 | <title>Database backup for the Enea Edge Management application</title> | ||
607 | |||
608 | <para>The following handles advanced configuration for a database backup. | ||
609 | A backup can be used to restore the database in case of corruption.</para> | ||
610 | |||
611 | <section id="db_backup_once"> | ||
612 | <title>One-time backup of the database</title> | ||
613 | |||
614 | <para>The following steps are used to perform a database backup from the | ||
615 | Enea Edge Management application:</para> | ||
616 | |||
617 | <orderedlist> | ||
618 | <listitem> | ||
619 | <para>In the <emphasis role="bold">System Backup</emphasis> window, | ||
620 | select the <emphasis role="bold">Backups</emphasis> tab.</para> | ||
621 | </listitem> | ||
622 | |||
623 | <listitem> | ||
624 | <para>Press the <emphasis role="bold">Backup Now</emphasis> button | ||
625 | in the <emphasis role="bold">Backups</emphasis> tab.</para> | ||
626 | </listitem> | ||
627 | |||
628 | <listitem> | ||
629 | <para>In the new window select the <emphasis role="bold">Database | ||
630 | Export</emphasis> option from the <emphasis role="bold">Backup | ||
631 | Type</emphasis> drop-down.</para> | ||
632 | </listitem> | ||
633 | |||
634 | <listitem> | ||
635 | <para>Set the <emphasis role="bold">Execution</emphasis> option to | ||
636 | <emphasis role="bold">Now</emphasis>.</para> | ||
637 | </listitem> | ||
638 | |||
639 | <listitem> | ||
640 | <para>Press the <emphasis role="bold">Execute</emphasis> button and | ||
641 | wait until the Status message shows: <emphasis role="bold">System | ||
642 | Backup Completed</emphasis>.</para> | ||
643 | </listitem> | ||
644 | </orderedlist> | ||
645 | |||
646 | <para>Once the backup is successfully executed it will be visible in the | ||
647 | <emphasis role="bold">System Backup</emphasis> window with a name that | ||
648 | respects the following format: | ||
649 | <literal>DatabaseExport_[date]_[timestamp].zip</literal>.</para> | ||
650 | </section> | ||
651 | |||
652 | <section id="db_backup_restore"> | ||
653 | <title>Restoring the database from a backup</title> | ||
654 | |||
655 | <para>The following steps are used to perform a database restore from | ||
656 | the Enea Edge Management application:</para> | ||
657 | |||
658 | <orderedlist> | ||
659 | <listitem> | ||
660 | <para>In the <emphasis role="bold">System Backup</emphasis> window, | ||
661 | select the <emphasis role="bold">Backups</emphasis> tab.</para> | ||
662 | </listitem> | ||
663 | |||
664 | <listitem> | ||
665 | <para>Select the backup you want to restore from the list.</para> | ||
666 | |||
667 | <note> | ||
668 | <para>Database backups follow the naming convention: | ||
669 | <literal>DatabaseExport_[date]_[timestamp].zip</literal>.</para> | ||
670 | </note> | ||
671 | </listitem> | ||
672 | |||
673 | <listitem> | ||
674 | <para>Click the <emphasis role="bold">Restore</emphasis> | ||
675 | button.</para> | ||
676 | </listitem> | ||
677 | |||
678 | <listitem> | ||
679 | <para>In the window that appears, click <emphasis | ||
680 | role="bold">OK</emphasis> to proceed with the restore | ||
681 | operation.</para> | ||
682 | </listitem> | ||
683 | |||
684 | <listitem> | ||
685 | <para>Follow the instructions in the pop-up window to restart the | ||
686 | server using the CentOS 7 command:</para> | ||
687 | |||
688 | <programlisting>sudo systemctl restart ucpemanager.service</programlisting> | ||
689 | </listitem> | ||
690 | </orderedlist> | ||
691 | </section> | ||
692 | |||
693 | <section id="db_scheduled_backup"> | ||
694 | <title>Scheduled backup of the database</title> | ||
695 | |||
696 | <para>The following steps are used to perform a scheduled database | ||
697 | backup from the Enea Edge Management application:</para> | ||
698 | |||
699 | <orderedlist> | ||
700 | <listitem> | ||
701 | <para>In the <emphasis role="bold">System Backup</emphasis> window, | ||
702 | select the <emphasis role="bold">Backups</emphasis> tab.</para> | ||
703 | </listitem> | ||
704 | |||
705 | <listitem> | ||
706 | <para>Press the <emphasis role="bold">Backup Now</emphasis> button | ||
707 | in the <emphasis role="bold">Backups</emphasis> tab.</para> | ||
708 | </listitem> | ||
709 | |||
710 | <listitem> | ||
711 | <para>In the new window select the <emphasis role="bold">Database | ||
712 | Export</emphasis> option from the <emphasis role="bold">Backup | ||
713 | Type</emphasis> drop-down.</para> | ||
714 | </listitem> | ||
715 | |||
716 | <listitem> | ||
717 | <para>Set the <emphasis role="bold">Execution</emphasis> option to | ||
718 | <emphasis role="bold">Scheduled</emphasis>.</para> | ||
719 | </listitem> | ||
720 | |||
721 | <listitem> | ||
722 | <para>Fill in the <emphasis role="bold">Description</emphasis> | ||
723 | field.</para> | ||
724 | </listitem> | ||
725 | |||
726 | <listitem> | ||
727 | <para>Set the <emphasis role="bold">Begin Date</emphasis>.</para> | ||
728 | </listitem> | ||
729 | |||
730 | <listitem> | ||
731 | <para>Fill in the non-mandatory fields accordingly.</para> | ||
732 | |||
733 | <note> | ||
734 | <para>The <emphasis role="bold">End Date</emphasis> field becomes | ||
735 | available once the <emphasis role="bold">Periodicity</emphasis> | ||
736 | option is set to something other than <emphasis | ||
737 | role="bold">Once</emphasis>.</para> | ||
738 | </note> | ||
739 | </listitem> | ||
740 | |||
741 | <listitem> | ||
742 | <para>Click the <emphasis role="bold">Schedule</emphasis> button to | ||
743 | schedule the backup.</para> | ||
744 | </listitem> | ||
745 | </orderedlist> | ||
746 | |||
747 | <figure> | ||
748 | <title>Scheduled Backup Configuration Example</title> | ||
749 | |||
750 | <mediaobject> | ||
751 | <imageobject> | ||
752 | <imagedata align="center" contentwidth="615" | ||
753 | fileref="images/scheduled_backup.png" /> | ||
754 | </imageobject> | ||
755 | </mediaobject> | ||
756 | </figure> | ||
757 | |||
758 | <para>The backups created will be visible in the <emphasis | ||
759 | role="bold">System Backup</emphasis> window with a name following the | ||
760 | format: <literal>DatabaseExport_[date]_[timestamp].zip</literal>.</para> | ||
761 | </section> | ||
472 | </section> | 762 | </section> |
473 | 763 | ||
474 | <section condition="hidden" id="high_availability_ig"> | 764 | <section condition="hidden" id="high_availability_ig"> |
@@ -476,7 +766,7 @@ node0.1048576kB = 3 </programlisting> | |||
476 | Availability Mode</title> | 766 | Availability Mode</title> |
477 | 767 | ||
478 | <para>The following describes the setup needed for running the Enea Edge | 768 | <para>The following describes the setup needed for running the Enea Edge |
479 | Management application in High Availabilty (HA) mode, with a MariaDB | 769 | Management application in High Availability (HA) mode, with a MariaDB |
480 | database cluster. A setup example is illustrated in the diagram | 770 | database cluster. A setup example is illustrated in the diagram |
481 | below.</para> | 771 | below.</para> |
482 | 772 | ||
@@ -500,7 +790,7 @@ node0.1048576kB = 3 </programlisting> | |||
500 | single Virtual IP (VIP). The cluster can be reached either from the | 790 | single Virtual IP (VIP). The cluster can be reached either from the |
501 | primary server IP or via VIP (recommended), since the VIP interface is | 791 | primary server IP or via VIP (recommended), since the VIP interface is |
502 | spawned on the primary server. In case of a primary failure, a newly | 792 | spawned on the primary server. In case of a primary failure, a newly |
503 | elected primary (from one of the backups) will respawn the VIP interface. | 793 | elected primary (from one of the backups) will re-spawn the VIP interface. |
504 | The firewall in this scenario will allocate a public IP for the outside | 794 | The firewall in this scenario will allocate a public IP for the outside |
505 | world that will be translated into the VIP. Also in this example, the | 795 | world that will be translated into the VIP. Also in this example, the |
506 | traffic towards the cluster from outside the firewall is done through | 796 | traffic towards the cluster from outside the firewall is done through |
@@ -519,8 +809,8 @@ node0.1048576kB = 3 </programlisting> | |||
519 | Limitations</emphasis></para> | 809 | Limitations</emphasis></para> |
520 | 810 | ||
521 | <para>Enea's solution for Edge Management High-Availability is designed to | 811 | <para>Enea's solution for Edge Management High-Availability is designed to |
522 | maximize resiliency of the management function. However, the current design | 812 | maximize resiliency of the management function. However, the current |
523 | does not provide guaranteed consistency across all Enea Edge | 813 | design does not provide guaranteed consistency across all Enea Edge |
524 | Management instances, i.e. some information might become out-of-sync in | 814 | Management instances, i.e. some information might become out-of-sync in |
525 | certain conditions.</para> | 815 | certain conditions.</para> |
526 | 816 | ||
@@ -540,7 +830,7 @@ node0.1048576kB = 3 </programlisting> | |||
540 | and filesystem have been synchronized. If a Backup instance becomes the | 830 | and filesystem have been synchronized. If a Backup instance becomes the |
541 | active one before synchronization takes place, this would result in an | 831 | active one before synchronization takes place, this would result in an |
542 | out-of-sync state.</para> | 832 | out-of-sync state.</para> |
543 | 833 | ||
544 | <section id="ha_reqs"> | 834 | <section id="ha_reqs"> |
545 | <title>Requirements for High Availability</title> | 835 | <title>Requirements for High Availability</title> |
546 | 836 | ||
@@ -840,7 +1130,7 @@ galera-4-26.4.6-1.el7.centos.x86_64</programlisting> | |||
840 | #wsrep_provider_options= | 1130 | #wsrep_provider_options= |
841 | 1131 | ||
842 | # Logical cluster name. Should be the same for all nodes. | 1132 | # Logical cluster name. Should be the same for all nodes. |
843 | <emphasis role="bold">wsrep_cluster_name="ucpemanager"</emphasis> | 1133 | <emphasis role="bold">wsrep_cluster_name="EneaEdgeManagement"</emphasis> |
844 | 1134 | ||
845 | # Group communication system handle | 1135 | # Group communication system handle |
846 | <emphasis role="bold">wsrep_cluster_address="gcomm://192.168.10.11,192.168.10.12,..,192.168.10.16"</emphasis> | 1136 | <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> | |||
945 | <para>Create the initial database and grant access to it:</para> | 1235 | <para>Create the initial database and grant access to it:</para> |
946 | 1236 | ||
947 | <programlisting>[root@localhost application]# mysql --host=localhost --user=root -p | 1237 | <programlisting>[root@localhost application]# mysql --host=localhost --user=root -p |
948 | MariaDB [(none)]> CREATE DATABASE ucpemanager CHARACTER SET='utf8' \ | 1238 | MariaDB [(none)]> CREATE DATABASE EneaEdgeManagement CHARACTER SET='utf8' \ |
949 | COLLATE='utf8_bin'; | 1239 | COLLATE='utf8_bin'; |
950 | Query OK, 1 row affected (0.004 sec) | 1240 | Query OK, 1 row affected (0.004 sec) |
951 | 1241 | ||
952 | MariaDB [(none)]> GRANT ALL PRIVILEGES ON ucpemanager.* \ | 1242 | MariaDB [(none)]> GRANT ALL PRIVILEGES ON EneaEdgeManagement.* \ |
953 | TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION;</programlisting> | 1243 | TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION;</programlisting> |
954 | </listitem> | 1244 | </listitem> |
955 | </orderedlist> | 1245 | </orderedlist> |
@@ -978,7 +1268,7 @@ TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION;</programlisting> | |||
978 | 1268 | ||
979 | <section id="ha_ucpe_mg"> | 1269 | <section id="ha_ucpe_mg"> |
980 | <title>Installing the Enea Edge Management application in High | 1270 | <title>Installing the Enea Edge Management application in High |
981 | Availabilty mode</title> | 1271 | Availability mode</title> |
982 | 1272 | ||
983 | <para>These steps must be taken on each of the CentOS 7 machines that | 1273 | <para>These steps must be taken on each of the CentOS 7 machines that |
984 | will host the Enea Edge Management application. It will be installed | 1274 | will host the Enea Edge Management application. It will be installed |
@@ -989,7 +1279,7 @@ TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION;</programlisting> | |||
989 | Management application, and run:</para> | 1279 | Management application, and run:</para> |
990 | 1280 | ||
991 | <programlisting>[root@localhost distro]#./install.sh /opt/ \ | 1281 | <programlisting>[root@localhost distro]#./install.sh /opt/ \ |
992 | Enea_NFV_Access_uCPEManager_2.3.0-build23.tar.gz | 1282 | Enea_Edge_Management_<version>-build<build_number>.tar.gz |
993 | This will install the Enea Edge Management application into the /opt/ucpemanager folder. | 1283 | This will install the Enea Edge Management application into the /opt/ucpemanager folder. |
994 | Select the following options, while asked by the installation script: | 1284 | Select the following options, while asked by the installation script: |
995 | Are you using the embedded PostgreSQL database? [Y/N]: <emphasis role="bold">N</emphasis> | 1285 | Are you using the embedded PostgreSQL database? [Y/N]: <emphasis role="bold">N</emphasis> |
@@ -1008,12 +1298,12 @@ Creating database configuration file \ | |||
1008 | Done . | 1298 | Done . |
1009 | … | 1299 | … |
1010 | Installing ucpemanager service .. | 1300 | Installing ucpemanager service .. |
1011 | Specify service username [ucpemanager]: | 1301 | Specify service username [EneaEdgeManagement]: |
1012 | Specify service password [ucpemanager]: somepassword | 1302 | Specify service password [EneaEdgeManagement]: somepassword |
1013 | … | 1303 | … |
1014 | Specify the IP address of the local interface: <emphasis role="bold">192.168.10.11</emphasis> | 1304 | Specify the IP address of the local interface: <emphasis role="bold">192.168.10.11</emphasis> |
1015 | Is this server part of a cluster? [Y/N]: <emphasis role="bold">Y</emphasis> | 1305 | Is this server part of a cluster? [Y/N]: <emphasis role="bold">Y</emphasis> |
1016 | Specify the name of the cluster [ucpemanager]: | 1306 | Specify the name of the cluster [EneaEdgeManagement]: |
1017 | Specify the shared (virtual) cluster IP address: <emphasis role="bold">192.168.10.10</emphasis> | 1307 | Specify the shared (virtual) cluster IP address: <emphasis role="bold">192.168.10.10</emphasis> |
1018 | Specify the netmask for the cluster IP address [255.255.255.0]: | 1308 | Specify the netmask for the cluster IP address [255.255.255.0]: |
1019 | Specify the IP address of the (optional) arbiter: <emphasis role="bold">192.168.10.13</emphasis> | 1309 | Specify the IP address of the (optional) arbiter: <emphasis role="bold">192.168.10.13</emphasis> |
@@ -1042,17 +1332,19 @@ Configuration complete.</programlisting> | |||
1042 | role="bold">System</emphasis> and select <emphasis role="bold">Cluster | 1332 | role="bold">System</emphasis> and select <emphasis role="bold">Cluster |
1043 | View</emphasis>. The list of Enea Edge Management servers should be | 1333 | View</emphasis>. The list of Enea Edge Management servers should be |
1044 | displayed, with one listed as Primary and the rest as Backup.</para> | 1334 | displayed, with one listed as Primary and the rest as Backup.</para> |
1045 | 1335 | ||
1046 | <note><para>To avoid split-brain (network-partitioning) scenarios, it is possible | 1336 | <note> |
1047 | for the user to specify an IP:port tuple for a system that acts as an | 1337 | <para>To avoid split-brain (network-partitioning) scenarios, it is |
1048 | Arbiter. In case both Primary and Backup servers cannot reach the Arbiter, | 1338 | possible for the user to specify an IP:port tuple for a system that |
1049 | there will be no Primary system to connect to and the management services | 1339 | acts as an Arbiter. In case both Primary and Backup servers cannot |
1050 | will be unavailable.</para> | 1340 | reach the Arbiter, there will be no Primary system to connect to and |
1051 | 1341 | the management services will be unavailable.</para> | |
1052 | <para>This can be manually remedied by either fixing the network situation | 1342 | |
1053 | that caused the partitioning or modifying Arbiter information in the | 1343 | <para>This can be manually remedied by either fixing the network |
1054 | configuration file on the server that the user decides should be the | 1344 | situation that caused the partitioning or modifying Arbiter |
1055 | (one and only) Primary server.</para></note> | 1345 | information in the configuration file on the server that the user |
1346 | decides should be the (one and only) Primary server.</para> | ||
1347 | </note> | ||
1056 | 1348 | ||
1057 | <para><remark>ELCCR-907</remark>At times the VIP address is not | 1349 | <para><remark>ELCCR-907</remark>At times the VIP address is not |
1058 | acquired by any of the backup nodes if a power failure happens on | 1350 | acquired by any of the backup nodes if a power failure happens on |
@@ -1070,7 +1362,7 @@ Configuration complete.</programlisting> | |||
1070 | <section id="ha_upgrade"> | 1362 | <section id="ha_upgrade"> |
1071 | <title>Upgrading a High Availability Deployment</title> | 1363 | <title>Upgrading a High Availability Deployment</title> |
1072 | 1364 | ||
1073 | <para>Upgrading a High Availabilty deployment is a highly complex, | 1365 | <para>Upgrading a High Availability deployment is a highly complex, |
1074 | multi-step process that requires care to ensure both consistency and | 1366 | multi-step process that requires care to ensure both consistency and |
1075 | high-availability. Some steps need to be done manually.</para> | 1367 | high-availability. Some steps need to be done manually.</para> |
1076 | 1368 | ||
@@ -1163,4 +1455,4 @@ Configuration complete.</programlisting> | |||
1163 | </orderedlist> | 1455 | </orderedlist> |
1164 | </section> | 1456 | </section> |
1165 | </section> | 1457 | </section> |
1166 | </chapter> | 1458 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-edge-getting-started/doc/book.xml b/doc/book-enea-edge-getting-started/doc/book.xml index 07021cb..e74ac85 100644 --- a/doc/book-enea-edge-getting-started/doc/book.xml +++ b/doc/book-enea-edge-getting-started/doc/book.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="UTF-8"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ |
4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> | 4 | <!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> |
@@ -7,10 +7,9 @@ | |||
7 | <title><trademark class="registered">Enea</trademark> Edge Getting | 7 | <title><trademark class="registered">Enea</trademark> Edge Getting |
8 | Started</title> | 8 | Started</title> |
9 | 9 | ||
10 | <subtitle>Release Version <xi:include | 10 | <subtitle>Release Version <xi:include href="../../eltf_params_updated.xml" |
11 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" | ||
12 | xmlns:xi="http://www.w3.org/2001/XInclude" | 11 | xmlns:xi="http://www.w3.org/2001/XInclude" |
13 | xpointer="element(EneaLinux_REL_VER/1)" /></subtitle> | 12 | xpointer="element(EneaEdge_REL_VER/1)" /></subtitle> |
14 | 13 | ||
15 | <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> | 14 | <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> |
16 | 15 | ||
@@ -37,6 +36,8 @@ | |||
37 | <xi:include href="log_collector.xml" | 36 | <xi:include href="log_collector.xml" |
38 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 37 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
39 | 38 | ||
39 | <xi:include href="submaps.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
40 | |||
40 | <xi:include href="grafana.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | 41 | <xi:include href="grafana.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> |
41 | 42 | ||
42 | <xi:include href="troubleshooting.xml" | 43 | <xi:include href="troubleshooting.xml" |
diff --git a/doc/book-enea-edge-getting-started/doc/images/debug_settings.png b/doc/book-enea-edge-getting-started/doc/images/debug_settings.png index 2c97b2c..7bd9be2 100755 --- a/doc/book-enea-edge-getting-started/doc/images/debug_settings.png +++ b/doc/book-enea-edge-getting-started/doc/images/debug_settings.png | |||
Binary files differ | |||
diff --git a/doc/book-enea-edge-getting-started/doc/images/edit_inter.png b/doc/book-enea-edge-getting-started/doc/images/edit_inter.png index fddde37..33015fa 100755 --- a/doc/book-enea-edge-getting-started/doc/images/edit_inter.png +++ b/doc/book-enea-edge-getting-started/doc/images/edit_inter.png | |||
Binary files differ | |||
diff --git a/doc/book-enea-edge-getting-started/doc/images/onboard_a_vnf_image.png b/doc/book-enea-edge-getting-started/doc/images/onboard_a_vnf_image.png index da52202..773c1ef 100755 --- a/doc/book-enea-edge-getting-started/doc/images/onboard_a_vnf_image.png +++ b/doc/book-enea-edge-getting-started/doc/images/onboard_a_vnf_image.png | |||
Binary files differ | |||
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 | |||
diff --git a/doc/book-enea-edge-getting-started/doc/installation_guide.xml b/doc/book-enea-edge-getting-started/doc/installation_guide.xml index 477b5c4..da62568 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml | |||
@@ -92,14 +92,14 @@ | |||
92 | <para>One or more uCPE devices.</para> | 92 | <para>One or more uCPE devices.</para> |
93 | 93 | ||
94 | <para>Whitebox devices where the Enea Edge Runtime will be installed, | 94 | <para>Whitebox devices where the Enea Edge Runtime will be installed, |
95 | containing a minimum of 2 cores and 4 GB RAM and at least two ethernet | 95 | containing a minimum of 2 cores and 2 GB RAM and at least two ethernet |
96 | ports that will be configured as WAN and LAN during deployment.</para> | 96 | ports that will be configured as WAN and LAN during deployment.</para> |
97 | 97 | ||
98 | <para>When hosting an entire solution including one or several network | 98 | <para>When hosting an entire solution including one or several network |
99 | services, the hardware must also have the resources to host one or | 99 | services, the hardware must also have the resources to host one or |
100 | more VNFs. During a typical evaluation, a dual VNF service on the Enea | 100 | more VNFs. A dual VNF service on the Enea Edge Runtime typically needs |
101 | Edge Runtime needs a CPU with 4-8 cores and at least 8 GB RAM. The | 101 | a CPU with 4-8 cores and at least 8 GB RAM. The supported Intel CPUs |
102 | supported Intel CPUs of Enea Edge are documented in the <xi:include | 102 | of Enea Edge are documented in the <xi:include |
103 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | 103 | href="../../s_docbuild/olinkdb/pardoc-common.xml" |
104 | xmlns:xi="http://www.w3.org/2001/XInclude" | 104 | xmlns:xi="http://www.w3.org/2001/XInclude" |
105 | xpointer="element(book_enea_edge_release_info/1)" /> Manual.</para> | 105 | xpointer="element(book_enea_edge_release_info/1)" /> Manual.</para> |
@@ -121,12 +121,13 @@ | |||
121 | 121 | ||
122 | <listitem> | 122 | <listitem> |
123 | <para>Connecting to the GUI of the Enea Edge Management | 123 | <para>Connecting to the GUI of the Enea Edge Management |
124 | application for management and configuration. Network access | 124 | application for management and configuration.</para> |
125 | between the CentOS 7 server and the laptop is required. Please see | 125 | |
126 | the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 126 | <note> |
127 | xmlns:xi="http://www.w3.org/2001/XInclude" | 127 | <para>Network access between the CentOS 7 server and the laptop |
128 | xpointer="element(book_enea_edge_release_info/1)" /> Manual | 128 | is required. The recommended browser for the current release is |
129 | available with your release, for recommended browsers.</para> | 129 | Google Chrome.</para> |
130 | </note> | ||
130 | </listitem> | 131 | </listitem> |
131 | </itemizedlist> | 132 | </itemizedlist> |
132 | </listitem> | 133 | </listitem> |
@@ -479,12 +480,12 @@ userdel postgres</programlisting> | |||
479 | <literal>Enea_Edge_Management_<version>-build<build_number>.tar.gz</literal></para> | 480 | <literal>Enea_Edge_Management_<version>-build<build_number>.tar.gz</literal></para> |
480 | 481 | ||
481 | <para>The directory in which the archive has been unpacked will be | 482 | <para>The directory in which the archive has been unpacked will be |
482 | denoted as: <literal><uCPEM-installerdir></literal>.</para> | 483 | denoted as: <literal><EEMg-installerdir></literal>.</para> |
483 | </listitem> | 484 | </listitem> |
484 | 485 | ||
485 | <listitem> | 486 | <listitem> |
486 | <para>Enter | 487 | <para>Enter |
487 | <literal><uCPEM-installerdir>/dist</literal>.</para> | 488 | <literal><EEMg-installerdir>/dist</literal>.</para> |
488 | </listitem> | 489 | </listitem> |
489 | 490 | ||
490 | <listitem> | 491 | <listitem> |
@@ -503,7 +504,7 @@ userdel postgres</programlisting> | |||
503 | <para>Run the following interactive command:</para> | 504 | <para>Run the following interactive command:</para> |
504 | 505 | ||
505 | <programlisting>./install.sh /opt/ems \ | 506 | <programlisting>./install.sh /opt/ems \ |
506 | Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</programlisting> | 507 | Enea_Edge_Management_<version>-build<build_number>.tar.gz</programlisting> |
507 | 508 | ||
508 | <para>The default configuration values are specified in brackets. | 509 | <para>The default configuration values are specified in brackets. |
509 | If no other value is preferred and typed in, pressing | 510 | If no other value is preferred and typed in, pressing |
@@ -565,12 +566,12 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
565 | <itemizedlist spacing="compact"> | 566 | <itemizedlist spacing="compact"> |
566 | <listitem> | 567 | <listitem> |
567 | <para>Specify a service username | 568 | <para>Specify a service username |
568 | <literal>[ucpemanager]:</literal></para> | 569 | <literal>[EneaEdgeManagement]</literal>:</para> |
569 | </listitem> | 570 | </listitem> |
570 | 571 | ||
571 | <listitem> | 572 | <listitem> |
572 | <para>Specify a service password | 573 | <para>Specify a service password |
573 | <literal>[ucpemanager]</literal>:</para> | 574 | <literal>[EneaEdgeManagement]</literal>:</para> |
574 | </listitem> | 575 | </listitem> |
575 | </itemizedlist> | 576 | </itemizedlist> |
576 | </listitem> | 577 | </listitem> |
@@ -593,35 +594,51 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
593 | </listitem> | 594 | </listitem> |
594 | 595 | ||
595 | <listitem> | 596 | <listitem> |
596 | <para>Create the self-signed certificate: <literal>Specify IP or domain name</literal> | 597 | <para>Create the self-signed certificate: <literal>Specify IP |
597 | (or press <literal>Enter</literal> to skip):</para> | 598 | or domain name</literal> (or press <literal>Enter</literal> to |
598 | 599 | skip):</para> | |
599 | <para>The Tomcat self-signed certificate can be generated | 600 | |
600 | again by running the | 601 | <para>The Tomcat self-signed certificate can be generated |
601 | <filename>createCertificate.sh</filename>. For more details, please see <olink | 602 | again by running the |
602 | targetdoc="book_enea_edge_getting_started" | 603 | <filename>createCertificate.sh</filename>. For more details, |
603 | targetptr="create_certificate">Tomcat Certificate | 604 | please see <olink targetdoc="book_enea_edge_getting_started" |
604 | Generation in the <ns:include | 605 | targetptr="create_certificate">Tomcat Certificate Generation |
605 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 606 | in the <ns:include |
606 | xpointer="element(book_enea_edge_getting_started/1)" | 607 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
607 | xmlns:ns="http://www.w3.org/2001/XInclude" /></olink> Manual.</para> | 608 | xmlns:ns="http://www.w3.org/2001/XInclude" |
608 | 609 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> | |
610 | Manual.</para> | ||
611 | |||
609 | <note> | 612 | <note> |
610 | <para>The generation of the Tomcat self-signed cerificate | 613 | <para>The generation of the Tomcat self-signed certificate |
611 | should be skipped only if another certifcate will be | 614 | should be skipped only if another certificate will be |
612 | provided.</para> | 615 | provided. In case a custom certificate is used, not |
616 | generated with the <literal>createCertificate.sh</literal> | ||
617 | script, the keystore file containing the certificate must be | ||
618 | manually copied to the <literal> | ||
619 | /opt/ems/ucpemanager/application/config/certificates</literal> | ||
620 | folder, after the installation is done. The application must | ||
621 | then be restarted in order for the certificate to take | ||
622 | effect. The default name of the file is | ||
623 | <filename>.Keystore</filename>.</para> | ||
624 | |||
625 | <para>To change the default name, the configuration file | ||
626 | <filename>server.xml</filename> from the | ||
627 | <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config</literal> | ||
628 | folder must be copied to | ||
629 | <literal>/opt/ems/ucpemanager/application/config/</literal>. | ||
630 | The <literal>keystoreFile</literal> attribute from the | ||
631 | <literal><Connector executor="tomcatThreadPool"</literal> | ||
632 | tag must also be changed. Similarly, if a password has been | ||
633 | set, it should be added to the | ||
634 | <literal>keystorePass</literal> attribute: | ||
635 | <literal>keystorePass="NEW_PASSWORD"</literal>.</para> | ||
613 | </note> | 636 | </note> |
614 | </listitem> | 637 | </listitem> |
615 | 638 | ||
616 | <listitem> | 639 | <listitem> |
617 | <para>Heap Configuration:</para> | 640 | <para>Heap Configuration: <literal>Please enter the new |
618 | 641 | Maximum Heap Size [4g]</literal>:</para> | |
619 | <itemizedlist spacing="compact"> | ||
620 | <listitem> | ||
621 | <para>Please enter the new Maximum Heap Size | ||
622 | [4g]:</para> | ||
623 | </listitem> | ||
624 | </itemizedlist> | ||
625 | </listitem> | 642 | </listitem> |
626 | </itemizedlist> | 643 | </itemizedlist> |
627 | 644 | ||
@@ -649,16 +666,17 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
649 | </listitem> | 666 | </listitem> |
650 | 667 | ||
651 | <listitem> | 668 | <listitem> |
652 | <para>Using the IPv4 address of the CentOS 7 Server in a web | 669 | <para>Using the IPv4 address or the FQDN of the CentOS 7 Server in |
653 | browser, running on the laptop, log into the Enea Edge Management | 670 | a web browser, running on the laptop, log into the Enea Edge |
654 | GUI using the default username and password: | 671 | Management GUI using the default username and password: |
655 | <literal>admin/admin</literal>.</para> | 672 | <literal>admin/admin</literal>.</para> |
656 | </listitem> | 673 | </listitem> |
657 | </orderedlist> | 674 | </orderedlist> |
658 | 675 | ||
659 | <note> | 676 | <note> |
660 | <para>The IPv4 address of the CentOS 7 Server will be used as a configuration | 677 | <para>The IPv4 address or the FQDN of the CentOS 7 Server will be |
661 | parameter when setting up the uCPE devices.</para> | 678 | used as a configuration parameter when setting up the uCPE |
679 | devices.</para> | ||
662 | 680 | ||
663 | <para>If the CentOS 7 Server is installed behind NAT, the IPv4 | 681 | <para>If the CentOS 7 Server is installed behind NAT, the IPv4 |
664 | address used will be the public IP of the NAT device and port | 682 | address used will be the public IP of the NAT device and port |
@@ -692,9 +710,9 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
692 | GUI (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is | 710 | GUI (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is |
693 | different from the snapshot obtained during an Enea Edge Management | 711 | different from the snapshot obtained during an Enea Edge Management |
694 | Upgrade or Uninstall operation | 712 | Upgrade or Uninstall operation |
695 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) needed | 713 | (<filename>EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz</filename>) |
696 | for recovery of the Enea Edge Management application. For more | 714 | needed for recovery of the Enea Edge Management application. For |
697 | details, see <olink targetdoc="book_enea_edge_getting_started" | 715 | more details, see <olink targetdoc="book_enea_edge_getting_started" |
698 | targetptr="restore_prev_ucpe_install">Restoring a previous Enea Edge | 716 | targetptr="restore_prev_ucpe_install">Restoring a previous Enea Edge |
699 | Management installation in the <xi:include | 717 | Management installation in the <xi:include |
700 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 718 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
@@ -708,7 +726,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
708 | installation:</para> | 726 | installation:</para> |
709 | 727 | ||
710 | <programlisting>./install.sh \ | 728 | <programlisting>./install.sh \ |
711 | /opt/ems Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz \ | 729 | /opt/ems Enea_Edge_Management_<version>-build<build_number>.tar.gz \ |
712 | SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> | 730 | SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> |
713 | </section> | 731 | </section> |
714 | </section> | 732 | </section> |
@@ -754,10 +772,11 @@ sdb 8:0 0 111.8G 0 disk | |||
754 | <para>Copy the <filename>.hddimg</filename> image onto the USB | 772 | <para>Copy the <filename>.hddimg</filename> image onto the USB |
755 | stick, e.g:</para> | 773 | stick, e.g:</para> |
756 | 774 | ||
757 | <programlisting>sudo dd if=./enea-nfv-access-<machine>.hddimg \ | 775 | <programlisting>sudo dd if=./enea-edge-runtime-<processor>.hddimg \ |
758 | of=/dev/sdb bs=4M conv=fsync</programlisting> | 776 | of=/dev/sdb bs=4M conv=fsync</programlisting> |
759 | 777 | ||
760 | <para>Where <filename>enea-nfv-access-<machine>.hddimg</filename> is | 778 | <para>Where |
779 | <filename>enea-edge-runtime-<processor>.hddimg</filename> is | ||
761 | the <filename>.hddimg</filename> file and <literal>sdb</literal> is | 780 | the <filename>.hddimg</filename> file and <literal>sdb</literal> is |
762 | the assigned USB device name.</para> | 781 | the assigned USB device name.</para> |
763 | </listitem> | 782 | </listitem> |
@@ -767,7 +786,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
767 | <section id="prep_phys_deploy"> | 786 | <section id="prep_phys_deploy"> |
768 | <title>Preparing Physical Deployment for Installation</title> | 787 | <title>Preparing Physical Deployment for Installation</title> |
769 | 788 | ||
770 | <figure> | 789 | <figure id="prep_hw_installation"> |
771 | <title>Preparing for Hardware Installation</title> | 790 | <title>Preparing for Hardware Installation</title> |
772 | 791 | ||
773 | <mediaobject> | 792 | <mediaobject> |
@@ -911,15 +930,16 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
911 | be entered here (if needed), are the tag(s) specified when | 930 | be entered here (if needed), are the tag(s) specified when |
912 | creating an offline configuration in the Enea Edge Management | 931 | creating an offline configuration in the Enea Edge Management |
913 | application. A later addition of customer tags can only be done | 932 | application. A later addition of customer tags can only be done |
914 | by reinstalling the uCPE devices.</para> | 933 | by re-installing the uCPE devices.</para> |
915 | </listitem> | 934 | </listitem> |
916 | </itemizedlist> | 935 | </itemizedlist> |
917 | </listitem> | 936 | </listitem> |
918 | 937 | ||
919 | <listitem> | 938 | <listitem> |
920 | <para>Connect the WAN cable to the uCPE device (see Figure 2). This | 939 | <para>Connect the WAN cable to the uCPE device (see <link |
921 | will be used as the uCPE management network interface, as described | 940 | linkend="prep_hw_installation">Figure 2.1 Preparing for Hardware |
922 | below.</para> | 941 | Installation</link>). This will be used as the uCPE management |
942 | network interface, as described below.</para> | ||
923 | </listitem> | 943 | </listitem> |
924 | 944 | ||
925 | <listitem> | 945 | <listitem> |
@@ -934,8 +954,31 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
934 | </listitem> | 954 | </listitem> |
935 | 955 | ||
936 | <listitem> | 956 | <listitem> |
937 | <para>Plug-in additional WAN interfaces (if applicable) and | 957 | <para>Plug in additional WAN interfaces (if applicable) and |
938 | provide their Layer 3 configuration.</para> | 958 | provide their Layer 3 configuration. An interface can be |
959 | configured in <literal>dhcp</literal> or | ||
960 | <literal>static</literal> mode. When configured in static mode, | ||
961 | the following options are available:</para> | ||
962 | |||
963 | <itemizedlist spacing="compact"> | ||
964 | <listitem> | ||
965 | <para>Static IP (mandatory)</para> | ||
966 | </listitem> | ||
967 | |||
968 | <listitem> | ||
969 | <para>Netmask (mandatory)</para> | ||
970 | </listitem> | ||
971 | |||
972 | <listitem> | ||
973 | <para>Gateway (mandatory)</para> | ||
974 | </listitem> | ||
975 | |||
976 | <listitem> | ||
977 | <para>DNS Server List (a comma separated list of IPv4 | ||
978 | addresses) (optional). If left empty it will use the Gateway | ||
979 | as the DNS, with 1.1.1.1 as fallback.</para> | ||
980 | </listitem> | ||
981 | </itemizedlist> | ||
939 | </listitem> | 982 | </listitem> |
940 | </itemizedlist> | 983 | </itemizedlist> |
941 | </listitem> | 984 | </listitem> |
@@ -963,7 +1006,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
963 | <section id="prep_phys_exec"> | 1006 | <section id="prep_phys_exec"> |
964 | <title>Preparing Physical Deployment for Execution</title> | 1007 | <title>Preparing Physical Deployment for Execution</title> |
965 | 1008 | ||
966 | <figure> | 1009 | <figure id="prep_deploy_execution"> |
967 | <title>Preparing for Deployment Execution</title> | 1010 | <title>Preparing for Deployment Execution</title> |
968 | 1011 | ||
969 | <mediaobject> | 1012 | <mediaobject> |
@@ -1138,8 +1181,9 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1138 | (disconnected) in the Enea Edge Management application. The uCPE device | 1181 | (disconnected) in the Enea Edge Management application. The uCPE device |
1139 | configuration can be corrected by removing the WAN cable(s), | 1182 | configuration can be corrected by removing the WAN cable(s), |
1140 | reconnecting the laptop to the LAN interface of the uCPE device and | 1183 | reconnecting the laptop to the LAN interface of the uCPE device and |
1141 | rebooting it. At this point, the Web-installer can be accessed from the | 1184 | rebooting it. After a timeout of a few minutes, the Web-installer can be |
1142 | laptop as described in <olink targetdoc="book_enea_edge_getting_started" | 1185 | accessed from the laptop as described in <olink |
1186 | targetdoc="book_enea_edge_getting_started" | ||
1143 | targetptr="install_ena_device">Installing Enea Edge - uCPE Device | 1187 | targetptr="install_ena_device">Installing Enea Edge - uCPE Device |
1144 | installation in the <xi:include | 1188 | installation in the <xi:include |
1145 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 1189 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
@@ -1156,7 +1200,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1156 | application, it is ready for central management. Two important functions | 1200 | application, it is ready for central management. Two important functions |
1157 | available in the Enea Edge Management GUI are alarm checking and resource | 1201 | available in the Enea Edge Management GUI are alarm checking and resource |
1158 | allocation. Additionally, the device can be rebooted, the factory settings | 1202 | allocation. Additionally, the device can be rebooted, the factory settings |
1159 | can be restored or simply the vCPE service can be restarted.</para> | 1203 | can be restored or simply the Enea Edge Management Agent service can be |
1204 | restarted.</para> | ||
1160 | 1205 | ||
1161 | <section id="check_alarms"> | 1206 | <section id="check_alarms"> |
1162 | <title>Checking Alarms</title> | 1207 | <title>Checking Alarms</title> |
@@ -1182,17 +1227,17 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1182 | in use.</para> | 1227 | in use.</para> |
1183 | 1228 | ||
1184 | <para>To check CPU, RAM and disk utilization simply select the uCPE | 1229 | <para>To check CPU, RAM and disk utilization simply select the uCPE |
1185 | device and go to the <emphasis role="bold">Virtual Machines</emphasis> | 1230 | device and go to the device view tab (the tab bears the device name |
1186 | tab in the map view. The same view will show active VNFs running on the | 1231 | as its title). The same view will show active VNFs running on the |
1187 | uCPE device once instantiated.</para> | 1232 | uCPE device once instantiated.</para> |
1188 | </section> | 1233 | </section> |
1189 | 1234 | ||
1190 | <section id="basic_oper_device"> | 1235 | <section id="basic_oper_device"> |
1191 | <title>Basic operations for uCPE device Managememt</title> | 1236 | <title>Basic operations for uCPE device Management</title> |
1192 | 1237 | ||
1193 | <para>When the uCPE device is connected to the Enea Edge Management | 1238 | <para>When the uCPE device is connected to the Enea Edge Management |
1194 | application, it can be rebooted, the factory settings can be restored or | 1239 | application, it can be rebooted, the factory settings can be restored or |
1195 | simply the vCPE service can be restarted.</para> | 1240 | simply the Enea Edge Management Agent service can be restarted.</para> |
1196 | 1241 | ||
1197 | <para>Select the uCPE device and go to the <emphasis | 1242 | <para>Select the uCPE device and go to the <emphasis |
1198 | role="bold">Operations</emphasis> menu, where the following options are | 1243 | role="bold">Operations</emphasis> menu, where the following options are |
@@ -1207,20 +1252,23 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1207 | <listitem> | 1252 | <listitem> |
1208 | <para><emphasis role="bold">Factory reset</emphasis>. Resets the | 1253 | <para><emphasis role="bold">Factory reset</emphasis>. Resets the |
1209 | device to its default factory settings. All current configuration | 1254 | device to its default factory settings. All current configuration |
1210 | settings are lost. All running VNFs are destroyed. Any installed | 1255 | settings are lost. All running VNFs are destroyed. All uploaded VM |
1211 | custom scripts will be removed and they will need to be | 1256 | image files are deleted. Existing log files will be kept.</para> |
1212 | reinstalled.</para> | ||
1213 | 1257 | ||
1214 | <para>Only the vCPE service will be restarted, the device will not | 1258 | <para>This command will only restart the Enea Edge Management Agent |
1215 | be rebooted. No reboot is needed.</para> | 1259 | service, the device will not be rebooted. No reboot is |
1260 | needed.</para> | ||
1216 | 1261 | ||
1217 | <para>Once the vCPE service restart completes, appropriate day-0 | 1262 | <para>Once the service restart completes, appropriate day-0 |
1218 | provisioning will take place.</para> | 1263 | provisioning will take place. Previously installed custom scripts |
1264 | will be reinstalled on the uCPE device, and upon receiving the | ||
1265 | custom script(s), the device will reboot.</para> | ||
1219 | </listitem> | 1266 | </listitem> |
1220 | 1267 | ||
1221 | <listitem> | 1268 | <listitem> |
1222 | <para><emphasis role="bold">Restart Vcpe</emphasis>. Restarts the | 1269 | <para><emphasis role="bold">Restart Vcpe</emphasis>. Restarts the |
1223 | vCPE service on the device. The device will not be rebooted.</para> | 1270 | Enea Edge Management Agent service. The device will not be |
1271 | rebooted.</para> | ||
1224 | </listitem> | 1272 | </listitem> |
1225 | </itemizedlist> | 1273 | </itemizedlist> |
1226 | </section> | 1274 | </section> |
@@ -1252,4 +1300,4 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1252 | </note> | 1300 | </note> |
1253 | </section> | 1301 | </section> |
1254 | </section> | 1302 | </section> |
1255 | </chapter> | 1303 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-edge-getting-started/doc/introduction.xml b/doc/book-enea-edge-getting-started/doc/introduction.xml index eaa5521..8f1e854 100644 --- a/doc/book-enea-edge-getting-started/doc/introduction.xml +++ b/doc/book-enea-edge-getting-started/doc/introduction.xml | |||
@@ -62,7 +62,7 @@ | |||
62 | <para>Enea Edge Runtime is a lightweight, multi-architecture | 62 | <para>Enea Edge Runtime is a lightweight, multi-architecture |
63 | virtualization platform built on de-facto standards in an SDN/NFV | 63 | virtualization platform built on de-facto standards in an SDN/NFV |
64 | ecosystem. It is designed for a high networking performance with minimal | 64 | ecosystem. It is designed for a high networking performance with minimal |
65 | hardware footprint, by only providing relevant functionalties and | 65 | hardware footprint, by only providing relevant functionalities and |
66 | technologies.</para> | 66 | technologies.</para> |
67 | 67 | ||
68 | <para>Virtualization methods include Virtual Machines (KVM / QEMU) and | 68 | <para>Virtualization methods include Virtual Machines (KVM / QEMU) and |
@@ -70,7 +70,7 @@ | |||
70 | ensured by an accelerated data plane relying on technologies like DPDK, | 70 | ensured by an accelerated data plane relying on technologies like DPDK, |
71 | OVS-DPDK and SR-IOV/PCI-Passthrough. Key functionalities, such as | 71 | OVS-DPDK and SR-IOV/PCI-Passthrough. Key functionalities, such as |
72 | platform software management, virtualized networking, VNFs life-cycle | 72 | platform software management, virtualized networking, VNFs life-cycle |
73 | management and FCAPS are provided through the YANG-modelled NETCONF | 73 | management and FCAPS are provided through the YANG-modeled NETCONF |
74 | protocol.</para> | 74 | protocol.</para> |
75 | 75 | ||
76 | <figure> | 76 | <figure> |
diff --git a/doc/book-enea-edge-getting-started/doc/log_collector.xml b/doc/book-enea-edge-getting-started/doc/log_collector.xml index 1148dc2..3499978 100644 --- a/doc/book-enea-edge-getting-started/doc/log_collector.xml +++ b/doc/book-enea-edge-getting-started/doc/log_collector.xml | |||
@@ -340,7 +340,7 @@ | |||
340 | <para>Often, sending the Enea Edge Management logs together with | 340 | <para>Often, sending the Enea Edge Management logs together with |
341 | collected uCPE device logs to the support team provides important | 341 | collected uCPE device logs to the support team provides important |
342 | information for troubleshooting (especially in cases of connectivity | 342 | information for troubleshooting (especially in cases of connectivity |
343 | issues with the uCPE device and error popups).</para> | 343 | issues with the uCPE device and error pop-ups).</para> |
344 | 344 | ||
345 | <para>Enea Edge Management log files are located in | 345 | <para>Enea Edge Management log files are located in |
346 | <filename>application/logs/</filename> in the Enea Edge Management | 346 | <filename>application/logs/</filename> in the Enea Edge Management |
@@ -358,14 +358,14 @@ | |||
358 | 358 | ||
359 | <listitem> | 359 | <listitem> |
360 | <para>Select the desired log file | 360 | <para>Select the desired log file |
361 | (<filename>ucpemanager.log</filename> or | 361 | (<filename>EneaEdgeManagement.log</filename> or |
362 | <filename>watchdog.log</filename>) and press the <emphasis | 362 | <filename>watchdog.log</filename>) and press the <emphasis |
363 | role="bold">Download</emphasis> button.</para> | 363 | role="bold">Download</emphasis> button.</para> |
364 | </listitem> | 364 | </listitem> |
365 | 365 | ||
366 | <listitem> | 366 | <listitem> |
367 | <para>A new (blank) popup window opens and the file is downloaded | 367 | <para>A new (blank) pop-up window opens and the file is downloaded |
368 | locally. This popup can be closed after the download.</para> | 368 | locally. This pop-up can be closed after the download.</para> |
369 | </listitem> | 369 | </listitem> |
370 | 370 | ||
371 | <listitem> | 371 | <listitem> |
@@ -394,7 +394,7 @@ | |||
394 | <para>Log collection from uCPE Devices can also be done when there is no | 394 | <para>Log collection from uCPE Devices can also be done when there is no |
395 | Enea Edge Management connection. A SSH connection to the uCPE Device is | 395 | Enea Edge Management connection. A SSH connection to the uCPE Device is |
396 | needed for use of the log collector script, which can be found in the uCPE | 396 | needed for use of the log collector script, which can be found in the uCPE |
397 | Device file system in <literal>/usr/local/enea/</literal>.</para> | 397 | Device file system in <literal>/usr/enea/</literal>.</para> |
398 | 398 | ||
399 | <para>The Log collector script takes relevant information about the system | 399 | <para>The Log collector script takes relevant information about the system |
400 | and collects it in an archive:</para> | 400 | and collects it in an archive:</para> |
diff --git a/doc/book-enea-edge-getting-started/doc/net_config_options.xml b/doc/book-enea-edge-getting-started/doc/net_config_options.xml index ff513c9..a9faf0a 100644 --- a/doc/book-enea-edge-getting-started/doc/net_config_options.xml +++ b/doc/book-enea-edge-getting-started/doc/net_config_options.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="UTF-8"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
2 | <chapter id="net_config_operations"> | 2 | <chapter id="net_config_operations"> |
3 | <title>Network Configuration Options</title> | 3 | <title>Network Configuration Options</title> |
4 | 4 | ||
@@ -218,9 +218,9 @@ | |||
218 | 218 | ||
219 | <listitem> | 219 | <listitem> |
220 | <para>In order to edit an already configured interface, (as in the | 220 | <para>In order to edit an already configured interface, (as in the |
221 | example popup shown below, a WAN interface) double click on the | 221 | example pop-up shown below, a WAN interface) double click on the |
222 | desired one and a popup will appear. A different popup appears for | 222 | desired one and a pop-up will appear. A different pop-up appears |
223 | each type of interface. From the <emphasis role="bold">Host | 223 | for each type of interface. From the <emphasis role="bold">Host |
224 | Interface</emphasis> window, a user can change the networking type | 224 | Interface</emphasis> window, a user can change the networking type |
225 | and the IP address assignment:</para> | 225 | and the IP address assignment:</para> |
226 | 226 | ||
@@ -240,9 +240,10 @@ | |||
240 | <note> | 240 | <note> |
241 | <para>When changing the <literal>address-assignment</literal> from | 241 | <para>When changing the <literal>address-assignment</literal> from |
242 | static to DHCP, if any of the <literal>ip-address</literal>, | 242 | static to DHCP, if any of the <literal>ip-address</literal>, |
243 | <literal>netmask</literal> or <literal>gateway</literal> fields have | 243 | <literal>netmask</literal>, <literal>gateway</literal> or |
244 | invalid values a validation error will be triggered. These fields | 244 | <literal>dns-servers</literal> fields have invalid values a |
245 | must be empty or have the valid values for their respective address | 245 | validation error will be triggered. These fields must be empty or |
246 | have the valid values for their respective address | ||
246 | assignment.</para> | 247 | assignment.</para> |
247 | </note> | 248 | </note> |
248 | </section> | 249 | </section> |
@@ -270,7 +271,7 @@ | |||
270 | 271 | ||
271 | <listitem> | 272 | <listitem> |
272 | <para>In order to edit an already configured interface, (as in the | 273 | <para>In order to edit an already configured interface, (as in the |
273 | example popup shown below, a WAP interface) double click on the | 274 | example pop-up shown below, a WAP interface) double click on the |
274 | desired one and a pop-up will appear. A different pop-up appears | 275 | desired one and a pop-up will appear. A different pop-up appears |
275 | for each type of interface. From the <literal>Host | 276 | for each type of interface. From the <literal>Host |
276 | Interface</literal> window, the following parameters are | 277 | Interface</literal> window, the following parameters are |
@@ -385,7 +386,7 @@ | |||
385 | </note> | 386 | </note> |
386 | 387 | ||
387 | <para>There are three types of bridges which can be created, each one | 388 | <para>There are three types of bridges which can be created, each one |
388 | fulfiling a different role.</para> | 389 | fulfilling a different role.</para> |
389 | 390 | ||
390 | <section id="inband_mg_bridge"> | 391 | <section id="inband_mg_bridge"> |
391 | <title>uCPE In-band Management bridge</title> | 392 | <title>uCPE In-band Management bridge</title> |
@@ -580,9 +581,9 @@ | |||
580 | 581 | ||
581 | <listitem> | 582 | <listitem> |
582 | <para>DeviceVersion: <xi:include | 583 | <para>DeviceVersion: <xi:include |
583 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" | 584 | href="../../eltf_params_updated.xml" |
584 | xmlns:xi="http://www.w3.org/2001/XInclude" | 585 | xmlns:xi="http://www.w3.org/2001/XInclude" |
585 | xpointer="element(EneaLinux_REL_VER/1)" /></para> | 586 | xpointer="element(EneaEdge_REL_VER/1)" /></para> |
586 | </listitem> | 587 | </listitem> |
587 | 588 | ||
588 | <listitem> | 589 | <listitem> |
@@ -651,10 +652,15 @@ | |||
651 | <title>Custom Scripts for Custom Networking Configurations</title> | 652 | <title>Custom Scripts for Custom Networking Configurations</title> |
652 | 653 | ||
653 | <para>The custom scripts feature allows users to execute user-defined | 654 | <para>The custom scripts feature allows users to execute user-defined |
654 | scripts on the uCPE device at various times.This allows for more flexible | 655 | scripts on the uCPE device at various times. This allows for more flexible |
655 | and advanced configurations such as a LTE modem configuration, advanced | 656 | and advanced configurations such as a LTE modem configuration, advanced |
656 | network configurations or OVS flow rule programming at any time.</para> | 657 | network configurations or OVS flow rule programming at any time.</para> |
657 | 658 | ||
659 | <note> | ||
660 | <para>In the current Enea Edge Management application version custom | ||
661 | scripts are not supported as part of the offline config.</para> | ||
662 | </note> | ||
663 | |||
658 | <section id="upload_scripts"> | 664 | <section id="upload_scripts"> |
659 | <title>Uploading Scripts</title> | 665 | <title>Uploading Scripts</title> |
660 | 666 | ||
@@ -678,8 +684,8 @@ | |||
678 | </listitem> | 684 | </listitem> |
679 | 685 | ||
680 | <listitem> | 686 | <listitem> |
681 | <para><literal>Once-after-startup</literal>. The script will always | 687 | <para><literal>Once-after-startup</literal>. The script will only |
682 | execute after the system has rebooted, after all device | 688 | execute once after the system has rebooted, after all device |
683 | configuration processes have completed.</para> | 689 | configuration processes have completed.</para> |
684 | </listitem> | 690 | </listitem> |
685 | 691 | ||
@@ -720,6 +726,16 @@ | |||
720 | role="bold">Send</emphasis>.</para> | 726 | role="bold">Send</emphasis>.</para> |
721 | </listitem> | 727 | </listitem> |
722 | </orderedlist> | 728 | </orderedlist> |
729 | |||
730 | <note> | ||
731 | <para>If two scripts are uploaded one at a time, the Enea Edge | ||
732 | Management application will delete the first script already added from | ||
733 | the device and apply the new one. In order for both scripts to be available on | ||
734 | the device, both scripts must be uploaded at once.</para> | ||
735 | |||
736 | <para>If multiple custom scripts of the same type are uploaded at the | ||
737 | same time, they are executed in alphabetical order.</para> | ||
738 | </note> | ||
723 | </section> | 739 | </section> |
724 | 740 | ||
725 | <section id="remove_scripts"> | 741 | <section id="remove_scripts"> |
@@ -900,14 +916,32 @@ | |||
900 | </mediaobject> | 916 | </mediaobject> |
901 | </figure> | 917 | </figure> |
902 | 918 | ||
903 | <note> | 919 | <para>Only a single Wireless AP is allowed on a physical interface. The |
904 | <para>Only a single Wireless AP is allowed on a physical interface. The | ||
905 | validation of the <literal>wap-capable</literal> interface is done when | 920 | validation of the <literal>wap-capable</literal> interface is done when |
906 | adding the Wireless AP, so, in case of an error, the parameters of the | 921 | adding the Wireless AP, so, in case of an error, the parameters of the |
907 | <literal>wap-capable</literal> interface must be rechecked. This can be | 922 | <literal>wap-capable</literal> interface must be rechecked. This can be |
908 | done by accessing the <emphasis role="bold">Configuration</emphasis> | 923 | done by accessing the <emphasis role="bold">Configuration</emphasis> |
909 | menu and selecting <emphasis role="bold">External | 924 | menu and selecting <emphasis role="bold">External |
910 | Interfaces</emphasis>.</para> | 925 | Interfaces</emphasis>.</para> |
926 | |||
927 | <note> | ||
928 | <para>For the 2.4GHz band, the <literal>802.11 g/n</literal> wireless | ||
929 | mode will use a 40MHz channel width by default. For regulatory | ||
930 | requirements compliance, channels are scanned in order to avoid | ||
931 | overlapping with existing networks. If overlaps are detected, primary | ||
932 | and secondary Wireless AP channels will be swapped, resulting in an | ||
933 | effective channel width of 20MHz instead of 40Mhz being used. | ||
934 | To avoid this, select another wireless channel.</para> | ||
935 | |||
936 | <para>For the 5GHz band, the <literal>802.11 n</literal> and the | ||
937 | <literal>802.11 ac/n</literal> wireless modes can be configured | ||
938 | explicitly to use a specific channel number, even when Automatic | ||
939 | Channel Selection (<literal>ACS</literal>) is available. For regulatory | ||
940 | requirements compliance, channels are scanned in order to avoid | ||
941 | overlapping with existing networks. If overlaps are detected, | ||
942 | <literal>ACS</literal> will try to find another free channel, | ||
943 | resulting in a different channel number being used instead of the one | ||
944 | explicitly configured. To avoid this, select another wireless channel.</para> | ||
911 | </note> | 945 | </note> |
912 | </section> | 946 | </section> |
913 | </chapter> \ No newline at end of file | 947 | </chapter> |
diff --git a/doc/book-enea-edge-getting-started/doc/submaps.xml b/doc/book-enea-edge-getting-started/doc/submaps.xml new file mode 100644 index 0000000..bdb769e --- /dev/null +++ b/doc/book-enea-edge-getting-started/doc/submaps.xml | |||
@@ -0,0 +1,344 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <chapter id="submaps"> | ||
3 | <title>Submaps</title> | ||
4 | |||
5 | <para>The System domain of the Enea Edge Managemement application can be | ||
6 | split into different submaps, used to organize the uCPE devices more | ||
7 | effectively. Each domain is organized like a tree, with each submap being | ||
8 | able to have several other submaps within it. Each device can be placed in | ||
9 | only one submap and the user can create virtual links between devices.</para> | ||
10 | |||
11 | <para>Submaps support managed and unmanaged uCPE devices. An unmanaged | ||
12 | device is an icon that looks like a device within the | ||
13 | <emphasis role="bold">Map</emphasis> (it supports links and has a similar | ||
14 | icon) but is not a real managed device.</para> | ||
15 | |||
16 | <section id="submap_op"> | ||
17 | <title>Submap Operations</title> | ||
18 | |||
19 | <para>In the <emphasis role="bold">System</emphasis> view, right-clicking | ||
20 | on a submap opens up a menu with the following operations:</para> | ||
21 | |||
22 | <itemizedlist> | ||
23 | <listitem> | ||
24 | <para>Add Submap</para> | ||
25 | |||
26 | <para>This option is used for adding a new submap, placed in the | ||
27 | <emphasis role="bold">System</emphasis> view under the current one in | ||
28 | the tree. The new submap will also be added in the <emphasis | ||
29 | role="bold">Map</emphasis> view of the parent submap.</para> | ||
30 | |||
31 | <para>When selecting this option, the following fields need to be set | ||
32 | in the <emphasis role="bold">Add Submap</emphasis> window that | ||
33 | pops-up:</para> | ||
34 | |||
35 | <table id="submap_props"> | ||
36 | <title>Submap properties</title> | ||
37 | |||
38 | <tgroup cols="2"> | ||
39 | <tbody> | ||
40 | <row> | ||
41 | <entry>Name</entry> | ||
42 | |||
43 | <entry>The name of the domain map. This is | ||
44 | mandatory.</entry> | ||
45 | </row> | ||
46 | |||
47 | <row> | ||
48 | <entry>Description</entry> | ||
49 | |||
50 | <entry>A text description of the domain map.</entry> | ||
51 | </row> | ||
52 | |||
53 | <row> | ||
54 | <entry>Background Color</entry> | ||
55 | |||
56 | <entry>The background color of the domain map. Possible | ||
57 | values: white, black, blue, cyan, grey, green, magenta, | ||
58 | orange, pink, red, yellow.</entry> | ||
59 | </row> | ||
60 | |||
61 | <row> | ||
62 | <entry>Background Image</entry> | ||
63 | |||
64 | <entry>The background image of the domain map.</entry> | ||
65 | </row> | ||
66 | |||
67 | <row> | ||
68 | <entry>Icon Image</entry> | ||
69 | |||
70 | <entry>The icon image of the domain map.</entry> | ||
71 | </row> | ||
72 | |||
73 | <row> | ||
74 | <entry>Snap to Grid</entry> | ||
75 | |||
76 | <entry>True if a placed device should snap to the grid | ||
77 | automatically.</entry> | ||
78 | </row> | ||
79 | |||
80 | <row> | ||
81 | <entry>X Grid (px)</entry> | ||
82 | |||
83 | <entry>The number of pixels between placement positions in | ||
84 | the horizontal position in the grid. Disabled if | ||
85 | <literal>Snap to Grid</literal> is false.</entry> | ||
86 | </row> | ||
87 | |||
88 | <row> | ||
89 | <entry>Y Grid (px)</entry> | ||
90 | |||
91 | <entry>The number of pixels between placement positions in | ||
92 | the vertical position in the grid. Disabled if <literal>Snap | ||
93 | to Grid</literal> is false.</entry> | ||
94 | </row> | ||
95 | |||
96 | <row> | ||
97 | <entry>Direction</entry> | ||
98 | |||
99 | <entry>This value describes the direction of sorting the | ||
100 | items (horizontal or vertical).</entry> | ||
101 | </row> | ||
102 | |||
103 | <row> | ||
104 | <entry>Sort Method</entry> | ||
105 | |||
106 | <entry>This value describes the sorting method used when | ||
107 | arranging icons. Natural is [a1,a2,a11] and Alphabetical is | ||
108 | [a1,a11,a2].</entry> | ||
109 | </row> | ||
110 | |||
111 | <row> | ||
112 | <entry>Arrangement Wrap</entry> | ||
113 | |||
114 | <entry>This value indicates the maximum number of items | ||
115 | placed before wrapping to the next row or column.</entry> | ||
116 | </row> | ||
117 | </tbody> | ||
118 | </tgroup> | ||
119 | </table> | ||
120 | |||
121 | <note> | ||
122 | <para><literal>Snap to Grid</literal>, <literal>Direction</literal> | ||
123 | and <literal>Sort Method</literal> have the <literal>System | ||
124 | Default</literal> option. This option can be set by accessing | ||
125 | <emphasis role="bold">System</emphasis>, selecting <emphasis | ||
126 | role="bold">Configuration</emphasis> under the <emphasis | ||
127 | role="bold">Properties</emphasis> tab, and navigating to the <emphasis | ||
128 | role="bold">GUI</emphasis> tab.</para> | ||
129 | |||
130 | <para>More images for backgrounds and icons can be uploaded by | ||
131 | accessing <emphasis role="bold">System</emphasis>, selecting | ||
132 | <emphasis role="bold">Media Files</emphasis> under the <emphasis | ||
133 | role="bold">Icons</emphasis> tab or the <emphasis | ||
134 | role="bold">Backgrounds</emphasis> tab, respectively.</para> | ||
135 | </note> | ||
136 | </listitem> | ||
137 | |||
138 | <listitem> | ||
139 | <para>Remove Submap</para> | ||
140 | |||
141 | <para>This option is used for removing the current submap. The submap | ||
142 | must be empty, all children submaps or uCPE Devices must be deleted first.</para> | ||
143 | </listitem> | ||
144 | |||
145 | <listitem> | ||
146 | <para>Properties</para> | ||
147 | |||
148 | <para>This option is used for viewing and/or editing the properties of | ||
149 | the current submap. For more details please see the <link | ||
150 | linkend="submap_props">Submap properties</link> table.</para> | ||
151 | </listitem> | ||
152 | |||
153 | <listitem> | ||
154 | <para>Move Device</para> | ||
155 | |||
156 | <para>This option is used for adding devices to the current submap. | ||
157 | All devices appear in this list (placed and unplaced). If the device | ||
158 | is already added to a submap, it will be moved from that submap to the | ||
159 | current one.</para> | ||
160 | </listitem> | ||
161 | </itemizedlist> | ||
162 | </section> | ||
163 | |||
164 | <section id="map_op"> | ||
165 | <title>Map Operations</title> | ||
166 | |||
167 | <para>Right-clicking anywhere in the <emphasis role="bold">Map</emphasis> | ||
168 | view opens up a menu with the following operations:</para> | ||
169 | |||
170 | <itemizedlist> | ||
171 | <listitem> | ||
172 | <para>Place Device</para> | ||
173 | |||
174 | <para>This option is used for adding one or more devices in the | ||
175 | current submap. Only unplaced devices appear in this list.</para> | ||
176 | </listitem> | ||
177 | |||
178 | <listitem> | ||
179 | <para>Move Device</para> | ||
180 | |||
181 | <para>This option is used for moving one or more devices from other | ||
182 | submaps to the current submap. All devices appear in this list (placed | ||
183 | and unplaced). If the device is already added to a submap, it will be | ||
184 | removed from that submap.</para> | ||
185 | </listitem> | ||
186 | |||
187 | <listitem> | ||
188 | <para>Add Unmanaged</para> | ||
189 | |||
190 | <para>This option is used for creating an unmanaged device. An | ||
191 | unmanaged device is represented by an icon in the current view that | ||
192 | looks like a device (it supports links and has a similar icon) but | ||
193 | is not a real managed device. It will be automatically placed in the current | ||
194 | submap. When selecting this option, the following fields need to be | ||
195 | set in the <emphasis role="bold">Add Unmanaged</emphasis> window that | ||
196 | pops-up:</para> | ||
197 | |||
198 | <table id="unmanaged_props"> | ||
199 | <title>Unmanaged device properties</title> | ||
200 | |||
201 | <tgroup cols="2"> | ||
202 | <tbody> | ||
203 | <row> | ||
204 | <entry>Name</entry> | ||
205 | |||
206 | <entry>The name of the device.</entry> | ||
207 | </row> | ||
208 | |||
209 | <row> | ||
210 | <entry>Description</entry> | ||
211 | |||
212 | <entry>A text description of the device.</entry> | ||
213 | </row> | ||
214 | |||
215 | <row> | ||
216 | <entry>Icon Image</entry> | ||
217 | |||
218 | <entry>The icon image of the device.</entry> | ||
219 | </row> | ||
220 | |||
221 | <row> | ||
222 | <entry>Status</entry> | ||
223 | |||
224 | <entry>The status of the device.</entry> | ||
225 | </row> | ||
226 | |||
227 | <row> | ||
228 | <entry>Status Tooltip</entry> | ||
229 | |||
230 | <entry>The tooltip for the device status.</entry> | ||
231 | </row> | ||
232 | </tbody> | ||
233 | </tgroup> | ||
234 | </table> | ||
235 | </listitem> | ||
236 | |||
237 | <listitem> | ||
238 | <para>Add Link</para> | ||
239 | |||
240 | <para>This option is used for creating a virtual link between two | ||
241 | devices. They can be any two devices, it does not matter if they are | ||
242 | unplaced, placed in the current submap or placed in any other submap. | ||
243 | When selecting this option, the following fields need to be set in the | ||
244 | <emphasis role="bold">Add Link</emphasis> window:</para> | ||
245 | |||
246 | <table id="link_props"> | ||
247 | <title>Link properties</title> | ||
248 | |||
249 | <tgroup cols="2"> | ||
250 | <tbody> | ||
251 | <row> | ||
252 | <entry>Name</entry> | ||
253 | |||
254 | <entry>The name of the link.</entry> | ||
255 | </row> | ||
256 | |||
257 | <row> | ||
258 | <entry>Description</entry> | ||
259 | |||
260 | <entry>A text description of the link.</entry> | ||
261 | </row> | ||
262 | |||
263 | <row> | ||
264 | <entry>From</entry> | ||
265 | |||
266 | <entry>One of the endpoints of the link.</entry> | ||
267 | </row> | ||
268 | |||
269 | <row> | ||
270 | <entry>To</entry> | ||
271 | |||
272 | <entry>The 2nd endpoint of the link.</entry> | ||
273 | </row> | ||
274 | </tbody> | ||
275 | </tgroup> | ||
276 | </table> | ||
277 | </listitem> | ||
278 | |||
279 | <listitem> | ||
280 | <para>Properties</para> | ||
281 | |||
282 | <para>This option is used for viewing and/or editing the properties of | ||
283 | the current submap. For more details please see the <link | ||
284 | linkend="submap_props">Submap properties</link> table.</para> | ||
285 | </listitem> | ||
286 | |||
287 | <listitem> | ||
288 | <para>Arrange icons</para> | ||
289 | |||
290 | <para>This option can be used to auto-arrange devices placed in the | ||
291 | current submap. The rearrangement is done based on the submap's | ||
292 | properties.</para> | ||
293 | </listitem> | ||
294 | </itemizedlist> | ||
295 | </section> | ||
296 | |||
297 | <section id="device_op"> | ||
298 | <title>Device Operations</title> | ||
299 | |||
300 | <para>In the <emphasis role="bold">Map</emphasis> view, right-clicking on | ||
301 | a device opens up a menu with the following operations:</para> | ||
302 | |||
303 | <itemizedlist> | ||
304 | <listitem> | ||
305 | <para>Links...</para> | ||
306 | |||
307 | <para>This option is used for viewing all links to and from that | ||
308 | device.</para> | ||
309 | </listitem> | ||
310 | |||
311 | <listitem> | ||
312 | <para>Remove</para> | ||
313 | |||
314 | <para>For managed devices, this option is used for removing the device | ||
315 | from the map. The managed device will not be removed completely from | ||
316 | the Enea Edge Management application, but will be moved to the <emphasis | ||
317 | role="bold">Unplaced</emphasis> submap instead.</para> | ||
318 | |||
319 | <para>For unmanaged devices, this option removes the device altogether | ||
320 | from the Enea Edge Management application.</para> | ||
321 | </listitem> | ||
322 | |||
323 | <listitem> | ||
324 | <para>Add Link</para> | ||
325 | |||
326 | <para>This option is used for creating a virtual link between two | ||
327 | devices. They can be any two devices, it does not matter if they are | ||
328 | unplaced, placed in the current submap or placed in any other submap. | ||
329 | The current device is already selected as the <emphasis | ||
330 | role="bold">From</emphasis> endpoint in the <emphasis role="bold">Add | ||
331 | Link</emphasis> pop-up. For more details please see the <link | ||
332 | linkend="link_props">Link properties</link> table.</para> | ||
333 | </listitem> | ||
334 | |||
335 | <listitem> | ||
336 | <para>Properties</para> | ||
337 | |||
338 | <para>This option is used for viewing and editing the properties of an | ||
339 | unmanaged device. For more details please see the <link | ||
340 | linkend="unmanaged_props">Unmanaged device properties</link> table.</para> | ||
341 | </listitem> | ||
342 | </itemizedlist> | ||
343 | </section> | ||
344 | </chapter> \ No newline at end of file | ||
diff --git a/doc/book-enea-edge-getting-started/doc/troubleshooting.xml b/doc/book-enea-edge-getting-started/doc/troubleshooting.xml index fcf991e..0e6322f 100644 --- a/doc/book-enea-edge-getting-started/doc/troubleshooting.xml +++ b/doc/book-enea-edge-getting-started/doc/troubleshooting.xml | |||
@@ -54,7 +54,7 @@ | |||
54 | </row> | 54 | </row> |
55 | 55 | ||
56 | <row> | 56 | <row> |
57 | <entry>The uCPE Device cannot boot after an upgrade.</entry> | 57 | <entry>The uCPE device cannot boot after an upgrade.</entry> |
58 | 58 | ||
59 | <entry><orderedlist> | 59 | <entry><orderedlist> |
60 | <listitem> | 60 | <listitem> |
@@ -96,7 +96,7 @@ | |||
96 | 96 | ||
97 | <entry>If a working snapshot obtained during a previous Upgrade or | 97 | <entry>If a working snapshot obtained during a previous Upgrade or |
98 | Uninstall is available | 98 | Uninstall is available |
99 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>): | 99 | (<filename>EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz</filename>): |
100 | <orderedlist> | 100 | <orderedlist> |
101 | <listitem> | 101 | <listitem> |
102 | <para>Cleanup the current upgrade attempt with:</para> | 102 | <para>Cleanup the current upgrade attempt with:</para> |
@@ -164,7 +164,7 @@ | |||
164 | <para>Connect to the uCPE Device console and run the factory | 164 | <para>Connect to the uCPE Device console and run the factory |
165 | reset script:</para> | 165 | reset script:</para> |
166 | 166 | ||
167 | <programlisting>/usr/local/odm/bin/factory_reset.sh</programlisting> | 167 | <programlisting>/usr/enea/odm/bin/factory_reset.sh</programlisting> |
168 | </listitem> | 168 | </listitem> |
169 | 169 | ||
170 | <listitem> | 170 | <listitem> |
diff --git a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml index ac2ebb6..6a02d47 100644 --- a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml | |||
@@ -24,11 +24,11 @@ | |||
24 | folder.</para> | 24 | folder.</para> |
25 | 25 | ||
26 | <para>The directory in which the archive has been unpacked will be | 26 | <para>The directory in which the archive has been unpacked will be |
27 | denoted as <literal><uCPEM-installerdir></literal>.</para> | 27 | denoted as <literal><EEMg-installerdir></literal>.</para> |
28 | </listitem> | 28 | </listitem> |
29 | 29 | ||
30 | <listitem> | 30 | <listitem> |
31 | <para>Enter <literal><uCPEM-installerdir>/dist</literal>.</para> | 31 | <para>Enter <literal><EEMg-installerdir>/dist</literal>.</para> |
32 | </listitem> | 32 | </listitem> |
33 | 33 | ||
34 | <listitem> | 34 | <listitem> |
@@ -37,7 +37,7 @@ | |||
37 | Management installation:</para> | 37 | Management installation:</para> |
38 | 38 | ||
39 | <programlisting>./upgrade.sh /opt/ems \ | 39 | <programlisting>./upgrade.sh /opt/ems \ |
40 | Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</programlisting> | 40 | Enea_Edge_Management_<version>-build<build_number>.tar.gz</programlisting> |
41 | </listitem> | 41 | </listitem> |
42 | </orderedlist> | 42 | </orderedlist> |
43 | 43 | ||
@@ -52,9 +52,9 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
52 | <listitem> | 52 | <listitem> |
53 | <para>Create a compressed file of the <literal>ucpemanager</literal> | 53 | <para>Create a compressed file of the <literal>ucpemanager</literal> |
54 | application folder | 54 | application folder |
55 | (<filename>ucpemanager-Back-up-YYYYddMMHHmm.tar.gz</filename>), which | 55 | (<filename>EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz</filename>), which |
56 | contains a snapshot of the existing installation in the | 56 | contains a snapshot of the existing installation in the |
57 | <literal><uCPEM-installerdir>/dist</literal> directory.</para> | 57 | <literal><EEMg-installerdir>/dist</literal> directory.</para> |
58 | 58 | ||
59 | <note> | 59 | <note> |
60 | <para>The snapshot file created during the upgrade can be used for | 60 | <para>The snapshot file created during the upgrade can be used for |
@@ -104,19 +104,19 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
104 | 104 | ||
105 | <listitem> | 105 | <listitem> |
106 | <para>The directory in which the archive has been unpacked will be | 106 | <para>The directory in which the archive has been unpacked will be |
107 | denoted as <literal><uCPEM-installerdir></literal>.</para> | 107 | denoted as <literal><EEMg-installerdir></literal>.</para> |
108 | </listitem> | 108 | </listitem> |
109 | 109 | ||
110 | <listitem> | 110 | <listitem> |
111 | <para>Copy the snapshot file | 111 | <para>Copy the snapshot file |
112 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) | 112 | (<filename>EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz</filename>) |
113 | created during a previous Enea Edge Management Upgrade or Enea Edge | 113 | created during a previous Enea Edge Management Upgrade or Enea Edge |
114 | Management Uninstall Operation into the | 114 | Management Uninstall Operation into the |
115 | <literal><uCPEM-installerdir>/dist</literal> directory.</para> | 115 | <literal><EEMg-installerdir>/dist</literal> directory.</para> |
116 | </listitem> | 116 | </listitem> |
117 | 117 | ||
118 | <listitem> | 118 | <listitem> |
119 | <para>Enter <literal><uCPEM-installerdir>/dist</literal>.</para> | 119 | <para>Enter <literal><EEMg-installerdir>/dist</literal>.</para> |
120 | </listitem> | 120 | </listitem> |
121 | 121 | ||
122 | <listitem> | 122 | <listitem> |
@@ -124,7 +124,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
124 | <literal>/opt/ems</literal> to the correct location of the Enea Edge | 124 | <literal>/opt/ems</literal> to the correct location of the Enea Edge |
125 | Management installation:</para> | 125 | Management installation:</para> |
126 | 126 | ||
127 | <programlisting>./restore.sh /opt/ems ucpemanager-Backup-YYYYddMMHHmm.tar.gz</programlisting> | 127 | <programlisting>./restore.sh /opt/ems EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz</programlisting> |
128 | </listitem> | 128 | </listitem> |
129 | </orderedlist> | 129 | </orderedlist> |
130 | 130 | ||
@@ -158,12 +158,12 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
158 | <listitem> | 158 | <listitem> |
159 | <para>Navigate to the folder where the Enea Edge Management | 159 | <para>Navigate to the folder where the Enea Edge Management |
160 | application is unpacked: | 160 | application is unpacked: |
161 | <filename><uCPEM-installerdir></filename>.</para> | 161 | <filename><EEMg-installerdir></filename>.</para> |
162 | </listitem> | 162 | </listitem> |
163 | 163 | ||
164 | <listitem> | 164 | <listitem> |
165 | <para>Enter | 165 | <para>Enter |
166 | <literal><uCPEM-installerdir>/dist</literal>.</para> | 166 | <literal><EEMg-installerdir>/dist</literal>.</para> |
167 | </listitem> | 167 | </listitem> |
168 | 168 | ||
169 | <listitem> | 169 | <listitem> |
@@ -186,7 +186,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
186 | <listitem> | 186 | <listitem> |
187 | <para>Create a compressed file of the <literal>ucpemanager</literal> | 187 | <para>Create a compressed file of the <literal>ucpemanager</literal> |
188 | application folder: | 188 | application folder: |
189 | <filename>ucpemanager-Back-up-YYYYddMMHHmm.tar.gz</filename>, which | 189 | <filename>EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz</filename>, which |
190 | contains a snapshot of the existing installation and functions as a | 190 | contains a snapshot of the existing installation and functions as a |
191 | restore point.</para> | 191 | restore point.</para> |
192 | 192 | ||
@@ -289,7 +289,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
289 | 289 | ||
290 | <note> | 290 | <note> |
291 | <para>The uCPE Device upgrade is done with image files of the type | 291 | <para>The uCPE Device upgrade is done with image files of the type |
292 | <literal>rootfs.ostree.tar.bz2</literal>, which are available in the | 292 | <literal>ostree.tar.bz2</literal>, which are available in the |
293 | <filename>Enea_Edge_Runtime_<processor>_<version>-build<build_number>.tar.gz</filename> | 293 | <filename>Enea_Edge_Runtime_<processor>_<version>-build<build_number>.tar.gz</filename> |
294 | file you downloaded with your release.</para> | 294 | file you downloaded with your release.</para> |
295 | </note> | 295 | </note> |
@@ -313,7 +313,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
313 | <listitem> | 313 | <listitem> |
314 | <para>Select <emphasis role="bold">Choose File</emphasis> to | 314 | <para>Select <emphasis role="bold">Choose File</emphasis> to |
315 | provide the path to the image file (must be of type | 315 | provide the path to the image file (must be of type |
316 | <literal>rootfs.os-tree.tar.bz2</literal>).</para> | 316 | <literal>ostree.tar.bz2</literal>).</para> |
317 | </listitem> | 317 | </listitem> |
318 | 318 | ||
319 | <listitem> | 319 | <listitem> |
@@ -470,7 +470,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
470 | 470 | ||
471 | <para>The status of the installation and upgrade can be viewed in the | 471 | <para>The status of the installation and upgrade can be viewed in the |
472 | <emphasis role="bold">Upgrade Operations</emphasis> tab. Ongoing or | 472 | <emphasis role="bold">Upgrade Operations</emphasis> tab. Ongoing or |
473 | scheduled upgrade operations can be viewed or cancelled.</para> | 473 | scheduled upgrade operations can be viewed or canceled.</para> |
474 | 474 | ||
475 | <para><emphasis role="bold">To view the status of an installation or | 475 | <para><emphasis role="bold">To view the status of an installation or |
476 | upgrade operations</emphasis></para> | 476 | upgrade operations</emphasis></para> |
@@ -620,4 +620,4 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
620 | </section> | 620 | </section> |
621 | </section> | 621 | </section> |
622 | </section> | 622 | </section> |
623 | </chapter> \ No newline at end of file | 623 | </chapter> |
diff --git a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml index 058be40..beea8fc 100644 --- a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml +++ b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml | |||
@@ -10,7 +10,7 @@ | |||
10 | <title>Onboarding a VNF</title> | 10 | <title>Onboarding a VNF</title> |
11 | 11 | ||
12 | <para>The onboarding of a VNF means adding it to the Enea Edge Management | 12 | <para>The onboarding of a VNF means adding it to the Enea Edge Management |
13 | application VNF Catalogue and preparing it for instantiation (deployment | 13 | application VNF Catalog and preparing it for instantiation (deployment |
14 | on connected uCPE devices). This is accomplished using the Enea Edge | 14 | on connected uCPE devices). This is accomplished using the Enea Edge |
15 | Management Onboarding graphical user interface.</para> | 15 | Management Onboarding graphical user interface.</para> |
16 | 16 | ||
@@ -210,9 +210,8 @@ | |||
210 | Management application.</para> | 210 | Management application.</para> |
211 | 211 | ||
212 | <note> | 212 | <note> |
213 | <para>CAUTION: The user MUST save and use the same order for the | 213 | <para>The user MUST save and use the same order for the virtual |
214 | virtual interfaces during both the onboarding and instantiation | 214 | interfaces during both the onboarding and instantiation phases.</para> |
215 | phases.</para> | ||
216 | </note> | 215 | </note> |
217 | 216 | ||
218 | <para><emphasis role="bold">Cloud Init Tab</emphasis></para> | 217 | <para><emphasis role="bold">Cloud Init Tab</emphasis></para> |
@@ -228,7 +227,7 @@ | |||
228 | <para>To onboard a VNF you must specify the <literal>Cloud-Init | 227 | <para>To onboard a VNF you must specify the <literal>Cloud-Init |
229 | Datasource</literal> that the VNF uses. This information is procured | 228 | Datasource</literal> that the VNF uses. This information is procured |
230 | from the VNF Vendor. Choose one of the following methods to specify | 229 | from the VNF Vendor. Choose one of the following methods to specify |
231 | the datasource:</para> | 230 | the data-source:</para> |
232 | 231 | ||
233 | <itemizedlist spacing="compact"> | 232 | <itemizedlist spacing="compact"> |
234 | <listitem> | 233 | <listitem> |
@@ -320,7 +319,7 @@ | |||
320 | </itemizedlist> | 319 | </itemizedlist> |
321 | 320 | ||
322 | <note> | 321 | <note> |
323 | <para>The last three properties are useful in conjuction with the | 322 | <para>The last three properties are useful in conjunction with the |
324 | <literal>vnfMgmt</literal> bridge type. They allow the user to map the | 323 | <literal>vnfMgmt</literal> bridge type. They allow the user to map the |
325 | internal VNF management port to an external port, useful for VNF | 324 | internal VNF management port to an external port, useful for VNF |
326 | configuration from WAN.</para> | 325 | configuration from WAN.</para> |
@@ -498,7 +497,8 @@ | |||
498 | role="bold">Reverse SSH</emphasis> . By default, the start port | 497 | role="bold">Reverse SSH</emphasis> . By default, the start port |
499 | will be <literal>7000</literal> and the maximum number of ports | 498 | will be <literal>7000</literal> and the maximum number of ports |
500 | allocated to all devices is 10. Only one port per device is | 499 | allocated to all devices is 10. Only one port per device is |
501 | allowed.</para> | 500 | allowed. The maximum number of ports allocated can be increased |
501 | up to 65536, if necessary.</para> | ||
502 | 502 | ||
503 | <para>When the SSH window is closed, the tunnel configuration is | 503 | <para>When the SSH window is closed, the tunnel configuration is |
504 | deleted on the uCPE device and the tunnel is destroyed, so that | 504 | deleted on the uCPE device and the tunnel is destroyed, so that |
@@ -526,4 +526,126 @@ | |||
526 | </listitem> | 526 | </listitem> |
527 | </orderedlist> | 527 | </orderedlist> |
528 | </section> | 528 | </section> |
529 | |||
530 | <section id="vnf_snapshots"> | ||
531 | <title>VNF Snapshots</title> | ||
532 | |||
533 | <para>The following sections describe the mechanism of saving | ||
534 | (snapshotting) and restoring a VNF context on the uCPE device using the | ||
535 | Enea Edge Management application.</para> | ||
536 | |||
537 | <para>The uCPE devices should be connected to the Enea Edge Management | ||
538 | application and should have at least one VNF instantiated.</para> | ||
539 | |||
540 | <section id="vnf_live_snapshot"> | ||
541 | <title>VNF Live Snapshot</title> | ||
542 | |||
543 | <para>To perform a snapshot of an existing VNF on a uCPE device, do the | ||
544 | following in the Enea Edge Management application:</para> | ||
545 | |||
546 | <orderedlist> | ||
547 | <listitem> | ||
548 | <para>Select the uCPE device and access the <emphasis | ||
549 | role="bold">Configuration</emphasis> menu, then select <emphasis | ||
550 | role="bold">Virtual Machines</emphasis> and <emphasis | ||
551 | role="bold">VMs</emphasis>.</para> | ||
552 | </listitem> | ||
553 | |||
554 | <listitem> | ||
555 | <para>Select a virtual machine and click the <emphasis | ||
556 | role="bold">Snapshots..</emphasis> button. The <emphasis | ||
557 | role="bold">VM Snapshot Table on <device-name> (IP)</emphasis> | ||
558 | window will open.</para> | ||
559 | </listitem> | ||
560 | |||
561 | <listitem> | ||
562 | <para>Press the <emphasis role="bold">Create</emphasis> button and | ||
563 | the <emphasis role="bold">Create VM Snapshot on <device-name> | ||
564 | (IP)</emphasis> window will open.</para> | ||
565 | </listitem> | ||
566 | |||
567 | <listitem> | ||
568 | <para>Change the file name, if needed, and press the <emphasis | ||
569 | role="bold">Create</emphasis> button. The current pop-up window will | ||
570 | close after a few seconds and a new entry will be shown in the | ||
571 | <emphasis role="bold">VM Snapshot Table on <device-name | ||
572 | (IP)></emphasis>.</para> | ||
573 | </listitem> | ||
574 | </orderedlist> | ||
575 | </section> | ||
576 | |||
577 | <section id="restore_snapshot"> | ||
578 | <title>Restoring a VNF Snapshot</title> | ||
579 | |||
580 | <para>When needed, a VNF snapshot can be restored by doing the | ||
581 | following:</para> | ||
582 | |||
583 | <orderedlist> | ||
584 | <listitem> | ||
585 | <para>Select the uCPE device and access the <emphasis | ||
586 | role="bold">Configuration</emphasis> menu, then select <emphasis | ||
587 | role="bold">Virtual Machines</emphasis> and choose <emphasis | ||
588 | role="bold">VMs</emphasis>.</para> | ||
589 | </listitem> | ||
590 | |||
591 | <listitem> | ||
592 | <para>Select a virtual machine and press the <emphasis | ||
593 | role="bold">Snapshots</emphasis> button. The <emphasis | ||
594 | role="bold">VM Snapshot Table on <device-name> (IP)</emphasis> | ||
595 | window will open.</para> | ||
596 | </listitem> | ||
597 | |||
598 | <listitem> | ||
599 | <para>Select the snapshot entry from table.</para> | ||
600 | </listitem> | ||
601 | |||
602 | <listitem> | ||
603 | <para>Press the <emphasis role="bold">Restore</emphasis> button. A | ||
604 | success message will appear in the same window: <literal>Restored VM | ||
605 | from snapshot</literal>.</para> | ||
606 | </listitem> | ||
607 | </orderedlist> | ||
608 | </section> | ||
609 | |||
610 | <section id="delete_snapshot"> | ||
611 | <title>Deleting a VNF Snapshot</title> | ||
612 | |||
613 | <para>Deleting an older snapshot can be performed by doing the | ||
614 | following:</para> | ||
615 | |||
616 | <orderedlist> | ||
617 | <listitem> | ||
618 | <para>Select the uCPE device and access the <emphasis | ||
619 | role="bold">Configuration</emphasis> menu, then select <emphasis | ||
620 | role="bold">Virtual Machines</emphasis> and choose <emphasis | ||
621 | role="bold">VMs</emphasis>.</para> | ||
622 | </listitem> | ||
623 | |||
624 | <listitem> | ||
625 | <para>Select a virtual machine and press the <emphasis | ||
626 | role="bold">Snapshots..</emphasis> button. The <emphasis | ||
627 | role="bold">VM Snapshot Table on <device-name> (IP)</emphasis> | ||
628 | window will open.</para> | ||
629 | </listitem> | ||
630 | |||
631 | <listitem> | ||
632 | <para>Select the snapshot entry from the table.</para> | ||
633 | </listitem> | ||
634 | |||
635 | <listitem> | ||
636 | <para>Press the <emphasis role="bold">Delete</emphasis> | ||
637 | button.</para> | ||
638 | </listitem> | ||
639 | </orderedlist> | ||
640 | |||
641 | <para>A success message will be shown in the same window: | ||
642 | <literal>Snapshot deleted</literal>. The snapshot file will be deleted | ||
643 | from the uCPE device and the table will be updated.</para> | ||
644 | |||
645 | <note> | ||
646 | <para>Deleting a VNF instance automatically deletes all snapshots | ||
647 | associated with it.</para> | ||
648 | </note> | ||
649 | </section> | ||
650 | </section> | ||
529 | </chapter> \ No newline at end of file | 651 | </chapter> \ No newline at end of file |