diff options
Diffstat (limited to 'doc')
6 files changed, 363 insertions, 282 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml index b82d48b..9f0aa37 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml | |||
| @@ -17,9 +17,69 @@ | |||
| 17 | <listitem> | 17 | <listitem> |
| 18 | <para>One server running the CentOS 7 distribution</para> | 18 | <para>One server running the CentOS 7 distribution</para> |
| 19 | 19 | ||
| 20 | <para>Minimal Requirement: 4 Cores, 16 GB RAM and 300 GB single disk | 20 | <note> |
| 21 | storage. Make sure the CentOS 7 server is updated to the latest | 21 | <para>The CentOS 7 server must be updated to the latest revision |
| 22 | revision before installing Enea NFV Access.</para> | 22 | before installing Enea NFV Access.</para> |
| 23 | </note> | ||
| 24 | |||
| 25 | <para>The following will detail CPU, RAM and storage requirements for | ||
| 26 | the uCPE Manager.</para> | ||
| 27 | |||
| 28 | <itemizedlist> | ||
| 29 | <listitem> | ||
| 30 | <para>For small-sized deployments (tens of devices):</para> | ||
| 31 | |||
| 32 | <itemizedlist spacing="compact"> | ||
| 33 | <listitem> | ||
| 34 | <para>4 cores</para> | ||
| 35 | </listitem> | ||
| 36 | |||
| 37 | <listitem> | ||
| 38 | <para>16 GB RAM</para> | ||
| 39 | </listitem> | ||
| 40 | |||
| 41 | <listitem> | ||
| 42 | <para>300 GB single disk storage</para> | ||
| 43 | </listitem> | ||
| 44 | </itemizedlist> | ||
| 45 | </listitem> | ||
| 46 | |||
| 47 | <listitem> | ||
| 48 | <para>For mid-sized deployments (hundreds of devices):</para> | ||
| 49 | |||
| 50 | <itemizedlist spacing="compact"> | ||
| 51 | <listitem> | ||
| 52 | <para>8 cores</para> | ||
| 53 | </listitem> | ||
| 54 | |||
| 55 | <listitem> | ||
| 56 | <para>32 GB RAM</para> | ||
| 57 | </listitem> | ||
| 58 | |||
| 59 | <listitem> | ||
| 60 | <para>300 GB single disk storage</para> | ||
| 61 | </listitem> | ||
| 62 | </itemizedlist> | ||
| 63 | </listitem> | ||
| 64 | |||
| 65 | <listitem> | ||
| 66 | <para>For large deployments (thousands of devices):</para> | ||
| 67 | |||
| 68 | <itemizedlist spacing="compact"> | ||
| 69 | <listitem> | ||
| 70 | <para>16 cores</para> | ||
| 71 | </listitem> | ||
| 72 | |||
| 73 | <listitem> | ||
| 74 | <para>64-256 GB RAM</para> | ||
| 75 | </listitem> | ||
| 76 | |||
| 77 | <listitem> | ||
| 78 | <para>1-2 TB single disk storage</para> | ||
| 79 | </listitem> | ||
| 80 | </itemizedlist> | ||
| 81 | </listitem> | ||
| 82 | </itemizedlist> | ||
| 23 | 83 | ||
| 24 | <para>The purpose of the CentOS 7 server is to host the Enea uCPE | 84 | <para>The purpose of the CentOS 7 server is to host the Enea uCPE |
| 25 | Manager. Network access between the CentOS 7 server and the uCPE | 85 | Manager. Network access between the CentOS 7 server and the uCPE |
| @@ -30,8 +90,8 @@ | |||
| 30 | <listitem> | 90 | <listitem> |
| 31 | <para>One or more uCPE devices.</para> | 91 | <para>One or more uCPE devices.</para> |
| 32 | 92 | ||
| 33 | <para>Whitebox devices where the Enea NFV Access Runtime Platform | 93 | <para>Whitebox devices where the Enea NFV Access Runtime Platform will |
| 34 | will be installed, containing a minimum of 2 cores and 4 GB RAM and at | 94 | be installed, containing a minimum of 2 cores and 4 GB RAM and at |
| 35 | least two ethernet ports that will be configured as WAN and LAN during | 95 | least two ethernet ports that will be configured as WAN and LAN during |
| 36 | deployment.</para> | 96 | deployment.</para> |
| 37 | 97 | ||
| @@ -251,14 +311,14 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</p | |||
| 251 | 311 | ||
| 252 | <listitem> | 312 | <listitem> |
| 253 | <para>Execute the following command to check if you have a currently | 313 | <para>Execute the following command to check if you have a currently |
| 254 | running the PostgreSQL database server:</para> | 314 | running PostgreSQL database server:</para> |
| 255 | 315 | ||
| 256 | <programlisting>ps -ef | grep post</programlisting> | 316 | <programlisting>ps -ef | grep post</programlisting> |
| 257 | </listitem> | 317 | </listitem> |
| 258 | 318 | ||
| 259 | <listitem> | 319 | <listitem> |
| 260 | <para>Remove the currently installed PostgreSQL server (including | 320 | <para>Remove the installed PostgreSQL server (including the existing |
| 261 | the existing postgres user):</para> | 321 | postgres user):</para> |
| 262 | 322 | ||
| 263 | <programlisting>yum remove postgres\* | 323 | <programlisting>yum remove postgres\* |
| 264 | rm -rf /var/lib/pgsql | 324 | rm -rf /var/lib/pgsql |
| @@ -327,7 +387,7 @@ userdel postgres</programlisting> | |||
| 327 | <para>Each uCPE device needs a unique identifier. This identifier is | 387 | <para>Each uCPE device needs a unique identifier. This identifier is |
| 328 | used to match the registration in the Enea uCPE Manager and the offline | 388 | used to match the registration in the Enea uCPE Manager and the offline |
| 329 | configuration of the uCPE device during ZTP (Zero Touch | 389 | configuration of the uCPE device during ZTP (Zero Touch |
| 330 | Provisioning)</para> | 390 | Provisioning).</para> |
| 331 | 391 | ||
| 332 | <para>Select a text string to represent the uCPE device, e.g. | 392 | <para>Select a text string to represent the uCPE device, e.g. |
| 333 | <literal>uCPE-1</literal> or | 393 | <literal>uCPE-1</literal> or |
| @@ -395,7 +455,7 @@ userdel postgres</programlisting> | |||
| 395 | <section id="install_ucpe_mg"> | 455 | <section id="install_ucpe_mg"> |
| 396 | <title>Installing the Enea uCPE Manager</title> | 456 | <title>Installing the Enea uCPE Manager</title> |
| 397 | 457 | ||
| 398 | <para>The Enea uCPE Manager can be installed using as a fresh/first-time | 458 | <para>The Enea uCPE Manager can be installed using a fresh (first-time) |
| 399 | configuration or using a backup file of a previous installation, created | 459 | configuration or using a backup file of a previous installation, created |
| 400 | within the Enea uCPE Manager GUI.</para> | 460 | within the Enea uCPE Manager GUI.</para> |
| 401 | 461 | ||
| @@ -569,7 +629,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 569 | <note> | 629 | <note> |
| 570 | <para>The IPv4 address of the CentOS 7 Server, connected to the same | 630 | <para>The IPv4 address of the CentOS 7 Server, connected to the same |
| 571 | network as the uCPE Devices, will be used as a configuration | 631 | network as the uCPE Devices, will be used as a configuration |
| 572 | parameter both when setting up the uCPE devices.</para> | 632 | parameter when setting up the uCPE devices.</para> |
| 573 | </note> | 633 | </note> |
| 574 | </section> | 634 | </section> |
| 575 | 635 | ||
| @@ -577,14 +637,15 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 577 | <title>Installation of the Enea uCPE Manager using a System | 637 | <title>Installation of the Enea uCPE Manager using a System |
| 578 | Back-up</title> | 638 | Back-up</title> |
| 579 | 639 | ||
| 580 | <para>The Enea uCPE Manager can be restored if a back-up file has been | 640 | <para>The Enea uCPE Manager can be restored if a backup file has been |
| 581 | previously created.</para> | 641 | previously created.</para> |
| 582 | 642 | ||
| 583 | <para>A backup file can be created by accessing: | 643 | <para>A backup file can be created by accessing the <emphasis |
| 584 | <literal>System</literal> -> <literal>System Backup</literal> from | 644 | role="bold">System</emphasis> menu, and clicking <emphasis |
| 585 | the Enea uCPE Manager GUI. The resulting zip archive will be located | 645 | role="bold">System Backup</emphasis>, from the Enea uCPE Manager GUI. |
| 586 | in the <filename>/opt/ems/ucpemanager/application/backup</filename> | 646 | The resulting zip archive will be located in the |
| 587 | folder and will be named | 647 | <filename>/opt/ems/ucpemanager/application/backup</filename> folder |
| 648 | and will be named | ||
| 588 | <literal>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</literal> (e.g | 649 | <literal>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</literal> (e.g |
| 589 | System-Backup_Feb19_2013_2257_42.zip). Save the archive to another | 650 | System-Backup_Feb19_2013_2257_42.zip). Save the archive to another |
| 590 | location outside the Enea uCPE Manager installation folder for future | 651 | location outside the Enea uCPE Manager installation folder for future |
| @@ -593,11 +654,11 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 593 | <note> | 654 | <note> |
| 594 | <para>The System Back-up file obtained from the Enea uCPE Manager | 655 | <para>The System Back-up file obtained from the Enea uCPE Manager |
| 595 | GUI (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is | 656 | GUI (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is |
| 596 | different from the Enea uCPE Manager snapshot obtained during a Enea | 657 | different from the snapshot obtained during a Enea uCPE Manager |
| 597 | uCPE Manager Upgrade or Uninstall operation | 658 | Upgrade or Uninstall operation |
| 598 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) needed | 659 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) needed |
| 599 | for recovery of the Enea uCPE Manager. For more details please see | 660 | for recovery of the Enea uCPE Manager. For more details, see <olink |
| 600 | <olink targetdoc="book_enea_nfv_access_getting_started" | 661 | targetdoc="book_enea_nfv_access_getting_started" |
| 601 | targetptr="restore_prev_ucpe_install">Restoring a previous uCPE | 662 | targetptr="restore_prev_ucpe_install">Restoring a previous uCPE |
| 602 | Manager installation in the <xi:include | 663 | Manager installation in the <xi:include |
| 603 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 664 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
| @@ -619,15 +680,15 @@ SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> | |||
| 619 | <title>Preparing the USB stick for installation of the Enea NFV Access | 680 | <title>Preparing the USB stick for installation of the Enea NFV Access |
| 620 | Runtime Platform</title> | 681 | Runtime Platform</title> |
| 621 | 682 | ||
| 622 | <para>To install the Enea NFV Access Runtime Platform, create a | 683 | <para>To install the Enea NFV Access Runtime Platform, create a bootable |
| 623 | bootable USB stick with the image you intend to install.</para> | 684 | USB stick with the image you intend to install.</para> |
| 624 | 685 | ||
| 625 | <para>In the example below, step by step instructions are provided for | 686 | <para>In the example below, step by step instructions are provided for |
| 626 | the CentOS 7 distribution. It's possible with the appropriate tools to | 687 | the CentOS 7 distribution. It's possible with the appropriate tools to |
| 627 | also use Windows OS or MacOS.</para> | 688 | also use Windows OS or MacOS.</para> |
| 628 | 689 | ||
| 629 | <note> | 690 | <note> |
| 630 | <para>The .hddimg image is available in the | 691 | <para>The <filename>.hddimg</filename> image is available in the |
| 631 | <filename>Enea_NFV_Access_Run_Time_Platform_ | 692 | <filename>Enea_NFV_Access_Run_Time_Platform_ |
| 632 | <processor>_<version>-build<build_number>.tar.gz</filename> | 693 | <processor>_<version>-build<build_number>.tar.gz</filename> |
| 633 | file you downloaded with your release.</para> | 694 | file you downloaded with your release.</para> |
| @@ -682,9 +743,9 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
| 682 | </figure> | 743 | </figure> |
| 683 | 744 | ||
| 684 | <para>While the uCPE device is powered off, in order to install and | 745 | <para>While the uCPE device is powered off, in order to install and |
| 685 | configure the Enea NFV Access Runtime using the prepared USB stick, | 746 | configure the Enea NFV Access Runtime Platform (using the prepared USB |
| 686 | connect the laptop to a uCPE device LAN port. For this purpose, a Layer | 747 | stick), connect the laptop to a uCPE device LAN port. For this purpose, |
| 687 | 2 switch or direct cable connection can be used.</para> | 748 | a Layer 2 switch or direct cable connection can be used.</para> |
| 688 | </section> | 749 | </section> |
| 689 | 750 | ||
| 690 | <section id="install_ena_device"> | 751 | <section id="install_ena_device"> |
| @@ -723,7 +784,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
| 723 | </listitem> | 784 | </listitem> |
| 724 | 785 | ||
| 725 | <listitem> | 786 | <listitem> |
| 726 | <para>Customer Tags. They are used for Zero Touch Provisining | 787 | <para>Customer Tags. They are used for Zero Touch Provisioning |
| 727 | (ZTP) and can be left empty for a base configuration. What can | 788 | (ZTP) and can be left empty for a base configuration. What can |
| 728 | be entered here (if needed), are the tag(s) specified when | 789 | be entered here (if needed), are the tag(s) specified when |
| 729 | creating an offline configuration in the Enea uCPE Manager. A | 790 | creating an offline configuration in the Enea uCPE Manager. A |
| @@ -760,9 +821,10 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
| 760 | 821 | ||
| 761 | <para>When the user has completed the configuration steps in the | 822 | <para>When the user has completed the configuration steps in the |
| 762 | Web-installer, Enea NFV Access is installed on the hard drive. At this | 823 | Web-installer, Enea NFV Access is installed on the hard drive. At this |
| 763 | stage, user should remove the USB stick and LAN cable and shutdown the | 824 | stage, the user should remove the USB stick and the LAN cable, and |
| 764 | uCPE device. It will be started after necessary configurations are done | 825 | shutdown the uCPE device. It will be started after necessary |
| 765 | on the Enea uCPE Manager, as described below.</para> | 826 | configurations are done on the Enea uCPE Manager, as described |
| 827 | below.</para> | ||
| 766 | 828 | ||
| 767 | <note> | 829 | <note> |
| 768 | <para>If the USB stick was booted in UEFI mode, an UEFI boot entry is | 830 | <para>If the USB stick was booted in UEFI mode, an UEFI boot entry is |
| @@ -817,11 +879,11 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
| 817 | 879 | ||
| 818 | <note> | 880 | <note> |
| 819 | <para>Day-0 configuration is a software lifecycle term referring to | 881 | <para>Day-0 configuration is a software lifecycle term referring to |
| 820 | early configurations to put the uCPE device in an active state. Day-1 | 882 | early configurations used to put the uCPE device in an active state. |
| 821 | Configurations are applied after Day-0 and set the uCPE device and its | 883 | Day-1 Configurations are applied after Day-0 and set the uCPE device |
| 822 | service in an active state. Day-2 Configurations are live | 884 | and its service in an active state. Day-2 Configurations are live |
| 823 | configurations on the uCPE and its service, applied after the uCPE | 885 | configurations on the uCPE device and its service, applied after they |
| 824 | device and its service have been activated.</para> | 886 | have been activated.</para> |
| 825 | </note> | 887 | </note> |
| 826 | 888 | ||
| 827 | <para>The offline configuration consists of data and parameters that are | 889 | <para>The offline configuration consists of data and parameters that are |
| @@ -834,27 +896,28 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
| 834 | <para>For this base configuration, the offline configuration will be | 896 | <para>For this base configuration, the offline configuration will be |
| 835 | left blank. The blank offline configuration can be filled with | 897 | left blank. The blank offline configuration can be filled with |
| 836 | user-specific values and data once the service is created, which is done | 898 | user-specific values and data once the service is created, which is done |
| 837 | after installation is complete.</para> | 899 | after the installation is complete.</para> |
| 838 | 900 | ||
| 839 | <note> | 901 | <note> |
| 840 | <para>If the offline configuration is not configured, an alarm will be | 902 | <para>If the offline configuration is not configured, an alarm will be |
| 841 | raised: <literal>Day-0 Config:ZTP:Major</literal> when the uCPE device | 903 | raised: <literal>Day-0 Config:ZTP:Major</literal> when the uCPE device |
| 842 | tries to connect to Enea uCPE Manager, informing the user that the ZTP | 904 | tries to connect to the Enea uCPE Manager, informing the user that the |
| 843 | setup failed for the uCPE device.</para> | 905 | ZTP setup failed for the uCPE device.</para> |
| 844 | </note> | 906 | </note> |
| 845 | 907 | ||
| 846 | <para><emphasis role="bold">To create an offline | 908 | <para><emphasis role="bold">To create an offline |
| 847 | configuration</emphasis> <orderedlist> | 909 | configuration</emphasis><orderedlist> |
| 848 | <listitem> | 910 | <listitem> |
| 849 | <para>In a browser access the Enea uCPE Manager, then | 911 | <para>In a browser access the Enea uCPE Manager, open <emphasis |
| 850 | <literal>Applications</literal>-><literal>Offline | 912 | role="bold">Applications</emphasis> and select <emphasis |
| 851 | Config</literal>.</para> | 913 | role="bold">Offline Config</emphasis>.</para> |
| 852 | </listitem> | 914 | </listitem> |
| 853 | 915 | ||
| 854 | <listitem> | 916 | <listitem> |
| 855 | <para>Create a new offline configuration in the GUI by clicking | 917 | <para>Create a new offline configuration in the GUI by selecting |
| 856 | <literal>Add</literal> and filling in the mandatory fields: | 918 | the <emphasis role="bold">Add</emphasis> button and filling in the |
| 857 | <literal>name</literal>, <literal>deviceVersion</literal> and | 919 | mandatory fields: <literal>name</literal>, |
| 920 | <literal>deviceVersion</literal> and | ||
| 858 | <literal>deviceId</literal>.</para> | 921 | <literal>deviceId</literal>.</para> |
| 859 | 922 | ||
| 860 | <para>The name is user defined and can be set to any unique text | 923 | <para>The name is user defined and can be set to any unique text |
| @@ -872,9 +935,10 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
| 872 | 935 | ||
| 873 | <para>In order to enroll a uCPE device in the management system and | 936 | <para>In order to enroll a uCPE device in the management system and |
| 874 | establish a management connection, the user will add uCPE device | 937 | establish a management connection, the user will add uCPE device |
| 875 | information in the Enea uCPE Manager. This is accomplished by selecting | 938 | information in the Enea uCPE Manager. This is accomplished by going to |
| 876 | <literal>Devices</literal> -> <literal>Manage</literal> -> | 939 | <emphasis role="bold">Devices</emphasis>, selecting <emphasis |
| 877 | <literal>Add</literal>.</para> | 940 | role="bold">Manage</emphasis> and then clicking the <emphasis |
| 941 | role="bold">Add</emphasis> button.</para> | ||
| 878 | 942 | ||
| 879 | <para>The relevant parameters are:</para> | 943 | <para>The relevant parameters are:</para> |
| 880 | 944 | ||
| @@ -927,8 +991,9 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
| 927 | established.</para> | 991 | established.</para> |
| 928 | 992 | ||
| 929 | <para>When a uCPE device is registered it can be manually added to the | 993 | <para>When a uCPE device is registered it can be manually added to the |
| 930 | map for overview. Right-click on the map and select <literal>Place | 994 | map for overview. <emphasis role="bold">Right-click</emphasis> on the |
| 931 | Device</literal> to put the uCPE device on the map.</para> | 995 | map and select <emphasis role="bold">Place Device</emphasis> to put the |
| 996 | uCPE device on the map.</para> | ||
| 932 | 997 | ||
| 933 | <para>In case of management connection failure (e.g. due to a | 998 | <para>In case of management connection failure (e.g. due to a |
| 934 | misconfiguration), the uCPE device status will be seen as RED | 999 | misconfiguration), the uCPE device status will be seen as RED |
| @@ -976,9 +1041,9 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
| 976 | of interest to check the amount of hardware resources in use.</para> | 1041 | of interest to check the amount of hardware resources in use.</para> |
| 977 | 1042 | ||
| 978 | <para>To check CPU, RAM and disk utilization simply select the uCPE | 1043 | <para>To check CPU, RAM and disk utilization simply select the uCPE |
| 979 | device and click the <literal>Virtual Machines</literal> tab in the map | 1044 | device and go to the <emphasis role="bold">Virtual Machines</emphasis> |
| 980 | view. The same view will show active VNFs running on the uCPE device | 1045 | tab in the map view. The same view will show active VNFs running on the |
| 981 | once instantiated.</para> | 1046 | uCPE device once instantiated.</para> |
| 982 | </section> | 1047 | </section> |
| 983 | 1048 | ||
| 984 | <section id="access_device_cli"> | 1049 | <section id="access_device_cli"> |
| @@ -986,18 +1051,19 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
| 986 | 1051 | ||
| 987 | <para>As a final check to make sure the uCPE device was installed and | 1052 | <para>As a final check to make sure the uCPE device was installed and |
| 988 | configured correctly, access the uCPE device Linux CLI by selecting the | 1053 | configured correctly, access the uCPE device Linux CLI by selecting the |
| 989 | uCPE device on the map and using the SSH button from the panel. A new | 1054 | uCPE device on the map and using the <emphasis role="bold">SSH |
| 990 | window will appear for CLI access. The default user and password are | 1055 | button</emphasis> from the panel. A new window will appear for CLI |
| 991 | <literal>root</literal> and blank, respectively.</para> | 1056 | access. The default user and password are <literal>root</literal> and |
| 1057 | blank, respectively.</para> | ||
| 992 | 1058 | ||
| 993 | <para>The Enea NFV Access CLI is a pure Linux CLI providing access to | 1059 | <para>The Enea NFV Access CLI is a pure Linux CLI providing access to |
| 994 | standard Linux CLI commands. The CLI is a central feature for running | 1060 | standard Linux CLI commands. The CLI is a central feature for running |
| 995 | custom scripting.</para> | 1061 | custom scripting.</para> |
| 996 | 1062 | ||
| 997 | <note> | 1063 | <note> |
| 998 | <para>In case the uCPE was installed behind a NAT device, reverse SSH | 1064 | <para>In case the uCPE device was installed behind a NAT device, the |
| 999 | connection will be used. For more details, please see <olink | 1065 | reverse SSH connection will be used. For more details, please see |
| 1000 | targetdoc="book_enea_nfv_access_getting_started" | 1066 | <olink targetdoc="book_enea_nfv_access_getting_started" |
| 1001 | targetptr="device_callhome_nat">Device Call Home Connection for | 1067 | targetptr="device_callhome_nat">Device Call Home Connection for |
| 1002 | deployment behind NAT in the <xi:include | 1068 | deployment behind NAT in the <xi:include |
| 1003 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 1069 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml b/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml index 8b8be31..1b415a2 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml | |||
| @@ -3,9 +3,9 @@ | |||
| 3 | <title>Using the Log Collector</title> | 3 | <title>Using the Log Collector</title> |
| 4 | 4 | ||
| 5 | <para>Troubleshooting problems on the uCPE device require an analysis of a | 5 | <para>Troubleshooting problems on the uCPE device require an analysis of a |
| 6 | set of information i.e. logs collected from the uCPE device and/or Enea uCPE | 6 | set of information i.e. logs collected from the uCPE device and/or the Enea |
| 7 | Manager. The following describe how the log collection mechanism | 7 | uCPE Manager. The following information describes how the log collection |
| 8 | works.</para> | 8 | mechanism works.</para> |
| 9 | 9 | ||
| 10 | <section id="log_collect_ucpem"> | 10 | <section id="log_collect_ucpem"> |
| 11 | <title>Log collecting using the Enea uCPE Manager</title> | 11 | <title>Log collecting using the Enea uCPE Manager</title> |
| @@ -22,8 +22,8 @@ | |||
| 22 | 22 | ||
| 23 | <orderedlist> | 23 | <orderedlist> |
| 24 | <listitem> | 24 | <listitem> |
| 25 | <para>Access <literal>Operations</literal> -> <literal>Collect | 25 | <para>Access <emphasis role="bold">Operations</emphasis> and then |
| 26 | Debug Logs</literal>.</para> | 26 | select <emphasis role="bold">Collect Debug Logs</emphasis>.</para> |
| 27 | </listitem> | 27 | </listitem> |
| 28 | 28 | ||
| 29 | <listitem> | 29 | <listitem> |
| @@ -31,7 +31,7 @@ | |||
| 31 | </listitem> | 31 | </listitem> |
| 32 | 32 | ||
| 33 | <listitem> | 33 | <listitem> |
| 34 | <para>Press the <literal>Execute</literal> button.</para> | 34 | <para>Press the <emphasis role="bold">Execute</emphasis> button.</para> |
| 35 | 35 | ||
| 36 | <para>A success message is shown in the same window as shown below. | 36 | <para>A success message is shown in the same window as shown below. |
| 37 | At this moment, the process of collecting logs on the uCPE device | 37 | At this moment, the process of collecting logs on the uCPE device |
| @@ -54,8 +54,8 @@ | |||
| 54 | <para>It might take some time for the archive to be created. When the | 54 | <para>It might take some time for the archive to be created. When the |
| 55 | operation completes, a "CollectLogsComplete" notification is sent from | 55 | operation completes, a "CollectLogsComplete" notification is sent from |
| 56 | the uCPE device to the Enea uCPE Manager. This can be viewed in the | 56 | the uCPE device to the Enea uCPE Manager. This can be viewed in the |
| 57 | GUI under the <literal>Faults</literal> -> | 57 | GUI in the <emphasis role="bold">Faults</emphasis> menu, after selecting |
| 58 | <literal>Events</literal> toolbar menu.</para> | 58 | <emphasis role="bold">Events</emphasis>.</para> |
| 59 | 59 | ||
| 60 | <figure> | 60 | <figure> |
| 61 | <title>Collecting Debug Logs</title> | 61 | <title>Collecting Debug Logs</title> |
| @@ -74,16 +74,16 @@ | |||
| 74 | <title>View collected Logs</title> | 74 | <title>View collected Logs</title> |
| 75 | 75 | ||
| 76 | <para>A list with the archives containing already collected logs will be | 76 | <para>A list with the archives containing already collected logs will be |
| 77 | shown in the <literal>Device File Listing</literal> table:</para> | 77 | shown in the <emphasis role="bold">Device File Listing</emphasis> table:</para> |
| 78 | 78 | ||
| 79 | <orderedlist> | 79 | <orderedlist> |
| 80 | <listitem> | 80 | <listitem> |
| 81 | <para>Access <literal>Files</literal> -> | 81 | <para>Access <emphasis role="bold">Files</emphasis> and then the |
| 82 | <literal>Download</literal>.</para> | 82 | <emphasis role="bold">Download</emphasis> button.</para> |
| 83 | </listitem> | 83 | </listitem> |
| 84 | 84 | ||
| 85 | <listitem> | 85 | <listitem> |
| 86 | <para>Press the <literal>List</literal> button.</para> | 86 | <para>Press the <emphasis role="bold">List</emphasis> button.</para> |
| 87 | 87 | ||
| 88 | <figure> | 88 | <figure> |
| 89 | <title>Device File Listing Table</title> | 89 | <title>Device File Listing Table</title> |
| @@ -100,7 +100,7 @@ | |||
| 100 | 100 | ||
| 101 | <note> | 101 | <note> |
| 102 | <para>If the filename you specified does not appear, it might still be | 102 | <para>If the filename you specified does not appear, it might still be |
| 103 | in the process of creation. Click on the <literal>Refresh</literal> | 103 | in the process of creation. Click on the <emphasis role="bold">Refresh</emphasis> |
| 104 | icon at the bottom of the table until you can see the desired file | 104 | icon at the bottom of the table until you can see the desired file |
| 105 | listing.</para> | 105 | listing.</para> |
| 106 | </note> | 106 | </note> |
| @@ -114,22 +114,22 @@ | |||
| 114 | 114 | ||
| 115 | <orderedlist> | 115 | <orderedlist> |
| 116 | <listitem> | 116 | <listitem> |
| 117 | <para>Access <literal>Files</literal> -> | 117 | <para>Access <emphasis role="bold">Files</emphasis> and choose the |
| 118 | <literal>Download</literal>.</para> | 118 | <emphasis role="bold">Download</emphasis> button.</para> |
| 119 | </listitem> | 119 | </listitem> |
| 120 | 120 | ||
| 121 | <listitem> | 121 | <listitem> |
| 122 | <para>Press the <literal>List</literal> button.</para> | 122 | <para>Press the <emphasis role="bold">List</emphasis> button.</para> |
| 123 | </listitem> | 123 | </listitem> |
| 124 | 124 | ||
| 125 | <listitem> | 125 | <listitem> |
| 126 | <para>In the <literal>Device File Listing</literal> table, select | 126 | <para>In the <emphasis role="bold">Device File Listing</emphasis> table, select |
| 127 | the archive you want to download from the uCPE device to Enea uCPE | 127 | the archive you want to download from the uCPE device to Enea uCPE |
| 128 | Manager.</para> | 128 | Manager.</para> |
| 129 | </listitem> | 129 | </listitem> |
| 130 | 130 | ||
| 131 | <listitem> | 131 | <listitem> |
| 132 | <para>Press the <literal>Download from Device</literal> | 132 | <para>Press the <emphasis role="bold">Download from Device</emphasis> |
| 133 | button.</para> | 133 | button.</para> |
| 134 | 134 | ||
| 135 | <para>The archive will be downloaded from the uCPE device and stored | 135 | <para>The archive will be downloaded from the uCPE device and stored |
| @@ -152,21 +152,21 @@ | |||
| 152 | 152 | ||
| 153 | <orderedlist> | 153 | <orderedlist> |
| 154 | <listitem> | 154 | <listitem> |
| 155 | <para>Access <literal>Devices</literal> -> | 155 | <para>Access the <emphasis role="bold">Devices</emphasis> menu and select |
| 156 | <literal>Files</literal>.</para> | 156 | <emphasis role="bold">Files</emphasis>.</para> |
| 157 | </listitem> | 157 | </listitem> |
| 158 | 158 | ||
| 159 | <listitem> | 159 | <listitem> |
| 160 | <para>Select the <literal>Downloaded Files</literal> tab.</para> | 160 | <para>Select the <emphasis role="bold">Downloaded Files</emphasis> tab.</para> |
| 161 | </listitem> | 161 | </listitem> |
| 162 | 162 | ||
| 163 | <listitem> | 163 | <listitem> |
| 164 | <para>Select an archive from <literal>Downloaded Files</literal> | 164 | <para>Select an archive from the <emphasis role="bold">Downloaded Files</emphasis> |
| 165 | table.</para> | 165 | table.</para> |
| 166 | </listitem> | 166 | </listitem> |
| 167 | 167 | ||
| 168 | <listitem> | 168 | <listitem> |
| 169 | <para>Click the <literal>Download</literal> button.</para> | 169 | <para>Click the <emphasis role="bold">Download</emphasis> button.</para> |
| 170 | 170 | ||
| 171 | <para>The file will be downloaded in browser's download | 171 | <para>The file will be downloaded in browser's download |
| 172 | folder.</para> | 172 | folder.</para> |
| @@ -193,21 +193,21 @@ | |||
| 193 | 193 | ||
| 194 | <orderedlist> | 194 | <orderedlist> |
| 195 | <listitem> | 195 | <listitem> |
| 196 | <para>Access <literal>Files</literal> -> | 196 | <para>Access <emphasis role="bold">Files</emphasis> and then click the |
| 197 | <literal>Download</literal>.</para> | 197 | <emphasis role="bold">Download</emphasis> button.</para> |
| 198 | </listitem> | 198 | </listitem> |
| 199 | 199 | ||
| 200 | <listitem> | 200 | <listitem> |
| 201 | <para>Press the <literal>List</literal> button.</para> | 201 | <para>Press the <emphasis role="bold">List</emphasis> button.</para> |
| 202 | </listitem> | 202 | </listitem> |
| 203 | 203 | ||
| 204 | <listitem> | 204 | <listitem> |
| 205 | <para>In the <literal>Device File Listing</literal> table, select | 205 | <para>In the <emphasis role="bold">Device File Listing</emphasis> table, select |
| 206 | the archive you want to delete from the uCPE device.</para> | 206 | the archive you want to delete from the uCPE device.</para> |
| 207 | </listitem> | 207 | </listitem> |
| 208 | 208 | ||
| 209 | <listitem> | 209 | <listitem> |
| 210 | <para>Press the <literal>Delete</literal> button.</para> | 210 | <para>Press the <emphasis role="bold">Delete</emphasis> button.</para> |
| 211 | 211 | ||
| 212 | <para>The archive will be deleted from the uCPE device and the table | 212 | <para>The archive will be deleted from the uCPE device and the table |
| 213 | will be updated.</para> | 213 | will be updated.</para> |
| @@ -218,8 +218,8 @@ | |||
| 218 | 218 | ||
| 219 | <orderedlist> | 219 | <orderedlist> |
| 220 | <listitem> | 220 | <listitem> |
| 221 | <para>Access <literal>Operations</literal> -> <literal>Delete | 221 | <para>Access the <emphasis role="bold">Operations</emphasis> menu and |
| 222 | Debug Log Archive</literal>.</para> | 222 | select <emphasis role="bold">Delete Debug Log Archive</emphasis>.</para> |
| 223 | </listitem> | 223 | </listitem> |
| 224 | 224 | ||
| 225 | <listitem> | 225 | <listitem> |
| @@ -227,7 +227,7 @@ | |||
| 227 | </listitem> | 227 | </listitem> |
| 228 | 228 | ||
| 229 | <listitem> | 229 | <listitem> |
| 230 | <para>Press the <literal>Execute</literal> button.</para> | 230 | <para>Press the <emphasis role="bold">Execute</emphasis> button.</para> |
| 231 | 231 | ||
| 232 | <para>A success message is displayed if the file is deleted from the | 232 | <para>A success message is displayed if the file is deleted from the |
| 233 | uCPE device correctly.</para> | 233 | uCPE device correctly.</para> |
| @@ -243,21 +243,21 @@ | |||
| 243 | 243 | ||
| 244 | <orderedlist> | 244 | <orderedlist> |
| 245 | <listitem> | 245 | <listitem> |
| 246 | <para>Access <literal>Devices</literal> -> | 246 | <para>Access the <emphasis role="bold">Devices</emphasis> menu, then select |
| 247 | <literal>Files</literal>.</para> | 247 | <emphasis role="bold">Files</emphasis>.</para> |
| 248 | </listitem> | 248 | </listitem> |
| 249 | 249 | ||
| 250 | <listitem> | 250 | <listitem> |
| 251 | <para>Select the <literal>Downloaded Files</literal> tab.</para> | 251 | <para>Select the <emphasis role="bold">Downloaded Files</emphasis> tab.</para> |
| 252 | </listitem> | 252 | </listitem> |
| 253 | 253 | ||
| 254 | <listitem> | 254 | <listitem> |
| 255 | <para>Select an archive from the <literal>Downloaded Files</literal> | 255 | <para>Select an archive from the <emphasis role="bold">Downloaded Files</emphasis> |
| 256 | table.</para> | 256 | table.</para> |
| 257 | </listitem> | 257 | </listitem> |
| 258 | 258 | ||
| 259 | <listitem> | 259 | <listitem> |
| 260 | <para>Click the <literal>Delete</literal> button.</para> | 260 | <para>Click the <emphasis role="bold">Delete</emphasis> button.</para> |
| 261 | 261 | ||
| 262 | <para>The file will be deleted from the Enea uCPE Manager and the | 262 | <para>The file will be deleted from the Enea uCPE Manager and the |
| 263 | table will be updated.</para> | 263 | table will be updated.</para> |
| @@ -279,12 +279,12 @@ | |||
| 279 | 279 | ||
| 280 | <orderedlist> | 280 | <orderedlist> |
| 281 | <listitem> | 281 | <listitem> |
| 282 | <para>Access <literal>Security</literal> -> | 282 | <para>Access the <emphasis role="bold">Security</emphasis> menu, |
| 283 | <literal>Configuration</literal>.</para> | 283 | then select <emphasis role="bold">Configuration</emphasis>.</para> |
| 284 | </listitem> | 284 | </listitem> |
| 285 | 285 | ||
| 286 | <listitem> | 286 | <listitem> |
| 287 | <para>Click the <literal>Security Groups</literal> tab.</para> | 287 | <para>Click the <emphasis role="bold">Security Groups</emphasis> tab.</para> |
| 288 | </listitem> | 288 | </listitem> |
| 289 | 289 | ||
| 290 | <listitem> | 290 | <listitem> |
| @@ -292,18 +292,18 @@ | |||
| 292 | </listitem> | 292 | </listitem> |
| 293 | 293 | ||
| 294 | <listitem> | 294 | <listitem> |
| 295 | <para>Click the <literal>Permissions</literal> tab on the right | 295 | <para>Click the <emphasis role="bold">Permissions</emphasis> tab on the right |
| 296 | side.</para> | 296 | side.</para> |
| 297 | </listitem> | 297 | </listitem> |
| 298 | 298 | ||
| 299 | <listitem> | 299 | <listitem> |
| 300 | <para>Click the <literal>Devices</literal> tab like in the image | 300 | <para>Click the <emphasis role="bold">Devices</emphasis> tab like in the image |
| 301 | below.</para> | 301 | below.</para> |
| 302 | </listitem> | 302 | </listitem> |
| 303 | 303 | ||
| 304 | <listitem> | 304 | <listitem> |
| 305 | <para>Change the <literal>Device File Management</literal> option to | 305 | <para>Change the <emphasis role="bold">Device File Management</emphasis> option to |
| 306 | <literal>none</literal> to disable the feature.</para> | 306 | <emphasis role="bold">none</emphasis> to disable the feature.</para> |
| 307 | </listitem> | 307 | </listitem> |
| 308 | </orderedlist> | 308 | </orderedlist> |
| 309 | 309 | ||
| @@ -336,16 +336,15 @@ | |||
| 336 | 336 | ||
| 337 | <orderedlist> | 337 | <orderedlist> |
| 338 | <listitem> | 338 | <listitem> |
| 339 | <para>Access <literal>Test</literal> -> <literal>Debug | 339 | <para>Access <emphasis role="bold">Test</emphasis>, then <emphasis role="bold">Debug |
| 340 | Settings</literal> and select the <literal>Log Files</literal> | 340 | Settings</emphasis> and select the <emphasis role="bold">Log Files</emphasis> tab.</para> |
| 341 | tab.</para> | ||
| 342 | </listitem> | 341 | </listitem> |
| 343 | 342 | ||
| 344 | <listitem> | 343 | <listitem> |
| 345 | <para>Select the desired log file | 344 | <para>Select the desired log file |
| 346 | (<filename>ucpemanager.log</filename> or | 345 | (<filename>ucpemanager.log</filename> or |
| 347 | <filename>watchdog.log</filename>) and press the | 346 | <filename>watchdog.log</filename>) and press the |
| 348 | <literal>Download</literal> button.</para> | 347 | <emphasis role="bold">Download</emphasis> button.</para> |
| 349 | </listitem> | 348 | </listitem> |
| 350 | 349 | ||
| 351 | <listitem> | 350 | <listitem> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml index 1d51537..034908a 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml | |||
| @@ -43,16 +43,16 @@ | |||
| 43 | 43 | ||
| 44 | <para>In use cases where CPU capacity is very limited, disabling DPDK | 44 | <para>In use cases where CPU capacity is very limited, disabling DPDK |
| 45 | can free up CPU capacity and overall performance can improve. Navigate | 45 | can free up CPU capacity and overall performance can improve. Navigate |
| 46 | to <literal>Configuration</literal> -> <literal>DPDK</literal> and | 46 | to <emphasis role="bold">Configuration</emphasis>, then <emphasis role="bold">DPDK</emphasis> and |
| 47 | deselect <literal>Enable DPDK</literal> to disable the DPDK.</para> | 47 | deselect <emphasis role="bold">Enable DPDK</emphasis> to disable the DPDK.</para> |
| 48 | 48 | ||
| 49 | <note> | 49 | <note> |
| 50 | <para>Disabling the DPDK cannot be done after other network | 50 | <para>Disabling the DPDK cannot be done after other network |
| 51 | configurations have been made.</para> | 51 | configurations have been made.</para> |
| 52 | </note> | 52 | </note> |
| 53 | 53 | ||
| 54 | <para>In <literal>Configuration</literal> -> <literal>DPDK</literal> | 54 | <para>In <emphasis role="bold">Configuration</emphasis>, select <emphasis role="bold">DPDK</emphasis> |
| 55 | it is also possible to configure DPDK resources such as:</para> | 55 | where DPDK resources can also be configured such as:</para> |
| 56 | 56 | ||
| 57 | <itemizedlist> | 57 | <itemizedlist> |
| 58 | <listitem> | 58 | <listitem> |
| @@ -89,9 +89,9 @@ | |||
| 89 | management system.</para> | 89 | management system.</para> |
| 90 | 90 | ||
| 91 | <para>To add an interface into the Enea uCPE Manager, select the uCPE | 91 | <para>To add an interface into the Enea uCPE Manager, select the uCPE |
| 92 | device, then from the top toolbar select <literal>Configuration -> | 92 | device, then from the top toolbar select <emphasis role="bold">Configuration</emphasis>, then |
| 93 | External Interfaces -> Configuration -> Add</literal>. The | 93 | <emphasis role="bold">External Interfaces</emphasis>, <emphasis role="bold">Configuration</emphasis>, |
| 94 | available Interface types are detailed below.</para> | 94 | and click the <emphasis role="bold">Add</emphasis> button. The available Interface types are detailed below.</para> |
| 95 | 95 | ||
| 96 | <section id="dpdk_interface_type"> | 96 | <section id="dpdk_interface_type"> |
| 97 | <title>DPDK Interface Type</title> | 97 | <title>DPDK Interface Type</title> |
| @@ -102,10 +102,10 @@ | |||
| 102 | bridge.</para> | 102 | bridge.</para> |
| 103 | 103 | ||
| 104 | <note> | 104 | <note> |
| 105 | <para>Make sure the <literal>Enable DPDK</literal> checkbox is | 105 | <para>Make sure the <emphasis role="bold">Enable DPDK</emphasis> checkbox is |
| 106 | selected in <literal>Device -> Configuration -> | 106 | selected by accessing <emphasis role="bold">Device</emphasis>, |
| 107 | DPDK</literal>, otherwise no interface can be assigned as | 107 | <emphasis role="bold">Configuration</emphasis> and choosing |
| 108 | DPDK.</para> | 108 | <emphasis role="bold">DPDK</emphasis>, otherwise no interface can be assigned as DPDK.</para> |
| 109 | </note> | 109 | </note> |
| 110 | 110 | ||
| 111 | <para>To add a DPDK interface under the management system, set | 111 | <para>To add a DPDK interface under the management system, set |
| @@ -202,17 +202,16 @@ | |||
| 202 | <listitem> | 202 | <listitem> |
| 203 | <para>To edit an interface configuration type from the Enea uCPE | 203 | <para>To edit an interface configuration type from the Enea uCPE |
| 204 | Manager, select the uCPE device, then from the top toolbar select | 204 | Manager, select the uCPE device, then from the top toolbar select |
| 205 | the <literal>Configuration</literal> menu then <literal>External | 205 | the <emphasis role="bold">Configuration</emphasis> menu, then <emphasis role="bold">External |
| 206 | Interfaces -> Configuration</literal>. The already configured | 206 | Interfaces</emphasis> and <emphasis role="bold">Configuration</emphasis>. |
| 207 | interfaces are displayed here, as can be seen in the figure | 207 | The already configured interfaces are displayed here, as seen in the figure above.</para> |
| 208 | above.</para> | ||
| 209 | </listitem> | 208 | </listitem> |
| 210 | 209 | ||
| 211 | <listitem> | 210 | <listitem> |
| 212 | <para>In order to edit an already configured interface, (as in the | 211 | <para>In order to edit an already configured interface, (as in the |
| 213 | example popup shown below, a WAN interface) double click on the | 212 | example popup shown below, a WAN interface) double click on the |
| 214 | desired one and a popup will appear. A different popup appears for | 213 | desired one and a popup will appear. A different popup appears for |
| 215 | each type of interface. From the <literal>Host Interface</literal> | 214 | each type of interface. From the <emphasis role="bold">Host Interface</emphasis> |
| 216 | window, a user can change the networking type and the IP address | 215 | window, a user can change the networking type and the IP address |
| 217 | assignment:</para> | 216 | assignment:</para> |
| 218 | 217 | ||
| @@ -243,9 +242,9 @@ | |||
| 243 | <title>Manual Configuration</title> | 242 | <title>Manual Configuration</title> |
| 244 | 243 | ||
| 245 | <para>For Manual Configuration of uCPE networking, select the uCPE | 244 | <para>For Manual Configuration of uCPE networking, select the uCPE |
| 246 | device first and then <literal>Configuration</literal> -> | 245 | device first, then access the <emphasis role="bold">Configuration</emphasis> menu, |
| 247 | <literal>External Interfaces</literal>, where one can find a list of | 246 | and choose <emphasis role="bold">External Interfaces</emphasis>, where a list of |
| 248 | available network interfaces and their capabilities.</para> | 247 | available network interfaces and their capabilities can be found.</para> |
| 249 | 248 | ||
| 250 | <para>After networking interfaces have been added to the Enea uCPE | 249 | <para>After networking interfaces have been added to the Enea uCPE |
| 251 | Manager, the user can change the interface type (DPDK, SR-IOV, | 250 | Manager, the user can change the interface type (DPDK, SR-IOV, |
| @@ -290,22 +289,23 @@ | |||
| 290 | </listitem> | 289 | </listitem> |
| 291 | 290 | ||
| 292 | <listitem> | 291 | <listitem> |
| 293 | <para>Select <literal>Configuration</literal>.</para> | 292 | <para>Select <emphasis role="bold">Configuration</emphasis>.</para> |
| 294 | </listitem> | 293 | </listitem> |
| 295 | 294 | ||
| 296 | <listitem> | 295 | <listitem> |
| 297 | <para>Click <literal>OpenvSwitch</literal>.</para> | 296 | <para>Click <emphasis role="bold">OpenvSwitch</emphasis>.</para> |
| 298 | </listitem> | 297 | </listitem> |
| 299 | 298 | ||
| 300 | <listitem> | 299 | <listitem> |
| 301 | <para>Select the <literal>Bridges</literal> option, then click | 300 | <para>Select the <emphasis role="bold">Bridges</emphasis> option, then click |
| 302 | <literal>Add</literal>.</para> | 301 | <emphasis role="bold">Add</emphasis>.</para> |
| 303 | </listitem> | 302 | </listitem> |
| 304 | </orderedlist> | 303 | </orderedlist> |
| 305 | 304 | ||
| 306 | <note> | 305 | <note> |
| 307 | <para>Depending on the settings in <literal>Configuration -> | 306 | <para>Depending on the settings found when accessing <emphasis role="bold">Configuration</emphasis>, |
| 308 | OpenVSwitch -> DPDK</literal>, OVS bridges with or without DPDK | 307 | <emphasis role="bold">OpenVSwitch</emphasis> and selecting |
| 308 | <emphasis role="bold">DPDK</emphasis>, OVS bridges with or without DPDK | ||
| 309 | support will be used on the uCPE device.</para> | 309 | support will be used on the uCPE device.</para> |
| 310 | </note> | 310 | </note> |
| 311 | 311 | ||
| @@ -473,9 +473,9 @@ | |||
| 473 | which occurs when the uCPE device connects to the Enea uCPE Manager | 473 | which occurs when the uCPE device connects to the Enea uCPE Manager |
| 474 | informing that the ZTP setup failed for the specific uCPE device.</para> | 474 | informing that the ZTP setup failed for the specific uCPE device.</para> |
| 475 | 475 | ||
| 476 | <para>To create an offline configuration, from the top toolbar menu | 476 | <para>To create an offline configuration, select from the top toolbar |
| 477 | select <literal>Applications</literal> -> <literal>Offline | 477 | the <emphasis role="bold">Applications</emphasis> menu, then <emphasis role="bold">Offline |
| 478 | Config</literal> -> <literal>Add</literal>. The following fields | 478 | Config</emphasis> and choose <emphasis role="bold">Add</emphasis>. The following fields |
| 479 | should be filled:</para> | 479 | should be filled:</para> |
| 480 | 480 | ||
| 481 | <itemizedlist> | 481 | <itemizedlist> |
| @@ -536,9 +536,9 @@ | |||
| 536 | <para>If a match is found, the offline configuration is sent to the | 536 | <para>If a match is found, the offline configuration is sent to the |
| 537 | device as part of Zero-Touch-Provisioning.</para> | 537 | device as part of Zero-Touch-Provisioning.</para> |
| 538 | 538 | ||
| 539 | <para>After creating the Offline Config Store, access the device through | 539 | <para>After creating the Offline Config Store, access the device by selecting |
| 540 | <literal>Applications</literal> -> <literal>offline config</literal> | 540 | <emphasis role="bold">Applications</emphasis>, then <emphasis role="bold">offline config</emphasis> |
| 541 | -> <literal>Config App</literal> and provision it with the required | 541 | and clicking <emphasis role="bold">Config App</emphasis>, to provision it with the required |
| 542 | initial configuration. This operation mirrors what happens during manual | 542 | initial configuration. This operation mirrors what happens during manual |
| 543 | configuration described previously.</para> | 543 | configuration described previously.</para> |
| 544 | 544 | ||
| @@ -547,9 +547,9 @@ | |||
| 547 | connects to the Enea uCPE Manager. Just changing an offline | 547 | connects to the Enea uCPE Manager. Just changing an offline |
| 548 | configuration will not push the new changes to the device. If an | 548 | configuration will not push the new changes to the device. If an |
| 549 | offline configuration is changed after uCPE device registration, a | 549 | offline configuration is changed after uCPE device registration, a |
| 550 | factory reset can be executed to force a new ZTP to execute by | 550 | factory reset can be executed to force a new ZTP to execute. |
| 551 | selecting the device, then <literal>Operations</literal> -> | 551 | Select the device, then access the <emphasis role="bold">Operations</emphasis> menu |
| 552 | <literal>factory reset</literal>.</para> | 552 | and select <emphasis role="bold">factory reset</emphasis>.</para> |
| 553 | </note> | 553 | </note> |
| 554 | </section> | 554 | </section> |
| 555 | </section> | 555 | </section> |
| @@ -597,22 +597,22 @@ | |||
| 597 | 597 | ||
| 598 | <orderedlist> | 598 | <orderedlist> |
| 599 | <listitem> | 599 | <listitem> |
| 600 | <para>Select <literal>Devices</literal> -> <literal>Custom | 600 | <para>Access the <emphasis role="bold">Devices</emphasis> menu, then <emphasis role="bold">Custom |
| 601 | Scripts</literal> -> <literal>Configure</literal>.</para> | 601 | Scripts</emphasis> and choose <emphasis role="bold">Configure</emphasis>.</para> |
| 602 | </listitem> | 602 | </listitem> |
| 603 | 603 | ||
| 604 | <listitem> | 604 | <listitem> |
| 605 | <para>Select <literal>Upload to EMS</literal>.</para> | 605 | <para>Select <emphasis role="bold">Upload to EMS</emphasis>.</para> |
| 606 | </listitem> | 606 | </listitem> |
| 607 | 607 | ||
| 608 | <listitem> | 608 | <listitem> |
| 609 | <para>In the <literal>Script Type</literal> menu, select the type | 609 | <para>In the <emphasis role="bold">Script Type</emphasis> menu, select the type |
| 610 | the uploaded script should have.</para> | 610 | the uploaded script should have.</para> |
| 611 | </listitem> | 611 | </listitem> |
| 612 | 612 | ||
| 613 | <listitem> | 613 | <listitem> |
| 614 | <para>Press <literal>Choose File</literal> to select the scripts | 614 | <para>Press <emphasis role="bold">Choose File</emphasis> to select the scripts |
| 615 | needed, and then press <literal>Send</literal>.</para> | 615 | needed, and then click <emphasis role="bold">Send</emphasis>.</para> |
| 616 | </listitem> | 616 | </listitem> |
| 617 | </orderedlist> | 617 | </orderedlist> |
| 618 | </section> | 618 | </section> |
| @@ -624,14 +624,14 @@ | |||
| 624 | 624 | ||
| 625 | <orderedlist> | 625 | <orderedlist> |
| 626 | <listitem> | 626 | <listitem> |
| 627 | <para>Select <literal>Devices</literal> -> <literal>Custom | 627 | <para>Access the <emphasis role="bold">Devices</emphasis> menu, then <emphasis role="bold">Custom |
| 628 | Scripts</literal> -> <literal>Configure</literal>.</para> | 628 | Scripts</emphasis> and select <emphasis role="bold">Configure</emphasis>.</para> |
| 629 | </listitem> | 629 | </listitem> |
| 630 | 630 | ||
| 631 | <listitem> | 631 | <listitem> |
| 632 | <para>Select the script you want to delete from the | 632 | <para>Select the script you want to delete from the |
| 633 | <literal>Uploaded Scripts</literal> tab and then click | 633 | <emphasis role="bold">Uploaded Scripts</emphasis> tab and then click |
| 634 | <literal>Delete</literal>, which will remove the script immediately | 634 | <emphasis role="bold">Delete</emphasis>, which will remove the script immediately |
| 635 | from the Enea uCPE Manager.</para> | 635 | from the Enea uCPE Manager.</para> |
| 636 | </listitem> | 636 | </listitem> |
| 637 | </orderedlist> | 637 | </orderedlist> |
| @@ -645,12 +645,12 @@ | |||
| 645 | 645 | ||
| 646 | <orderedlist> | 646 | <orderedlist> |
| 647 | <listitem> | 647 | <listitem> |
| 648 | <para>Select <literal>Devices</literal> -> <literal>Custom | 648 | <para>Access the <emphasis role="bold">Devices</emphasis> menu, choose <emphasis role="bold">Custom |
| 649 | Scripts</literal> -> <literal>Configure</literal>.</para> | 649 | Scripts</emphasis> and select <emphasis role="bold">Configure</emphasis>.</para> |
| 650 | </listitem> | 650 | </listitem> |
| 651 | 651 | ||
| 652 | <listitem> | 652 | <listitem> |
| 653 | <para>Select the <literal>Configuration</literal> tab and specify a | 653 | <para>Select the <emphasis role="bold">Configuration</emphasis> tab and specify a |
| 654 | new loacation to store the scripts.</para> | 654 | new loacation to store the scripts.</para> |
| 655 | 655 | ||
| 656 | <note> | 656 | <note> |
| @@ -669,21 +669,21 @@ | |||
| 669 | 669 | ||
| 670 | <orderedlist> | 670 | <orderedlist> |
| 671 | <listitem> | 671 | <listitem> |
| 672 | <para>Select <literal>Devices</literal> -> <literal>Custom | 672 | <para>Access the <emphasis role="bold">Devices</emphasis> menu, choose <emphasis role="bold">Custom |
| 673 | Scripts</literal> -> <literal>Apply Scripts</literal>.</para> | 673 | Scripts</emphasis> and select <emphasis role="bold">Apply Scripts</emphasis>.</para> |
| 674 | </listitem> | 674 | </listitem> |
| 675 | 675 | ||
| 676 | <listitem> | 676 | <listitem> |
| 677 | <para>In the <literal>Script Config Screen</literal> pop up, select | 677 | <para>In the <emphasis role="bold">Script Config Screen</emphasis> pop up, select |
| 678 | the devices from the device(s) chooser list on which to run the | 678 | the devices from the device(s) chooser list on which to run the |
| 679 | scripts. Press the <literal>></literal> button to move the | 679 | scripts. Press the <emphasis role="bold">></emphasis> button to move the |
| 680 | devices to the right side of the chooser, which is the list of | 680 | devices to the right side of the chooser, which is the list of |
| 681 | devices that will execute the selected scripts.</para> | 681 | devices that will execute the selected scripts.</para> |
| 682 | </listitem> | 682 | </listitem> |
| 683 | 683 | ||
| 684 | <listitem> | 684 | <listitem> |
| 685 | <para>Select the scripts from the list under the device(s) chooser | 685 | <para>Select the scripts from the list under the device(s) chooser |
| 686 | by pressing the <literal>+</literal> button.</para> | 686 | by pressing the <emphasis role="bold">+</emphasis> button.</para> |
| 687 | </listitem> | 687 | </listitem> |
| 688 | 688 | ||
| 689 | <listitem> | 689 | <listitem> |
| @@ -694,14 +694,14 @@ | |||
| 694 | </listitem> | 694 | </listitem> |
| 695 | 695 | ||
| 696 | <listitem> | 696 | <listitem> |
| 697 | <para>Check the checkbox <literal>Reboot devices</literal> if you | 697 | <para>Check the <emphasis role="bold">Reboot devices</emphasis> checkbox if you |
| 698 | want to reboot and execute the scripts at once and then press | 698 | want to reboot and execute the scripts at once and then select |
| 699 | <literal>ok</literal>.</para> | 699 | <emphasis role="bold">ok</emphasis>.</para> |
| 700 | 700 | ||
| 701 | <note> | 701 | <note> |
| 702 | <para>The status of execution for the scripts can be seen by | 702 | <para>The status of execution for the scripts can be seen by |
| 703 | opening the <literal>Fault</literal> -> | 703 | accessing <emphasis role="bold">Fault</emphasis>, opening the |
| 704 | <literal>Events</literal> screen and filtering by device and/or | 704 | <emphasis role="bold">Events</emphasis> screen and filtering by device and/or |
| 705 | the event name <filename>CustomScriptExecuted</filename>.</para> | 705 | the event name <filename>CustomScriptExecuted</filename>.</para> |
| 706 | </note> | 706 | </note> |
| 707 | </listitem> | 707 | </listitem> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml b/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml index e176cec..f416f8f 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml | |||
| @@ -2,20 +2,20 @@ | |||
| 2 | <chapter id="troubleshooting"> | 2 | <chapter id="troubleshooting"> |
| 3 | <title>Troubleshooting and Recovery</title> | 3 | <title>Troubleshooting and Recovery</title> |
| 4 | 4 | ||
| 5 | <para>The following is a small list of possible Enea NFV Access problems, | 5 | <para>In all scenarios where possible, collect the logs for |
| 6 | and their solutions. <emphasis role="bold">In all scenarios collect the logs | 6 | debugging. More information on log collecting can be found in |
| 7 | if possible for debugging.</emphasis> More information on log collecting can | 7 | <olink targetdoc="book_enea_nfv_access_getting_started" |
| 8 | be found in <olink targetdoc="book_enea_nfv_access_getting_started" | ||
| 9 | targetptr="log_collector">Using the Log Collector in the <xi:include | 8 | targetptr="log_collector">Using the Log Collector in the <xi:include |
| 10 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 9 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
| 11 | xmlns:xi="http://www.w3.org/2001/XInclude" | 10 | xmlns:xi="http://www.w3.org/2001/XInclude" |
| 12 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 11 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
| 13 | Manual.</para> | 12 | Manual.</para> |
| 14 | 13 | ||
| 15 | <para>If you encounter other issues or can't get Enea NFV Access to work | 14 | <para>The following is a small list of possible Enea NFV Access problems, |
| 15 | and their solutions. If you encounter other issues or can't get Enea NFV Access to work | ||
| 16 | successfully after consulting the information below, please use the <olink | 16 | successfully after consulting the information below, please use the <olink |
| 17 | targetdoc="book_enea_nfv_access_release_info" | 17 | targetdoc="book_enea_nfv_access_release_info" |
| 18 | targetptr="contacting_enea_support">Enea Support team Form, available in the | 18 | targetptr="contacting_enea_support">Enea Support Team Form, available in the |
| 19 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 19 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
| 20 | xmlns:xi="http://www.w3.org/2001/XInclude" | 20 | xmlns:xi="http://www.w3.org/2001/XInclude" |
| 21 | xpointer="element(book_enea_nfv_access_release_info/1)" /></olink> Manual | 21 | xpointer="element(book_enea_nfv_access_release_info/1)" /></olink> Manual |
| @@ -154,8 +154,8 @@ | |||
| 154 | </listitem> | 154 | </listitem> |
| 155 | 155 | ||
| 156 | <listitem> | 156 | <listitem> |
| 157 | <para>Use the <literal>Reconnect</literal> button from the | 157 | <para>Use the <emphasis role="bold">Reconnect</emphasis> |
| 158 | Enea uCPE Manager's GUI.</para> | 158 | button from the Enea uCPE Manager's GUI.</para> |
| 159 | </listitem> | 159 | </listitem> |
| 160 | 160 | ||
| 161 | <listitem> | 161 | <listitem> |
| @@ -205,17 +205,18 @@ | |||
| 205 | </listitem> | 205 | </listitem> |
| 206 | 206 | ||
| 207 | <listitem> | 207 | <listitem> |
| 208 | <para>Reboot the device using <literal>Operations</literal> | 208 | <para>Reboot the device by accessing <emphasis |
| 209 | -> <literal>Reboot</literal> menu options from within the | 209 | role="bold">Operations</emphasis> and then selecting <emphasis |
| 210 | Enea uCPE Manager.</para> | 210 | role="bold">Reboot</emphasis> from within the Enea uCPE |
| 211 | Manager.</para> | ||
| 211 | </listitem> | 212 | </listitem> |
| 212 | 213 | ||
| 213 | <listitem> | 214 | <listitem> |
| 214 | <para>If the above actions do not work, redeploy all services. | 215 | <para>If the above actions do not work, redeploy all services. |
| 215 | This is done by cleaning up the existing configuration using: | 216 | This is done by cleaning up the existing configuration by |
| 216 | <literal>Operations</literal> -> <literal>Factory | 217 | accessing <emphasis role="bold">Operations</emphasis>, then selecting |
| 217 | Reset</literal> for a specific device and redeploying the VNF | 218 | <emphasis role="bold">Factory Reset</emphasis> for a specific device and |
| 218 | services.</para> | 219 | redeploying the VNF services.</para> |
| 219 | </listitem> | 220 | </listitem> |
| 220 | </orderedlist></entry> | 221 | </orderedlist></entry> |
| 221 | </row> | 222 | </row> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml index 01fd8ec..2f5801c 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml | |||
| @@ -4,16 +4,17 @@ | |||
| 4 | 4 | ||
| 5 | <para>Enea provides regular releases that will require the upgrading of Enea | 5 | <para>Enea provides regular releases that will require the upgrading of Enea |
| 6 | NFV Access components. The Enea uCPE Manager must be upgraded first, | 6 | NFV Access components. The Enea uCPE Manager must be upgraded first, |
| 7 | followed by upgrading Enea NFV Access Runtime on the uCPE devices.</para> | 7 | followed by upgrading the Enea NFV Access Runtime Platform on the uCPE |
| 8 | devices.</para> | ||
| 8 | 9 | ||
| 9 | <section id="upgrade_mg"> | 10 | <section id="upgrade_mg"> |
| 10 | <title>Upgrading the Enea uCPE Manager</title> | 11 | <title>Upgrading the Enea uCPE Manager</title> |
| 11 | 12 | ||
| 12 | <note> | 13 | <note> |
| 13 | <para>It is recommended to create a system backup by accessing: | 14 | <para>It is recommended to create a system backup by accessing <emphasis |
| 14 | <literal>System</literal> -> <literal>System Backup</literal> from | 15 | role="bold">System</emphasis> and selecting <emphasis role="bold">System |
| 15 | the Enea uCPE Manager GUI, for recovery in case of an upgrade | 16 | Backup</emphasis> from the Enea uCPE Manager GUI, for recovery in case |
| 16 | failure.</para> | 17 | of an upgrade failure.</para> |
| 17 | </note> | 18 | </note> |
| 18 | 19 | ||
| 19 | <orderedlist> | 20 | <orderedlist> |
| @@ -171,7 +172,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 171 | 172 | ||
| 172 | <listitem> | 173 | <listitem> |
| 173 | <para>Uninstall the <literal>ucpemanager</literal> service, so that | 174 | <para>Uninstall the <literal>ucpemanager</literal> service, so that |
| 174 | it will not startup on reboot.</para> | 175 | it will not start up on reboot.</para> |
| 175 | </listitem> | 176 | </listitem> |
| 176 | 177 | ||
| 177 | <listitem> | 178 | <listitem> |
| @@ -220,38 +221,42 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 220 | </section> | 221 | </section> |
| 221 | 222 | ||
| 222 | <section id="mg_upgrade"> | 223 | <section id="mg_upgrade"> |
| 223 | <title>Managing the device Upgrade</title> | 224 | <title>Managing the uCPE device Upgrade</title> |
| 224 | 225 | ||
| 225 | <para>Before an installation or upgrade can be completed, certain | 226 | <para>Before an installation or upgrade can be completed, certain |
| 226 | configuration data must be set. Files also need to be uploaded to the | 227 | configuration data must be set. Files also need to be uploaded to the |
| 227 | Device Upgrade image repository to be uploaded to the device.</para> | 228 | Device Upgrade image repository in order to be uploaded to the |
| 229 | device.</para> | ||
| 228 | 230 | ||
| 229 | <para>Launch the Device Upgrade management console by selecting | 231 | <para>Launch the Device Upgrade management console by selecting |
| 230 | <literal>Devices</literal> -> <literal>Upgrade</literal> from the top | 232 | <emphasis role="bold">Devices</emphasis> and then the <emphasis |
| 231 | tool-bar. The console will contain the following tabs:</para> | 233 | role="bold">Upgrade</emphasis> button from the top tool-bar. The console |
| 234 | will contain the following tabs:</para> | ||
| 232 | 235 | ||
| 233 | <itemizedlist> | 236 | <itemizedlist> |
| 234 | <listitem> | 237 | <listitem> |
| 235 | <para><literal>Image Library</literal>. To add/delete an | 238 | <para><emphasis role="bold">Image Library</emphasis>. To add/delete |
| 236 | image.</para> | 239 | an image.</para> |
| 237 | </listitem> | 240 | </listitem> |
| 238 | 241 | ||
| 239 | <listitem> | 242 | <listitem> |
| 240 | <para><literal>Upgrade Operations</literal>. See running upgrades, | 243 | <para><emphasis role="bold">Upgrade Operations</emphasis>. See |
| 241 | cancel any upgrades in progress, start a uCPE device upgrade.</para> | 244 | upgrades that are currently running, cancel any upgrades in |
| 245 | progress, or start a uCPE device upgrade.</para> | ||
| 242 | </listitem> | 246 | </listitem> |
| 243 | 247 | ||
| 244 | <listitem> | 248 | <listitem> |
| 245 | <para><literal>Configuration</literal>. Upgrade configuration | 249 | <para><emphasis role="bold">Configuration</emphasis>. Upgrade |
| 246 | parameters.</para> | 250 | configuration parameters.</para> |
| 247 | </listitem> | 251 | </listitem> |
| 248 | </itemizedlist> | 252 | </itemizedlist> |
| 249 | 253 | ||
| 250 | <para>Press Close when the message <literal>File Uploaded | 254 | <para>Press <emphasis role="bold">Close</emphasis> when the message |
| 251 | Successfully</literal> appears on the File Upload Screen.</para> | 255 | <literal>File Uploaded Successfully</literal> appears on the <emphasis |
| 256 | role="bold">File Upload</emphasis> screen.</para> | ||
| 252 | 257 | ||
| 253 | <note> | 258 | <note> |
| 254 | <para>The uCPE Device upgrade is done with image files of type | 259 | <para>The uCPE Device upgrade is done with image files of the type |
| 255 | <literal>rootfs.ostree.tar.bz2</literal>, which are available in the | 260 | <literal>rootfs.ostree.tar.bz2</literal>, which are available in the |
| 256 | <filename>Enea_NFV_Access_Run_Time_Platform_<processor>_<version>-build<build_number>.tar.gz</filename> | 261 | <filename>Enea_NFV_Access_Run_Time_Platform_<processor>_<version>-build<build_number>.tar.gz</filename> |
| 257 | file you downloaded with your release.</para> | 262 | file you downloaded with your release.</para> |
| @@ -263,18 +268,19 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 263 | <para><emphasis role="bold">Adding an image to the image | 268 | <para><emphasis role="bold">Adding an image to the image |
| 264 | repository/library</emphasis><orderedlist> | 269 | repository/library</emphasis><orderedlist> |
| 265 | <listitem> | 270 | <listitem> |
| 266 | <para>Select <literal>Devices</literal> -> | 271 | <para>Select <emphasis role="bold">Devices</emphasis> and then |
| 267 | <literal>Upgrade</literal>.</para> | 272 | the <emphasis role="bold">Upgrade</emphasis> button.</para> |
| 268 | </listitem> | 273 | </listitem> |
| 269 | 274 | ||
| 270 | <listitem> | 275 | <listitem> |
| 271 | <para>Select <literal>Add</literal> from the <literal>Image | 276 | <para>Select <emphasis role="bold">Add</emphasis> from the |
| 272 | Library</literal> tab to add a new image file.</para> | 277 | <emphasis role="bold">Image Library</emphasis> tab to add a new |
| 278 | image file.</para> | ||
| 273 | </listitem> | 279 | </listitem> |
| 274 | 280 | ||
| 275 | <listitem> | 281 | <listitem> |
| 276 | <para>Click on <literal>Choose File</literal> to provide the | 282 | <para>Select <emphasis role="bold">Choose File</emphasis> to |
| 277 | path to the image file (must be of type | 283 | provide the path to the image file (must be of type |
| 278 | <literal>rootfs.os-tree.tar.bz2</literal>).</para> | 284 | <literal>rootfs.os-tree.tar.bz2</literal>).</para> |
| 279 | </listitem> | 285 | </listitem> |
| 280 | 286 | ||
| @@ -285,8 +291,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 285 | </listitem> | 291 | </listitem> |
| 286 | 292 | ||
| 287 | <listitem> | 293 | <listitem> |
| 288 | <para>Click <literal>Send</literal> to upload the image to the | 294 | <para>Click <emphasis role="bold">Send</emphasis> to upload the |
| 289 | image repository.</para> | 295 | image to the image repository.</para> |
| 290 | </listitem> | 296 | </listitem> |
| 291 | </orderedlist></para> | 297 | </orderedlist></para> |
| 292 | 298 | ||
| @@ -295,14 +301,14 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 295 | 301 | ||
| 296 | <orderedlist> | 302 | <orderedlist> |
| 297 | <listitem> | 303 | <listitem> |
| 298 | <para>Select <literal>Devices</literal> -> | 304 | <para>Select <emphasis role="bold">Devices</emphasis> and then the |
| 299 | <literal>Upgrade</literal>.</para> | 305 | <emphasis role="bold">Upgrade</emphasis> button.</para> |
| 300 | </listitem> | 306 | </listitem> |
| 301 | 307 | ||
| 302 | <listitem> | 308 | <listitem> |
| 303 | <para>Select the image you want to delete from the <literal>Image | 309 | <para>Select the image you want to delete from the <emphasis |
| 304 | Library</literal> tab and then click | 310 | role="bold">Image Library</emphasis> tab and then click <emphasis |
| 305 | <literal>Delete</literal>.</para> | 311 | role="bold">Delete</emphasis>.</para> |
| 306 | </listitem> | 312 | </listitem> |
| 307 | </orderedlist> | 313 | </orderedlist> |
| 308 | </section> | 314 | </section> |
| @@ -310,12 +316,12 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 310 | <section id="upgrade_options"> | 316 | <section id="upgrade_options"> |
| 311 | <title>Upgrade Operations</title> | 317 | <title>Upgrade Operations</title> |
| 312 | 318 | ||
| 313 | <para>The <literal>Upgrade Operations</literal> tab allows a user to | 319 | <para>The <emphasis role="bold">Upgrade Operations</emphasis> tab |
| 314 | manage uCPE device upgrades in the system. It allows the user to see | 320 | allows a user to manage uCPE device upgrades in the system. It allows |
| 315 | all the upgrades that are currently in progress, as well as listing | 321 | the user to see all the upgrades that are currently in progress, as |
| 316 | the completed ones. If an upgrade succeeds or fails, then a row will | 322 | well as listing the completed ones. If an upgrade succeeds or fails, |
| 317 | be added to the completed upgrades table. If one fails, the failure | 323 | then a row will be added to the completed upgrades table. If one |
| 318 | message will be visible in the table.</para> | 324 | fails, the failure message will be visible in the table.</para> |
| 319 | 325 | ||
| 320 | <note> | 326 | <note> |
| 321 | <para>The list of completed upgrade tasks resides in the cache | 327 | <para>The list of completed upgrade tasks resides in the cache |
| @@ -325,16 +331,17 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 325 | <para><emphasis role="bold">How to Install/Upgrade a device | 331 | <para><emphasis role="bold">How to Install/Upgrade a device |
| 326 | immediately or schedule the process for later</emphasis><orderedlist> | 332 | immediately or schedule the process for later</emphasis><orderedlist> |
| 327 | <listitem> | 333 | <listitem> |
| 328 | <para>Select <literal>Devices</literal> -> | 334 | <para>Select <emphasis role="bold">Devices</emphasis> and then |
| 329 | <literal>Upgrade</literal>.</para> | 335 | the <emphasis role="bold">Upgrade</emphasis> button.</para> |
| 330 | </listitem> | 336 | </listitem> |
| 331 | 337 | ||
| 332 | <listitem> | 338 | <listitem> |
| 333 | <para>Select <literal>Upgrade Devices</literal> from the | 339 | <para>Select <emphasis role="bold">Upgrade Devices</emphasis> |
| 334 | <literal>Upgrade Operations</literal> tab. This will launch a | 340 | from the <emphasis role="bold">Upgrade Operations</emphasis> |
| 335 | <literal>Multi Device Install Image</literal> screen that will | 341 | tab. This will launch a <literal>Multi Device Install |
| 336 | allow the user to install and upgrade more than one uCPE device | 342 | Image</literal> screen that will allow the user to install and |
| 337 | at a time or upgrade later.</para> | 343 | upgrade more than one uCPE device at a time or upgrade |
| 344 | later.</para> | ||
| 338 | </listitem> | 345 | </listitem> |
| 339 | </orderedlist></para> | 346 | </orderedlist></para> |
| 340 | 347 | ||
| @@ -360,8 +367,9 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 360 | </listitem> | 367 | </listitem> |
| 361 | 368 | ||
| 362 | <listitem> | 369 | <listitem> |
| 363 | <para><literal>Image File</literal>. Click on <literal>Choose | 370 | <para><literal>Image File</literal>. Click on <emphasis |
| 364 | Image File</literal> to select the image file.</para> | 371 | role="bold">Choose Image File</emphasis> to select the image |
| 372 | file.</para> | ||
| 365 | </listitem> | 373 | </listitem> |
| 366 | 374 | ||
| 367 | <listitem> | 375 | <listitem> |
| @@ -369,13 +377,14 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 369 | can accept an image file is populated when the image file is | 377 | can accept an image file is populated when the image file is |
| 370 | chosen.</para> | 378 | chosen.</para> |
| 371 | 379 | ||
| 372 | <para>Press the <literal>></literal> button to move the uCPE | 380 | <para>Press the <emphasis role="bold">></emphasis> button to |
| 373 | devices to the right side of the selector. Those chosen form the | 381 | move the uCPE devices to the right side of the selector. Those |
| 374 | list of uCPE devices that will be upgraded.</para> | 382 | chosen form the list of uCPE devices that will be upgraded.</para> |
| 375 | </listitem> | 383 | </listitem> |
| 376 | 384 | ||
| 377 | <listitem> | 385 | <listitem> |
| 378 | <para>Upgrade Operation. The available options are:</para> | 386 | <para><literal>Upgrade Operation</literal>. The available options |
| 387 | are:</para> | ||
| 379 | 388 | ||
| 380 | <itemizedlist> | 389 | <itemizedlist> |
| 381 | <listitem> | 390 | <listitem> |
| @@ -410,8 +419,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 410 | 419 | ||
| 411 | <para>The installed releases on a uCPE device can be viewed by | 420 | <para>The installed releases on a uCPE device can be viewed by |
| 412 | selecting the uCPE device first, then from the top toolbar selecting | 421 | selecting the uCPE device first, then from the top toolbar selecting |
| 413 | <literal>Configuration</literal> -> | 422 | <emphasis role="bold">Configuration</emphasis> and then the <emphasis |
| 414 | <literal>Upgrade</literal>.</para> | 423 | role="bold">Upgrade</emphasis> button.</para> |
| 415 | 424 | ||
| 416 | <para>The installed releases on the uCPE device, the release status, | 425 | <para>The installed releases on the uCPE device, the release status, |
| 417 | release state, <literal>commit-id</literal> and release version will | 426 | release state, <literal>commit-id</literal> and release version will |
| @@ -422,30 +431,31 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 422 | <title>uCPE device Upgrade Status</title> | 431 | <title>uCPE device Upgrade Status</title> |
| 423 | 432 | ||
| 424 | <para>The status of the installation and upgrade can be viewed in the | 433 | <para>The status of the installation and upgrade can be viewed in the |
| 425 | <literal>Upgrade Operations</literal> tab. Ongoing or scheduled | 434 | <emphasis role="bold">Upgrade Operations</emphasis> tab. Ongoing or |
| 426 | upgrade operations can be viewed or cancelled.</para> | 435 | scheduled upgrade operations can be viewed or cancelled.</para> |
| 427 | 436 | ||
| 428 | <para><emphasis role="bold">To view the status of an installation or | 437 | <para><emphasis role="bold">To view the status of an installation or |
| 429 | upgrade operations</emphasis></para> | 438 | upgrade operations</emphasis></para> |
| 430 | 439 | ||
| 431 | <orderedlist> | 440 | <orderedlist> |
| 432 | <listitem> | 441 | <listitem> |
| 433 | <para>Select <literal>Devices</literal> -> | 442 | <para>Select <emphasis role="bold">Devices</emphasis> and then the |
| 434 | <literal>Upgrade</literal>.</para> | 443 | <emphasis role="bold">Upgrade</emphasis> button.</para> |
| 435 | </listitem> | 444 | </listitem> |
| 436 | 445 | ||
| 437 | <listitem> | 446 | <listitem> |
| 438 | <para>Select <literal>Upgrade Operations</literal>. The ongoing | 447 | <para>Select <emphasis role="bold">Upgrade Operations</emphasis>. |
| 439 | operations are listed at the top and a history of failed or | 448 | The ongoing operations are listed at the top and a history of |
| 440 | successful operations are listed at the bottom.</para> | 449 | failed or successful operations are listed at the bottom.</para> |
| 441 | </listitem> | 450 | </listitem> |
| 442 | 451 | ||
| 443 | <listitem> | 452 | <listitem> |
| 444 | <para>Select an <literal>Active</literal> or <literal>Completed | 453 | <para>Select an <emphasis role="bold">Active</emphasis> or |
| 445 | Upgrade Operation</literal> and click the <literal>Device | 454 | <emphasis role="bold">Completed Upgrade Operation</emphasis> and |
| 446 | Status</literal> button to see detailed information regarding the | 455 | then the <emphasis role="bold">Device Status</emphasis> button to |
| 447 | upgrade operation, including the uCPE devices involved and | 456 | see detailed information regarding the upgrade operation, |
| 448 | information per uCPE device.</para> | 457 | including the uCPE devices involved and information per uCPE |
| 458 | device.</para> | ||
| 449 | </listitem> | 459 | </listitem> |
| 450 | </orderedlist> | 460 | </orderedlist> |
| 451 | 461 | ||
| @@ -454,15 +464,16 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 454 | 464 | ||
| 455 | <orderedlist> | 465 | <orderedlist> |
| 456 | <listitem> | 466 | <listitem> |
| 457 | <para>Select <literal>Devices</literal> -> | 467 | <para>Select <emphasis role="bold">Devices</emphasis>, then the |
| 458 | <literal>Upgrade</literal> -> <literal>Upgrade | 468 | <emphasis role="bold">Upgrade</emphasis> button and choose |
| 459 | Operations</literal>.</para> | 469 | <emphasis role="bold">Upgrade Operations</emphasis>.</para> |
| 460 | </listitem> | 470 | </listitem> |
| 461 | 471 | ||
| 462 | <listitem> | 472 | <listitem> |
| 463 | <para>Select an operation from the list and press <literal>Cancel | 473 | <para>Select an operation from the list and choose <emphasis |
| 464 | Upgrade</literal> and <literal>Confirm</literal>. The operation | 474 | role="bold">Cancel Upgrade</emphasis> and <emphasis |
| 465 | will then be deleted from the list.</para> | 475 | role="bold">Confirm</emphasis>. The operation will then be deleted |
| 476 | from the list.</para> | ||
| 466 | </listitem> | 477 | </listitem> |
| 467 | </orderedlist> | 478 | </orderedlist> |
| 468 | </section> | 479 | </section> |
| @@ -472,19 +483,20 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 472 | 483 | ||
| 473 | <note> | 484 | <note> |
| 474 | <para>The default values present in the configuration of each uCPE | 485 | <para>The default values present in the configuration of each uCPE |
| 475 | device are recommended for use. Modifying them is for an Advanced | 486 | device are recommended for use. Modifying them is for an <emphasis |
| 476 | User only.</para> | 487 | role="bold">Advanced User</emphasis> only.</para> |
| 477 | </note> | 488 | </note> |
| 478 | 489 | ||
| 479 | <para><emphasis role="bold">How to Configure the uCPE device | 490 | <para><emphasis role="bold">How to Configure the uCPE device |
| 480 | Upgrade</emphasis><orderedlist> | 491 | Upgrade</emphasis><orderedlist> |
| 481 | <listitem> | 492 | <listitem> |
| 482 | <para>Select <literal>Devices</literal> -> | 493 | <para>Select <emphasis role="bold">Devices</emphasis> and then |
| 483 | <literal>Upgrade</literal>.</para> | 494 | the <emphasis role="bold">Upgrade</emphasis> button.</para> |
| 484 | </listitem> | 495 | </listitem> |
| 485 | 496 | ||
| 486 | <listitem> | 497 | <listitem> |
| 487 | <para>Select <literal>Configuration</literal>.</para> | 498 | <para>Select <emphasis |
| 499 | role="bold">Configuration</emphasis>.</para> | ||
| 488 | </listitem> | 500 | </listitem> |
| 489 | 501 | ||
| 490 | <listitem> | 502 | <listitem> |
| @@ -528,17 +540,18 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
| 528 | 540 | ||
| 529 | <para>Each uCPE device can receive image files and use them to | 541 | <para>Each uCPE device can receive image files and use them to |
| 530 | upgrade. This can be done by selecting the uCPE device in the | 542 | upgrade. This can be done by selecting the uCPE device in the |
| 531 | <literal>System</literal> view and clicking the | 543 | <emphasis role="bold">System</emphasis> view and clicking the |
| 532 | <literal>Upgrade</literal> button. In the new window, an upgrade image | 544 | <emphasis role="bold">Upgrade</emphasis> button. In the new window, an |
| 533 | can be chosen from the <literal>Image Files</literal> tab by selecting | 545 | upgrade image can be chosen from the <emphasis role="bold">Image |
| 534 | the image file from the list and clicking the <literal>Install on | 546 | Files</emphasis> tab by selecting the image file from the list and |
| 535 | Device</literal> button.</para> | 547 | clicking the <emphasis role="bold">Install on Device</emphasis> |
| 548 | button.</para> | ||
| 536 | 549 | ||
| 537 | <para>Once an image is installed on the uCPE device, the image will be | 550 | <para>Once an image is installed on the uCPE device, the image will be |
| 538 | available on the uCPE device and be visible in the | 551 | available on the uCPE device and be visible in the <emphasis |
| 539 | <literal>Releases</literal> tab. It can then be selected from the list | 552 | role="bold">Releases</emphasis> tab. It can then be selected from the |
| 540 | and the upgrade started by clicking the <literal>Upgrade</literal> | 553 | list and the upgrade started by clicking the <emphasis |
| 541 | button.</para> | 554 | role="bold">Upgrade</emphasis> button.</para> |
| 542 | </section> | 555 | </section> |
| 543 | </section> | 556 | </section> |
| 544 | </section> | 557 | </section> |
diff --git a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml index 2dfe248..e8c65eb 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml | |||
| @@ -116,17 +116,17 @@ | |||
| 116 | 116 | ||
| 117 | <orderedlist> | 117 | <orderedlist> |
| 118 | <listitem> | 118 | <listitem> |
| 119 | <para>Select from the top toolbar <literal>VNF</literal> -> | 119 | <para>Select from the top toolbar <emphasis role="bold">VNF</emphasis> |
| 120 | <literal>Descriptors</literal></para> | 120 | and then <emphasis role="bold">Descriptors</emphasis>.</para> |
| 121 | </listitem> | 121 | </listitem> |
| 122 | 122 | ||
| 123 | <listitem> | 123 | <listitem> |
| 124 | <para>Click the <literal>On-board</literal> button.</para> | 124 | <para>Click the <emphasis role="bold">On-board</emphasis> button.</para> |
| 125 | </listitem> | 125 | </listitem> |
| 126 | 126 | ||
| 127 | <listitem> | 127 | <listitem> |
| 128 | <para>When prompted by the UI, make sure the <literal>VM | 128 | <para>When prompted by the UI, make sure the <emphasis role="bold">VM |
| 129 | Image</literal> radio button at the top of the onboarding screen is | 129 | Image</emphasis> radio button at the top of the onboarding screen is |
| 130 | selected, it will trigger a popup menu window.</para> | 130 | selected, it will trigger a popup menu window.</para> |
| 131 | </listitem> | 131 | </listitem> |
| 132 | </orderedlist> | 132 | </orderedlist> |
| @@ -153,7 +153,7 @@ | |||
| 153 | <listitem> | 153 | <listitem> |
| 154 | <para><emphasis role="bold">VM Image File</emphasis>. This is the | 154 | <para><emphasis role="bold">VM Image File</emphasis>. This is the |
| 155 | Virtual Machine image file for the VNF. Typically, it is a QCOW | 155 | Virtual Machine image file for the VNF. Typically, it is a QCOW |
| 156 | image. Press <literal>Choose File</literal> and select the image you | 156 | image. Press <emphasis role="bold">Choose File</emphasis> and select the image you |
| 157 | wish to upload.</para> | 157 | wish to upload.</para> |
| 158 | </listitem> | 158 | </listitem> |
| 159 | 159 | ||
| @@ -203,7 +203,7 @@ | |||
| 203 | 203 | ||
| 204 | <para><emphasis role="bold">Interfaces Tab</emphasis></para> | 204 | <para><emphasis role="bold">Interfaces Tab</emphasis></para> |
| 205 | 205 | ||
| 206 | <para>Click on the <literal>Interfaces</literal> tab to show the | 206 | <para>Click on the <emphasis role="bold">Interfaces</emphasis> tab to show the |
| 207 | Interfaces table.</para> | 207 | Interfaces table.</para> |
| 208 | 208 | ||
| 209 | <para>This table will contain the interfaces required by this VNF to be | 209 | <para>This table will contain the interfaces required by this VNF to be |
| @@ -219,7 +219,7 @@ | |||
| 219 | 219 | ||
| 220 | <para><emphasis role="bold">Cloud Init Tab</emphasis></para> | 220 | <para><emphasis role="bold">Cloud Init Tab</emphasis></para> |
| 221 | 221 | ||
| 222 | <para>Click the <literal>Cloud Init</literal> tab to provide the | 222 | <para>Click the <emphasis role="bold">Cloud Init</emphasis> tab to provide the |
| 223 | Cloud-Init configuration. There are three fields that need to be | 223 | Cloud-Init configuration. There are three fields that need to be |
| 224 | populated:</para> | 224 | populated:</para> |
| 225 | 225 | ||
| @@ -349,12 +349,12 @@ | |||
| 349 | 349 | ||
| 350 | <orderedlist> | 350 | <orderedlist> |
| 351 | <listitem> | 351 | <listitem> |
| 352 | <para>Select from the top toolbar <literal>VNF</literal> -> | 352 | <para>Select from the top toolbar <emphasis role="bold">VNF</emphasis> and |
| 353 | <literal>Instances</literal></para> | 353 | choose <emphasis role="bold">Instances</emphasis>.</para> |
| 354 | </listitem> | 354 | </listitem> |
| 355 | 355 | ||
| 356 | <listitem> | 356 | <listitem> |
| 357 | <para>Click the <literal>Add</literal> button.</para> | 357 | <para>Click the <emphasis role="bold">Add</emphasis> button.</para> |
| 358 | </listitem> | 358 | </listitem> |
| 359 | 359 | ||
| 360 | <listitem> | 360 | <listitem> |
| @@ -406,13 +406,13 @@ | |||
| 406 | </listitem> | 406 | </listitem> |
| 407 | 407 | ||
| 408 | <listitem> | 408 | <listitem> |
| 409 | <para>Hit the <literal>Create</literal> button to deploy the VNF and | 409 | <para>Hit the <emphasis role="bold">Create</emphasis> button to deploy the VNF and |
| 410 | run it on the specified uCPE device.</para> | 410 | run it on the specified uCPE device.</para> |
| 411 | </listitem> | 411 | </listitem> |
| 412 | </orderedlist> | 412 | </orderedlist> |
| 413 | 413 | ||
| 414 | <para>Selecting the<literal> VNF -> Events</literal> menu will show | 414 | <para>Selecting the <emphasis role="bold">VNF</emphasis> menu then choosing <emphasis role="bold">Events</emphasis> |
| 415 | that the VNF was created and a connection was established.</para> | 415 | will show that the VNF was created and a connection was established.</para> |
| 416 | </section> | 416 | </section> |
| 417 | 417 | ||
| 418 | <section id="enter_console"> | 418 | <section id="enter_console"> |
| @@ -426,7 +426,7 @@ | |||
| 426 | <orderedlist> | 426 | <orderedlist> |
| 427 | <listitem> | 427 | <listitem> |
| 428 | <para>SSH to the uCPE device from the Enea uCPE Manager | 428 | <para>SSH to the uCPE device from the Enea uCPE Manager |
| 429 | (<literal>Device->SSH</literal>) using:</para> | 429 | (Access the <emphasis role="bold">Device</emphasis> menu and select <emphasis role="bold">SSH</emphasis>) using:</para> |
| 430 | 430 | ||
| 431 | <itemizedlist> | 431 | <itemizedlist> |
| 432 | <listitem> | 432 | <listitem> |
| @@ -441,8 +441,10 @@ | |||
| 441 | NAT): the <literal>Username</literal> (default: root) and the | 441 | NAT): the <literal>Username</literal> (default: root) and the |
| 442 | <literal>Reverse ssh</literal> checkbox checked. The port will be | 442 | <literal>Reverse ssh</literal> checkbox checked. The port will be |
| 443 | automatically choosen by the Enea uCPE Manager in the range | 443 | automatically choosen by the Enea uCPE Manager in the range |
| 444 | defined in the <literal>System -> Configuration -> Reverse | 444 | defined in the <emphasis role="bold">SSH</emphasis> configuration panel, |
| 445 | SSH</literal> configuration panel. By default, the start port will | 445 | available when accessing <emphasis role="bold">System</emphasis>, then |
| 446 | <emphasis role="bold">Configuration</emphasis> and choosing <emphasis role="bold">Reverse | ||
| 447 | SSH</emphasis> . By default, the start port will | ||
| 446 | be <literal>7000</literal> and the maximum number of ports | 448 | be <literal>7000</literal> and the maximum number of ports |
| 447 | allocated to all devices is 10. Only one port per device is | 449 | allocated to all devices is 10. Only one port per device is |
| 448 | allowed.</para> | 450 | allowed.</para> |
