diff options
36 files changed, 1311 insertions, 1105 deletions
diff --git a/doc/Makefile b/doc/Makefile index 1a1bd48..95cc7eb 100644 --- a/doc/Makefile +++ b/doc/Makefile | |||
@@ -23,13 +23,13 @@ include init.mk | |||
23 | 23 | ||
24 | 24 | ||
25 | # ******************* AutoGenerated chapters from template and target READMEs ******* | 25 | # ******************* AutoGenerated chapters from template and target READMEs ******* |
26 | #BUILDBOOT_XML := book-enea-nfv-access-release-info/doc/build_boot_generated.xml | 26 | #BUILDBOOT_XML := book-enea-edge-release-info/doc/build_boot_generated.xml |
27 | #BUILDBOOT_TEMPLATE := book-enea-nfv-access-release-info/doc/build_boot_template.xml | 27 | #BUILDBOOT_TEMPLATE := book-enea-edge-release-info/doc/build_boot_template.xml |
28 | 28 | ||
29 | #PKGDIFF_GEN_XML := book-enea-nfv-access-release-info/doc/pkgdiff_generated.xml | 29 | #PKGDIFF_GEN_XML := book-enea-edge-release-info/doc/pkgdiff_generated.xml |
30 | #JIRA_ISSUES_GEN_XML := book-enea-nfv-access-release-info/doc/jiraissues_generated.xml | 30 | #JIRA_ISSUES_GEN_XML := book-enea-edge-release-info/doc/jiraissues_generated.xml |
31 | 31 | ||
32 | MACHINE_LIST_XML := book-enea-nfv-access-release-info/doc/machine_list_generated.xml | 32 | MACHINE_LIST_XML := book-enea-edge-release-info/doc/machine_list_generated.xml |
33 | 33 | ||
34 | ELTF_PARAMS_TEMPLATE := s_doceneacommon/doc/eltf_params_template.xml | 34 | ELTF_PARAMS_TEMPLATE := s_doceneacommon/doc/eltf_params_template.xml |
35 | ELTF_PARAMS_UPDATED := s_doceneacommon/doc/eltf_params_updated.xml | 35 | ELTF_PARAMS_UPDATED := s_doceneacommon/doc/eltf_params_updated.xml |
diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml index 4fe1c9a..9f6e64f 100644 --- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml +++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="auto_fw_test_harness"> | 2 | <chapter id="auto_fw_test_harness"> |
3 | <title>Automation Framework and Test Harness</title> | 3 | <title>Automation Framework and Test Harness</title> |
4 | 4 | ||
@@ -11,15 +11,16 @@ | |||
11 | 11 | ||
12 | <para>The <literal>/device</literal> folder contains Python scripts for | 12 | <para>The <literal>/device</literal> folder contains Python scripts for |
13 | adding uCPE device(s), receiving uCPE events' reports, removing a uCPE | 13 | adding uCPE device(s), receiving uCPE events' reports, removing a uCPE |
14 | device, waiting for a uCPE device to connect to the Enea Edge Management, as well | 14 | device, waiting for a uCPE device to connect to the Enea Edge Management |
15 | as scripts for adding and removing an offline configuration store. This | 15 | application, as well as scripts for adding and removing an offline |
16 | folder also contains scripts for uploading and removing an NFVA image into | 16 | configuration store. This folder also contains scripts for uploading and |
17 | the Enea Edge Management, and for installing and activating a NFVA image on a uCPE | 17 | removing an NFVA image into the Enea Edge Management application, and for |
18 | Device.</para> | 18 | installing and activating a NFVA image on a uCPE Device.</para> |
19 | 19 | ||
20 | <para>The <literal>/customScripts</literal> folder contains Python scripts | 20 | <para>The <literal>/customScripts</literal> folder contains Python scripts |
21 | for uploading custom scripts onto the Enea Edge Management and uCPE device(s), for | 21 | for uploading custom scripts onto the Enea Edge Management application and |
22 | removing custom scripts from the Enea Edge Management and uCPE device(s).</para> | 22 | uCPE device(s), for removing custom scripts from the Enea Edge Management |
23 | application and uCPE device(s).</para> | ||
23 | 24 | ||
24 | <para>The <literal>/network</literal> folder contains Python scripts for | 25 | <para>The <literal>/network</literal> folder contains Python scripts for |
25 | binding or unbinding a network interface to and from a uCPE device (DPDK | 26 | binding or unbinding a network interface to and from a uCPE device (DPDK |
@@ -32,14 +33,20 @@ | |||
32 | <para>Commands within the network folder that include the option | 33 | <para>Commands within the network folder that include the option |
33 | <emphasis role="bold">-o</emphasis> allow the user to perform the action | 34 | <emphasis role="bold">-o</emphasis> allow the user to perform the action |
34 | in an offline configuration store alternative available for use at a | 35 | in an offline configuration store alternative available for use at a |
35 | later setup time.</para> | 36 | later setup time.</para> |
36 | <para>Commands that include the <emphasis role="bold">-n</emphasis> | 37 | |
37 | option refer to a uCPE device, with the operation being performed on uCPE device.</para> | 38 | <para>Commands that include the <emphasis role="bold">-n</emphasis> |
38 | <para>All options contain either <emphasis role="bold">-n</emphasis>, | 39 | option refer to a uCPE device, with the operation being performed on |
39 | <emphasis role="bold">-o</emphasis> or both. One of them must always be provided, | 40 | uCPE device.</para> |
40 | if both are provided, -o has priority, and -n is thus ignored.</para> | 41 | |
41 | <para>In the following script examples, <emphasis> Enea Edge Management | 42 | <para>All options contain either <emphasis role="bold">-n</emphasis>, |
42 | </emphasis> is reffered as <emphasis>Enea uCPE Manager</emphasis>.</para> | 43 | <emphasis role="bold">-o</emphasis> or both. One of them must always be |
44 | provided, if both are provided, -o has priority, and -n is thus | ||
45 | ignored.</para> | ||
46 | |||
47 | <para>In the following script examples, <emphasis>Enea Edge Management | ||
48 | </emphasis> is reffered as <emphasis>Enea uCPE | ||
49 | Manager</emphasis>.</para> | ||
43 | </note> | 50 | </note> |
44 | 51 | ||
45 | <para>The <literal>/unittestSuite</literal> folder contains JSON files for | 52 | <para>The <literal>/unittestSuite</literal> folder contains JSON files for |
@@ -81,8 +88,8 @@ | |||
81 | the path to the file describing the test cases to be performed against | 88 | the path to the file describing the test cases to be performed against |
82 | the designated script.</para> | 89 | the designated script.</para> |
83 | 90 | ||
84 | <para>Steps for running the Python unit-test suite on the Enea Edge Management | 91 | <para>Steps for running the Python unit-test suite on the Enea Edge |
85 | are provided below.</para> | 92 | Management application are provided below.</para> |
86 | 93 | ||
87 | <section id="script_opts"> | 94 | <section id="script_opts"> |
88 | <title>Script Options</title> | 95 | <title>Script Options</title> |
@@ -236,26 +243,27 @@ consoleLoggingLevel = logging.INFO | |||
236 | <row> | 243 | <row> |
237 | <entry><literal>username</literal></entry> | 244 | <entry><literal>username</literal></entry> |
238 | 245 | ||
239 | <entry>The user authentication used to log into the | 246 | <entry>The user authentication used to log into the Enea Edge |
240 | Enea Edge Management. This can be overwritten by setting the Python | 247 | Management application. This can be overwritten by setting the |
241 | unit-test suite command line option | 248 | Python unit-test suite command line option |
242 | <literal>-u</literal>.</entry> | 249 | <literal>-u</literal>.</entry> |
243 | </row> | 250 | </row> |
244 | 251 | ||
245 | <row> | 252 | <row> |
246 | <entry><literal>password</literal></entry> | 253 | <entry><literal>password</literal></entry> |
247 | 254 | ||
248 | <entry>The password used to log into the Enea Edge Management. This | 255 | <entry>The password used to log into the Enea Edge Management |
249 | can be overwritten by setting the Python unit-test suite | 256 | application. This can be overwritten by setting the Python |
250 | command line option <literal>-p</literal>.</entry> | 257 | unit-test suite command line option |
258 | <literal>-p</literal>.</entry> | ||
251 | </row> | 259 | </row> |
252 | 260 | ||
253 | <row> | 261 | <row> |
254 | <entry><literal>host</literal></entry> | 262 | <entry><literal>host</literal></entry> |
255 | 263 | ||
256 | <entry>The IP address of the Enea Edge Management host. This can be | 264 | <entry>The IP address of the Enea Edge Management application |
257 | overwritten by setting the Python unit-test suite command line | 265 | host. This can be overwritten by setting the Python unit-test |
258 | option <literal>-H</literal>.</entry> | 266 | suite command line option <literal>-H</literal>.</entry> |
259 | </row> | 267 | </row> |
260 | 268 | ||
261 | <row> | 269 | <row> |
@@ -541,8 +549,8 @@ OK</programlisting> | |||
541 | <section id="add_ucpe_device"> | 549 | <section id="add_ucpe_device"> |
542 | <title>Adding a uCPE Device</title> | 550 | <title>Adding a uCPE Device</title> |
543 | 551 | ||
544 | <para>Steps for adding, configuring and running a uCPE device onto the | 552 | <para>Steps for adding, configuring and running a uCPE device into the |
545 | Enea Edge Management are described below .</para> | 553 | Enea Edge Management application are described below .</para> |
546 | 554 | ||
547 | <section id="opts_add_device"> | 555 | <section id="opts_add_device"> |
548 | <title>Script Options</title> | 556 | <title>Script Options</title> |
@@ -626,8 +634,8 @@ Options: | |||
626 | <section id="remove_ucpe_device"> | 634 | <section id="remove_ucpe_device"> |
627 | <title>Removing a uCPE Device</title> | 635 | <title>Removing a uCPE Device</title> |
628 | 636 | ||
629 | <para>Steps for removing a uCPE device from the Enea Edge Management are | 637 | <para>Steps for removing a uCPE device from the Enea Edge Management |
630 | described below.</para> | 638 | application are described below.</para> |
631 | 639 | ||
632 | <section id="rem_script_opts"> | 640 | <section id="rem_script_opts"> |
633 | <title>Script Options</title> | 641 | <title>Script Options</title> |
@@ -703,7 +711,8 @@ host | |||
703 | <title>Waiting a uCPE Device</title> | 711 | <title>Waiting a uCPE Device</title> |
704 | 712 | ||
705 | <para>Steps and details for how to Wait a uCPE device to connect to the | 713 | <para>Steps and details for how to Wait a uCPE device to connect to the |
706 | Enea Edge Management after installation, are described below.</para> | 714 | Enea Edge Management application after installation, are described |
715 | below.</para> | ||
707 | 716 | ||
708 | <section id="wait_script_opts"> | 717 | <section id="wait_script_opts"> |
709 | <title>Script Options</title> | 718 | <title>Script Options</title> |
@@ -781,7 +790,8 @@ Options: | |||
781 | <title>Printing the uCPE Device Log</title> | 790 | <title>Printing the uCPE Device Log</title> |
782 | 791 | ||
783 | <para>Steps and details on how to Print the events log for a specific | 792 | <para>Steps and details on how to Print the events log for a specific |
784 | uCPE device installed in the Enea Edge Management, are explained below.</para> | 793 | uCPE device installed in the Enea Edge Management application, are |
794 | explained below.</para> | ||
785 | 795 | ||
786 | <section id="print_script_opts"> | 796 | <section id="print_script_opts"> |
787 | <title>Script Options</title> | 797 | <title>Script Options</title> |
@@ -1382,8 +1392,8 @@ Options: | |||
1382 | <section id="onboard_vnf_image"> | 1392 | <section id="onboard_vnf_image"> |
1383 | <title>Onboarding a VNF Image Raw</title> | 1393 | <title>Onboarding a VNF Image Raw</title> |
1384 | 1394 | ||
1385 | <para>How to Onboard a VNF image in the Enea Edge Management based upon its raw | 1395 | <para>How to Onboard a VNF image in the Enea Edge Management application |
1386 | constituents, is detailed in depth below.</para> | 1396 | based upon its raw constituents, is detailed in depth below.</para> |
1387 | 1397 | ||
1388 | <section id="script_opts_image"> | 1398 | <section id="script_opts_image"> |
1389 | <title>Script Options</title> | 1399 | <title>Script Options</title> |
@@ -1499,8 +1509,8 @@ Options: | |||
1499 | <section id="offboard_vnf"> | 1509 | <section id="offboard_vnf"> |
1500 | <title>Offboarding a VNF</title> | 1510 | <title>Offboarding a VNF</title> |
1501 | 1511 | ||
1502 | <para>Steps on how to Offboard a VNF from the Enea Edge Management are detailed | 1512 | <para>Steps on how to Offboard a VNF from the Enea Edge Management |
1503 | below.</para> | 1513 | application are detailed below.</para> |
1504 | 1514 | ||
1505 | <section id="script_opts_offimage"> | 1515 | <section id="script_opts_offimage"> |
1506 | <title>Script Options</title> | 1516 | <title>Script Options</title> |
@@ -1565,7 +1575,8 @@ Options: | |||
1565 | <section id="instantiate_vnf"> | 1575 | <section id="instantiate_vnf"> |
1566 | <title>Instantiating a VNF</title> | 1576 | <title>Instantiating a VNF</title> |
1567 | 1577 | ||
1568 | <para>Instantiating a VNF via the Enea Edge Management is detailed below.</para> | 1578 | <para>Instantiating a VNF via the Enea Edge Management application is |
1579 | detailed below.</para> | ||
1569 | 1580 | ||
1570 | <section id="script_opts_inst"> | 1581 | <section id="script_opts_inst"> |
1571 | <title>Script Options</title> | 1582 | <title>Script Options</title> |
@@ -1644,8 +1655,8 @@ License("vnf_config/fortigateImage/fortigateLicense.lic") | |||
1644 | <section id="control_vnf_inst"> | 1655 | <section id="control_vnf_inst"> |
1645 | <title>Controlling a VNF Instance</title> | 1656 | <title>Controlling a VNF Instance</title> |
1646 | 1657 | ||
1647 | <para>How to Control a VNF instance from the Enea Edge Management is | 1658 | <para>How to Control a VNF instance from the Enea Edge Management |
1648 | detailed below.</para> | 1659 | application is detailed below.</para> |
1649 | 1660 | ||
1650 | <note> | 1661 | <note> |
1651 | <para>If a sequence of commands aiming to change the state of the VNF | 1662 | <para>If a sequence of commands aiming to change the state of the VNF |
@@ -1653,7 +1664,8 @@ License("vnf_config/fortigateImage/fortigateLicense.lic") | |||
1653 | become unresponsive. Depending on the actual VNF, the time required | 1664 | become unresponsive. Depending on the actual VNF, the time required |
1654 | between life-cycle operations may vary from several seconds to half a | 1665 | between life-cycle operations may vary from several seconds to half a |
1655 | minute or even more. If a VNF becomes unresponsive, the only possible | 1666 | minute or even more. If a VNF becomes unresponsive, the only possible |
1656 | action is to "Force Delete" the instance from the Enea Edge Management.</para> | 1667 | action is to "Force Delete" the instance from the Enea Edge Management |
1668 | application.</para> | ||
1657 | </note> | 1669 | </note> |
1658 | 1670 | ||
1659 | <section id="script_opts_control"> | 1671 | <section id="script_opts_control"> |
@@ -1803,10 +1815,11 @@ fortigateFWInstance | |||
1803 | </section> | 1815 | </section> |
1804 | 1816 | ||
1805 | <section id="upload_vnf_image"> | 1817 | <section id="upload_vnf_image"> |
1806 | <title>Uploading an Enea Edge image onto the Enea Edge Management</title> | 1818 | <title>Uploading an Enea Edge image onto the Enea Edge Management |
1819 | application</title> | ||
1807 | 1820 | ||
1808 | <para>Steps and options on how to Upload an Enea Edge image onto the | 1821 | <para>Steps and options on how to Upload an Enea Edge image onto the |
1809 | Enea Edge Management are described below.</para> | 1822 | Enea Edge Management application are described below.</para> |
1810 | 1823 | ||
1811 | <section id="script_opts_upload"> | 1824 | <section id="script_opts_upload"> |
1812 | <title>Script Options</title> | 1825 | <title>Script Options</title> |
@@ -1876,11 +1889,11 @@ Options: | |||
1876 | </section> | 1889 | </section> |
1877 | 1890 | ||
1878 | <section id="delete_vnf_image"> | 1891 | <section id="delete_vnf_image"> |
1879 | <title>Deleting an Enea Edge image file from the | 1892 | <title>Deleting an Enea Edge image file from the Enea Edge Management |
1880 | Enea Edge Management</title> | 1893 | application</title> |
1881 | 1894 | ||
1882 | <para>Steps and options on how to Delete an Enea Edge image from the | 1895 | <para>Steps and options on how to Delete an Enea Edge image from the |
1883 | Enea Edge Management are described below.</para> | 1896 | Enea Edge Management application are described below.</para> |
1884 | 1897 | ||
1885 | <section id="script_opts_deleteupload"> | 1898 | <section id="script_opts_deleteupload"> |
1886 | <title>Script Options</title> | 1899 | <title>Script Options</title> |
@@ -1951,11 +1964,11 @@ image was successfully removed | |||
1951 | 1964 | ||
1952 | <section id="install_activate_vnf_image"> | 1965 | <section id="install_activate_vnf_image"> |
1953 | <title>Installing and activating an Enea Edge image on an uCPE device | 1966 | <title>Installing and activating an Enea Edge image on an uCPE device |
1954 | from the Enea Edge Management</title> | 1967 | from the Enea Edge Management application</title> |
1955 | 1968 | ||
1956 | <para>Steps and options on how to Install and Activate an Enea Edge | 1969 | <para>Steps and options on how to Install and Activate an Enea Edge |
1957 | image on an uCPE device from the Enea Edge Management are described | 1970 | image on an uCPE device from the Enea Edge Management application are |
1958 | below.</para> | 1971 | described below.</para> |
1959 | 1972 | ||
1960 | <section id="script_opts_install_activate"> | 1973 | <section id="script_opts_install_activate"> |
1961 | <title>Script Options</title> | 1974 | <title>Script Options</title> |
@@ -1991,10 +2004,10 @@ Options: | |||
1991 | <section id="json_install_activate"> | 2004 | <section id="json_install_activate"> |
1992 | <title>Configuring the JSON File</title> | 2005 | <title>Configuring the JSON File</title> |
1993 | 2006 | ||
1994 | <para>The JSON configuration file needed to install and activate an Enea Edge | 2007 | <para>The JSON configuration file needed to install and activate an |
1995 | image on a uCPE device from the Enea Edge Management should | 2008 | Enea Edge image on a uCPE device from the Enea Edge Management |
1996 | contain a list of dictionaries. Each dictionary indicates the test | 2009 | application should contain a list of dictionaries. Each dictionary |
1997 | case name and the test case arguments passed to the | 2010 | indicates the test case name and the test case arguments passed to the |
1998 | <filename>installAndActivate</filename> Python module.</para> | 2011 | <filename>installAndActivate</filename> Python module.</para> |
1999 | 2012 | ||
2000 | <para><emphasis role="bold">Sample unit-test JSON file | 2013 | <para><emphasis role="bold">Sample unit-test JSON file |
@@ -2057,11 +2070,11 @@ enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 [20] | |||
2057 | 2070 | ||
2058 | <section id="clearing_info_upgrade"> | 2071 | <section id="clearing_info_upgrade"> |
2059 | <title>Clearing information about completed upgrades of uCPE devices | 2072 | <title>Clearing information about completed upgrades of uCPE devices |
2060 | from the Enea Edge Management</title> | 2073 | from the Enea Edge Management application</title> |
2061 | 2074 | ||
2062 | <para>Steps and options on how to clear information about completed | 2075 | <para>Steps and options on how to clear information about completed |
2063 | upgrades of uCPE devices from the Enea Edge Management are described | 2076 | upgrades of uCPE devices from the Enea Edge Management application are |
2064 | below.</para> | 2077 | described below.</para> |
2065 | 2078 | ||
2066 | <section id="script_opts_clearinfo"> | 2079 | <section id="script_opts_clearinfo"> |
2067 | <title>Script Options</title> | 2080 | <title>Script Options</title> |
@@ -2089,9 +2102,9 @@ Options: | |||
2089 | <title>Configuring the JSON File</title> | 2102 | <title>Configuring the JSON File</title> |
2090 | 2103 | ||
2091 | <para>No JSON configuration file is needed to clear information about | 2104 | <para>No JSON configuration file is needed to clear information about |
2092 | completed upgrades of uCPE devices from the Enea Edge Management. The | 2105 | completed upgrades of uCPE devices from the Enea Edge Management |
2093 | <filename>clearCompletedUpgradesInfo</filename> Python module can be | 2106 | application. The <filename>clearCompletedUpgradesInfo</filename> |
2094 | run without a JSON file as a parameter.</para> | 2107 | Python module can be run without a JSON file as a parameter.</para> |
2095 | </section> | 2108 | </section> |
2096 | 2109 | ||
2097 | <section id="pymod_clear_info"> | 2110 | <section id="pymod_clear_info"> |
@@ -2112,10 +2125,11 @@ Options: | |||
2112 | </section> | 2125 | </section> |
2113 | 2126 | ||
2114 | <section id="upload_custom_script"> | 2127 | <section id="upload_custom_script"> |
2115 | <title>Uploading a Custom Script to the Enea Edge Management</title> | 2128 | <title>Uploading a Custom Script to the Enea Edge Management |
2129 | application</title> | ||
2116 | 2130 | ||
2117 | <para>Steps and options on how to upload a custom script to the | 2131 | <para>Steps and options on how to upload a custom script to the Enea |
2118 | Enea Edge Management are described below.</para> | 2132 | Edge Management application are described below.</para> |
2119 | 2133 | ||
2120 | <section id="script_opts_upload_custom_script"> | 2134 | <section id="script_opts_upload_custom_script"> |
2121 | <title>Script Options</title> | 2135 | <title>Script Options</title> |
@@ -2149,8 +2163,9 @@ Options: | |||
2149 | <title>Configuring the JSON File</title> | 2163 | <title>Configuring the JSON File</title> |
2150 | 2164 | ||
2151 | <para>The JSON configuration file needed to upload a Custom Script to | 2165 | <para>The JSON configuration file needed to upload a Custom Script to |
2152 | the Enea Edge Management must contain a list of dictionaries. Each dictionary | 2166 | the Enea Edge Management application must contain a list of |
2153 | indicates the test case name and the test case arguments passed to the | 2167 | dictionaries. Each dictionary indicates the test case name and the |
2168 | test case arguments passed to the | ||
2154 | <filename>customScripts/upload</filename> Python module.</para> | 2169 | <filename>customScripts/upload</filename> Python module.</para> |
2155 | 2170 | ||
2156 | <para><emphasis role="bold">Sample unit-test JSON file | 2171 | <para><emphasis role="bold">Sample unit-test JSON file |
@@ -2186,11 +2201,11 @@ echo test_success_after_always | |||
2186 | </section> | 2201 | </section> |
2187 | 2202 | ||
2188 | <section id="upload_custom_script_device"> | 2203 | <section id="upload_custom_script_device"> |
2189 | <title>Uploading a Custom Script from the Enea Edge Management to a | 2204 | <title>Uploading a Custom Script from the Enea Edge Management |
2190 | Device</title> | 2205 | application to a Device</title> |
2191 | 2206 | ||
2192 | <para>Steps and options on how to upload a custom script from the | 2207 | <para>Steps and options on how to upload a custom script from the Enea |
2193 | Enea Edge Management to a Device are described below.</para> | 2208 | Edge Management application to a Device are described below.</para> |
2194 | 2209 | ||
2195 | <section id="script_opts_upload_custom_script_device"> | 2210 | <section id="script_opts_upload_custom_script_device"> |
2196 | <title>Script Options</title> | 2211 | <title>Script Options</title> |
@@ -2227,9 +2242,9 @@ Options: | |||
2227 | <title>Configuring the JSON File</title> | 2242 | <title>Configuring the JSON File</title> |
2228 | 2243 | ||
2229 | <para>The JSON configuration file needed to upload a Custom Script | 2244 | <para>The JSON configuration file needed to upload a Custom Script |
2230 | from the Enea Edge Management to a Device must contain a list of dictionaries. | 2245 | from the Enea Edge Management application to a Device must contain a |
2231 | Each dictionary indicates the test case name and the test case | 2246 | list of dictionaries. Each dictionary indicates the test case name and |
2232 | arguments passed to the | 2247 | the test case arguments passed to the |
2233 | <filename>customScripts/uploadOnDevice</filename> Python | 2248 | <filename>customScripts/uploadOnDevice</filename> Python |
2234 | module.</para> | 2249 | module.</para> |
2235 | 2250 | ||
@@ -2265,10 +2280,11 @@ test_success_after_always -e always-after-startup -n inteld1521-6 | |||
2265 | </section> | 2280 | </section> |
2266 | 2281 | ||
2267 | <section id="delete_custom_script"> | 2282 | <section id="delete_custom_script"> |
2268 | <title>Removing a Custom Script from the Enea Edge Management</title> | 2283 | <title>Removing a Custom Script from the Enea Edge Management |
2284 | application</title> | ||
2269 | 2285 | ||
2270 | <para>Steps and options on how to remove a custom script from the | 2286 | <para>Steps and options on how to remove a custom script from the Enea |
2271 | Enea Edge Management are described below.</para> | 2287 | Edge Management application are described below.</para> |
2272 | 2288 | ||
2273 | <section id="script_opts_delete_custom_script"> | 2289 | <section id="script_opts_delete_custom_script"> |
2274 | <title>Script Options</title> | 2290 | <title>Script Options</title> |
@@ -2302,9 +2318,10 @@ Options: | |||
2302 | <title>Configuring the JSON File</title> | 2318 | <title>Configuring the JSON File</title> |
2303 | 2319 | ||
2304 | <para>The JSON configuration file needed to remove a Custom Script | 2320 | <para>The JSON configuration file needed to remove a Custom Script |
2305 | from the Enea Edge Management<remark>did you mean device or | 2321 | from the Enea Edge Management application<remark>did you mean device |
2306 | Enea Edge Management?</remark> must contain a list of dictionaries. Each dictionary | 2322 | or Enea Edge Management application?</remark> must contain a list of |
2307 | indicates the test case name and the test case arguments passed to the | 2323 | dictionaries. Each dictionary indicates the test case name and the |
2324 | test case arguments passed to the | ||
2308 | <filename>customScripts/delete</filename> Python module.</para> | 2325 | <filename>customScripts/delete</filename> Python module.</para> |
2309 | 2326 | ||
2310 | <para><emphasis role="bold">Sample unit-test JSON file | 2327 | <para><emphasis role="bold">Sample unit-test JSON file |
@@ -2418,7 +2435,8 @@ phase always-after-startup from inteld1521-6 | |||
2418 | <section id="custom_script_eg"> | 2435 | <section id="custom_script_eg"> |
2419 | <title>Custom Script - Full Example</title> | 2436 | <title>Custom Script - Full Example</title> |
2420 | 2437 | ||
2421 | <para>All Python API used in this example are described in detail in the following sections.</para> | 2438 | <para>All Python API used in this example are described in detail in the |
2439 | following sections.</para> | ||
2422 | 2440 | ||
2423 | <para>The list of custom scripts can be found in | 2441 | <para>The list of custom scripts can be found in |
2424 | <literal><AF-TH-install-dir>/lab_config/customScripts</literal>:</para> | 2442 | <literal><AF-TH-install-dir>/lab_config/customScripts</literal>:</para> |
@@ -2471,7 +2489,8 @@ phase always-after-startup from inteld1521-6 | |||
2471 | </note> | 2489 | </note> |
2472 | 2490 | ||
2473 | <section id="upload_customscrp_ucpemg"> | 2491 | <section id="upload_customscrp_ucpemg"> |
2474 | <title>Uploading a Custom Script to the Enea Edge Management</title> | 2492 | <title>Uploading a Custom Script to the Enea Edge Management |
2493 | application</title> | ||
2475 | 2494 | ||
2476 | <programlisting>$ python automation_framework/customScripts/upload.py \ | 2495 | <programlisting>$ python automation_framework/customScripts/upload.py \ |
2477 | -f lab_config/customScripts/test_success_after_always -e always-after-startup | 2496 | -f lab_config/customScripts/test_success_after_always -e always-after-startup |
@@ -2487,8 +2506,8 @@ echo test_success_after_always | |||
2487 | </section> | 2506 | </section> |
2488 | 2507 | ||
2489 | <section id="upload_customscrp_device"> | 2508 | <section id="upload_customscrp_device"> |
2490 | <title>Uploading a Custom Script from the Enea Edge Management to a | 2509 | <title>Uploading a Custom Script from the Enea Edge Management |
2491 | Device</title> | 2510 | application to a Device</title> |
2492 | 2511 | ||
2493 | <programlisting>$ python automation_framework/customScripts/uploadOnDevice.py -c \ | 2512 | <programlisting>$ python automation_framework/customScripts/uploadOnDevice.py -c \ |
2494 | test_success_after_always -e always-after-startup -n inteld1521-6 | 2513 | test_success_after_always -e always-after-startup -n inteld1521-6 |
@@ -2519,7 +2538,8 @@ phase always-after-startup from inteld1521-6 | |||
2519 | </section> | 2538 | </section> |
2520 | 2539 | ||
2521 | <section id="remove_customscrp_ucpemg"> | 2540 | <section id="remove_customscrp_ucpemg"> |
2522 | <title>Removing a Custom Script from the Enea Edge Management</title> | 2541 | <title>Removing a Custom Script from the Enea Edge Management |
2542 | application</title> | ||
2523 | 2543 | ||
2524 | <programlisting>$ python automation_framework/customScripts/delete.py -c \ | 2544 | <programlisting>$ python automation_framework/customScripts/delete.py -c \ |
2525 | test_success_after_always -e always-after-startup | 2545 | test_success_after_always -e always-after-startup |
@@ -2538,15 +2558,15 @@ phase always-after-startup from uCPE Manager | |||
2538 | <section id="add_offline_config_store"> | 2558 | <section id="add_offline_config_store"> |
2539 | <title>Adding an Offline Configuration Store</title> | 2559 | <title>Adding an Offline Configuration Store</title> |
2540 | 2560 | ||
2541 | <para>Steps and options on how to add a Config Store in the | 2561 | <para>Steps and options on how to add a Config Store in the Enea Edge |
2542 | Enea Edge Management are described below.</para> | 2562 | Management application are described below.</para> |
2543 | 2563 | ||
2544 | <section id="script_opts_add_config_store"> | 2564 | <section id="script_opts_add_config_store"> |
2545 | <title>Script Options</title> | 2565 | <title>Script Options</title> |
2546 | 2566 | ||
2547 | <para>To add a config store in the Enea Edge Management use the | 2567 | <para>To add a config store in the Enea Edge Management application |
2548 | <filename>addConfigStore.py</filename> script detailed below. Bear in | 2568 | use the <filename>addConfigStore.py</filename> script detailed below. |
2549 | mind a <filename>CONFIGSTORE</filename> json file is needed to | 2569 | Bear in mind a <filename>CONFIGSTORE</filename> json file is needed to |
2550 | successfully run the script in order to add an offline configuration | 2570 | successfully run the script in order to add an offline configuration |
2551 | store.</para> | 2571 | store.</para> |
2552 | </section> | 2572 | </section> |
@@ -2568,8 +2588,8 @@ phase always-after-startup from uCPE Manager | |||
2568 | <section id="runpy_add_config_store"> | 2588 | <section id="runpy_add_config_store"> |
2569 | <title>Running the Python Module</title> | 2589 | <title>Running the Python Module</title> |
2570 | 2590 | ||
2571 | <para>Adding an offline config store in the Enea Edge Management using | 2591 | <para>Adding an offline config store in the Enea Edge Management |
2572 | the command line:</para> | 2592 | application using the command line:</para> |
2573 | 2593 | ||
2574 | <programlisting>python automation_framework/device/addConfigStore.py -f \ | 2594 | <programlisting>python automation_framework/device/addConfigStore.py -f \ |
2575 | lab_config/inteld1521-16/store.json | 2595 | lab_config/inteld1521-16/store.json |
@@ -2672,18 +2692,18 @@ Options: | |||
2672 | </section> | 2692 | </section> |
2673 | 2693 | ||
2674 | <section id="remove_offline_config_store"> | 2694 | <section id="remove_offline_config_store"> |
2675 | <title>Removing an Offline Configuration Store in the | 2695 | <title>Removing an Offline Configuration Store in the Enea Edge |
2676 | Enea Edge Management</title> | 2696 | Management application</title> |
2677 | 2697 | ||
2678 | <para>Steps and options on how to remove an upload of a Config Store | 2698 | <para>Steps and options on how to remove an upload of a Config Store |
2679 | from the Enea Edge Management are described below.</para> | 2699 | from the Enea Edge Management application are described below.</para> |
2680 | 2700 | ||
2681 | <note> | 2701 | <note> |
2682 | <para>Modifications of an Offline Configurations Store are not | 2702 | <para>Modifications of an Offline Configurations Store are not |
2683 | possible post deployment in the Enea Edge Management, as there is no option | 2703 | possible post deployment in the Enea Edge Management application, as |
2684 | for changing script states (e.g. changing the DPDK state in the | 2704 | there is no option for changing script states (e.g. changing the DPDK |
2685 | <filename>configDPDK.py</filename> python script or unbinding | 2705 | state in the <filename>configDPDK.py</filename> python script or |
2686 | interfaces). The offline store must be deleted and the new | 2706 | unbinding interfaces). The offline store must be deleted and the new |
2687 | state(s)/changes added in, before being deployed anew. This was not | 2707 | state(s)/changes added in, before being deployed anew. This was not |
2688 | deemed necessary for the current ZTP functionality.</para> | 2708 | deemed necessary for the current ZTP functionality.</para> |
2689 | </note> | 2709 | </note> |
@@ -2691,9 +2711,9 @@ Options: | |||
2691 | <section id="script_opts_remove_config_store"> | 2711 | <section id="script_opts_remove_config_store"> |
2692 | <title>Script options</title> | 2712 | <title>Script options</title> |
2693 | 2713 | ||
2694 | <para>To remove a config store from the Enea Edge Management use the | 2714 | <para>To remove a config store from the Enea Edge Management |
2695 | <filename>removeConfigStore.py</filename> script detailed | 2715 | application use the <filename>removeConfigStore.py</filename> script |
2696 | below.</para> | 2716 | detailed below.</para> |
2697 | 2717 | ||
2698 | <programlisting>python removeConfigStore.py -h | 2718 | <programlisting>python removeConfigStore.py -h |
2699 | Usage: removeConfigStore.py [options] | 2719 | Usage: removeConfigStore.py [options] |
@@ -2772,9 +2792,9 @@ Options: | |||
2772 | Manual.</para> | 2792 | Manual.</para> |
2773 | 2793 | ||
2774 | <para>The /<literal>uCPEM_config</literal> directory stores JSON | 2794 | <para>The /<literal>uCPEM_config</literal> directory stores JSON |
2775 | configuration files needed for the setup of the Enea Edge Management used by TH. | 2795 | configuration files needed for the setup of the Enea Edge Management |
2776 | One configuration file is needed per Enea Edge Management installation, to be used | 2796 | application used by TH. One configuration file is needed per Enea Edge |
2777 | in the TH.</para> | 2797 | Management installation, to be used in the TH.</para> |
2778 | 2798 | ||
2779 | <para>The <literal>/vnf_image</literal> directory stores the VNF Images | 2799 | <para>The <literal>/vnf_image</literal> directory stores the VNF Images |
2780 | needed by the Ansible Playbooks (i.e. the sample test cases).</para> | 2800 | needed by the Ansible Playbooks (i.e. the sample test cases).</para> |
@@ -2799,4 +2819,4 @@ Options: | |||
2799 | <filename>ansible.log</filename> and <filename>debug.log</filename> files, | 2819 | <filename>ansible.log</filename> and <filename>debug.log</filename> files, |
2800 | respectively.</para> | 2820 | respectively.</para> |
2801 | </section> | 2821 | </section> |
2802 | </chapter> | 2822 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/book.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/book.xml index a1ffed1..d533a74 100644 --- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/book.xml +++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/book.xml | |||
@@ -1,33 +1,32 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
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"> |
5 | ]> | 5 | ]> |
6 | <book id="book_enea_edge_auto_fw_th_user_guide"> | 6 | <book id="book_enea_edge_auto_fw_th_user_guide"> |
7 | <title><trademark class="registered">Enea</trademark> Edge Automation Framework and Test Harness User Guide</title> | 7 | <title><trademark class="registered">Enea</trademark> Edge Automation |
8 | Framework and Test Harness User Guide</title> | ||
8 | 9 | ||
9 | <subtitle>Release Version | 10 | <subtitle>Release Version <xi:include |
10 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" | 11 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" |
11 | xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> | 12 | xmlns:xi="http://www.w3.org/2001/XInclude" |
13 | xpointer="element(EneaLinux_REL_VER/1)" /></subtitle> | ||
12 | 14 | ||
13 | <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> | 15 | <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> |
14 | 16 | ||
15 | <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml" | 17 | <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml" |
16 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 18 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
17 | 19 | ||
18 | <xi:include href="overview.xml" | 20 | <xi:include href="overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> |
19 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
20 | 21 | ||
21 | <xi:include href="getting_started.xml" | 22 | <xi:include href="getting_started.xml" |
22 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 23 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
23 | 24 | ||
24 | <xi:include href="components.xml" | 25 | <xi:include href="components.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> |
25 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
26 | 26 | ||
27 | <xi:include href="automation_framework_test_harness.xml" | 27 | <xi:include href="automation_framework_test_harness.xml" |
28 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 28 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
29 | 29 | ||
30 | <xi:include href="troubleshooting_guide.xml" | 30 | <xi:include href="troubleshooting_guide.xml" |
31 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 31 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
32 | 32 | </book> \ No newline at end of file | |
33 | </book> | ||
diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml index 60675a8..94ee384 100644 --- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml +++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml | |||
@@ -1,9 +1,9 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="components"> | 2 | <chapter id="components"> |
3 | <title>Components</title> | 3 | <title>Components</title> |
4 | 4 | ||
5 | <para>An overview of the Enea Edge Runtime and the Edge Management | 5 | <para>An overview of the Enea Edge Runtime and the Edge Management in |
6 | in cooperation with the Enea Edge Automation Framework and Test Harness, will | 6 | cooperation with the Enea Edge Automation Framework and Test Harness, will |
7 | be presented in detail.</para> | 7 | be presented in detail.</para> |
8 | 8 | ||
9 | <figure> | 9 | <figure> |
@@ -20,22 +20,23 @@ | |||
20 | <section id="enfva_runtime_plt"> | 20 | <section id="enfva_runtime_plt"> |
21 | <title>Enea Edge</title> | 21 | <title>Enea Edge</title> |
22 | 22 | ||
23 | <para>Enea Edge is comprised of the Enea Edge Management and the Enea | 23 | <para>Enea Edge is comprised of the Enea Edge Management application and |
24 | Edge Runtime.</para> | 24 | Enea Edge Runtime.</para> |
25 | 25 | ||
26 | <section id="eucpe_manager"> | 26 | <section id="eucpe_manager"> |
27 | <title>Enea Edge Management</title> | 27 | <title>Enea Edge Management</title> |
28 | 28 | ||
29 | <para>The Enea Edge Management application needs to be installed on a | 29 | <para>The Enea Edge Management application needs to be installed on a |
30 | supported platform. Upon installation, the system will be set up to | 30 | supported platform. Upon installation, the system will be set up to |
31 | manage Enea Edge Runtime "devices", these are the virtualized CPE devices | 31 | manage Enea Edge Runtime "devices", these are the virtualized CPE |
32 | used in testing.</para> | 32 | devices used in testing.</para> |
33 | 33 | ||
34 | <para>For more on Enea Edge Management installation instructions, please | 34 | <para>For more on Enea Edge Management installation instructions, please |
35 | refer to the section on how to <olink | 35 | refer to the section on how to <olink |
36 | targetdoc="book_enea_edge_getting_started" | 36 | targetdoc="book_enea_edge_getting_started" |
37 | targetptr="install_ucpe_mg">Installing the Enea Edge Management in the | 37 | targetptr="install_ucpe_mg">Installing the Enea Edge Management |
38 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 38 | application in the <xi:include |
39 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
39 | xmlns:xi="http://www.w3.org/2001/XInclude" | 40 | xmlns:xi="http://www.w3.org/2001/XInclude" |
40 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> | 41 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
41 | Manual.</para> | 42 | Manual.</para> |
@@ -44,13 +45,15 @@ | |||
44 | <section id="ena_plat"> | 45 | <section id="ena_plat"> |
45 | <title>Enea Edge Runtime</title> | 46 | <title>Enea Edge Runtime</title> |
46 | 47 | ||
47 | <para>One or more uCPE devices running the Enea Edge Runtime | 48 | <para>One or more uCPE devices running the Enea Edge Runtime are |
48 | are required as hosts to run the VNF(s). The uCPE device is | 49 | required as hosts to run the VNF(s). The uCPE device is known to the |
49 | known to the Enea Edge Management as the "VcpeAgent" device module.</para> | 50 | Enea Edge Management application as the "VcpeAgent" device |
51 | module.</para> | ||
50 | 52 | ||
51 | <note> | 53 | <note> |
52 | <para>Before running any use case with the Enea Edge Automation Framework and | 54 | <para>Before running any use case with the Enea Edge Automation |
53 | Test Harness, make sure the uCPE device(s) have been added to the Edge Management.</para> | 55 | Framework and Test Harness, make sure the uCPE device(s) have been |
56 | added to the Enea Edge Management application.</para> | ||
54 | </note> | 57 | </note> |
55 | 58 | ||
56 | <para>Adding a VcpeAgent device can be done via two methods:</para> | 59 | <para>Adding a VcpeAgent device can be done via two methods:</para> |
@@ -69,8 +72,8 @@ | |||
69 | </listitem> | 72 | </listitem> |
70 | </itemizedlist> | 73 | </itemizedlist> |
71 | 74 | ||
72 | <para>For more on Enea Edge installation instructions, please | 75 | <para>For more on Enea Edge installation instructions, please refer to |
73 | refer to chapter <olink targetdoc="book_enea_edge_getting_started" | 76 | chapter <olink targetdoc="book_enea_edge_getting_started" |
74 | targetptr="prep_usb_ena">Preparing the USB stick for installation of the | 77 | targetptr="prep_usb_ena">Preparing the USB stick for installation of the |
75 | Enea Edge Runtime in the <xi:include | 78 | Enea Edge Runtime in the <xi:include |
76 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 79 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
@@ -83,16 +86,17 @@ | |||
83 | <section id="automation"> | 86 | <section id="automation"> |
84 | <title>Automation Framework</title> | 87 | <title>Automation Framework</title> |
85 | 88 | ||
86 | <para>Testing can be performed by running Automation Framework (AF) Python scripts | 89 | <para>Testing can be performed by running Automation Framework (AF) Python |
87 | against the Enea Edge Management REST API (Python samples supplied). This can be | 90 | scripts against the Enea Edge Management REST API (Python samples |
88 | done by using the Python scripts individually or by using the Python | 91 | supplied). This can be done by using the Python scripts individually or by |
89 | unit-test suite that is able to automatically run test-cases defined for | 92 | using the Python unit-test suite that is able to automatically run |
90 | each available Python script.</para> | 93 | test-cases defined for each available Python script.</para> |
91 | 94 | ||
92 | <para>In either case, it is desirable to use a different host (instead of | 95 | <para>In either case, it is desirable to use a different host (instead of |
93 | running the tests on the same system as the Enea Edge Management) in order to | 96 | running the tests on the same system as the Enea Edge Management |
94 | ensure that the Enea Edge Management is setup and installed correctly in terms of | 97 | application) in order to ensure that the Enea Edge Management application |
95 | allowing external users to access it and use it effectively.</para> | 98 | is setup and installed correctly in terms of allowing external users to |
99 | access it and use it effectively.</para> | ||
96 | </section> | 100 | </section> |
97 | 101 | ||
98 | <section id="harness"> | 102 | <section id="harness"> |
@@ -100,8 +104,8 @@ | |||
100 | 104 | ||
101 | <para>The Test Harness (TH) provides a way for driving configuration with | 105 | <para>The Test Harness (TH) provides a way for driving configuration with |
102 | Ansible Playbooks, by running the python modules from the Automation | 106 | Ansible Playbooks, by running the python modules from the Automation |
103 | Framework and by direct connection over SSH to the boards that run | 107 | Framework and by direct connection over SSH to the boards that run Enea |
104 | Enea Edge.</para> | 108 | Edge.</para> |
105 | 109 | ||
106 | <para>The Test Harness includes an automated test suite that | 110 | <para>The Test Harness includes an automated test suite that |
107 | contains:</para> | 111 | contains:</para> |
diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml index 455e142..255138b 100644 --- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml +++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="getting_started"> | 2 | <chapter id="getting_started"> |
3 | <title>Getting Started with the Enea Edge Automation Framework and Test | 3 | <title>Getting Started with the Enea Edge Automation Framework and Test |
4 | Harness</title> | 4 | Harness</title> |
@@ -6,8 +6,8 @@ | |||
6 | <section id="prerequisites"> | 6 | <section id="prerequisites"> |
7 | <title>Prerequisites</title> | 7 | <title>Prerequisites</title> |
8 | 8 | ||
9 | <para>For installation of the Enea Edge Automation Framework and Test Harness a | 9 | <para>For installation of the Enea Edge Automation Framework and Test |
10 | CentOS 7 host machine is needed with support for:</para> | 10 | Harness a CentOS 7 host machine is needed with support for:</para> |
11 | 11 | ||
12 | <itemizedlist> | 12 | <itemizedlist> |
13 | <listitem> | 13 | <listitem> |
@@ -28,10 +28,10 @@ | |||
28 | </itemizedlist> | 28 | </itemizedlist> |
29 | 29 | ||
30 | <note> | 30 | <note> |
31 | <para>The Enea Edge Automation Framework and Test Harness installation may be done | 31 | <para>The Enea Edge Automation Framework and Test Harness installation |
32 | on the same machine used for Enea Edge Management installation, although this is | 32 | may be done on the same machine used for the Enea Edge Management |
33 | not encouraged. For more details see section <olink | 33 | installation, although this is not encouraged. For more details see |
34 | targetdoc="book_enea_edge_auto_fw_th_user_guide" | 34 | section <olink targetdoc="book_enea_edge_auto_fw_th_user_guide" |
35 | targetptr="automation">Automation Framework in the <xi:include | 35 | targetptr="automation">Automation Framework in the <xi:include |
36 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 36 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
37 | xmlns:xi="http://www.w3.org/2001/XInclude" | 37 | xmlns:xi="http://www.w3.org/2001/XInclude" |
@@ -82,13 +82,14 @@ | |||
82 | </listitem> | 82 | </listitem> |
83 | 83 | ||
84 | <listitem> | 84 | <listitem> |
85 | <para>Enea Edge Management installed.</para> | 85 | <para>Enea Edge Management application installed.</para> |
86 | 86 | ||
87 | <note> | 87 | <note> |
88 | <para>For details on how to install the Enea Edge Management, see <olink | 88 | <para>For details on how to install the Enea Edge Management |
89 | targetdoc="book_enea_edge_getting_started" | 89 | application, see <olink targetdoc="book_enea_edge_getting_started" |
90 | targetptr="install_ucpe_mg">Installing the Enea Edge Management in the | 90 | targetptr="install_ucpe_mg">Installing the Enea Edge Management |
91 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 91 | application in the <xi:include |
92 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
92 | xmlns:xi="http://www.w3.org/2001/XInclude" | 93 | xmlns:xi="http://www.w3.org/2001/XInclude" |
93 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> | 94 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
94 | Manual.</para> | 95 | Manual.</para> |
@@ -180,7 +181,8 @@ | |||
180 | </listitem> | 181 | </listitem> |
181 | 182 | ||
182 | <listitem> | 183 | <listitem> |
183 | <para>Set up the Enea Edge Management which will be used by the TH:</para> | 184 | <para>Set up the Enea Edge Management application which will be used |
185 | by the TH:</para> | ||
184 | 186 | ||
185 | <orderedlist spacing="compact"> | 187 | <orderedlist spacing="compact"> |
186 | <listitem> | 188 | <listitem> |
@@ -221,18 +223,18 @@ | |||
221 | <literal><AF-THinstall-dir></literal> directory.</para> | 223 | <literal><AF-THinstall-dir></literal> directory.</para> |
222 | 224 | ||
223 | <para>Subsequent use of the installation requires activating the Python | 225 | <para>Subsequent use of the installation requires activating the Python |
224 | virtual enviroment before using the Enea Edge Automation Framework and Test Harness: | 226 | virtual enviroment before using the Enea Edge Automation Framework and |
225 | <literal>source | 227 | Test Harness: <literal>source |
226 | <AF-TH-install-dir>/testHarness-venv/bin/activate</literal>.</para> | 228 | <AF-TH-install-dir>/testHarness-venv/bin/activate</literal>.</para> |
227 | 229 | ||
228 | <para>Furthermore, if a user wants to use a new Enea Edge Management instance for | 230 | <para>Furthermore, if a user wants to use a new Enea Edge Management |
229 | a new session, the user also has to re-run the | 231 | instance for a new session, the user also has to re-run the |
230 | <filename>setupuCPEManager.yml</filename> playbook with the corresponding | 232 | <filename>setupuCPEManager.yml</filename> playbook with the corresponding |
231 | JSON config for the new Enea Edge Management instance.</para> | 233 | JSON config for the new Enea Edge Management instance.</para> |
232 | 234 | ||
233 | <note> | 235 | <note> |
234 | <para>Enea Edge Automation Framework and Test Harness History Information can be | 236 | <para>Enea Edge Automation Framework and Test Harness History |
235 | found in the AF&TH CHANGELOG file available in: | 237 | Information can be found in the AF&TH CHANGELOG file available in: |
236 | <filename><AF-TH-install-dir>/CHANGELOG</filename></para> | 238 | <filename><AF-TH-install-dir>/CHANGELOG</filename></para> |
237 | </note> | 239 | </note> |
238 | </section> | 240 | </section> |
diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml index 4fec3d9..1d07512 100644 --- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml +++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml | |||
@@ -1,21 +1,23 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="overview"> | 2 | <chapter id="overview"> |
3 | <title>Overview</title> | 3 | <title>Overview</title> |
4 | 4 | ||
5 | <para>This document describes the Enea Edge Automation Framework and Test Harness, along with instructions regarding the necessary steps to | 5 | <para>This document describes the Enea Edge Automation Framework and Test |
6 | run these software tools.</para> | 6 | Harness, along with instructions regarding the necessary steps to run these |
7 | software tools.</para> | ||
7 | 8 | ||
8 | <section id="descrip"> | 9 | <section id="descrip"> |
9 | <title>Description</title> | 10 | <title>Description</title> |
10 | 11 | ||
11 | <para>The Automation Framework provides a way for driving configuration | 12 | <para>The Automation Framework provides a way for driving configuration |
12 | with Python scripting. It complements the Enea Edge Management GUI and uses | 13 | with Python scripting. It complements the Enea Edge Management GUI and |
13 | the northbound REST APIs, given to provide full usability of the Enea Management | 14 | uses the northbound REST APIs, given to provide full usability of the Enea |
14 | features.</para> | 15 | Management features.</para> |
15 | 16 | ||
16 | <para>The Test Harness is based on running Ansible Playbooks to complete | 17 | <para>The Test Harness is based on running Ansible Playbooks to complete |
17 | different test cases, which make use of the Automation Framework Python | 18 | different test cases, which make use of the Automation Framework Python |
18 | modules and/or direct commands on the uCPE devices running the Enea Edge Runtime.</para> | 19 | modules and/or direct commands on the uCPE devices running the Enea Edge |
20 | Runtime.</para> | ||
19 | </section> | 21 | </section> |
20 | 22 | ||
21 | <section id="def_acro"> | 23 | <section id="def_acro"> |
@@ -39,8 +41,7 @@ | |||
39 | <row> | 41 | <row> |
40 | <entry>Enea Edge</entry> | 42 | <entry>Enea Edge</entry> |
41 | 43 | ||
42 | <entry>The Enea Edge Runtime and the | 44 | <entry>The Enea Edge Runtime and the Enea Edge Management.</entry> |
43 | Enea Edge Management.</entry> | ||
44 | </row> | 45 | </row> |
45 | </tbody> | 46 | </tbody> |
46 | </tgroup> | 47 | </tgroup> |
@@ -127,7 +128,6 @@ | |||
127 | <entry>Network Functions Virtualization.</entry> | 128 | <entry>Network Functions Virtualization.</entry> |
128 | </row> | 129 | </row> |
129 | 130 | ||
130 | |||
131 | <row> | 131 | <row> |
132 | <entry>OVS</entry> | 132 | <entry>OVS</entry> |
133 | 133 | ||
diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/troubleshooting_guide.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/troubleshooting_guide.xml index a5cd664..1ed4d92 100644 --- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/troubleshooting_guide.xml +++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/troubleshooting_guide.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="troubleshooting_guide"> | 2 | <chapter id="troubleshooting_guide"> |
3 | <title>Troubleshooting Guide</title> | 3 | <title>Troubleshooting Guide</title> |
4 | 4 | ||
@@ -21,12 +21,12 @@ | |||
21 | </listitem> | 21 | </listitem> |
22 | 22 | ||
23 | <listitem> | 23 | <listitem> |
24 | <para>When setting up the Enea Edge Management to be used by the TH through the | 24 | <para>When setting up the Enea Edge Management application to be used by |
25 | <literal>setupuCPEManager.yml</literal> Playbook, if the uCPE | 25 | the TH through the <literal>setupuCPEManager.yml</literal> Playbook, if |
26 | username/password/host are incorrect or are missing, all the Sample test | 26 | the uCPE username/password/host are incorrect or are missing, all the |
27 | cases will fail. If the FTP username/password/port are wrong or are | 27 | Sample test cases will fail. If the FTP username/password/port are wrong |
28 | missing, the tests that require file transfer to the Enea Edge Management will | 28 | or are missing, the tests that require file transfer to the Enea Edge |
29 | fail.</para> | 29 | Management application will fail.</para> |
30 | </listitem> | 30 | </listitem> |
31 | 31 | ||
32 | <listitem> | 32 | <listitem> |
diff --git a/doc/book-enea-edge-example-usecases/doc/128t_vnf_router.xml b/doc/book-enea-edge-example-usecases/doc/128t_vnf_router.xml index 89692b0..993da22 100644 --- a/doc/book-enea-edge-example-usecases/doc/128t_vnf_router.xml +++ b/doc/book-enea-edge-example-usecases/doc/128t_vnf_router.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="vnf_router_cust_uc"> | 2 | <chapter id="vnf_router_cust_uc"> |
3 | <title>128T VNF Router Example Use-case</title> | 3 | <title>128T VNF Router Example Use-case</title> |
4 | 4 | ||
@@ -68,8 +68,9 @@ | |||
68 | <para><emphasis role="bold">Configuring Network Interfaces on uCPE | 68 | <para><emphasis role="bold">Configuring Network Interfaces on uCPE |
69 | devices:</emphasis><orderedlist> | 69 | devices:</emphasis><orderedlist> |
70 | <listitem> | 70 | <listitem> |
71 | <para>Add the trgt uCPE device into Enea Edge Management: | 71 | <para>Add the trgt uCPE device into the Enea Edge Management |
72 | <literal>Devices -> Manage -> Add</literal>.</para> | 72 | application: <literal>Devices -> Manage -> |
73 | Add</literal>.</para> | ||
73 | 74 | ||
74 | <para>Fill in the required fields with the following data:</para> | 75 | <para>Fill in the required fields with the following data:</para> |
75 | 76 | ||
diff --git a/doc/book-enea-edge-example-usecases/doc/appendix_1.xml b/doc/book-enea-edge-example-usecases/doc/appendix_1.xml index df262af..8c76884 100644 --- a/doc/book-enea-edge-example-usecases/doc/appendix_1.xml +++ b/doc/book-enea-edge-example-usecases/doc/appendix_1.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <appendix id="appendix_one_cust"> | 2 | <appendix id="appendix_one_cust"> |
3 | <title>How to create a 128T cloud-init iso image (day-0 | 3 | <title>How to create a 128T cloud-init iso image (day-0 |
4 | configuration)</title> | 4 | configuration)</title> |
diff --git a/doc/book-enea-edge-example-usecases/doc/appendix_2.xml b/doc/book-enea-edge-example-usecases/doc/appendix_2.xml index 2458d99..7ef7c41 100644 --- a/doc/book-enea-edge-example-usecases/doc/appendix_2.xml +++ b/doc/book-enea-edge-example-usecases/doc/appendix_2.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <appendix id="appendix_two_cust"> | 2 | <appendix id="appendix_two_cust"> |
3 | <title>How to create the 128T image for NFV Access</title> | 3 | <title>How to create the 128T image for NFV Access</title> |
4 | 4 | ||
diff --git a/doc/book-enea-edge-example-usecases/doc/appendix_3.xml b/doc/book-enea-edge-example-usecases/doc/appendix_3.xml index e8bd5ce..063483a 100644 --- a/doc/book-enea-edge-example-usecases/doc/appendix_3.xml +++ b/doc/book-enea-edge-example-usecases/doc/appendix_3.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <appendix id="appendix_three_cust"> | 2 | <appendix id="appendix_three_cust"> |
3 | <title>How to configure Fortigate VNF (day-0 configuration)</title> | 3 | <title>How to configure Fortigate VNF (day-0 configuration)</title> |
4 | 4 | ||
diff --git a/doc/book-enea-edge-example-usecases/doc/appendix_4.xml b/doc/book-enea-edge-example-usecases/doc/appendix_4.xml index ef706ec..f52e33d 100644 --- a/doc/book-enea-edge-example-usecases/doc/appendix_4.xml +++ b/doc/book-enea-edge-example-usecases/doc/appendix_4.xml | |||
@@ -1,15 +1,15 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <appendix id="appendix_four_cust"> | 2 | <appendix id="appendix_four_cust"> |
3 | <title>Running Enea Edge Automation Framework and Test Harness</title> | 3 | <title>Running Enea Edge Automation Framework and Test Harness</title> |
4 | 4 | ||
5 | <para>For more detailed information regarding the Enea Edge Automation Framework and | 5 | <para>For more detailed information regarding the Enea Edge Automation |
6 | Test Harness please see the <xi:include | 6 | Framework and Test Harness please see the <xi:include |
7 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | 7 | href="../../s_docbuild/olinkdb/pardoc-common.xml" |
8 | xmlns:xi="http://www.w3.org/2001/XInclude" | 8 | xmlns:xi="http://www.w3.org/2001/XInclude" |
9 | xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" />.</para> | 9 | xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" />.</para> |
10 | 10 | ||
11 | <para>The most relevant information from the Enea Edge Automation Framework and Test | 11 | <para>The most relevant information from the Enea Edge Automation Framework |
12 | Harness structure is presented below:</para> | 12 | and Test Harness structure is presented below:</para> |
13 | 13 | ||
14 | <programlisting>|---automation_framework | 14 | <programlisting>|---automation_framework |
15 | | |---unittestSuite | 15 | | |---unittestSuite |
@@ -78,16 +78,17 @@ | |||
78 | 78 | ||
79 | <note> | 79 | <note> |
80 | <para>Before starting the two usecases detailed in the following appendix, | 80 | <para>Before starting the two usecases detailed in the following appendix, |
81 | the uCPE Device needs to be added into Enea Edge Management.</para> | 81 | the uCPE Device needs to be added into the Enea Edge Management |
82 | application.</para> | ||
82 | </note> | 83 | </note> |
83 | 84 | ||
84 | <para>To properly set up the Enea Edge Automation Framework and Test Harness please | 85 | <para>To properly set up the Enea Edge Automation Framework and Test Harness |
85 | see <olink targetdoc="book_enea_edge_auto_fw_th_user_guide" | 86 | please see <olink targetdoc="book_enea_edge_auto_fw_th_user_guide" |
86 | targetptr="initial_setup">Installation and Initial Setup in the <xi:include | 87 | targetptr="initial_setup">Installation and Initial Setup in the <xi:include |
87 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 88 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
88 | xmlns:xi="http://www.w3.org/2001/XInclude" | 89 | xmlns:xi="http://www.w3.org/2001/XInclude" |
89 | xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" /></olink> | 90 | xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" /></olink> for |
90 | for more details.</para> | 91 | more details.</para> |
91 | 92 | ||
92 | <para>To run a test:</para> | 93 | <para>To run a test:</para> |
93 | 94 | ||
diff --git a/doc/book-enea-edge-example-usecases/doc/appendix_5.xml b/doc/book-enea-edge-example-usecases/doc/appendix_5.xml index 67f38e5..abb4be8 100644 --- a/doc/book-enea-edge-example-usecases/doc/appendix_5.xml +++ b/doc/book-enea-edge-example-usecases/doc/appendix_5.xml | |||
@@ -1,6 +1,7 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <appendix id="appendix_five_cust"> | 2 | <appendix id="appendix_five_cust"> |
3 | <title>Example Tests Results using the Automation Framework and Test Harness</title> | 3 | <title>Example Tests Results using the Automation Framework and Test |
4 | Harness</title> | ||
4 | 5 | ||
5 | <para>In order to run the following example usecases, certain configuration | 6 | <para>In order to run the following example usecases, certain configuration |
6 | file entries need to be modified according to the network setup that it will | 7 | file entries need to be modified according to the network setup that it will |
@@ -39,8 +40,8 @@ | |||
39 | "maintMode": "false", | 40 | "maintMode": "false", |
40 | "version": "2.2.3", | 41 | "version": "2.2.3", |
41 | "deviceId": "inteld1521-17" | 42 | "deviceId": "inteld1521-17" |
42 | }</programlisting>The IP address of Enea Edge Management that will be used in | 43 | }</programlisting>The IP address of Enea Edge Management application that will |
43 | these examples is <literal>172.24.3.92</literal>.</para> | 44 | be used in these examples is <literal>172.24.3.92</literal>.</para> |
44 | 45 | ||
45 | <para>The FortiGate and 128T VNF images need to be copied into the | 46 | <para>The FortiGate and 128T VNF images need to be copied into the |
46 | <literal>vnf_image</literal> directory. The names should be the same as | 47 | <literal>vnf_image</literal> directory. The names should be the same as |
diff --git a/doc/book-enea-edge-example-usecases/doc/book.xml b/doc/book-enea-edge-example-usecases/doc/book.xml index 2ffbefe..fc69b88 100644 --- a/doc/book-enea-edge-example-usecases/doc/book.xml +++ b/doc/book-enea-edge-example-usecases/doc/book.xml | |||
@@ -1,14 +1,16 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
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"> |
5 | ]> | 5 | ]> |
6 | <book id="book_enea_edge_example_usecases"> | 6 | <book id="book_enea_edge_example_usecases"> |
7 | <title><trademark class="registered">Enea</trademark> Edge Example Use-cases</title> | 7 | <title><trademark class="registered">Enea</trademark> Edge Example |
8 | Use-cases</title> | ||
8 | 9 | ||
9 | <subtitle>Release Version | 10 | <subtitle>Release Version <xi:include |
10 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" | 11 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" |
11 | xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> | 12 | xmlns:xi="http://www.w3.org/2001/XInclude" |
13 | xpointer="element(EneaLinux_REL_VER/1)" /></subtitle> | ||
12 | 14 | ||
13 | <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> | 15 | <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> |
14 | 16 | ||
@@ -36,9 +38,7 @@ | |||
36 | <xi:include href="service_chaining_128t_fortigate.xml" | 38 | <xi:include href="service_chaining_128t_fortigate.xml" |
37 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 39 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
38 | 40 | ||
39 | <xi:include href="appendix_4.xml" | 41 | <xi:include href="appendix_4.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> |
40 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
41 | 42 | ||
42 | <xi:include href="appendix_5.xml" | 43 | <xi:include href="appendix_5.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> |
43 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 44 | </book> \ No newline at end of file |
44 | </book> | ||
diff --git a/doc/book-enea-edge-example-usecases/doc/clav_vnf_examples.xml b/doc/book-enea-edge-example-usecases/doc/clav_vnf_examples.xml index 8895c23..80755c2 100644 --- a/doc/book-enea-edge-example-usecases/doc/clav_vnf_examples.xml +++ b/doc/book-enea-edge-example-usecases/doc/clav_vnf_examples.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="clav_vnf_example"> | 2 | <chapter id="clav_vnf_example"> |
3 | <title>Clavister VNF Example Use-cases</title> | 3 | <title>Clavister VNF Example Use-cases</title> |
4 | 4 | ||
@@ -33,23 +33,33 @@ | |||
33 | 33 | ||
34 | <itemizedlist> | 34 | <itemizedlist> |
35 | <listitem> | 35 | <listitem> |
36 | <para>Enea Test VNF image. Please contact Enea to get this image.</para> | 36 | <para>Enea Test VNF image. Please contact Enea to get this |
37 | image.</para> | ||
37 | </listitem> | 38 | </listitem> |
38 | 39 | ||
39 | <listitem> | 40 | <listitem> |
40 | <para>Clavister VNF image. Please contact Clavister to get this | 41 | <para>Clavister VNF image. Please contact Clavister to get this |
41 | image.</para> | 42 | image.</para> |
42 | </listitem> | 43 | </listitem> |
43 | 44 | ||
44 | <listitem><para>VNF Configuration files. These files are provided with your Enea | 45 | <listitem> |
45 | Edge release:</para> | 46 | <para>VNF Configuration files. These files are provided with your |
46 | 47 | Enea Edge release:</para> | |
47 | <itemizedlist spacing="compact"> | 48 | |
48 | <listitem><para><filename>clavister-cloudinit.conf</filename>.</para></listitem> | 49 | <itemizedlist spacing="compact"> |
49 | <listitem><para><filename>enea-vnf-iperf-client.conf</filename>.</para></listitem> | 50 | <listitem> |
50 | <listitem><para><filename>enea-vnf-iperf-server.conf</filename>.</para></listitem> | 51 | <para><filename>clavister-cloudinit.conf</filename>.</para> |
52 | </listitem> | ||
53 | |||
54 | <listitem> | ||
55 | <para><filename>enea-vnf-iperf-client.conf</filename>.</para> | ||
56 | </listitem> | ||
57 | |||
58 | <listitem> | ||
59 | <para><filename>enea-vnf-iperf-server.conf</filename>.</para> | ||
60 | </listitem> | ||
51 | </itemizedlist> | 61 | </itemizedlist> |
52 | </listitem> | 62 | </listitem> |
53 | </itemizedlist> | 63 | </itemizedlist> |
54 | </section> | 64 | </section> |
55 | 65 | ||
@@ -62,22 +72,22 @@ | |||
62 | bridges.</para> | 72 | bridges.</para> |
63 | 73 | ||
64 | <figure> | 74 | <figure> |
65 | <title>Clavister VNF using an Open vSwitch bridge</title> | 75 | <title>Clavister VNF using an Open vSwitch bridge</title> |
66 | 76 | ||
67 | <mediaobject> | 77 | <mediaobject> |
68 | <imageobject> | 78 | <imageobject> |
69 | <imagedata align="center" contentwidth="600" | 79 | <imagedata align="center" contentwidth="600" |
70 | fileref="images/uc_clavister_bridge.png" /> | 80 | fileref="images/uc_clavister_bridge.png" /> |
71 | </imageobject> | 81 | </imageobject> |
72 | </mediaobject> | 82 | </mediaobject> |
73 | </figure> | 83 | </figure> |
74 | 84 | ||
75 | <note> | 85 | <note> |
76 | <para>When connecting, the uCPE devices can use a back-to-back or a VPN connection. | 86 | <para>When connecting, the uCPE devices can use a back-to-back or a |
77 | An appropriate interface with the required capabilities needs to be chosen for | 87 | VPN connection. An appropriate interface with the required |
78 | this purpose.</para> | 88 | capabilities needs to be chosen for this purpose.</para> |
79 | </note> | 89 | </note> |
80 | 90 | ||
81 | <para><emphasis role="bold">Network Configuration:</emphasis></para> | 91 | <para><emphasis role="bold">Network Configuration:</emphasis></para> |
82 | 92 | ||
83 | <orderedlist> | 93 | <orderedlist> |
@@ -324,21 +334,32 @@ root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting> | |||
324 | 334 | ||
325 | <itemizedlist> | 335 | <itemizedlist> |
326 | <listitem> | 336 | <listitem> |
327 | <para>Enea Test VNF image. Please contact Enea to get this image.</para> | 337 | <para>Enea Test VNF image. Please contact Enea to get this |
338 | image.</para> | ||
328 | </listitem> | 339 | </listitem> |
329 | 340 | ||
330 | <listitem> | 341 | <listitem> |
331 | <para>Clavister VNF image. Please contact Clavister to get this | 342 | <para>Clavister VNF image. Please contact Clavister to get this |
332 | image.</para> | 343 | image.</para> |
333 | </listitem> | 344 | </listitem> |
334 | 345 | ||
335 | <listitem><para>VNF Configuration files. These files are provided with your Enea | 346 | <listitem> |
336 | Edge release:</para> | 347 | <para>VNF Configuration files. These files are provided with your |
348 | Enea Edge release:</para> | ||
349 | |||
337 | <itemizedlist spacing="compact"> | 350 | <itemizedlist spacing="compact"> |
338 | <listitem><para><filename>clavister-cloudinit.conf</filename>.</para></listitem> | 351 | <listitem> |
339 | <listitem><para><filename>enea-vnf-iperf-client.conf</filename>.</para></listitem> | 352 | <para><filename>clavister-cloudinit.conf</filename>.</para> |
340 | <listitem><para><filename>enea-vnf-iperf-server.conf</filename>.</para></listitem> | 353 | </listitem> |
341 | </itemizedlist> | 354 | |
355 | <listitem> | ||
356 | <para><filename>enea-vnf-iperf-client.conf</filename>.</para> | ||
357 | </listitem> | ||
358 | |||
359 | <listitem> | ||
360 | <para><filename>enea-vnf-iperf-server.conf</filename>.</para> | ||
361 | </listitem> | ||
362 | </itemizedlist> | ||
342 | </listitem> | 363 | </listitem> |
343 | </itemizedlist> | 364 | </itemizedlist> |
344 | </section> | 365 | </section> |
@@ -367,8 +388,9 @@ root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting> | |||
367 | <listitem> | 388 | <listitem> |
368 | <para>Select uCPE device 1, access <literal>Configuration</literal>, | 389 | <para>Select uCPE device 1, access <literal>Configuration</literal>, |
369 | add the network interface that will be used and configure it for | 390 | add the network interface that will be used and configure it for |
370 | SR-IOV. For <literal>sriov-mode</literal> select <literal>adapter-pool</literal> and for | 391 | SR-IOV. For <literal>sriov-mode</literal> select |
371 | <literal>sriov-num-vfs</literal> select "2".</para> | 392 | <literal>adapter-pool</literal> and for |
393 | <literal>sriov-num-vfs</literal> select "2".</para> | ||
372 | </listitem> | 394 | </listitem> |
373 | 395 | ||
374 | <listitem> | 396 | <listitem> |
diff --git a/doc/book-enea-edge-example-usecases/doc/enea_test_vnf_examples.xml b/doc/book-enea-edge-example-usecases/doc/enea_test_vnf_examples.xml index bee5a63..0c3815e 100644 --- a/doc/book-enea-edge-example-usecases/doc/enea_test_vnf_examples.xml +++ b/doc/book-enea-edge-example-usecases/doc/enea_test_vnf_examples.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter condition="hidden" id="enea_vnf_examples"> | 2 | <chapter condition="hidden" id="enea_vnf_examples"> |
3 | <title>Enea Test VNF Example Use-cases</title> | 3 | <title>Enea Test VNF Example Use-cases</title> |
4 | 4 | ||
@@ -17,8 +17,8 @@ | |||
17 | 17 | ||
18 | <itemizedlist> | 18 | <itemizedlist> |
19 | <listitem> | 19 | <listitem> |
20 | <para>2 Network Interfaces. One for Enea Edge Management and one for data | 20 | <para>2 Network Interfaces. One for the Enea Edge Management |
21 | traffic.</para> | 21 | application and one for data traffic.</para> |
22 | </listitem> | 22 | </listitem> |
23 | 23 | ||
24 | <listitem> | 24 | <listitem> |
@@ -168,8 +168,8 @@ | |||
168 | </listitem> | 168 | </listitem> |
169 | 169 | ||
170 | <listitem> | 170 | <listitem> |
171 | <para>Instantiate the Enea Edge TestPMD termination VNF on | 171 | <para>Instantiate the Enea Edge TestPMD termination VNF on uCPE |
172 | uCPE Device 2 by filling the required fields with the following | 172 | Device 2 by filling the required fields with the following |
173 | values:</para> | 173 | values:</para> |
174 | 174 | ||
175 | <itemizedlist spacing="compact"> | 175 | <itemizedlist spacing="compact"> |
@@ -218,7 +218,7 @@ | |||
218 | <literal>testpmd_term</literal>.</para> | 218 | <literal>testpmd_term</literal>.</para> |
219 | 219 | ||
220 | <note> | 220 | <note> |
221 | <para>The flow rules can be described using either the Enea Edge | 221 | <para>The flow rules can be described using either the Enea Edge |
222 | Management interface or the configuration files.</para> | 222 | Management interface or the configuration files.</para> |
223 | </note> | 223 | </note> |
224 | </listitem> | 224 | </listitem> |
diff --git a/doc/book-enea-edge-example-usecases/doc/forti_vnf_examples.xml b/doc/book-enea-edge-example-usecases/doc/forti_vnf_examples.xml index 1e81ca4..cc3be97 100644 --- a/doc/book-enea-edge-example-usecases/doc/forti_vnf_examples.xml +++ b/doc/book-enea-edge-example-usecases/doc/forti_vnf_examples.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="vnf_fortigate"> | 2 | <chapter id="vnf_fortigate"> |
3 | <title>FortiGate VNF Example Use-cases</title> | 3 | <title>FortiGate VNF Example Use-cases</title> |
4 | 4 | ||
@@ -254,8 +254,8 @@ | |||
254 | targetptr="fortigate_webmg">FortiGate VNF web management in the | 254 | targetptr="fortigate_webmg">FortiGate VNF web management in the |
255 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 255 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
256 | xmlns:xi="http://www.w3.org/2001/XInclude" | 256 | xmlns:xi="http://www.w3.org/2001/XInclude" |
257 | xpointer="element(book_enea_edge_example_usecases/1)" /></olink> | 257 | xpointer="element(book_enea_edge_example_usecases/1)" /></olink> Manual |
258 | Manual for more information.</para> | 258 | for more information.</para> |
259 | </section> | 259 | </section> |
260 | </section> | 260 | </section> |
261 | 261 | ||
diff --git a/doc/book-enea-edge-example-usecases/doc/introduction.xml b/doc/book-enea-edge-example-usecases/doc/introduction.xml index ca0b310..27824da 100644 --- a/doc/book-enea-edge-example-usecases/doc/introduction.xml +++ b/doc/book-enea-edge-example-usecases/doc/introduction.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="intro"> | 2 | <chapter id="intro"> |
3 | <title>Introduction</title> | 3 | <title>Introduction</title> |
4 | 4 | ||
@@ -6,19 +6,19 @@ | |||
6 | configuration, onboarding and instantiation of certain VNFs, VNF chaining, | 6 | configuration, onboarding and instantiation of certain VNFs, VNF chaining, |
7 | etc.</para> | 7 | etc.</para> |
8 | 8 | ||
9 | <para>Before running any example use case make sure the uCPE device(s) have | 9 | <para>Before running any example use-case make sure the uCPE device(s) have |
10 | been added to Enea Edge Management and placed on the map. For detailed | 10 | been added to the Enea Edge Management application and placed on the map. |
11 | information on how to add a device to Enea Edge Management, how to configure the | 11 | For detailed information on how to add a device to the Enea Edge Management |
12 | network interfaces to use DPDK, PCI-passthrough or SR-IOV drivers, or VNF | 12 | application, how to configure the network interfaces to use DPDK, |
13 | configuration, please refer to the <xi:include | 13 | PCI-passthrough or SR-IOV drivers, or VNF configuration, please refer to the |
14 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | 14 | <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
15 | xmlns:xi="http://www.w3.org/2001/XInclude" | 15 | xmlns:xi="http://www.w3.org/2001/XInclude" |
16 | xpointer="element(book_enea_edge_getting_started/1)" /> Manual.</para> | 16 | xpointer="element(book_enea_edge_getting_started/1)" /> Manual.</para> |
17 | 17 | ||
18 | <note> | 18 | <note> |
19 | <para>Examples presented in this document use 3rd-party VNFs, which are | 19 | <para>Examples presented in this document use 3rd-party VNFs, which are |
20 | not provided by Enea. To procure and use these VNF image files and license | 20 | not provided by Enea. To procure and use these VNF image files and license |
21 | files, please contact the VNF provider. </para> | 21 | files, please contact the VNF provider.</para> |
22 | 22 | ||
23 | <para>Request the VNF prerequisites from the VNF vendors, or alternatively | 23 | <para>Request the VNF prerequisites from the VNF vendors, or alternatively |
24 | obtain the prerequisites based on instructions from each VNF vendor | 24 | obtain the prerequisites based on instructions from each VNF vendor |
diff --git a/doc/book-enea-edge-example-usecases/doc/service_chaining_128t_fortigate.xml b/doc/book-enea-edge-example-usecases/doc/service_chaining_128t_fortigate.xml index bb05905..4529fbf 100644 --- a/doc/book-enea-edge-example-usecases/doc/service_chaining_128t_fortigate.xml +++ b/doc/book-enea-edge-example-usecases/doc/service_chaining_128t_fortigate.xml | |||
@@ -1,10 +1,10 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="service_chaining_128t_fortigate"> | 2 | <chapter id="service_chaining_128t_fortigate"> |
3 | <title>Service Chaining 128T - Fortigate Example Use-case</title> | 3 | <title>Service Chaining 128T - Fortigate Example Use-case</title> |
4 | 4 | ||
5 | <para>The following is an example of how to setup and configure a service | 5 | <para>The following is an example of how to setup and configure a service |
6 | chain on top of the Enea Edge Runtime, using the | 6 | chain on top of the Enea Edge Runtime, using the following commercial VNFs: |
7 | following commercial VNFs: 128T router and FortiGate.</para> | 7 | 128T router and FortiGate.</para> |
8 | 8 | ||
9 | <section id="prereq_serv_chain_cust"> | 9 | <section id="prereq_serv_chain_cust"> |
10 | <title>Prerequisites</title> | 10 | <title>Prerequisites</title> |
@@ -86,9 +86,9 @@ | |||
86 | <para><emphasis role="bold">Configuring Network Interfaces on uCPE | 86 | <para><emphasis role="bold">Configuring Network Interfaces on uCPE |
87 | devices:</emphasis><orderedlist> | 87 | devices:</emphasis><orderedlist> |
88 | <listitem> | 88 | <listitem> |
89 | <para>Add the trgt uCPE device into Enea Edge Management: | 89 | <para>Add the trgt uCPE device into the Enea Edge Management |
90 | <literal>Devices -> Manage -> Add</literal>, and fill in the | 90 | application: <literal>Devices -> Manage -> Add</literal>, |
91 | required fields with the following data:</para> | 91 | and fill in the required fields with the following data:</para> |
92 | 92 | ||
93 | <table> | 93 | <table> |
94 | <title>Device Details</title> | 94 | <title>Device Details</title> |
diff --git a/doc/book-enea-edge-example-usecases/doc/vnf_chaining.xml b/doc/book-enea-edge-example-usecases/doc/vnf_chaining.xml index 24442af..affbf39 100644 --- a/doc/book-enea-edge-example-usecases/doc/vnf_chaining.xml +++ b/doc/book-enea-edge-example-usecases/doc/vnf_chaining.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="vnf_chaining"> | 2 | <chapter id="vnf_chaining"> |
3 | <title>VNF Chaining Example Use-case</title> | 3 | <title>VNF Chaining Example Use-case</title> |
4 | 4 | ||
@@ -11,9 +11,8 @@ | |||
11 | 11 | ||
12 | <para>The following is an example of how to setup and configure a | 12 | <para>The following is an example of how to setup and configure a |
13 | branch-to-branch service comprised on two commercial VNFs (SD-WAN + | 13 | branch-to-branch service comprised on two commercial VNFs (SD-WAN + |
14 | Firewall). This service will run in a service chain on top of the Enea | 14 | Firewall). This service will run in a service chain on top of the Enea Edge |
15 | Edge Runtime, deployed through the Enea Edge | 15 | Runtime, deployed through the Enea Edge Management.</para> |
16 | Management.</para> | ||
17 | 16 | ||
18 | <para>In the example setup the following commercial VNFs are used: Juniper | 17 | <para>In the example setup the following commercial VNFs are used: Juniper |
19 | vSRX as the SD-WAN VNF and Fortigate as the Router/Firewall.</para> | 18 | vSRX as the SD-WAN VNF and Fortigate as the Router/Firewall.</para> |
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 e321cf9..90de441 100644 --- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml +++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 2 | <!DOCTYPE chapter 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 | <chapter id="advanced_conf"> | 4 | <chapter id="advanced_conf"> |
@@ -23,14 +23,14 @@ | |||
23 | proceeds to install the system by dividing the disk into 2 partitions: a | 23 | proceeds to install the system by dividing the disk into 2 partitions: a |
24 | GPT partition containing the GRUB boot loader and a second partition | 24 | GPT partition containing the GRUB boot loader and a second partition |
25 | containing the Enea Edge Runtime root filesystem. When the installation is | 25 | containing the Enea Edge Runtime root filesystem. When the installation is |
26 | complete, the uCPE device is automatically rebooted into Enea Edge | 26 | complete, the uCPE device is automatically rebooted into the Enea Edge |
27 | Runtime.</para> | 27 | Runtime.</para> |
28 | 28 | ||
29 | <note> | 29 | <note> |
30 | <para>The <literal>.hddimg</literal>, <literal>initramfs</literal>, and | 30 | <para>The <literal>.hddimg</literal>, <literal>initramfs</literal>, and |
31 | <literal>bzImage</literal> files are available in the | 31 | <literal>bzImage</literal> files are available in the |
32 | <filename>Enea_Edge_Runtime_<processor>_<version>-<build_number>.tar.gz</filename> | 32 | <filename>Enea_Edge_Runtime_<processor>_<version>-<build_number>.tar.gz</filename> |
33 | file you downloaded with your release.</para> | 33 | file downloaded with your release.</para> |
34 | </note> | 34 | </note> |
35 | 35 | ||
36 | <section id="bare_meta_prov_prereq"> | 36 | <section id="bare_meta_prov_prereq"> |
@@ -102,32 +102,26 @@ | |||
102 | <para>An installation configuration file needs to be prepared on the | 102 | <para>An installation configuration file needs to be prepared on the |
103 | HTTP server. The format of the configuration file is a list of | 103 | HTTP server. The format of the configuration file is a list of |
104 | "<literal>name = value</literal>" pairs and the available parameters | 104 | "<literal>name = value</literal>" pairs and the available parameters |
105 | are described below.</para> | 105 | are described below:</para> |
106 | |||
107 | <para>Mandatory parameter(s):</para> | ||
108 | 106 | ||
109 | <itemizedlist> | 107 | <itemizedlist> |
110 | <listitem> | 108 | <listitem> |
111 | <para><literal>image_url</literal>. The HTTP server URL used for | 109 | <para><literal>image_url</literal> (mandatory). The HTTP server |
112 | downloading the Enea Edge Runtime image.</para> | 110 | URL used for downloading the Enea Edge Runtime image.</para> |
113 | </listitem> | 111 | </listitem> |
114 | </itemizedlist> | ||
115 | |||
116 | <para>Optional parameters:</para> | ||
117 | 112 | ||
118 | <itemizedlist> | ||
119 | <listitem> | 113 | <listitem> |
120 | <para><literal>install_drive</literal>. The name of the drive | 114 | <para><literal>install_drive</literal> (optional). The name of the |
121 | where the Enea Edge Runtime will be installed (e.g | 115 | drive where the Enea Edge Runtime will be installed (e.g |
122 | <literal>/dev/sda</literal>). If not set, the installer will use | 116 | <literal>/dev/sda</literal>). If not set, the installer will use |
123 | the largest detected (non-USB) drive on the uCPE device.</para> | 117 | the largest detected (non-USB) drive on the uCPE device.</para> |
124 | </listitem> | 118 | </listitem> |
125 | 119 | ||
126 | <listitem> | 120 | <listitem> |
127 | <para><literal>prompt_user</literal>. If the parameter is set to | 121 | <para><literal>prompt_user</literal> (optional). If the parameter |
128 | "yes", the installer will ask for confirmation before formatting | 122 | is set to "yes", the installer will ask for confirmation before |
129 | and partitioning the drive. The default behaviour is to proceed | 123 | formatting and partitioning the drive. The default behaviour is to |
130 | automatically without any user interaction.</para> | 124 | proceed automatically without any user interaction.</para> |
131 | </listitem> | 125 | </listitem> |
132 | </itemizedlist> | 126 | </itemizedlist> |
133 | 127 | ||
@@ -175,7 +169,7 @@ ipappend 2</programlisting> | |||
175 | ipmitool -U <user> -P <password> -H <uCPE device IPMI IP address> power reset </programlisting> | 169 | ipmitool -U <user> -P <password> -H <uCPE device IPMI IP address> power reset </programlisting> |
176 | 170 | ||
177 | <para>The uCPE devices should be configured in BIOS to boot from the | 171 | <para>The uCPE devices should be configured in BIOS to boot from the |
178 | installation drive first in order to automatically start the Enea Edge | 172 | installation drive first in order to automatically start Enea Edge |
179 | Runtime when the installation is finished.</para> | 173 | Runtime when the installation is finished.</para> |
180 | </section> | 174 | </section> |
181 | </section> | 175 | </section> |
@@ -418,12 +412,13 @@ node0.1048576kB = 3 </programlisting> | |||
418 | </section> | 412 | </section> |
419 | 413 | ||
420 | <section condition="hidden" id="high_availability_ig"> | 414 | <section condition="hidden" id="high_availability_ig"> |
421 | <title>Installing the Enea Edge Management in High Availability | 415 | <title>Installing the Enea Edge Management application in High |
422 | Mode</title> | 416 | Availability Mode</title> |
423 | 417 | ||
424 | <para>The following describes the setup needed for running the Enea Edge | 418 | <para>The following describes the setup needed for running the Enea Edge |
425 | Management in High Availabilty (HA) mode, with a MariaDB database cluster. | 419 | Management application in High Availabilty (HA) mode, with a MariaDB |
426 | A setup example is illustrated in the diagram below.</para> | 420 | database cluster. A setup example is illustrated in the diagram |
421 | below.</para> | ||
427 | 422 | ||
428 | <figure> | 423 | <figure> |
429 | <title>The High Availability setup</title> | 424 | <title>The High Availability setup</title> |
@@ -441,24 +436,51 @@ node0.1048576kB = 3 </programlisting> | |||
441 | example, two of the machines are running only MariaDB, while the rest are | 436 | example, two of the machines are running only MariaDB, while the rest are |
442 | hosting a MariaDB server and an Enea Edge Management instance. The entire | 437 | hosting a MariaDB server and an Enea Edge Management instance. The entire |
443 | network is hidden behind a firewall that performs NAT. While in protection | 438 | network is hidden behind a firewall that performs NAT. While in protection |
444 | (cluster) mode, the Enea Edge Management instances promote a single | 439 | (cluster) mode, the Enea Edge Management application instances promote a |
445 | Virtual IP (VIP). The cluster can be reached either from the primary | 440 | single Virtual IP (VIP). The cluster can be reached either from the |
446 | server IP or via VIP (recommended), since the VIP interface is spawned on | 441 | primary server IP or via VIP (recommended), since the VIP interface is |
447 | the primary server. In case of a primary failure, the newly elected | 442 | spawned on the primary server. In case of a primary failure, a newly |
448 | primary (from one of the backups) will respawn the VIP interface. The | 443 | elected primary (from one of the backups) will respawn the VIP interface. |
449 | firewall in this scenario will allocate a public IP for the outside world | 444 | The firewall in this scenario will allocate a public IP for the outside |
450 | that will be translated into the VIP. Also in this example, the traffic | 445 | world that will be translated into the VIP. Also in this example, the |
451 | towards the cluster from outside the firewall is done through HTTPS, which | 446 | traffic towards the cluster from outside the firewall is done through |
452 | will be translated to HTTP inside the private network.</para> | 447 | HTTPS, which will be translated to HTTP inside the private network.</para> |
453 | 448 | ||
454 | <note> | 449 | <note> |
455 | <para>By default, communication to the Enea Edge Management is done with | 450 | <para>By default, communication to the Enea Edge Management application |
456 | HTTPS. To enable HTTP, go to <emphasis role="bold">System</emphasis>, | 451 | is done with HTTPS. To enable HTTP, go to <emphasis |
457 | <emphasis role="bold">Configuration</emphasis>, click on the <emphasis | 452 | role="bold">System</emphasis>, <emphasis |
453 | role="bold">Configuration</emphasis>, click on the <emphasis | ||
458 | role="bold">Web Access</emphasis> tab and check the <emphasis | 454 | role="bold">Web Access</emphasis> tab and check the <emphasis |
459 | role="bold">Enable HTTP</emphasis> checkbox.</para> | 455 | role="bold">Enable HTTP</emphasis> checkbox.</para> |
460 | </note> | 456 | </note> |
461 | 457 | ||
458 | <para><emphasis role="bold">High-Availability - Design | ||
459 | Limitations</emphasis></para> | ||
460 | |||
461 | <para>Enea's solution for Edge Management High-Availability is designed to | ||
462 | maximize resiliency of the management function. However, the current design | ||
463 | does not provide guaranteed consistency across all Enea Edge | ||
464 | Management instances, i.e. some information might become out-of-sync in | ||
465 | certain conditions.</para> | ||
466 | |||
467 | <para>In order to reach full consistency, design would rely on | ||
468 | transactional data updates across the Primary instance and all Backups, | ||
469 | but the latency would significantly increase for all management | ||
470 | operations, which is considered to be a severe limitation.</para> | ||
471 | |||
472 | <para>In the current version of the Enea Edge Management application when | ||
473 | in High Availability mode, there are two kinds of data that needs to be | ||
474 | synchronized: data in the database and data residing in the Primary | ||
475 | instance filesystem. This means that there are intervals when data is | ||
476 | being synchronized from the Primary instance to the Backup(s) and Primary | ||
477 | failure at this time will result in incomplete/inconsistent data on the | ||
478 | Backup(s). For example, a VNF which has been onboarded on the Primary | ||
479 | instance will not be visible in a Backup instance(s) until both database | ||
480 | and filesystem have been synchronized. If a Backup instance becomes the | ||
481 | active one before synchronization takes place, this would result in an | ||
482 | out-of-sync state.</para> | ||
483 | |||
462 | <section id="ha_reqs"> | 484 | <section id="ha_reqs"> |
463 | <title>Requirements for High Availability</title> | 485 | <title>Requirements for High Availability</title> |
464 | 486 | ||
@@ -467,7 +489,8 @@ node0.1048576kB = 3 </programlisting> | |||
467 | 489 | ||
468 | <itemizedlist> | 490 | <itemizedlist> |
469 | <listitem> | 491 | <listitem> |
470 | <para>Machines running the Enea Edge Management and MariaDB:</para> | 492 | <para>Machines running the Enea Edge Management application and |
493 | MariaDB:</para> | ||
471 | 494 | ||
472 | <itemizedlist spacing="compact"> | 495 | <itemizedlist spacing="compact"> |
473 | <listitem> | 496 | <listitem> |
@@ -507,13 +530,12 @@ node0.1048576kB = 3 </programlisting> | |||
507 | <section id="firewall_rules"> | 530 | <section id="firewall_rules"> |
508 | <title>Firewall Rules</title> | 531 | <title>Firewall Rules</title> |
509 | 532 | ||
510 | <para>Please refer to <olink | 533 | <para>Please refer to <olink targetdoc="book_enea_edge_getting_started" |
511 | targetdoc="book_enea_nfv_access_getting_started" | ||
512 | targetptr="firewall_config">Firewall Configuration in the <xi:include | 534 | targetptr="firewall_config">Firewall Configuration in the <xi:include |
513 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 535 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
514 | xmlns:xi="http://www.w3.org/2001/XInclude" | 536 | xmlns:xi="http://www.w3.org/2001/XInclude" |
515 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 537 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> Manual. |
516 | Manual. In addition, the following configuration is needed:</para> | 538 | In addition, the following configuration is needed:</para> |
517 | 539 | ||
518 | <orderedlist> | 540 | <orderedlist> |
519 | <listitem> | 541 | <listitem> |
@@ -590,7 +612,8 @@ SELINUXTYPE=targeted</programlisting> | |||
590 | </table> | 612 | </table> |
591 | 613 | ||
592 | <para>For MariaDB, the following ports must be opened (on each MariaDB | 614 | <para>For MariaDB, the following ports must be opened (on each MariaDB |
593 | server, including the ones hosting the Enea Edge Management):</para> | 615 | server, including the ones hosting the Enea Edge Management |
616 | application):</para> | ||
594 | 617 | ||
595 | <table> | 618 | <table> |
596 | <title>Ports for MariaDB Machines</title> | 619 | <title>Ports for MariaDB Machines</title> |
@@ -685,9 +708,10 @@ SELINUXTYPE=targeted</programlisting> | |||
685 | <section id="ha_installation"> | 708 | <section id="ha_installation"> |
686 | <title>Installing High Availability</title> | 709 | <title>Installing High Availability</title> |
687 | 710 | ||
688 | <para>The Enea Edge Management can be installed in High Availability | 711 | <para>The Enea Edge Management application can be installed in High |
689 | mode with a MariaDB database cluster by performing the following steps. | 712 | Availability mode with a MariaDB database cluster by performing the |
690 | The mandatory Java configuration is also detailed.</para> | 713 | following steps. The mandatory Java configuration is also |
714 | detailed.</para> | ||
691 | 715 | ||
692 | <section id="ha_mariadb"> | 716 | <section id="ha_mariadb"> |
693 | <title>Installing and configuring the MariaDB cluster</title> | 717 | <title>Installing and configuring the MariaDB cluster</title> |
@@ -706,14 +730,16 @@ SELINUXTYPE=targeted</programlisting> | |||
706 | <para>Install the MariaDB official yum repository. Create a file | 730 | <para>Install the MariaDB official yum repository. Create a file |
707 | named <literal>mariadb.repo</literal> in | 731 | named <literal>mariadb.repo</literal> in |
708 | <literal>/etc/yum.repos.d/</literal> with the following | 732 | <literal>/etc/yum.repos.d/</literal> with the following |
709 | content:<programlisting># MariaDB 10.5 CentOS repository list - created 2021-02-16 08:46 UTC | 733 | content:</para> |
734 | |||
735 | <programlisting># MariaDB 10.5 CentOS repository list - created 2021-02-16 08:46 UTC | ||
710 | # http://downloads.mariadb.org/mariadb/repositories/ | 736 | # http://downloads.mariadb.org/mariadb/repositories/ |
711 | [mariadb] | 737 | [mariadb] |
712 | name = MariaDB | 738 | name = MariaDB |
713 | baseurl = http://yum.mariadb.org/10.5/centos7-amd64 | 739 | baseurl = http://yum.mariadb.org/10.5/centos7-amd64 |
714 | gpgkey=https://yum.mariadb.org/RPM-GPG-KEY-MariaDB | 740 | gpgkey=https://yum.mariadb.org/RPM-GPG-KEY-MariaDB |
715 | gpgcheck=1 | 741 | gpgcheck=1 |
716 | </programlisting></para> | 742 | </programlisting> |
717 | 743 | ||
718 | <note> | 744 | <note> |
719 | <para>For more information about setting the repository, consult | 745 | <para>For more information about setting the repository, consult |
@@ -825,20 +851,20 @@ Switch to unix_socket authentication [Y/n] <emphasis role="bold">Y</emphasis> | |||
825 | Enabled successfully! | 851 | Enabled successfully! |
826 | Reloading privilege tables.. | 852 | Reloading privilege tables.. |
827 | ... Success! | 853 | ... Success! |
828 | … | 854 | … |
829 | Change the root password? [Y/n] <emphasis role="bold">Y</emphasis> | 855 | Change the root password? [Y/n] <emphasis role="bold">Y</emphasis> |
830 | New password: | 856 | New password: |
831 | Re-enter new password: | 857 | Re-enter new password: |
832 | Password updated successfully! | 858 | Password updated successfully! |
833 | Reloading privilege tables.. | 859 | Reloading privilege tables.. |
834 | ... Success! | 860 | ... Success! |
835 | … | 861 | … |
836 | Remove anonymous users? [Y/n] <emphasis role="bold">Y</emphasis> | 862 | Remove anonymous users? [Y/n] <emphasis role="bold">Y</emphasis> |
837 | ... Success! | 863 | ... Success! |
838 | … | 864 | … |
839 | Disallow root login remotely? [Y/n] <emphasis role="bold">Y</emphasis> | 865 | Disallow root login remotely? [Y/n] <emphasis role="bold">Y</emphasis> |
840 | ... Success! | 866 | ... Success! |
841 | … | 867 | … |
842 | Remove test database and access to it? [Y/n] <emphasis role="bold">Y (optional)</emphasis> | 868 | Remove test database and access to it? [Y/n] <emphasis role="bold">Y (optional)</emphasis> |
843 | - Dropping test database... | 869 | - Dropping test database... |
844 | ... Success! | 870 | ... Success! |
@@ -873,12 +899,12 @@ TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION;</programlisting> | |||
873 | <title>Installing the Java SDK</title> | 899 | <title>Installing the Java SDK</title> |
874 | 900 | ||
875 | <para>Please refer to <olink | 901 | <para>Please refer to <olink |
876 | targetdoc="book_enea_nfv_access_getting_started" | 902 | targetdoc="book_enea_edge_getting_started" |
877 | targetptr="openjdk_postgresql_config">Configuring OpenJDK and | 903 | targetptr="openjdk_postgresql_config">Configuring OpenJDK and |
878 | PostgreSQL in the <xi:include | 904 | PostgreSQL in the <xi:include |
879 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 905 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
880 | xmlns:xi="http://www.w3.org/2001/XInclude" | 906 | xmlns:xi="http://www.w3.org/2001/XInclude" |
881 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 907 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
882 | Manual, for details on how to install and configure Java | 908 | Manual, for details on how to install and configure Java |
883 | OpenJDK.</para> | 909 | OpenJDK.</para> |
884 | 910 | ||
@@ -891,40 +917,40 @@ TO 'enea'@'%' IDENTIFIED BY 'somepassword' WITH GRANT OPTION;</programlisting> | |||
891 | </section> | 917 | </section> |
892 | 918 | ||
893 | <section id="ha_ucpe_mg"> | 919 | <section id="ha_ucpe_mg"> |
894 | <title>Installing the Enea Edge Management in High Availabilty | 920 | <title>Installing the Enea Edge Management application in High |
895 | mode</title> | 921 | Availabilty mode</title> |
896 | 922 | ||
897 | <para>These steps must be taken on each of the CentOS 7 machines that | 923 | <para>These steps must be taken on each of the CentOS 7 machines that |
898 | will host the Enea Edge Management. The Enea Edge Management will be | 924 | will host the Enea Edge Management application. It will be installed |
899 | installed and the setup for the external database cluster will be | 925 | and the setup for the external database cluster will be |
900 | prepared.</para> | 926 | prepared.</para> |
901 | 927 | ||
902 | <para>As the root user, go to the distribution folder of the Enea Edge | 928 | <para>As the root user, go to the distribution folder of the Enea Edge |
903 | Management, and run:</para> | 929 | Management application, and run:</para> |
904 | 930 | ||
905 | <programlisting>[root@localhost distro]#./install.sh /opt/ \ | 931 | <programlisting>[root@localhost distro]#./install.sh /opt/ \ |
906 | Enea_NFV_Access_uCPEManager_2.3.0-build23.tar.gz | 932 | Enea_NFV_Access_uCPEManager_2.3.0-build23.tar.gz |
907 | This will install uCPEManager into /opt/ucpemanager folder. | 933 | This will install the Enea Edge Management application into the /opt/ucpemanager folder. |
908 | Select the following options, while asked by the installation script: | 934 | Select the following options, while asked by the installation script: |
909 | Are you using the embedded PostgreSQL database? [Y/N]: <emphasis role="bold">N</emphasis> | 935 | Are you using the embedded PostgreSQL database? [Y/N]: <emphasis role="bold">N</emphasis> |
910 | External database selected, getting user information ... | 936 | External database selected, getting user information ... |
911 | Press 1 for PostgreSQL, 2 for MariaDB, 3 for SQL Server, 4 for Oracle and 5 \ | 937 | Press 1 for PostgreSQL, 2 for MariaDB, 3 for SQL Server, 4 for Oracle and 5 \ |
912 | for MySQL: <emphasis role="bold">2</emphasis> | 938 | for MySQL: <emphasis role="bold">2</emphasis> |
913 | Specify database server name(s) or IP Address(es): \ | 939 | Specify database server name(s) or IP Address(es): \ |
914 | <emphasis role="bold">192.168.10.11,192.168.10.12,…,192.168.10.16 *(see note)</emphasis> | 940 | <emphasis role="bold">192.168.10.11,192.168.10.12,…,192.168.10.16 *(see note)</emphasis> |
915 | Specify database ID (or name) [ucpemanager]: | 941 | Specify database ID (or name) [ucpemanager]: |
916 | Specify database server port [3306]: | 942 | Specify database server port [3306]: |
917 | Specify database user name [root]: enea | 943 | Specify database user name [root]: enea |
918 | Specify database password [root]: somepassword | 944 | Specify database password [root]: somepassword |
919 | Specify database startup thread pool size [1]: | 945 | Specify database startup thread pool size [1]: |
920 | Creating database configuration file \ | 946 | Creating database configuration file \ |
921 | /opt//ucpemanager/application/config/databaseConfig.xml ... | 947 | /opt/ucpemanager/application/config/databaseConfig.xml ... |
922 | Done . | 948 | Done . |
923 | … | 949 | … |
924 | Installing ucpemanager service .. | 950 | Installing ucpemanager service .. |
925 | Specify service username [ucpemanager]: | 951 | Specify service username [ucpemanager]: |
926 | Specify service password [ucpemanager]: somepassword | 952 | Specify service password [ucpemanager]: somepassword |
927 | … | 953 | … |
928 | Specify the IP address of the local interface: <emphasis role="bold">192.168.10.11</emphasis> | 954 | Specify the IP address of the local interface: <emphasis role="bold">192.168.10.11</emphasis> |
929 | Is this server part of a cluster? [Y/N]: <emphasis role="bold">Y</emphasis> | 955 | Is this server part of a cluster? [Y/N]: <emphasis role="bold">Y</emphasis> |
930 | Specify the name of the cluster [ucpemanager]: | 956 | Specify the name of the cluster [ucpemanager]: |
@@ -938,9 +964,9 @@ Configuration complete.</programlisting> | |||
938 | <note> | 964 | <note> |
939 | <para>For each Enea Edge Management installation, place the local | 965 | <para>For each Enea Edge Management installation, place the local |
940 | interface IP first in the list of IPs. This will optimize database | 966 | interface IP first in the list of IPs. This will optimize database |
941 | communication, since the Enea Edge Management uses the list of IPs | 967 | communication, since the Enea Edge Management application uses the |
942 | sequentially, therefore using the internal loopback interface for | 968 | list of IPs sequentially, therefore using the internal loopback |
943 | communicating with the database.</para> | 969 | interface for communicating with the database.</para> |
944 | </note> | 970 | </note> |
945 | 971 | ||
946 | <para>The arbiter IP and port are used to mitigate split brain | 972 | <para>The arbiter IP and port are used to mitigate split brain |
@@ -956,6 +982,24 @@ Configuration complete.</programlisting> | |||
956 | role="bold">System</emphasis> and select <emphasis role="bold">Cluster | 982 | role="bold">System</emphasis> and select <emphasis role="bold">Cluster |
957 | View</emphasis>. The list of Enea Edge Management servers should be | 983 | View</emphasis>. The list of Enea Edge Management servers should be |
958 | displayed, with one listed as Primary and the rest as Backup.</para> | 984 | displayed, with one listed as Primary and the rest as Backup.</para> |
985 | |||
986 | <note><para>To avoid split-brain (network-partitioning) scenarios, it is possible | ||
987 | for the user to specify an IP:port tuple for a system that acts as an | ||
988 | Arbiter. In case both Primary and Backup servers cannot reach the Arbiter, | ||
989 | there will be no Primary system to connect to and the management services | ||
990 | will be unavailable.</para> | ||
991 | |||
992 | <para>This can be manually remedied by either fixing the network situation | ||
993 | that caused the partitioning or modifying Arbiter information in the | ||
994 | configuration file on the server that the user decides should be the | ||
995 | (one and only) Primary server.</para></note> | ||
996 | |||
997 | <para><remark>ELCCR-907</remark>At times the VIP address is not | ||
998 | acquired by any of the backup nodes if a power failure happens on | ||
999 | primary node in a High Availability setup. To recover, follow the | ||
1000 | official documentation available at <ulink | ||
1001 | url="https://mariadb.com/kb/en/galera-cluster-recovery/">Galera | ||
1002 | Cluster Recovery</ulink>.</para> | ||
959 | 1003 | ||
960 | <para>To change the configuration at a later point after the | 1004 | <para>To change the configuration at a later point after the |
961 | installation, either uninstall and then reinstall the product, or | 1005 | installation, either uninstall and then reinstall the product, or |
@@ -972,8 +1016,9 @@ Configuration complete.</programlisting> | |||
972 | 1016 | ||
973 | <orderedlist> | 1017 | <orderedlist> |
974 | <listitem> | 1018 | <listitem> |
975 | <para>We start with the assumption that <literal>ucpeManager-1 | 1019 | <para>We start with the assumption that |
976 | </literal>is the "PRIMARY" server.</para> | 1020 | <literal>EneaEdgeManagement-1 </literal>is the "PRIMARY" |
1021 | server.</para> | ||
977 | </listitem> | 1022 | </listitem> |
978 | 1023 | ||
979 | <listitem> | 1024 | <listitem> |
@@ -988,34 +1033,35 @@ Configuration complete.</programlisting> | |||
988 | </listitem> | 1033 | </listitem> |
989 | 1034 | ||
990 | <listitem> | 1035 | <listitem> |
991 | <para>Run the upgrade process on <literal>ucpeManager-3</literal> | 1036 | <para>Run the upgrade process on |
992 | and <literal>ucpeManager-4</literal>. This will upgrade the service | 1037 | <literal>EneaEdgeManagement-3</literal> and |
993 | to the current release. Once the upgrade process completes, shutdown | 1038 | <literal>EneaEdgeManagement-4</literal>. This will upgrade the |
994 | the Enea Edge Management service on both machines.</para> | 1039 | service to the current release. Once the upgrade process completes, |
1040 | shutdown the Enea Edge Management service on both machines.</para> | ||
995 | </listitem> | 1041 | </listitem> |
996 | 1042 | ||
997 | <listitem> | 1043 | <listitem> |
998 | <para>Disconnect the <literal>ucpeManager-2</literal> machine from | 1044 | <para>Disconnect the <literal>EneaEdgeManagement-2</literal> machine |
999 | the network (which will take MariaDB-2 offline as well). At this | 1045 | from the network (which will take MariaDB-2 offline as well). At |
1000 | point, only the "PRIMARY" server is running, this is the start of | 1046 | this point, only the "PRIMARY" server is running, this is the start |
1001 | the interval when we are susceptible to single-server | 1047 | of the interval when we are susceptible to single-server |
1002 | failure.</para> | 1048 | failure.</para> |
1003 | </listitem> | 1049 | </listitem> |
1004 | 1050 | ||
1005 | <listitem> | 1051 | <listitem> |
1006 | <para>Shutdown the MariaDB-2 process and run the Enea Edge | 1052 | <para>Shutdown the MariaDB-2 process and run the Enea Edge |
1007 | Management upgrade process on <literal>ucpeManager-2</literal>. This | 1053 | Management upgrade process on |
1008 | will upgrade the service to the current release. Once the upgrade | 1054 | <literal>EneaEdgeManagement-2</literal>. This will upgrade the |
1009 | process completes, shutdown the Enea Edge Management service on the | 1055 | service to the current release. Once the upgrade process completes, |
1010 | machine.</para> | 1056 | shutdown the Enea Edge Management service on the machine.</para> |
1011 | </listitem> | 1057 | </listitem> |
1012 | 1058 | ||
1013 | <listitem> | 1059 | <listitem> |
1014 | <para>Reconnect the network interfaces towards the VPN for MariaDB-4 | 1060 | <para>Reconnect the network interfaces towards the VPN for MariaDB-4 |
1015 | (<literal>ucpeManager-3</literal>), MariaDB-5 | 1061 | (<literal>EneaEdgeManagement-3</literal>), MariaDB-5 |
1016 | (<literal>ucpeManager-4</literal>) and MariaDB-6 | 1062 | (<literal>EneaEdgeManagement-4</literal>) and MariaDB-6 |
1017 | (<literal>ucpeManager-2</literal>). Restart database services on | 1063 | (<literal>EneaEdgeManagement-2</literal>). Restart database services |
1018 | MariaDB-2, MariaDB-4, MariaDB-5 and MariaDB-6. This will allow | 1064 | on MariaDB-2, MariaDB-4, MariaDB-5 and MariaDB-6. This will allow |
1019 | database services on all machines to synchronize, any data that has | 1065 | database services on all machines to synchronize, any data that has |
1020 | been modified during the upgrade process will be made | 1066 | been modified during the upgrade process will be made |
1021 | consistent.</para> | 1067 | consistent.</para> |
@@ -1023,35 +1069,36 @@ Configuration complete.</programlisting> | |||
1023 | 1069 | ||
1024 | <listitem> | 1070 | <listitem> |
1025 | <para>Shutdown the "Primary" server | 1071 | <para>Shutdown the "Primary" server |
1026 | (<literal>ucpeManager-1</literal>). At this point, the service is no | 1072 | (<literal>EneaEdgeManagement-1</literal>). At this point, the |
1027 | longer available.</para> | 1073 | service is no longer available.</para> |
1028 | </listitem> | 1074 | </listitem> |
1029 | 1075 | ||
1030 | <listitem> | 1076 | <listitem> |
1031 | <para>Start the Enea Edge Management services on | 1077 | <para>Start the Enea Edge Management service on |
1032 | <literal>ucpeManager-2</literal>. This machine will come up as the | 1078 | <literal>EneaEdgeManagement-2</literal>. This machine will come up |
1033 | new "PRIMARY" with the upgraded software. As part of the startup | 1079 | as the new "PRIMARY" with the upgraded software. As part of the |
1034 | process, it will upgrade the database and perform any other | 1080 | startup process, it will upgrade the database and perform any other |
1035 | upgrade-related functionality.</para> | 1081 | upgrade-related functionality.</para> |
1036 | </listitem> | 1082 | </listitem> |
1037 | 1083 | ||
1038 | <listitem> | 1084 | <listitem> |
1039 | <para>At this point (once startup completes), service is available. | 1085 | <para>At this point (once startup completes), service is available. |
1040 | However, we are still susceptible to single-server failure.</para> | 1086 | However, the system is still susceptible to single-server |
1087 | failure.</para> | ||
1041 | </listitem> | 1088 | </listitem> |
1042 | 1089 | ||
1043 | <listitem> | 1090 | <listitem> |
1044 | <para>Start the Enea Edge Management services on | 1091 | <para>Start the Enea Edge Management services on |
1045 | <literal>ucpeManager-3</literal> and | 1092 | <literal>EneaEdgeManagement-3</literal> and |
1046 | <literal>ucpeManager-4</literal>. At this point, we are in | 1093 | <literal>EneaEdgeManagement-4</literal>. At this point, they will |
1047 | highly-available mode.</para> | 1094 | operate in highly-available mode.</para> |
1048 | </listitem> | 1095 | </listitem> |
1049 | 1096 | ||
1050 | <listitem> | 1097 | <listitem> |
1051 | <para>Upgrade the Enea Edge Management on | 1098 | <para>Upgrade the Enea Edge Management application on |
1052 | <literal>ucpeManager-1</literal> (the one that has been shut down). | 1099 | <literal>EneaEdgeManagement-1</literal> (the one that has been shut |
1053 | Once that upgrade is complete and the service restarts, the entire | 1100 | down). Once that upgrade is complete and the service restarts, the |
1054 | setup has been upgraded to the new version.</para> | 1101 | entire setup has been upgraded to the new version.</para> |
1055 | </listitem> | 1102 | </listitem> |
1056 | </orderedlist> | 1103 | </orderedlist> |
1057 | </section> | 1104 | </section> |
diff --git a/doc/book-enea-edge-getting-started/doc/book.xml b/doc/book-enea-edge-getting-started/doc/book.xml index f02f770..07021cb 100644 --- a/doc/book-enea-edge-getting-started/doc/book.xml +++ b/doc/book-enea-edge-getting-started/doc/book.xml | |||
@@ -1,14 +1,16 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
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"> |
5 | ]> | 5 | ]> |
6 | <book id="book_enea_edge_getting_started"> | 6 | <book id="book_enea_edge_getting_started"> |
7 | <title><trademark class="registered">Enea</trademark> Edge Getting Started</title> | 7 | <title><trademark class="registered">Enea</trademark> Edge Getting |
8 | Started</title> | ||
8 | 9 | ||
9 | <subtitle>Release Version | 10 | <subtitle>Release Version <xi:include |
10 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" | 11 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" |
11 | xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> | 12 | xmlns:xi="http://www.w3.org/2001/XInclude" |
13 | xpointer="element(EneaLinux_REL_VER/1)" /></subtitle> | ||
12 | 14 | ||
13 | <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> | 15 | <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> |
14 | 16 | ||
@@ -17,28 +19,26 @@ | |||
17 | 19 | ||
18 | <xi:include href="introduction.xml" | 20 | <xi:include href="introduction.xml" |
19 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 21 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
20 | 22 | ||
21 | <xi:include href="installation_guide.xml" | 23 | <xi:include href="installation_guide.xml" |
22 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 24 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
23 | 25 | ||
24 | <xi:include href="upgrade_ena.xml" | 26 | <xi:include href="upgrade_ena.xml" |
25 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 27 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
26 | 28 | ||
27 | <xi:include href="advanced_configurations.xml" | 29 | <xi:include href="advanced_configurations.xml" |
28 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 30 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
29 | 31 | ||
30 | <xi:include href="net_config_options.xml" | 32 | <xi:include href="net_config_options.xml" |
31 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 33 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
32 | 34 | ||
33 | <xi:include href="vnf_mg.xml" | 35 | <xi:include href="vnf_mg.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> |
34 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
35 | 36 | ||
36 | <xi:include href="log_collector.xml" | 37 | <xi:include href="log_collector.xml" |
37 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 38 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
38 | 39 | ||
39 | <xi:include href="grafana.xml" | 40 | <xi:include href="grafana.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> |
40 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
41 | 41 | ||
42 | <xi:include href="troubleshooting.xml" | 42 | <xi:include href="troubleshooting.xml" |
43 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 43 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
44 | </book> | 44 | </book> \ No newline at end of file |
diff --git a/doc/book-enea-edge-getting-started/doc/grafana.xml b/doc/book-enea-edge-getting-started/doc/grafana.xml index 5dfaa98..807c2ac 100644 --- a/doc/book-enea-edge-getting-started/doc/grafana.xml +++ b/doc/book-enea-edge-getting-started/doc/grafana.xml | |||
@@ -1,21 +1,25 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="grafana"> | 2 | <chapter id="grafana"> |
3 | <title>Using Grafana and InfluxDB</title> | 3 | <title>Using Grafana and InfluxDB</title> |
4 | 4 | ||
5 | <para>InfluxDB is essentially a time series database process that runs on a | 5 | <para><ulink url="https://docs.influxdata.com/influxdb/">InfluxDB</ulink> is |
6 | server, while Grafana is a visualization tool for time series data. Grafana | 6 | essentially a time series database process that runs on a server, while |
7 | is a very lightweight server-side application, and most of the monitoring | 7 | <ulink url="https://grafana.com/docs/grafana">Grafana</ulink> is a |
8 | runs in a browser.</para> | 8 | visualization tool for time series data. Grafana is a very lightweight |
9 | server-side application, and most of the data monitoring runs in a browser.</para> | ||
10 | |||
11 | <para>For details on version information for these two components, please refer to the | ||
12 | <ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
13 | xmlns:ns="http://www.w3.org/2001/XInclude" | ||
14 | xpointer="element(book_enea_edge_telemetry_open_source/1)" />.</para> | ||
9 | 15 | ||
10 | <section id="telemetry_deployment"> | 16 | <section id="telemetry_deployment"> |
11 | <title>Deploying Grafana and InfluxDB</title> | 17 | <title>Deploying Grafana and InfluxDB</title> |
12 | 18 | ||
13 | <para>Grafana and InfluxDB can be deployed using images for Docker on | 19 | <para>Grafana and InfluxDB can be deployed using images for Docker on |
14 | linux. These images are provided by Enea along with a deploy script and | 20 | linux. These images are provided by Enea along with a deploy script and |
15 | predefined dashboards.</para> | 21 | predefined dashboards. The Grafana and InfluxDB images can be deployed on |
16 | 22 | the same machine or on separate machines.</para> | |
17 | <para>The Grafana and InfluxDB images can be deployed on the same machine | ||
18 | or on separate machines.</para> | ||
19 | 23 | ||
20 | <section id="prereq_deploy"> | 24 | <section id="prereq_deploy"> |
21 | <title>Prerequisites for Deploying an Image</title> | 25 | <title>Prerequisites for Deploying an Image</title> |
@@ -28,55 +32,59 @@ | |||
28 | </listitem> | 32 | </listitem> |
29 | 33 | ||
30 | <listitem> | 34 | <listitem> |
31 | <para>Internet connection for installing the Docker tool.</para> | 35 | <para>Internet connection for installing the Docker tool.</para> |
32 | </listitem> | 36 | </listitem> |
33 | 37 | ||
34 | <listitem> | 38 | <listitem> |
35 | <para>Root rights on the CentOS 7 machine.</para> | 39 | <para>Root rights on the CentOS 7 machine.</para> |
36 | </listitem> | 40 | </listitem> |
37 | </itemizedlist> | 41 | </itemizedlist> |
38 | </section> | 42 | </section> |
39 | 43 | ||
40 | <section id="docker_steps"> | 44 | <section id="docker_steps"> |
41 | <title>Setting up Docker for Grafana and InfluxDB</title> | 45 | <title>Setting up Docker for Grafana and InfluxDB</title> |
42 | 46 | ||
43 | <para>In order to use the Grafana and InfluxDB containers, the Docker | 47 | <para>In order to use the Grafana and InfluxDB containers, the Docker |
44 | tool that runs and manages containers needs to be available on | 48 | tool that runs and manages containers needs to be available on the |
45 | the server.</para> | 49 | server.</para> |
46 | 50 | ||
47 | <para>To install Docker on a CentOS 7 server open a terminal, log | 51 | <para>To install Docker on a CentOS 7 server open a terminal, log into a |
48 | into a bash shell with the root account and run the following commands:</para> | 52 | bash shell with the root account and run the following commands:</para> |
49 | 53 | ||
50 | <orderedlist> | 54 | <orderedlist> |
51 | <listitem> | ||
52 | <para><literal>yum check-update</literal></para> | ||
53 | </listitem> | ||
54 | |||
55 | <listitem> | 55 | <listitem> |
56 | <para><literal>yum install -y yum-utils device-mapper-persistent-data lvm2</literal></para> | 56 | <para><literal>yum check-update</literal></para> |
57 | </listitem> | 57 | </listitem> |
58 | |||
59 | <listitem> | ||
60 | <para><literal>yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo</literal></para> | ||
61 | </listitem> | ||
62 | |||
63 | <listitem> | ||
64 | <para><literal>yum install docker</literal></para> | ||
65 | </listitem> | ||
66 | </orderedlist> | ||
67 | |||
68 | <para>In order to deploy the Grafana and InfluxDB images, the Docker | ||
69 | service needs to be started. To start the Docker service, log into | ||
70 | a bash shell with the root account and run the following command: | ||
71 | <literal>systemctl start docker</literal>.</para> | ||
72 | |||
73 | <note><para>By default, the Docker service is not configured to start at boot. | ||
74 | In order to configure it to autostart, log into a bash shell | ||
75 | with the root account and run the following command: | ||
76 | <literal>systemctl enable docker</literal>. The Grafana and InfluxDB | ||
77 | images are configured to autostart when the Docker service starts.</para></note> | ||
78 | </section> | ||
79 | 58 | ||
59 | <listitem> | ||
60 | <para><literal>yum install -y yum-utils | ||
61 | device-mapper-persistent-data lvm2</literal></para> | ||
62 | </listitem> | ||
63 | |||
64 | <listitem> | ||
65 | <para><literal>yum-config-manager --add-repo | ||
66 | https://download.docker.com/linux/centos/docker-ce.repo</literal></para> | ||
67 | </listitem> | ||
68 | |||
69 | <listitem> | ||
70 | <para><literal>yum install docker</literal></para> | ||
71 | </listitem> | ||
72 | </orderedlist> | ||
73 | |||
74 | <para>In order to deploy the Grafana and InfluxDB images, the Docker | ||
75 | service needs to be started. To start the Docker service, log into a | ||
76 | bash shell with the root account and run the following command: | ||
77 | <literal>systemctl start docker</literal>.</para> | ||
78 | |||
79 | <note> | ||
80 | <para>By default, the Docker service is not configured to start at | ||
81 | boot. In order to configure it to autostart, log into a bash shell | ||
82 | with the root account and run the following command: | ||
83 | <literal>systemctl enable docker</literal>. The Grafana and InfluxDB | ||
84 | images are configured to autostart when the Docker service | ||
85 | starts.</para> | ||
86 | </note> | ||
87 | </section> | ||
80 | 88 | ||
81 | <section id="deploy_steps"> | 89 | <section id="deploy_steps"> |
82 | <title>Deploying Grafana and InfluxDB</title> | 90 | <title>Deploying Grafana and InfluxDB</title> |
@@ -90,11 +98,13 @@ | |||
90 | <filename>Enea_Edge_Telemetry_Deploy_<version>-build<build_number>.tar.gz</filename>.</para> | 98 | <filename>Enea_Edge_Telemetry_Deploy_<version>-build<build_number>.tar.gz</filename>.</para> |
91 | 99 | ||
92 | <para>The directory in which the archive will be unpacked will be | 100 | <para>The directory in which the archive will be unpacked will be |
93 | denoted as: <literal><Telemetry-installdir></literal>.</para> | 101 | denoted as: |
102 | <literal><Telemetry-installerdir></literal>.</para> | ||
94 | </listitem> | 103 | </listitem> |
95 | 104 | ||
96 | <listitem> | 105 | <listitem> |
97 | <para>Enter <literal><Telemetry-installdir></literal>.</para> | 106 | <para>Enter |
107 | <literal><Telemetry-installerdir></literal>.</para> | ||
98 | </listitem> | 108 | </listitem> |
99 | 109 | ||
100 | <listitem> | 110 | <listitem> |
@@ -103,25 +113,26 @@ | |||
103 | </listitem> | 113 | </listitem> |
104 | 114 | ||
105 | <listitem> | 115 | <listitem> |
106 | <para>When prompted, select what images you want to deploy. | 116 | <para>When prompted, select what images you want to deploy. Select |
107 | Select <literal>Both</literal> unless you wish for the Grafana | 117 | <literal>Both</literal> unless you wish for the Grafana and InfluxDB |
108 | and InfluxDB images to be on separate servers.</para> | 118 | images to be on separate servers.</para> |
109 | 119 | ||
110 | <note> | 120 | <note> |
111 | <para>If an image is already deployed, you will be prompted | 121 | <para>If an image is already deployed, you will be prompted to |
112 | to replace it.</para> | 122 | replace it.</para> |
113 | 123 | ||
114 | <para>By default, Grafana is configured for deployment on the | 124 | <para>By default, Grafana is configured for deployment on the same |
115 | same server as InfluxDB. Please read the Grafana documentation | 125 | server as InfluxDB. Please read the Grafana documentation on how |
116 | on how to configure it if you wish to deploy the images | 126 | to configure it if you wish to deploy the images on separate |
117 | on separate servers.</para> | 127 | servers.</para> |
118 | </note> | 128 | </note> |
119 | </listitem> | 129 | </listitem> |
120 | 130 | ||
121 | <listitem> | 131 | <listitem> |
122 | <para>During the InfluxDB deployment, you will be prompted to | 132 | <para>During the InfluxDB deployment, you will be prompted to |
123 | provide a username and password. These must match the ones | 133 | provide a username and password. These must match the ones |
124 | configured in the Enea Edge Management for Telemetry.</para> | 134 | configured in the Enea Edge Management application for |
135 | Telemetry.</para> | ||
125 | 136 | ||
126 | <note> | 137 | <note> |
127 | <para>Changing the InfluxDB username and password requires | 138 | <para>Changing the InfluxDB username and password requires |
@@ -135,47 +146,48 @@ | |||
135 | present and have the status <literal>Up</literal>.</para> | 146 | present and have the status <literal>Up</literal>.</para> |
136 | </listitem> | 147 | </listitem> |
137 | </orderedlist> | 148 | </orderedlist> |
138 | 149 | ||
139 | <note> | 150 | <note> |
140 | <para>The provided Grafana instance by default uses the | 151 | <para>The provided Grafana instance by default uses the |
141 | <literal>Username:</literal> <emphasis role="bold">admin</emphasis> and | 152 | <literal>Username:</literal> <emphasis role="bold">admin</emphasis> |
142 | <literal>Password:</literal> <emphasis role="bold">admin</emphasis>.</para> | 153 | and <literal>Password:</literal> <emphasis |
143 | </note> | 154 | role="bold">admin</emphasis>.</para> |
144 | </section> | 155 | </note> |
145 | </section> | 156 | </section> |
146 | 157 | </section> | |
147 | <section id="telemetry_firewall_settings"> | 158 | |
148 | <title>Firewall settings for Grafana and InfluxDB</title> | 159 | <section id="telemetry_firewall_settings"> |
149 | 160 | <title>Firewall settings for Grafana and InfluxDB</title> | |
150 | <para>If a firewall is running on the machines where Grafana and InfluxDB are | 161 | |
151 | deployed, this firewall needs to be configured so the required ports are | 162 | <para>If a firewall is running on the machines where Grafana and InfluxDB |
152 | enabled.</para> | 163 | are deployed, this firewall needs to be configured so the required ports |
153 | 164 | are enabled.</para> | |
154 | <para>To enable the ports, log into a bash shell with the root account and | 165 | |
155 | perform the following: | 166 | <para>To enable the ports, log into a bash shell with the root account and |
156 | </para> | 167 | perform the following:</para> |
157 | 168 | ||
158 | <orderedlist> | 169 | <orderedlist> |
159 | <listitem> | 170 | <listitem> |
160 | <para>For InfluxDB, run the following command:</para> | 171 | <para>For InfluxDB, run the following command:</para> |
161 | 172 | ||
162 | <programlisting>firewall-cmd --permanent --add-port=25826/tcp</programlisting> | 173 | <programlisting>firewall-cmd --permanent --add-port=25826/tcp</programlisting> |
163 | </listitem> | 174 | </listitem> |
164 | 175 | ||
165 | <listitem> | 176 | <listitem> |
166 | <para>For Grafana, run the following command:</para> | 177 | <para>For Grafana, run the following command:</para> |
167 | 178 | ||
168 | <programlisting>firewall-cmd --permanent --add-port=3000/tcp</programlisting> | 179 | <programlisting>firewall-cmd --permanent --add-port=3000/tcp</programlisting> |
169 | </listitem> | 180 | </listitem> |
170 | </orderedlist> | 181 | </orderedlist> |
171 | </section> | 182 | </section> |
172 | 183 | ||
173 | <section id="grafana_settings"> | 184 | <section id="grafana_settings"> |
174 | <title>Setting Grafana and InfluxDB parameters</title> | 185 | <title>Setting Grafana and InfluxDB parameters</title> |
175 | 186 | ||
176 | <para>Customizing InfluxDB and Grafana parameters can be done in the Enea uCPE Manager | 187 | <para>Customizing InfluxDB and Grafana parameters can be done in the Enea |
177 | GUI by selecting <emphasis role="bold">System</emphasis>, then the <emphasis | 188 | Edge Management GUI by selecting the <emphasis |
178 | role="bold">Configuration</emphasis> menu, accessing the <emphasis | 189 | role="bold">System</emphasis> menu, then <emphasis |
190 | role="bold">Configuration</emphasis>, accessing the <emphasis | ||
179 | role="bold">Properties</emphasis> tab, and clicking on the <emphasis | 191 | role="bold">Properties</emphasis> tab, and clicking on the <emphasis |
180 | role="bold">Telemetry</emphasis> tab. The settings that can be changed are | 192 | role="bold">Telemetry</emphasis> tab. The settings that can be changed are |
181 | listed in the table below:</para> | 193 | listed in the table below:</para> |
@@ -202,8 +214,8 @@ | |||
202 | <row> | 214 | <row> |
203 | <entry>Grafana Hostname or IP Address</entry> | 215 | <entry>Grafana Hostname or IP Address</entry> |
204 | 216 | ||
205 | <entry>The public hostname or IP address where the Grafana instance is | 217 | <entry>The public hostname or IP address where the Grafana |
206 | installed.</entry> | 218 | instance is installed.</entry> |
207 | 219 | ||
208 | <entry>no default</entry> | 220 | <entry>no default</entry> |
209 | </row> | 221 | </row> |
@@ -220,7 +232,7 @@ | |||
220 | <entry>Grafana Dashboard</entry> | 232 | <entry>Grafana Dashboard</entry> |
221 | 233 | ||
222 | <entry>The dashboard that should be used when opening Grafana | 234 | <entry>The dashboard that should be used when opening Grafana |
223 | using the Enea Edge Management.</entry> | 235 | using the Enea Edge Management application.</entry> |
224 | 236 | ||
225 | <entry>host</entry> | 237 | <entry>host</entry> |
226 | </row> | 238 | </row> |
@@ -228,8 +240,8 @@ | |||
228 | <row> | 240 | <row> |
229 | <entry>InfluxDB Hostname or IP Address</entry> | 241 | <entry>InfluxDB Hostname or IP Address</entry> |
230 | 242 | ||
231 | <entry>The public hostname or IP address where the InfluxDB database is | 243 | <entry>The public hostname or IP address where the InfluxDB |
232 | installed.</entry> | 244 | database is installed.</entry> |
233 | 245 | ||
234 | <entry>no default</entry> | 246 | <entry>no default</entry> |
235 | </row> | 247 | </row> |
@@ -265,8 +277,9 @@ | |||
265 | </table> | 277 | </table> |
266 | 278 | ||
267 | <para>When changing any of the settings in the <emphasis | 279 | <para>When changing any of the settings in the <emphasis |
268 | role="bold">Telemetry</emphasis> tab, the Enea Edge Management will inform | 280 | role="bold">Telemetry</emphasis> tab, the Enea Edge Management application |
269 | all uCPE devices of the change if they have telemetry running.</para> | 281 | will inform all uCPE devices of the change if they have telemetry |
282 | running.</para> | ||
270 | 283 | ||
271 | <figure> | 284 | <figure> |
272 | <title>Telemetry Properties</title> | 285 | <title>Telemetry Properties</title> |
@@ -289,7 +302,7 @@ | |||
289 | options are available.</para> | 302 | options are available.</para> |
290 | 303 | ||
291 | <para>When starting Telemetry for a uCPE device, the Enea Edge Management | 304 | <para>When starting Telemetry for a uCPE device, the Enea Edge Management |
292 | sends the following information about the InfluxDB:</para> | 305 | application sends the following information about the InfluxDB:</para> |
293 | 306 | ||
294 | <itemizedlist> | 307 | <itemizedlist> |
295 | <listitem> | 308 | <listitem> |
@@ -324,9 +337,10 @@ | |||
324 | </figure> | 337 | </figure> |
325 | 338 | ||
326 | <para>When the Telemetry status is changed on a uCPE device, a | 339 | <para>When the Telemetry status is changed on a uCPE device, a |
327 | notification is sent to the Enea Edge Management. These notifications can | 340 | notification is sent to the Enea Edge Management application. These |
328 | be inspected under <emphasis role="bold">Fault</emphasis> found in the | 341 | notifications can be inspected under <emphasis |
329 | <emphasis role="bold">Event</emphasis> menu.</para> | 342 | role="bold">Fault</emphasis> found in the <emphasis |
343 | role="bold">Event</emphasis> menu.</para> | ||
330 | </section> | 344 | </section> |
331 | 345 | ||
332 | <section id="grafana_launch"> | 346 | <section id="grafana_launch"> |
@@ -344,4 +358,4 @@ | |||
344 | <emphasis role="bold">Telemetry</emphasis> tab. The default dashboard | 358 | <emphasis role="bold">Telemetry</emphasis> tab. The default dashboard |
345 | available when launching Grafana can be customized as well.</para> | 359 | available when launching Grafana can be customized as well.</para> |
346 | </section> | 360 | </section> |
347 | </chapter> | 361 | </chapter> \ No newline at end of file |
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 2805d4f..1ca3b02 100644 --- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml +++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="installation_guide"> | 2 | <chapter id="installation_guide"> |
3 | <title>Setting up and Installing the Enea Edge Base Configuration</title> | 3 | <title>Setting up and Installing the Enea Edge Base Configuration</title> |
4 | 4 | ||
@@ -18,11 +18,12 @@ | |||
18 | 18 | ||
19 | <note> | 19 | <note> |
20 | <para>The CentOS 7 server must be updated to the latest revision | 20 | <para>The CentOS 7 server must be updated to the latest revision |
21 | before installing Enea Edge.</para> | 21 | before installing Enea Edge, and configured for English language |
22 | usage.</para> | ||
22 | </note> | 23 | </note> |
23 | 24 | ||
24 | <para>The following will detail CPU, RAM and storage requirements for | 25 | <para>The following will detail CPU, RAM and storage requirements for |
25 | the Enea Edge Management Application.</para> | 26 | the Enea Edge Management application:</para> |
26 | 27 | ||
27 | <itemizedlist> | 28 | <itemizedlist> |
28 | <listitem> | 29 | <listitem> |
@@ -81,9 +82,10 @@ | |||
81 | </itemizedlist> | 82 | </itemizedlist> |
82 | 83 | ||
83 | <para>The purpose of the CentOS 7 server is to host the Enea Edge | 84 | <para>The purpose of the CentOS 7 server is to host the Enea Edge |
84 | Management Application. Network access between the CentOS 7 server and the uCPE | 85 | Management application. Network access between the CentOS 7 server and |
85 | devices is required. The Enea Edge Management and the uCPE devices | 86 | the uCPE devices is required. The Enea Edge Management application and |
86 | will be connected on separate subnets to avoid inconsistencies.</para> | 87 | the uCPE devices will be connected on separate subnets to avoid |
88 | inconsistencies.</para> | ||
87 | </listitem> | 89 | </listitem> |
88 | 90 | ||
89 | <listitem> | 91 | <listitem> |
@@ -100,8 +102,7 @@ | |||
100 | supported Intel CPUs of Enea Edge are documented in the <xi:include | 102 | supported Intel CPUs of Enea Edge are documented in the <xi:include |
101 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | 103 | href="../../s_docbuild/olinkdb/pardoc-common.xml" |
102 | xmlns:xi="http://www.w3.org/2001/XInclude" | 104 | xmlns:xi="http://www.w3.org/2001/XInclude" |
103 | xpointer="element(book_enea_nfv_access_release_info/1)" /> | 105 | xpointer="element(book_enea_edge_release_info/1)" /> Manual.</para> |
104 | Manual.</para> | ||
105 | 106 | ||
106 | <para>Enea Edge Runtime needs EFI support in BIOS to boot. When | 107 | <para>Enea Edge Runtime needs EFI support in BIOS to boot. When |
107 | configuring the uCPE device BIOS a serial connection is | 108 | configuring the uCPE device BIOS a serial connection is |
@@ -119,12 +120,12 @@ | |||
119 | </listitem> | 120 | </listitem> |
120 | 121 | ||
121 | <listitem> | 122 | <listitem> |
122 | <para>Connecting to the GUI of the Enea Edge Management for | 123 | <para>Connecting to the GUI of the Enea Edge Management |
123 | management and configuration. Network access between the CentOS 7 | 124 | application for management and configuration. Network access |
124 | server and the laptop is required. Please see the <xi:include | 125 | between the CentOS 7 server and the laptop is required. Please see |
125 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | 126 | the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
126 | xmlns:xi="http://www.w3.org/2001/XInclude" | 127 | xmlns:xi="http://www.w3.org/2001/XInclude" |
127 | xpointer="element(book_enea_nfv_access_release_info/1)" /> Manual | 128 | xpointer="element(book_enea_edge_release_info/1)" /> Manual |
128 | available with your release, for recommended browsers.</para> | 129 | available with your release, for recommended browsers.</para> |
129 | </listitem> | 130 | </listitem> |
130 | </itemizedlist> | 131 | </itemizedlist> |
@@ -147,9 +148,10 @@ | |||
147 | 148 | ||
148 | <para>Any firewall running on the CentOS 7 server may block the | 149 | <para>Any firewall running on the CentOS 7 server may block the |
149 | management protocols required to communicate between the uCPE device and | 150 | management protocols required to communicate between the uCPE device and |
150 | the Enea Edge Management as well as between the Enea Edge Management and | 151 | the Enea Edge Management application as well as between the Enea Edge |
151 | its northbound clients. Quick handling of a blocking firewall would be | 152 | Management application and its northbound clients. Quick handling of a |
152 | to disable it, typical for a lab environment, through:</para> | 153 | blocking firewall would be to disable it, typical for a lab environment, |
154 | through:</para> | ||
153 | 155 | ||
154 | <programlisting>sudo systemctl stop firewalld | 156 | <programlisting>sudo systemctl stop firewalld |
155 | sudo systemctl disable firewalld | 157 | sudo systemctl disable firewalld |
@@ -186,10 +188,8 @@ sudo systemctl mask now firewalld</programlisting> | |||
186 | 188 | ||
187 | <entry>UDP</entry> | 189 | <entry>UDP</entry> |
188 | 190 | ||
189 | 191 | <entry>Required for the Enea Edge Management application High | |
190 | <entry condition="hidden">Required for the Enea Edge Management High Availability | 192 | Availability Configuration.</entry> |
191 | |||
192 | Configuration.</entry> | ||
193 | </row> | 193 | </row> |
194 | 194 | ||
195 | <row> | 195 | <row> |
@@ -197,9 +197,8 @@ sudo systemctl mask now firewalld</programlisting> | |||
197 | 197 | ||
198 | <entry>TCP</entry> | 198 | <entry>TCP</entry> |
199 | 199 | ||
200 | <entry condition="hidden">Required for the Enea Edge Management High Availability | 200 | <entry>Required for the Enea Edge Management application High |
201 | 201 | Availability Configuration.</entry> | |
202 | Configuration.</entry> | ||
203 | </row> | 202 | </row> |
204 | 203 | ||
205 | <row> | 204 | <row> |
@@ -223,7 +222,7 @@ sudo systemctl mask now firewalld</programlisting> | |||
223 | </table> | 222 | </table> |
224 | 223 | ||
225 | <para>Use the following command sequence to enable the required ports | 224 | <para>Use the following command sequence to enable the required ports |
226 | for deployment of the Enea Edge Management:</para> | 225 | for deployment of the Enea Edge Management application:</para> |
227 | 226 | ||
228 | <programlisting>sudo firewall-cmd --permanent --add-port=80/tcp | 227 | <programlisting>sudo firewall-cmd --permanent --add-port=80/tcp |
229 | sudo firewall-cmd --permanent --add-port=443/tcp | 228 | sudo firewall-cmd --permanent --add-port=443/tcp |
@@ -238,18 +237,19 @@ sudo firewall-cmd --reload</programlisting> | |||
238 | port-filtering firewall, then all the aforementioned ports need to | 237 | port-filtering firewall, then all the aforementioned ports need to |
239 | also be enabled on the respective firewall. As an additional | 238 | also be enabled on the respective firewall. As an additional |
240 | requirement, port 22/TCP also needs to be enabled for reverse SSH to | 239 | requirement, port 22/TCP also needs to be enabled for reverse SSH to |
241 | the Enea Edge Management.</para> | 240 | the Enea Edge Management application.</para> |
242 | 241 | ||
243 | <para>No enabling and no forwarding rules are necessary for ports | 242 | <para>No enabling and no forwarding rules are necessary for ports |
244 | 2021-2040 if using Enea Edge 2.4.0 or newer.</para> | 243 | 2021-2040 if Enea Edge 2.4.0 or newer is used.</para> |
245 | </note> | 244 | </note> |
246 | </section> | 245 | </section> |
247 | 246 | ||
248 | <section id="openjdk_postgresql_config"> | 247 | <section id="openjdk_postgresql_config"> |
249 | <title>Configuring OpenJDK and PostgreSQL</title> | 248 | <title>Configuring OpenJDK and PostgreSQL</title> |
250 | 249 | ||
251 | <para>The Enea Edge Management requires a specific Java version (OpenJDK | 250 | <para>The Enea Edge Management application requires a specific Java |
252 | 11) and a PostgreSQL version to operate correctly.</para> | 251 | version (OpenJDK 11) and a PostgreSQL version to operate |
252 | correctly.</para> | ||
253 | 253 | ||
254 | <para><emphasis role="bold">Installing OpenJDK</emphasis></para> | 254 | <para><emphasis role="bold">Installing OpenJDK</emphasis></para> |
255 | 255 | ||
@@ -299,10 +299,10 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</p | |||
299 | </listitem> | 299 | </listitem> |
300 | </orderedlist> | 300 | </orderedlist> |
301 | 301 | ||
302 | <para>The Enea Edge Management requires a specific PostgreeSQL version. | 302 | <para>The Enea Edge Management application requires a specific |
303 | This is embedded in the Enea Edge Management installation. In order to | 303 | PostgreSQL version. This is embedded in the Enea Edge Management |
304 | avoid conflicts, any existing PostgreeSQL installation needs to be | 304 | installation. In order to avoid conflicts, any existing PostgreSQL |
305 | uninstalled.</para> | 305 | installation needs to be uninstalled.</para> |
306 | 306 | ||
307 | <para><emphasis role="bold">Uninstalling PostgreSQL</emphasis></para> | 307 | <para><emphasis role="bold">Uninstalling PostgreSQL</emphasis></para> |
308 | 308 | ||
@@ -324,8 +324,9 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</p | |||
324 | postgres user):</para> | 324 | postgres user):</para> |
325 | 325 | ||
326 | <note> | 326 | <note> |
327 | <para>This step is not necessary if the Enea Edge Management will | 327 | <para>This step is not necessary if the Enea Edge Management |
328 | be using an external database (like MariaDB).</para> | 328 | application will be using an external database (like |
329 | MariaDB).</para> | ||
329 | </note> | 330 | </note> |
330 | 331 | ||
331 | <programlisting>yum remove postgres\* | 332 | <programlisting>yum remove postgres\* |
@@ -357,11 +358,13 @@ userdel postgres</programlisting> | |||
357 | 358 | ||
358 | <listitem> | 359 | <listitem> |
359 | <para>Follow the installation steps for the Enea Edge Management | 360 | <para>Follow the installation steps for the Enea Edge Management |
360 | available in <olink targetdoc="book_enea_nfv_access_getting_started" | 361 | application available in <olink |
361 | targetptr="install_ucpe_mg">Installing the Enea Edge Management in | 362 | targetdoc="book_enea_edge_getting_started" |
362 | the <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 363 | targetptr="install_ucpe_mg">Installing the Enea Edge Management |
364 | application in the <xi:include | ||
365 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
363 | xmlns:xi="http://www.w3.org/2001/XInclude" | 366 | xmlns:xi="http://www.w3.org/2001/XInclude" |
364 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 367 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
365 | Manual.</para> | 368 | Manual.</para> |
366 | </listitem> | 369 | </listitem> |
367 | </orderedlist> | 370 | </orderedlist> |
@@ -388,16 +391,14 @@ userdel postgres</programlisting> | |||
388 | <title>Determining the Device ID</title> | 391 | <title>Determining the Device ID</title> |
389 | 392 | ||
390 | <para>Each uCPE device needs a unique identifier. This identifier is | 393 | <para>Each uCPE device needs a unique identifier. This identifier is |
391 | used to match the registration in the Enea Edge Management and the | 394 | used to match the registration in the Enea Edge Management application |
392 | offline configuration of the uCPE device during ZTP (Zero Touch | 395 | and the offline configuration of the uCPE device during ZTP (Zero Touch |
393 | Provisioning).</para> | 396 | Provisioning).</para> |
394 | 397 | ||
395 | <para>Select a text string to represent the uCPE device, e.g. | 398 | <para>Select a text string to represent the uCPE device, e.g. |
396 | <literal>uCPE-1</literal> or <literal>fwa-t1012vc_boston_1234</literal>. | 399 | <literal>uCPE-1</literal> or <literal>fwa-t1012vc_boston_1234</literal>. |
397 | It can have any length and any type of characters with the exception of | 400 | It can have any length and any type of characters with the exception of |
398 | quotation characters (' or ") or line terminators (\n or \r) which can | 401 | quotation characters (' or ") or line terminators (\n or \r).</para> |
399 | interfere with the JSON format of the | ||
400 | <filename>install_data.json</filename> file.</para> | ||
401 | </section> | 402 | </section> |
402 | 403 | ||
403 | <section id="bios_config"> | 404 | <section id="bios_config"> |
@@ -459,30 +460,31 @@ userdel postgres</programlisting> | |||
459 | <title>Preparing the Deployment</title> | 460 | <title>Preparing the Deployment</title> |
460 | 461 | ||
461 | <section id="install_ucpe_mg"> | 462 | <section id="install_ucpe_mg"> |
462 | <title>Installing the Enea Edge Management</title> | 463 | <title>Installing the Enea Edge Management application</title> |
463 | 464 | ||
464 | <para>The Enea Edge Management can be installed using a fresh | 465 | <para>The Enea Edge Management application can be installed using a |
465 | (first-time) configuration or using a backup file of a previous | 466 | fresh (first-time) configuration or using a backup file of a previous |
466 | installation, created within the Enea Edge Management GUI.</para> | 467 | installation, created within the Enea Edge Management GUI.</para> |
467 | 468 | ||
468 | <section id="fresh_ucpemg_install"> | 469 | <section id="fresh_ucpemg_install"> |
469 | <title>Fresh Installation of the Enea Edge Management</title> | 470 | <title>Fresh Installation of the Enea Edge Management |
471 | application</title> | ||
470 | 472 | ||
471 | <para>On the CentOS 7 server open a terminal, log into a bash shell | 473 | <para>On the CentOS 7 server open a terminal, log into a bash shell |
472 | with the root account and perform the following:</para> | 474 | with the root account and perform the following:</para> |
473 | 475 | ||
474 | <orderedlist> | 476 | <orderedlist> |
475 | <listitem> | 477 | <listitem> |
476 | |||
477 | <para>Extract | 478 | <para>Extract |
478 | <literal>Enea_Edge_Management_<version>-build<build_number>.tar.gz</literal></para> | 479 | <literal>Enea_Edge_Management_<version>-build<build_number>.tar.gz</literal></para> |
479 | 480 | ||
480 | <para>The directory in which the archive has been unpacked will be | 481 | <para>The directory in which the archive has been unpacked will be |
481 | denoted as: <literal><uCPEM-installdir></literal>.</para> | 482 | denoted as: <literal><uCPEM-installerdir></literal>.</para> |
482 | </listitem> | 483 | </listitem> |
483 | 484 | ||
484 | <listitem> | 485 | <listitem> |
485 | <para>Enter <literal><uCPEM-installdir>/dist</literal>.</para> | 486 | <para>Enter |
487 | <literal><uCPEM-installerdir>/dist</literal>.</para> | ||
486 | </listitem> | 488 | </listitem> |
487 | 489 | ||
488 | <listitem> | 490 | <listitem> |
@@ -511,8 +513,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
511 | 513 | ||
512 | <note> | 514 | <note> |
513 | <para>The same configuration values set now will need to be | 515 | <para>The same configuration values set now will need to be |
514 | provided when upgrading or uninstalling the Enea Edge | 516 | provided when upgrading or uninstalling the Enea Edge Management |
515 | Management.</para> | 517 | application.</para> |
516 | </note> | 518 | </note> |
517 | 519 | ||
518 | <itemizedlist> | 520 | <itemizedlist> |
@@ -527,32 +529,32 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
527 | 529 | ||
528 | <listitem> | 530 | <listitem> |
529 | <para>Specify the database process password | 531 | <para>Specify the database process password |
530 | <literal>[postgres]:</literal></para> | 532 | <literal>[postgres]</literal>:</para> |
531 | </listitem> | 533 | </listitem> |
532 | 534 | ||
533 | <listitem> | 535 | <listitem> |
534 | <para>Specify the database ID (or name) | 536 | <para>Specify the database ID (or name) |
535 | <literal>[ucpemanager]:</literal></para> | 537 | <literal>[ucpemanager]</literal>:</para> |
536 | </listitem> | 538 | </listitem> |
537 | 539 | ||
538 | <listitem> | 540 | <listitem> |
539 | <para>Specify the database server port | 541 | <para>Specify the database server port |
540 | <literal>[5432]:</literal></para> | 542 | <literal>[5432]</literal>:</para> |
541 | </listitem> | 543 | </listitem> |
542 | 544 | ||
543 | <listitem> | 545 | <listitem> |
544 | <para>Specify a database user name | 546 | <para>Specify a database user name |
545 | <literal>[postgres]:</literal></para> | 547 | <literal>[postgres]</literal>:</para> |
546 | </listitem> | 548 | </listitem> |
547 | 549 | ||
548 | <listitem> | 550 | <listitem> |
549 | <para>Specify a database password | 551 | <para>Specify a database password |
550 | <literal>[postgres]:</literal></para> | 552 | <literal>[postgres]</literal>:</para> |
551 | </listitem> | 553 | </listitem> |
552 | 554 | ||
553 | <listitem> | 555 | <listitem> |
554 | <para>Specify the database startup thread pool size | 556 | <para>Specify the database startup thread pool size |
555 | <literal>[1]:</literal></para> | 557 | <literal>[1]</literal>:</para> |
556 | </listitem> | 558 | </listitem> |
557 | </itemizedlist> | 559 | </itemizedlist> |
558 | </listitem> | 560 | </listitem> |
@@ -563,17 +565,17 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
563 | <itemizedlist spacing="compact"> | 565 | <itemizedlist spacing="compact"> |
564 | <listitem> | 566 | <listitem> |
565 | <para>Specify a service username | 567 | <para>Specify a service username |
566 | [<literal>ucpemanager</literal>]:</para> | 568 | <literal>[ucpemanager]:</literal></para> |
567 | </listitem> | 569 | </listitem> |
568 | 570 | ||
569 | <listitem> | 571 | <listitem> |
570 | <para>Specify a service password | 572 | <para>Specify a service password |
571 | <literal>[ucpemanager</literal>]:</para> | 573 | <literal>[ucpemanager]</literal>:</para> |
572 | </listitem> | 574 | </listitem> |
573 | </itemizedlist> | 575 | </itemizedlist> |
574 | </listitem> | 576 | </listitem> |
575 | 577 | ||
576 | <listitem condition="hidden"> | 578 | <listitem> |
577 | <para>High Availability Configurations:</para> | 579 | <para>High Availability Configurations:</para> |
578 | 580 | ||
579 | <itemizedlist> | 581 | <itemizedlist> |
@@ -597,7 +599,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
597 | 599 | ||
598 | <listitem> | 600 | <listitem> |
599 | <para>Create the self-signed certificate: <literal>Specify IP | 601 | <para>Create the self-signed certificate: <literal>Specify IP |
600 | or domain name:</literal></para> | 602 | or domain name</literal>:</para> |
601 | 603 | ||
602 | <note> | 604 | <note> |
603 | <para>The certificate can be generated again by running the | 605 | <para>The certificate can be generated again by running the |
@@ -620,12 +622,12 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
620 | </listitem> | 622 | </listitem> |
621 | 623 | ||
622 | <listitem> | 624 | <listitem> |
623 | <para>Install the Enea Edge Management as a service with the | 625 | <para>Install the Enea Edge Management application as a |
624 | name <literal>ucpemanager</literal>.</para> | 626 | service with the name <literal>ucpemanager</literal>.</para> |
625 | </listitem> | 627 | </listitem> |
626 | 628 | ||
627 | <listitem> | 629 | <listitem> |
628 | <para>Start the <literal>ucpemanager</literal> service</para> | 630 | <para>Start the <literal>ucpemanager</literal> service.</para> |
629 | </listitem> | 631 | </listitem> |
630 | </itemizedlist> | 632 | </itemizedlist> |
631 | </listitem> | 633 | </listitem> |
@@ -639,24 +641,24 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
639 | </orderedlist> | 641 | </orderedlist> |
640 | 642 | ||
641 | <note> | 643 | <note> |
642 | <para>The IPv4 address of the CentOS 7 Server, connected to the same | 644 | <para>The IPv4 address of the CentOS 7 Server will be used as a configuration |
643 | network as the uCPE Devices, will be used as a configuration | ||
644 | parameter when setting up the uCPE devices.</para> | 645 | parameter when setting up the uCPE devices.</para> |
645 | 646 | ||
646 | <para>If the CentOS 7 Server is installed behind NAT, the IPv4 | 647 | <para>If the CentOS 7 Server is installed behind NAT, the IPv4 |
647 | address used will be the public IP of the NAT device and port | 648 | address used will be the public IP of the NAT device and port |
648 | forwarding rules must be created to ensure the uCPE device can | 649 | forwarding rules must be created to ensure the uCPE device can |
649 | access the Enea Edge Management. For more details, please see <link | 650 | access the Enea Edge Management application. For more details, |
650 | linkend="firewall_config">Firewall Configuration</link>.</para> | 651 | please see <link linkend="firewall_config">Firewall |
652 | Configuration</link>.</para> | ||
651 | </note> | 653 | </note> |
652 | </section> | 654 | </section> |
653 | 655 | ||
654 | <section id="install_ucpemg_from_backup"> | 656 | <section id="install_ucpemg_from_backup"> |
655 | <title>Installation of the Enea Edge Management using a System | 657 | <title>Installation of the Enea Edge Management application using a |
656 | Back-up</title> | 658 | System Back-up</title> |
657 | 659 | ||
658 | <para>The Enea Edge Management can be restored if a backup file has | 660 | <para>The Enea Edge Management application can be restored if a backup |
659 | been previously created.</para> | 661 | file has been previously created.</para> |
660 | 662 | ||
661 | <para>A backup file can be created by accessing the <emphasis | 663 | <para>A backup file can be created by accessing the <emphasis |
662 | role="bold">System</emphasis> menu, and clicking <emphasis | 664 | role="bold">System</emphasis> menu, and clicking <emphasis |
@@ -672,21 +674,21 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
672 | <note> | 674 | <note> |
673 | <para>The System Back-up file obtained from the Enea Edge Management | 675 | <para>The System Back-up file obtained from the Enea Edge Management |
674 | GUI (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is | 676 | GUI (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is |
675 | different from the snapshot obtained during a Enea Edge Management | 677 | different from the snapshot obtained during an Enea Edge Management |
676 | Upgrade or Uninstall operation | 678 | Upgrade or Uninstall operation |
677 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) needed | 679 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) needed |
678 | for recovery of the Enea Edge Management. For more details, see | 680 | for recovery of the Enea Edge Management application. For more |
679 | <olink targetdoc="book_enea_nfv_access_getting_started" | 681 | details, see <olink targetdoc="book_enea_edge_getting_started" |
680 | targetptr="restore_prev_ucpe_install">Restoring a previous Enea Edge | 682 | targetptr="restore_prev_ucpe_install">Restoring a previous Enea Edge |
681 | Management installation in the <xi:include | 683 | Management installation in the <xi:include |
682 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 684 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
683 | xmlns:xi="http://www.w3.org/2001/XInclude" | 685 | xmlns:xi="http://www.w3.org/2001/XInclude" |
684 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 686 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
685 | Manual.</para> | 687 | Manual.</para> |
686 | </note> | 688 | </note> |
687 | 689 | ||
688 | <para>To install the Enea Edge Management with the restore option | 690 | <para>To install the Enea Edge Management application with the restore |
689 | provide an additional argument as shown below during | 691 | option provide an additional argument as shown below during |
690 | installation:</para> | 692 | installation:</para> |
691 | 693 | ||
692 | <programlisting>./install.sh \ | 694 | <programlisting>./install.sh \ |
@@ -708,8 +710,7 @@ SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> | |||
708 | 710 | ||
709 | <note> | 711 | <note> |
710 | <para>The <filename>.hddimg</filename> image is available in the | 712 | <para>The <filename>.hddimg</filename> image is available in the |
711 | <filename>Enea_Edge_Runtime_Platform_ | 713 | <filename>Enea_Edge_Runtime_<processor>_<version>-build<build_number>.tar.gz</filename> |
712 | <processor>_<version>-build<build_number>.tar.gz</filename> | ||
713 | file you downloaded with your release.</para> | 714 | file you downloaded with your release.</para> |
714 | </note> | 715 | </note> |
715 | 716 | ||
@@ -719,7 +720,7 @@ SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> | |||
719 | <orderedlist> | 720 | <orderedlist> |
720 | <listitem> | 721 | <listitem> |
721 | <para>Copy the <filename>.hddimg</filename> image file provided by | 722 | <para>Copy the <filename>.hddimg</filename> image file provided by |
722 | Enea, into the CentOS 7 server.</para> | 723 | Enea, onto the CentOS 7 server.</para> |
723 | </listitem> | 724 | </listitem> |
724 | 725 | ||
725 | <listitem> | 726 | <listitem> |
@@ -740,10 +741,9 @@ sdb 8:0 0 111.8G 0 disk | |||
740 | <programlisting>sudo dd if=./enea-nfv-access-<machine>.hddimg \ | 741 | <programlisting>sudo dd if=./enea-nfv-access-<machine>.hddimg \ |
741 | of=/dev/sdb bs=4M conv=fsync</programlisting> | 742 | of=/dev/sdb bs=4M conv=fsync</programlisting> |
742 | 743 | ||
743 | <para>Where | 744 | <para>Where <filename>enea-nfv-access-<machine>.hddimg</filename> is |
744 | <filename>enea-nfv-access-<machine>.hddimg</filename> is the | 745 | the <filename>.hddimg</filename> file and <literal>sdb</literal> is |
745 | <filename>.hddimg</filename> file and <literal>sdb</literal> is the | 746 | the assigned USB device name.</para> |
746 | assigned USB device name.</para> | ||
747 | </listitem> | 747 | </listitem> |
748 | </orderedlist> | 748 | </orderedlist> |
749 | </section> | 749 | </section> |
@@ -790,8 +790,9 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
790 | 790 | ||
791 | <listitem> | 791 | <listitem> |
792 | <para>On the <emphasis role="bold">Requirements</emphasis> page of | 792 | <para>On the <emphasis role="bold">Requirements</emphasis> page of |
793 | the Web-installer, the user must confirm the current state of | 793 | the Web-installer, the user must confirm the the current state of |
794 | installation prerequisites is inline with the desired state:</para> | 794 | the installation prerequisites is inline with the desired |
795 | state:</para> | ||
795 | 796 | ||
796 | <itemizedlist> | 797 | <itemizedlist> |
797 | <listitem> | 798 | <listitem> |
@@ -833,12 +834,12 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
833 | does not support IOMMU Group separation, there are certain | 834 | does not support IOMMU Group separation, there are certain |
834 | limitations regarding how the <literal>vfio-pci</literal> | 835 | limitations regarding how the <literal>vfio-pci</literal> |
835 | driver can be used. For more details, see the <olink | 836 | driver can be used. For more details, see the <olink |
836 | targetdoc="book_enea_nfv_access_release_info" | 837 | targetdoc="book_enea_edge_release_info" |
837 | targetptr="bugs-limitations">Known Issues and Limitations in | 838 | targetptr="bugs-limitations">Known Issues and Limitations in |
838 | this Release in the <xi:include | 839 | this Release in the <xi:include |
839 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 840 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
840 | xmlns:xi="http://www.w3.org/2001/XInclude" | 841 | xmlns:xi="http://www.w3.org/2001/XInclude" |
841 | xpointer="element(book_enea_nfv_access_release_info/1)" /></olink> | 842 | xpointer="element(book_enea_edge_release_info/1)" /></olink> |
842 | Manual.</para> | 843 | Manual.</para> |
843 | </listitem> | 844 | </listitem> |
844 | </itemizedlist> | 845 | </itemizedlist> |
@@ -860,8 +861,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
860 | 861 | ||
861 | <itemizedlist> | 862 | <itemizedlist> |
862 | <listitem> | 863 | <listitem> |
863 | <para>The static Enea Edge Management IP Address or FQDN. This can be | 864 | <para>The static Enea Edge Management IP Address or FQDN. This |
864 | either:</para> | 865 | can be either:</para> |
865 | 866 | ||
866 | <itemizedlist spacing="compact"> | 867 | <itemizedlist spacing="compact"> |
867 | <listitem> | 868 | <listitem> |
@@ -878,23 +879,23 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
878 | 879 | ||
879 | <listitem> | 880 | <listitem> |
880 | <para>The Fully Qualified Domain Name (FQDN) of the Enea | 881 | <para>The Fully Qualified Domain Name (FQDN) of the Enea |
881 | uCPE Manager host machine.</para> | 882 | Edge Management host machine.</para> |
882 | </listitem> | 883 | </listitem> |
883 | </itemizedlist> | 884 | </itemizedlist> |
884 | </listitem> | 885 | </listitem> |
885 | 886 | ||
886 | <listitem> | 887 | <listitem> |
887 | <para>The unique identifier of the uCPE device (called | 888 | <para>The unique identifier of the uCPE device (called |
888 | "DeviceId" in this guide).</para> | 889 | "DeviceId" in this Manual).</para> |
889 | </listitem> | 890 | </listitem> |
890 | 891 | ||
891 | <listitem> | 892 | <listitem> |
892 | <para>Customer Tags. They are used for Zero Touch Provisioning | 893 | <para>Customer Tags. They are used for Zero Touch Provisioning |
893 | (ZTP) and can be left empty for a base configuration. What can | 894 | (ZTP) and can be left empty for a base configuration. What can |
894 | be entered here (if needed), are the tag(s) specified when | 895 | be entered here (if needed), are the tag(s) specified when |
895 | creating an offline configuration in the Enea Edge Management. A | 896 | creating an offline configuration in the Enea Edge Management |
896 | later addition of customer tags can only be done by reinstalling | 897 | application. A later addition of customer tags can only be done |
897 | the uCPE devices.</para> | 898 | by reinstalling the uCPE devices.</para> |
898 | </listitem> | 899 | </listitem> |
899 | </itemizedlist> | 900 | </itemizedlist> |
900 | </listitem> | 901 | </listitem> |
@@ -912,8 +913,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
912 | <itemizedlist> | 913 | <itemizedlist> |
913 | <listitem> | 914 | <listitem> |
914 | <para>Select a WAN interface to use as the management network | 915 | <para>Select a WAN interface to use as the management network |
915 | interface. This interface is used by the Enea Edge Management to | 916 | interface. This interface is used by the Enea Edge Management |
916 | communicate with the uCPE device.</para> | 917 | application to communicate with the uCPE device.</para> |
917 | </listitem> | 918 | </listitem> |
918 | 919 | ||
919 | <listitem> | 920 | <listitem> |
@@ -928,14 +929,14 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
928 | Web-installer, Enea Edge Runtime is installed on the hard drive. At this | 929 | Web-installer, Enea Edge Runtime is installed on the hard drive. At this |
929 | stage, the user should remove the USB stick and the LAN cable, and | 930 | stage, the user should remove the USB stick and the LAN cable, and |
930 | shutdown the uCPE device. It will be started after necessary | 931 | shutdown the uCPE device. It will be started after necessary |
931 | configurations are done in the Enea Edge Management, as described | 932 | configurations are done in the Enea Edge Management application, as |
932 | below.</para> | 933 | described below.</para> |
933 | 934 | ||
934 | <note> | 935 | <note> |
935 | <para>If errors are detected during installation, full logs will be | 936 | <para>If errors are detected during installation, full logs will be |
936 | available on the last page of the Web-installer. Please contact Enea | 937 | available on the last page of the Web-installer. Please contact Enea |
937 | for log analysis. The system is not expected to be usable if errors are | 938 | for log analysis. The system is not expected to be usable if errors |
938 | reported during installation.</para> | 939 | are reported during installation.</para> |
939 | 940 | ||
940 | <para>If the USB stick was booted in UEFI mode, a UEFI boot entry is | 941 | <para>If the USB stick was booted in UEFI mode, a UEFI boot entry is |
941 | automatically created and the system will start booting from the hard | 942 | automatically created and the system will start booting from the hard |
@@ -962,12 +963,12 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
962 | <itemizedlist> | 963 | <itemizedlist> |
963 | <listitem> | 964 | <listitem> |
964 | <para>Network connection between the server running the Enea Edge | 965 | <para>Network connection between the server running the Enea Edge |
965 | Management and the laptop.</para> | 966 | Management application and the laptop.</para> |
966 | </listitem> | 967 | </listitem> |
967 | 968 | ||
968 | <listitem> | 969 | <listitem> |
969 | <para>Network connection between the server running the Enea Edge | 970 | <para>Network connection between the server running the Enea Edge |
970 | Management and the uCPE device.</para> | 971 | Management application and the uCPE device.</para> |
971 | </listitem> | 972 | </listitem> |
972 | </itemizedlist> | 973 | </itemizedlist> |
973 | </section> | 974 | </section> |
@@ -977,15 +978,15 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
977 | <title>Management of uCPE Devices</title> | 978 | <title>Management of uCPE Devices</title> |
978 | 979 | ||
979 | <para>When the installation is complete the uCPE device can be managed in | 980 | <para>When the installation is complete the uCPE device can be managed in |
980 | the Enea Edge Management.</para> | 981 | the Enea Edge Management application.</para> |
981 | 982 | ||
982 | <section id="add_offline_config"> | 983 | <section id="add_offline_config"> |
983 | <title>Add a default Offline Configuration</title> | 984 | <title>Add a default Offline Configuration</title> |
984 | 985 | ||
985 | <para>Zero Touch Provisioning is always turned on when a uCPE device | 986 | <para>Zero Touch Provisioning is always turned on when a uCPE device |
986 | connects to the Enea Edge Management. To enable it in the Enea Edge | 987 | connects to the Enea Edge Management application. To enable it in the |
987 | Management, an offline configuration needs to be registered for Day-0 | 988 | Enea Edge Management application, an offline configuration needs to be |
988 | configuration.</para> | 989 | registered for Day-0 configuration.</para> |
989 | 990 | ||
990 | <note> | 991 | <note> |
991 | <para>Day-0 configuration is a software lifecycle term referring to | 992 | <para>Day-0 configuration is a software lifecycle term referring to |
@@ -998,10 +999,10 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
998 | 999 | ||
999 | <para>The offline configuration consists of data and parameters that are | 1000 | <para>The offline configuration consists of data and parameters that are |
1000 | meant to be automatically set when a uCPE device connects to the Enea | 1001 | meant to be automatically set when a uCPE device connects to the Enea |
1001 | Edge Management for the first time. The configuration is typically | 1002 | Edge Management application for the first time. The configuration is |
1002 | focused on setting up the network management of the uCPE device, e.g. | 1003 | typically focused on setting up the network management of the uCPE |
1003 | configuring network interfaces, WAN and LAN networking and service | 1004 | device, e.g. configuring network interfaces, WAN and LAN networking and |
1004 | chains.</para> | 1005 | service chains.</para> |
1005 | 1006 | ||
1006 | <para>For this base configuration, the offline configuration will be | 1007 | <para>For this base configuration, the offline configuration will be |
1007 | left blank. The blank offline configuration can be filled with | 1008 | left blank. The blank offline configuration can be filled with |
@@ -1011,33 +1012,35 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1011 | <note> | 1012 | <note> |
1012 | <para>If the offline configuration is not configured, an alarm will be | 1013 | <para>If the offline configuration is not configured, an alarm will be |
1013 | raised: <literal>Day-0 Config:ZTP:Major</literal> when the uCPE device | 1014 | raised: <literal>Day-0 Config:ZTP:Major</literal> when the uCPE device |
1014 | tries to connect to the Enea Edge Management, informing the user that | 1015 | tries to connect to the Enea Edge Management application, informing |
1015 | the ZTP setup failed for the uCPE device.</para> | 1016 | the user that the ZTP setup failed for the uCPE device.</para> |
1016 | </note> | 1017 | </note> |
1017 | 1018 | ||
1018 | <para><emphasis role="bold">To create an offline | 1019 | <para><emphasis role="bold">Creating an offline |
1019 | configuration</emphasis><orderedlist> | 1020 | configuration</emphasis></para> |
1020 | <listitem> | ||
1021 | <para>In a browser access the Enea Edge Management, open <emphasis | ||
1022 | role="bold">Applications</emphasis> and select <emphasis | ||
1023 | role="bold">Offline Config</emphasis>.</para> | ||
1024 | </listitem> | ||
1025 | 1021 | ||
1026 | <listitem> | 1022 | <orderedlist> |
1027 | <para>Create a new offline configuration in the GUI by selecting | 1023 | <listitem> |
1028 | the <emphasis role="bold">Add</emphasis> button and filling in the | 1024 | <para>In a browser, access the Enea Edge Management application, |
1029 | mandatory fields: <literal>name</literal>, | 1025 | open <emphasis role="bold">Applications</emphasis> and select |
1030 | <literal>deviceVersion</literal> and | 1026 | <emphasis role="bold">Offline Config</emphasis>.</para> |
1031 | <literal>deviceId</literal>.</para> | 1027 | </listitem> |
1032 | 1028 | ||
1033 | <para>The name is user defined and can be set to any unique text | 1029 | <listitem> |
1034 | string identifying the configuration. The | 1030 | <para>Create a new offline configuration in the GUI by selecting the |
1035 | <literal>deviceVersion</literal> must match the Enea Edge Runtime | 1031 | <emphasis role="bold">Add</emphasis> button and filling in the |
1036 | version of the uCPE device and the <literal>deviceId</literal> | 1032 | mandatory fields: <literal>name</literal>, |
1037 | must be the previously set identifier of the uCPE device | 1033 | <literal>deviceVersion</literal> and |
1038 | (DeviceId).</para> | 1034 | <literal>deviceId</literal>.</para> |
1039 | </listitem> | 1035 | |
1040 | </orderedlist></para> | 1036 | <para>The name is user defined and can be set to any unique text |
1037 | string identifying the configuration. The | ||
1038 | <literal>deviceVersion</literal> must match the Enea Edge Runtime | ||
1039 | version of the uCPE device and the <literal>deviceId</literal> must | ||
1040 | be the previously set identifier of the uCPE device | ||
1041 | (DeviceId).</para> | ||
1042 | </listitem> | ||
1043 | </orderedlist> | ||
1041 | </section> | 1044 | </section> |
1042 | 1045 | ||
1043 | <section id="add_ucpe_mg"> | 1046 | <section id="add_ucpe_mg"> |
@@ -1045,10 +1048,10 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1045 | 1048 | ||
1046 | <para>In order to enroll a uCPE device in the management system and | 1049 | <para>In order to enroll a uCPE device in the management system and |
1047 | establish a management connection, the user will add uCPE device | 1050 | establish a management connection, the user will add uCPE device |
1048 | information in the Enea Edge Management. This is accomplished by going | 1051 | information in the Enea Edge Management application. This is |
1049 | to <emphasis role="bold">Devices</emphasis>, selecting <emphasis | 1052 | accomplished by going to <emphasis role="bold">Devices</emphasis>, |
1050 | role="bold">Manage</emphasis> and then clicking the <emphasis | 1053 | selecting <emphasis role="bold">Manage</emphasis> and then clicking the |
1051 | role="bold">Add</emphasis> button.</para> | 1054 | <emphasis role="bold">Add</emphasis> button.</para> |
1052 | 1055 | ||
1053 | <para>The relevant parameters are:</para> | 1056 | <para>The relevant parameters are:</para> |
1054 | 1057 | ||
@@ -1060,7 +1063,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1060 | 1063 | ||
1061 | <listitem> | 1064 | <listitem> |
1062 | <para><emphasis role="bold">Name.</emphasis> The name by which the | 1065 | <para><emphasis role="bold">Name.</emphasis> The name by which the |
1063 | uCPE device is referred to in the Enea Edge Management. | 1066 | uCPE device is referred to in the Enea Edge Management application. |
1064 | (Mandatory).</para> | 1067 | (Mandatory).</para> |
1065 | </listitem> | 1068 | </listitem> |
1066 | 1069 | ||
@@ -1092,22 +1095,22 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1092 | </itemizedlist> | 1095 | </itemizedlist> |
1093 | 1096 | ||
1094 | <para>For more details concerning Device Calls Home, please see <olink | 1097 | <para>For more details concerning Device Calls Home, please see <olink |
1095 | targetdoc="book_enea_nfv_access_getting_started" | 1098 | targetdoc="book_enea_edge_getting_started" |
1096 | targetptr="device_callhome_nat">Device Call Home Connection for | 1099 | targetptr="device_callhome_nat">Device Call Home Connection for |
1097 | Deployment behind NAT in the <xi:include | 1100 | Deployment behind NAT in the <xi:include |
1098 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 1101 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
1099 | xmlns:xi="http://www.w3.org/2001/XInclude" | 1102 | xmlns:xi="http://www.w3.org/2001/XInclude" |
1100 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 1103 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
1101 | Manual.</para> | 1104 | Manual.</para> |
1102 | </section> | 1105 | </section> |
1103 | 1106 | ||
1104 | <section id="boot_device_add_map"> | 1107 | <section id="boot_device_add_map"> |
1105 | <title>Booting the uCPE device and adding it to the Map</title> | 1108 | <title>Booting the uCPE device and adding it to the Map</title> |
1106 | 1109 | ||
1107 | <para>When connectivity is established with the Enea Edge Management and | 1110 | <para>When connectivity is established with the Enea Edge Management |
1108 | a uCPE device is already registered with a matching <literal>Device | 1111 | application and a uCPE device is already registered with a matching |
1109 | ID</literal>, the installation is complete, and the connection is | 1112 | <literal>Device ID</literal>, the installation is complete, and the |
1110 | established.</para> | 1113 | connection is established.</para> |
1111 | 1114 | ||
1112 | <para>When a uCPE device is registered it can be manually added to the | 1115 | <para>When a uCPE device is registered it can be manually added to the |
1113 | map for overview. <emphasis role="bold">Right-click</emphasis> on the | 1116 | map for overview. <emphasis role="bold">Right-click</emphasis> on the |
@@ -1116,17 +1119,16 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1116 | 1119 | ||
1117 | <para>In case of management connection failure (e.g. due to a | 1120 | <para>In case of management connection failure (e.g. due to a |
1118 | misconfiguration), the uCPE device status will be seen as RED | 1121 | misconfiguration), the uCPE device status will be seen as RED |
1119 | (disconnected) in the Enea Edge Management. The uCPE device | 1122 | (disconnected) in the Enea Edge Management application. The uCPE device |
1120 | configuration can be corrected by removing the WAN cable(s), | 1123 | configuration can be corrected by removing the WAN cable(s), |
1121 | reconnecting the laptop to the LAN interface of the uCPE device and | 1124 | reconnecting the laptop to the LAN interface of the uCPE device and |
1122 | rebooting it. At this point, the Web-installer can be accessed from the | 1125 | rebooting it. At this point, the Web-installer can be accessed from the |
1123 | laptop as described in <olink | 1126 | laptop as described in <olink targetdoc="book_enea_edge_getting_started" |
1124 | targetdoc="book_enea_nfv_access_getting_started" | ||
1125 | targetptr="install_ena_device">Installing Enea Edge - uCPE Device | 1127 | targetptr="install_ena_device">Installing Enea Edge - uCPE Device |
1126 | installation in the <xi:include | 1128 | installation in the <xi:include |
1127 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 1129 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
1128 | xmlns:xi="http://www.w3.org/2001/XInclude" | 1130 | xmlns:xi="http://www.w3.org/2001/XInclude" |
1129 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 1131 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
1130 | Manual.</para> | 1132 | Manual.</para> |
1131 | </section> | 1133 | </section> |
1132 | </section> | 1134 | </section> |
@@ -1134,17 +1136,17 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1134 | <section id="ucpe_monitor"> | 1136 | <section id="ucpe_monitor"> |
1135 | <title>uCPE Device Monitorization and Control</title> | 1137 | <title>uCPE Device Monitorization and Control</title> |
1136 | 1138 | ||
1137 | <para>Once the uCPE device is connected to the Enea Edge Management | 1139 | <para>Once the uCPE device is connected to the Enea Edge Management |
1138 | application, it is ready for central management. Two important functions | 1140 | application, it is ready for central management. Two important functions |
1139 | available in the Enea uCPE Management GUI are alarm checking and resource | 1141 | available in the Enea Edge Management GUI are alarm checking and resource |
1140 | allocation. Additionally, the device can be rebooted, the factory settings | 1142 | allocation. Additionally, the device can be rebooted, the factory settings |
1141 | can be restored or simply the vCPE service can be restarted.</para> | 1143 | can be restored or simply the vCPE service can be restarted.</para> |
1142 | 1144 | ||
1143 | <section id="check_alarms"> | 1145 | <section id="check_alarms"> |
1144 | <title>Checking Alarms</title> | 1146 | <title>Checking Alarms</title> |
1145 | 1147 | ||
1146 | <para>The Enea Edge Management dashboard presents alarms in a specific | 1148 | <para>The Enea Edge Management application dashboard presents alarms in |
1147 | window on the front page.</para> | 1149 | a specific window on the front page.</para> |
1148 | 1150 | ||
1149 | <para>An alarm can be easily triggered by disconnecting and reconnecting | 1151 | <para>An alarm can be easily triggered by disconnecting and reconnecting |
1150 | the WAN ethernet cable from the uCPE device. The management system will | 1152 | the WAN ethernet cable from the uCPE device. The management system will |
@@ -1152,15 +1154,16 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1152 | Disconnected::Critical</literal>.</para> | 1154 | Disconnected::Critical</literal>.</para> |
1153 | 1155 | ||
1154 | <para>A separate Alarm Management window can be accessed from the Enea | 1156 | <para>A separate Alarm Management window can be accessed from the Enea |
1155 | Edge Management menu for in-depth access and programming of Alarms and | 1157 | Edge Management menu for in-depth access and programming of <emphasis |
1156 | Events.</para> | 1158 | role="bold">Alarms and Events</emphasis>.</para> |
1157 | </section> | 1159 | </section> |
1158 | 1160 | ||
1159 | <section id="ck_resource_alloc"> | 1161 | <section id="ck_resource_alloc"> |
1160 | <title>Checking uCPE device Resource Allocation</title> | 1162 | <title>Checking uCPE device Resource Allocation</title> |
1161 | 1163 | ||
1162 | <para>When the uCPE device is connected to the Enea Edge Management it | 1164 | <para>When the uCPE device is connected to the Enea Edge Management |
1163 | is of interest to check the amount of hardware resources in use.</para> | 1165 | application it is of interest to check the amount of hardware resources |
1166 | in use.</para> | ||
1164 | 1167 | ||
1165 | <para>To check CPU, RAM and disk utilization simply select the uCPE | 1168 | <para>To check CPU, RAM and disk utilization simply select the uCPE |
1166 | device and go to the <emphasis role="bold">Virtual Machines</emphasis> | 1169 | device and go to the <emphasis role="bold">Virtual Machines</emphasis> |
@@ -1171,23 +1174,26 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1171 | <section id="basic_oper_device"> | 1174 | <section id="basic_oper_device"> |
1172 | <title>Basic operations for uCPE device Managememt</title> | 1175 | <title>Basic operations for uCPE device Managememt</title> |
1173 | 1176 | ||
1174 | <para>When the uCPE device is connected to the Enea Edge Management application, it can | 1177 | <para>When the uCPE device is connected to the Enea Edge Management |
1175 | be rebooted, the factory settings can be restored or simply the vCPE | 1178 | application, it can be rebooted, the factory settings can be restored or |
1176 | service can be restarted.</para> | 1179 | simply the vCPE service can be restarted.</para> |
1177 | 1180 | ||
1178 | <para>Select the uCPE device and go to the <emphasis | 1181 | <para>Select the uCPE device and go to the <emphasis |
1179 | role="bold">Operations</emphasis> menu, where the following options are available:</para> | 1182 | role="bold">Operations</emphasis> menu, where the following options are |
1183 | available:</para> | ||
1180 | 1184 | ||
1181 | <itemizedlist> | 1185 | <itemizedlist> |
1182 | <listitem> | 1186 | <listitem> |
1183 | <para><emphasis role="bold">Reboot</emphasis>. Reboots the device. Settings will be preserved.</para> | 1187 | <para><emphasis role="bold">Reboot</emphasis>. Reboots the device. |
1188 | Settings will be preserved.</para> | ||
1184 | </listitem> | 1189 | </listitem> |
1185 | 1190 | ||
1186 | <listitem> | 1191 | <listitem> |
1187 | <para><emphasis role="bold">Factory reset</emphasis>. Resets the device to its | 1192 | <para><emphasis role="bold">Factory reset</emphasis>. Resets the |
1188 | default factory settings. All current configuration settings are lost. All | 1193 | device to its default factory settings. All current configuration |
1189 | running VNFs are destroyed. Any installed custom scripts will be removed and | 1194 | settings are lost. All running VNFs are destroyed. Any installed |
1190 | they will need to be reinstalled.</para> | 1195 | custom scripts will be removed and they will need to be |
1196 | reinstalled.</para> | ||
1191 | 1197 | ||
1192 | <para>Only the vCPE service will be restarted, the device will not | 1198 | <para>Only the vCPE service will be restarted, the device will not |
1193 | be rebooted. No reboot is needed.</para> | 1199 | be rebooted. No reboot is needed.</para> |
@@ -1220,14 +1226,14 @@ of=/dev/sdb bs=4M conv=fsync</programlisting> | |||
1220 | <note> | 1226 | <note> |
1221 | <para>In case the uCPE device was installed behind a NAT device, the | 1227 | <para>In case the uCPE device was installed behind a NAT device, the |
1222 | reverse SSH connection will be used. For more details, please see | 1228 | reverse SSH connection will be used. For more details, please see |
1223 | <olink targetdoc="book_enea_nfv_access_getting_started" | 1229 | <olink targetdoc="book_enea_edge_getting_started" |
1224 | targetptr="device_callhome_nat">Device Call Home Connection for | 1230 | targetptr="device_callhome_nat">Device Call Home Connection for |
1225 | deployment behind NAT in the <xi:include | 1231 | deployment behind NAT in the <xi:include |
1226 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 1232 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
1227 | xmlns:xi="http://www.w3.org/2001/XInclude" | 1233 | xmlns:xi="http://www.w3.org/2001/XInclude" |
1228 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 1234 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
1229 | Manual.</para> | 1235 | Manual.</para> |
1230 | </note> | 1236 | </note> |
1231 | </section> | 1237 | </section> |
1232 | </section> | 1238 | </section> |
1233 | </chapter> | 1239 | </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 5786883..eaa5521 100644 --- a/doc/book-enea-edge-getting-started/doc/introduction.xml +++ b/doc/book-enea-edge-getting-started/doc/introduction.xml | |||
@@ -1,16 +1,16 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 2 | <!DOCTYPE chapter 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 | <chapter id="intro_ucpe"> | 4 | <chapter id="intro_ucpe"> |
5 | <title>Overview</title> | 5 | <title>Overview</title> |
6 | 6 | ||
7 | <para>This document describes the Enea Edge and provides installation | 7 | <para>This document describes Enea Edge and provides installation steps for |
8 | steps for deploying a base configuration in order to create:</para> | 8 | deploying a base configuration in order to create:</para> |
9 | 9 | ||
10 | <itemizedlist> | 10 | <itemizedlist> |
11 | <listitem> | 11 | <listitem> |
12 | <para>A functional Enea Edge Management installation ready to manage uCPE | 12 | <para>A functional Enea Edge Management installation ready to manage |
13 | devices.</para> | 13 | uCPE devices.</para> |
14 | </listitem> | 14 | </listitem> |
15 | 15 | ||
16 | <listitem> | 16 | <listitem> |
@@ -32,44 +32,42 @@ | |||
32 | 32 | ||
33 | <itemizedlist> | 33 | <itemizedlist> |
34 | <listitem> | 34 | <listitem> |
35 | <para>The Enea Edge Runtime, which acts as the host | 35 | <para>Enea Edge Runtime, which acts as the host for Virtualized |
36 | for Virtualized Network Functions (VNFs) and provides management over | 36 | Network Functions (VNFs) and provides management over NETCONF.</para> |
37 | NETCONF.</para> | ||
38 | </listitem> | 37 | </listitem> |
39 | 38 | ||
40 | <listitem> | 39 | <listitem> |
41 | <para>The Enea Edge Management, a solution that runs on an external | 40 | <para>Enea Edge Management, an application that runs on an external |
42 | server, used for VNF Management and managing large numbers of uCPE | 41 | server, used for VNF Management and managing large numbers of uCPE |
43 | devices.</para> | 42 | devices.</para> |
44 | </listitem> | 43 | </listitem> |
45 | </itemizedlist> | 44 | </itemizedlist> |
46 | 45 | ||
47 | 46 | <para>In addition, Enea Edge includes a framework for automation and | |
48 | <para>In addition, Enea Edge includes a framework for | 47 | testing. More information can be found in the <xi:include |
49 | automation and testing. More information can be found in | 48 | href="../../s_docbuild/olinkdb/pardoc-common.xml" |
50 | <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
51 | xmlns:xi="http://www.w3.org/2001/XInclude" | 49 | xmlns:xi="http://www.w3.org/2001/XInclude" |
52 | xpointer="element(book_enea_nfv_access_auto_fw_user_guide/1)" />.</para> | 50 | xpointer="element(book_enea_edge_automation_user_guide/1)" />.</para> |
53 | 51 | ||
54 | <para>Details concerning release content, including documentation | 52 | <para>Details concerning release content, including documentation |
55 | structure, are provided in the <xi:include | 53 | structure, are provided in the <xi:include |
56 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | 54 | href="../../s_docbuild/olinkdb/pardoc-common.xml" |
57 | xmlns:xi="http://www.w3.org/2001/XInclude" | 55 | xmlns:xi="http://www.w3.org/2001/XInclude" |
58 | xpointer="element(book_enea_nfv_access_release_info/1)" /> Manual included | 56 | xpointer="element(book_enea_edge_release_info/1)" /> Manual included |
59 | with your release.</para> | 57 | with your release.</para> |
60 | 58 | ||
61 | <section id="nfv_access"> | 59 | <section id="nfv_access"> |
62 | <title>Enea Edge Runtime</title> | 60 | <title>Enea Edge Runtime</title> |
63 | 61 | ||
64 | <para>Enea Edge Runtime is a lightweight, | 62 | <para>Enea Edge Runtime is a lightweight, multi-architecture |
65 | multi-architecture virtualization platform built on de-facto standards | 63 | virtualization platform built on de-facto standards in an SDN/NFV |
66 | in an SDN/NFV ecosystem. It is designed for a high networking | 64 | ecosystem. It is designed for a high networking performance with minimal |
67 | performance with minimal hardware footprint, by only providing relevant | 65 | hardware footprint, by only providing relevant functionalties and |
68 | functionalties and technologies.</para> | 66 | technologies.</para> |
69 | 67 | ||
70 | <para>Virtualization methods include Virtual Machines (KVM / QEMU) and | 68 | <para>Virtualization methods include Virtual Machines (KVM / QEMU) and |
71 | container(s) (Docker). High networking throughput and low latency are | 69 | container(s) (Docker). High networking throughput and low latency are |
72 | ensured by accelerated data plane relying on technologies like DPDK, | 70 | ensured by an accelerated data plane relying on technologies like DPDK, |
73 | OVS-DPDK and SR-IOV/PCI-Passthrough. Key functionalities, such as | 71 | OVS-DPDK and SR-IOV/PCI-Passthrough. Key functionalities, such as |
74 | platform software management, virtualized networking, VNFs life-cycle | 72 | platform software management, virtualized networking, VNFs life-cycle |
75 | management and FCAPS are provided through the YANG-modelled NETCONF | 73 | management and FCAPS are provided through the YANG-modelled NETCONF |
@@ -90,13 +88,14 @@ | |||
90 | <section id="ucpe_manager"> | 88 | <section id="ucpe_manager"> |
91 | <title>Enea Edge Management</title> | 89 | <title>Enea Edge Management</title> |
92 | 90 | ||
93 | <para>The Enea Edge Management is centralized control system providing | 91 | <para>The Enea Edge Management application is a centralized control system providing |
94 | uCPEs domain management capabilities through a GUI and REST API. It can | 92 | domain management capabilities to uCPEs through a GUI and REST API. It can |
95 | be deployed on a host or a virtual machine running 64-bit CentOS 7 on an | 93 | be deployed on a host or a virtual machine running 64-bit CentOS 7 on an |
96 | x86 platform. The Enea Edge Management uses a southbound NETCONF protocol | 94 | x86 platform. The Enea Edge Management application uses a southbound NETCONF |
97 | to connect and manage uCPE devices.</para> | 95 | protocol to connect and manage uCPE devices.</para> |
98 | 96 | ||
99 | <para>The Enea Edge Management provides the following key features:</para> | 97 | <para>The Enea Edge Management application provides the following key |
98 | features:</para> | ||
100 | 99 | ||
101 | <itemizedlist> | 100 | <itemizedlist> |
102 | <listitem> | 101 | <listitem> |
@@ -144,8 +143,8 @@ | |||
144 | <row> | 143 | <row> |
145 | <entry>Enea Edge</entry> | 144 | <entry>Enea Edge</entry> |
146 | 145 | ||
147 | <entry>The Enea Edge Runtime and the Enea Edge | 146 | <entry>The Enea Edge Runtime and Enea Edge |
148 | Management.</entry> | 147 | Management solutions.</entry> |
149 | </row> | 148 | </row> |
150 | 149 | ||
151 | <row> | 150 | <row> |
@@ -158,15 +157,14 @@ | |||
158 | <row> | 157 | <row> |
159 | <entry>Enea Edge Management</entry> | 158 | <entry>Enea Edge Management</entry> |
160 | 159 | ||
161 | <entry>Enea Universal Customer Premises Equipment | 160 | <entry>The Enea Universal Customer Premises Equipment |
162 | Manager.</entry> | 161 | Manager.</entry> |
163 | </row> | 162 | </row> |
164 | 163 | ||
165 | <row> | 164 | <row> |
166 | <entry>uCPE device</entry> | 165 | <entry>uCPE device</entry> |
167 | 166 | ||
168 | <entry>A whitebox running the Enea Edge | 167 | <entry>A whitebox running the Enea Edge Runtime.</entry> |
169 | Runtime.</entry> | ||
170 | </row> | 168 | </row> |
171 | </tbody> | 169 | </tbody> |
172 | </tgroup> | 170 | </tgroup> |
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 baa1340..1148dc2 100644 --- a/doc/book-enea-edge-getting-started/doc/log_collector.xml +++ b/doc/book-enea-edge-getting-started/doc/log_collector.xml | |||
@@ -1,17 +1,17 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="log_collector"> | 2 | <chapter id="log_collector"> |
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 a uCPE device require an analysis of a set |
6 | set of information i.e. logs collected from the uCPE device and/or the Enea | 6 | of data and information i.e. logs collected from the uCPE device and/or the |
7 | Edge Management. The following information describes how the log collection | 7 | Enea Edge Management application. The following information describes how |
8 | mechanism works.</para> | 8 | the log collection mechanism works.</para> |
9 | 9 | ||
10 | <section id="log_collect_ucpem"> | 10 | <section id="log_collect_ucpem"> |
11 | <title>Log collecting using the Enea Edge Management</title> | 11 | <title>Log collecting using the Enea Edge Management application</title> |
12 | 12 | ||
13 | <para>The Enea Edge Management allows for collecting a set of logs and state | 13 | <para>The Enea Edge Management application allows for collecting a set of |
14 | information from a uCPE device.</para> | 14 | logs and state information from a uCPE device.</para> |
15 | 15 | ||
16 | <section id="log_collect"> | 16 | <section id="log_collect"> |
17 | <title>Collecting the Logs</title> | 17 | <title>Collecting the Logs</title> |
@@ -31,7 +31,8 @@ | |||
31 | </listitem> | 31 | </listitem> |
32 | 32 | ||
33 | <listitem> | 33 | <listitem> |
34 | <para>Press the <emphasis role="bold">Execute</emphasis> button.</para> | 34 | <para>Press the <emphasis role="bold">Execute</emphasis> |
35 | button.</para> | ||
35 | 36 | ||
36 | <para>A success message is shown in the same window as shown below. | 37 | <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 | 38 | At this moment, the process of collecting logs on the uCPE device |
@@ -53,9 +54,9 @@ | |||
53 | <note> | 54 | <note> |
54 | <para>It might take some time for the archive to be created. When the | 55 | <para>It might take some time for the archive to be created. When the |
55 | operation completes, a "CollectLogsComplete" notification is sent from | 56 | operation completes, a "CollectLogsComplete" notification is sent from |
56 | the uCPE device to the Enea Edge Management. This can be viewed in the | 57 | the uCPE device to the Enea Edge Management application. This can be |
57 | GUI in the <emphasis role="bold">Faults</emphasis> menu, after selecting | 58 | viewed in the GUI in the <emphasis role="bold">Faults</emphasis> menu, |
58 | <emphasis role="bold">Events</emphasis>.</para> | 59 | after selecting <emphasis role="bold">Events</emphasis>.</para> |
59 | 60 | ||
60 | <figure> | 61 | <figure> |
61 | <title>Collecting Debug Logs</title> | 62 | <title>Collecting Debug Logs</title> |
@@ -74,12 +75,13 @@ | |||
74 | <title>View collected Logs</title> | 75 | <title>View collected Logs</title> |
75 | 76 | ||
76 | <para>A list with the archives containing already collected logs will be | 77 | <para>A list with the archives containing already collected logs will be |
77 | shown in the <emphasis role="bold">Device File Listing</emphasis> table:</para> | 78 | shown in the <emphasis role="bold">Device File Listing</emphasis> |
79 | table:</para> | ||
78 | 80 | ||
79 | <orderedlist> | 81 | <orderedlist> |
80 | <listitem> | 82 | <listitem> |
81 | <para>Access <emphasis role="bold">Files</emphasis> and then the | 83 | <para>Access the <emphasis role="bold">Files</emphasis> menu and |
82 | <emphasis role="bold">Download</emphasis> button.</para> | 84 | select the <emphasis role="bold">Download</emphasis> button.</para> |
83 | </listitem> | 85 | </listitem> |
84 | 86 | ||
85 | <listitem> | 87 | <listitem> |
@@ -100,9 +102,9 @@ | |||
100 | 102 | ||
101 | <note> | 103 | <note> |
102 | <para>If the filename you specified does not appear, it might still be | 104 | <para>If the filename you specified does not appear, it might still be |
103 | in the process of creation. Click on the <emphasis role="bold">Refresh</emphasis> | 105 | in the process of creation. Click on the <emphasis |
104 | icon at the bottom of the table until you can see the desired file | 106 | role="bold">Refresh</emphasis> icon at the bottom of the table until |
105 | listing.</para> | 107 | you can see the desired file listing.</para> |
106 | </note> | 108 | </note> |
107 | </section> | 109 | </section> |
108 | 110 | ||
@@ -110,12 +112,12 @@ | |||
110 | <title>Downloading Logs from the uCPE Device</title> | 112 | <title>Downloading Logs from the uCPE Device</title> |
111 | 113 | ||
112 | <para>This option transfers a debug file archive from the uCPE device to | 114 | <para>This option transfers a debug file archive from the uCPE device to |
113 | Enea Edge Management.</para> | 115 | Enea Edge Management application.</para> |
114 | 116 | ||
115 | <orderedlist> | 117 | <orderedlist> |
116 | <listitem> | 118 | <listitem> |
117 | <para>Access <emphasis role="bold">Files</emphasis> and choose the | 119 | <para>Access the <emphasis role="bold">Files</emphasis> menu and |
118 | <emphasis role="bold">Download</emphasis> button.</para> | 120 | select the <emphasis role="bold">Download</emphasis> button.</para> |
119 | </listitem> | 121 | </listitem> |
120 | 122 | ||
121 | <listitem> | 123 | <listitem> |
@@ -123,17 +125,17 @@ | |||
123 | </listitem> | 125 | </listitem> |
124 | 126 | ||
125 | <listitem> | 127 | <listitem> |
126 | <para>In the <emphasis role="bold">Device File Listing</emphasis> table, select | 128 | <para>In the <emphasis role="bold">Device File Listing</emphasis> |
127 | the archive you want to download from the uCPE device to Enea Edge | 129 | table, select the archive you want to download from the uCPE device |
128 | Management.</para> | 130 | to Enea Edge Management.</para> |
129 | </listitem> | 131 | </listitem> |
130 | 132 | ||
131 | <listitem> | 133 | <listitem> |
132 | <para>Press the <emphasis role="bold">Download from Device</emphasis> | 134 | <para>Press the <emphasis role="bold">Download from |
133 | button.</para> | 135 | Device</emphasis> button.</para> |
134 | 136 | ||
135 | <para>The archive will be downloaded from the uCPE device and stored | 137 | <para>The archive will be downloaded from the uCPE device and stored |
136 | on the Enea Edge Management.</para> | 138 | on the Enea Edge Management application.</para> |
137 | </listitem> | 139 | </listitem> |
138 | </orderedlist> | 140 | </orderedlist> |
139 | 141 | ||
@@ -146,30 +148,33 @@ | |||
146 | <section id="download_logs_locally"> | 148 | <section id="download_logs_locally"> |
147 | <title>Downloading collected Logs locally</title> | 149 | <title>Downloading collected Logs locally</title> |
148 | 150 | ||
149 | <para>This option downloads a logs archive from the Enea Edge Management to | 151 | <para>This option downloads a logs archive from the Enea Edge Management |
150 | a local (user) machine for analysis. The archive must first be available | 152 | application to a local (user) machine for analysis. The archive must |
151 | in the Enea Edge Management in order to be downloaded.</para> | 153 | first be available in the Enea Edge Management application in order to |
154 | be downloaded.</para> | ||
152 | 155 | ||
153 | <orderedlist> | 156 | <orderedlist> |
154 | <listitem> | 157 | <listitem> |
155 | <para>Access the <emphasis role="bold">Devices</emphasis> menu and select | 158 | <para>Access the <emphasis role="bold">Devices</emphasis> menu and |
156 | <emphasis role="bold">Files</emphasis>.</para> | 159 | select <emphasis role="bold">Files</emphasis>.</para> |
157 | </listitem> | 160 | </listitem> |
158 | 161 | ||
159 | <listitem> | 162 | <listitem> |
160 | <para>Select the <emphasis role="bold">Downloaded Files</emphasis> tab.</para> | 163 | <para>Select the <emphasis role="bold">Downloaded Files</emphasis> |
164 | tab.</para> | ||
161 | </listitem> | 165 | </listitem> |
162 | 166 | ||
163 | <listitem> | 167 | <listitem> |
164 | <para>Select an archive from the <emphasis role="bold">Downloaded Files</emphasis> | 168 | <para>Select an archive from the <emphasis role="bold">Downloaded |
165 | table.</para> | 169 | Files</emphasis> table.</para> |
166 | </listitem> | 170 | </listitem> |
167 | 171 | ||
168 | <listitem> | 172 | <listitem> |
169 | <para>Click the <emphasis role="bold">Download</emphasis> button.</para> | 173 | <para>Click the <emphasis role="bold">Download</emphasis> |
174 | button.</para> | ||
170 | 175 | ||
171 | <para>The file will be downloaded in browser's download | 176 | <para>The file will be downloaded in the download folder of the |
172 | folder.</para> | 177 | supported browser in use.</para> |
173 | 178 | ||
174 | <figure> | 179 | <figure> |
175 | <title>Downloaded Files Table</title> | 180 | <title>Downloaded Files Table</title> |
@@ -189,12 +194,13 @@ | |||
189 | <title>Deleting a Logs Archive from a uCPE device</title> | 194 | <title>Deleting a Logs Archive from a uCPE device</title> |
190 | 195 | ||
191 | <para>Use this option when you want to delete unnecessary collected logs | 196 | <para>Use this option when you want to delete unnecessary collected logs |
192 | on the uCPE device.</para> | 197 | on a uCPE device.</para> |
193 | 198 | ||
194 | <orderedlist> | 199 | <orderedlist> |
195 | <listitem> | 200 | <listitem> |
196 | <para>Access <emphasis role="bold">Files</emphasis> and then click the | 201 | <para>Access the <emphasis role="bold">Files</emphasis> menu and |
197 | <emphasis role="bold">Download</emphasis> button.</para> | 202 | then click the <emphasis role="bold">Download</emphasis> |
203 | button.</para> | ||
198 | </listitem> | 204 | </listitem> |
199 | 205 | ||
200 | <listitem> | 206 | <listitem> |
@@ -202,12 +208,14 @@ | |||
202 | </listitem> | 208 | </listitem> |
203 | 209 | ||
204 | <listitem> | 210 | <listitem> |
205 | <para>In the <emphasis role="bold">Device File Listing</emphasis> table, select | 211 | <para>In the <emphasis role="bold">Device File Listing</emphasis> |
206 | the archive you want to delete from the uCPE device.</para> | 212 | table, select the archive you want to delete from the uCPE |
213 | device.</para> | ||
207 | </listitem> | 214 | </listitem> |
208 | 215 | ||
209 | <listitem> | 216 | <listitem> |
210 | <para>Press the <emphasis role="bold">Delete</emphasis> button.</para> | 217 | <para>Press the <emphasis role="bold">Delete</emphasis> |
218 | button.</para> | ||
211 | 219 | ||
212 | <para>The archive will be deleted from the uCPE device and the table | 220 | <para>The archive will be deleted from the uCPE device and the table |
213 | will be updated.</para> | 221 | will be updated.</para> |
@@ -218,8 +226,9 @@ | |||
218 | 226 | ||
219 | <orderedlist> | 227 | <orderedlist> |
220 | <listitem> | 228 | <listitem> |
221 | <para>Access the <emphasis role="bold">Operations</emphasis> menu and | 229 | <para>Access the <emphasis role="bold">Operations</emphasis> menu |
222 | select <emphasis role="bold">Delete Debug Log Archive</emphasis>.</para> | 230 | and select <emphasis role="bold">Delete Debug Log |
231 | Archive</emphasis>.</para> | ||
223 | </listitem> | 232 | </listitem> |
224 | 233 | ||
225 | <listitem> | 234 | <listitem> |
@@ -227,7 +236,8 @@ select <emphasis role="bold">Delete Debug Log Archive</emphasis>.</para> | |||
227 | </listitem> | 236 | </listitem> |
228 | 237 | ||
229 | <listitem> | 238 | <listitem> |
230 | <para>Press the <emphasis role="bold">Execute</emphasis> button.</para> | 239 | <para>Press the <emphasis role="bold">Execute</emphasis> |
240 | button.</para> | ||
231 | 241 | ||
232 | <para>A success message is displayed if the file is deleted from the | 242 | <para>A success message is displayed if the file is deleted from the |
233 | uCPE device correctly.</para> | 243 | uCPE device correctly.</para> |
@@ -236,55 +246,59 @@ select <emphasis role="bold">Delete Debug Log Archive</emphasis>.</para> | |||
236 | </section> | 246 | </section> |
237 | 247 | ||
238 | <section id="delete_archives_ucpem"> | 248 | <section id="delete_archives_ucpem"> |
239 | <title>Deleting a Logs Archive from the Enea Edge Management</title> | 249 | <title>Deleting a Logs Archive from the Enea Edge Management |
250 | application</title> | ||
240 | 251 | ||
241 | <para>This option deletes a logs archive from the Enea Edge | 252 | <para>This option deletes a logs archive from the Enea Edge Management |
242 | Management.</para> | 253 | application.</para> |
243 | 254 | ||
244 | <orderedlist> | 255 | <orderedlist> |
245 | <listitem> | 256 | <listitem> |
246 | <para>Access the <emphasis role="bold">Devices</emphasis> menu, then select | 257 | <para>Access the <emphasis role="bold">Devices</emphasis> menu, then |
247 | <emphasis role="bold">Files</emphasis>.</para> | 258 | select <emphasis role="bold">Files</emphasis>.</para> |
248 | </listitem> | 259 | </listitem> |
249 | 260 | ||
250 | <listitem> | 261 | <listitem> |
251 | <para>Select the <emphasis role="bold">Downloaded Files</emphasis> tab.</para> | 262 | <para>Select the <emphasis role="bold">Downloaded Files</emphasis> |
263 | tab.</para> | ||
252 | </listitem> | 264 | </listitem> |
253 | 265 | ||
254 | <listitem> | 266 | <listitem> |
255 | <para>Select an archive from the <emphasis role="bold">Downloaded Files</emphasis> | 267 | <para>Select an archive from the <emphasis role="bold">Downloaded |
256 | table.</para> | 268 | Files</emphasis> table.</para> |
257 | </listitem> | 269 | </listitem> |
258 | 270 | ||
259 | <listitem> | 271 | <listitem> |
260 | <para>Click the <emphasis role="bold">Delete</emphasis> button.</para> | 272 | <para>Click the <emphasis role="bold">Delete</emphasis> |
273 | button.</para> | ||
261 | 274 | ||
262 | <para>The file will be deleted from the Enea Edge Management and the | 275 | <para>The file will be deleted from the Enea Edge Management |
263 | table will be updated.</para> | 276 | application and the table will be updated.</para> |
264 | </listitem> | 277 | </listitem> |
265 | </orderedlist> | 278 | </orderedlist> |
266 | 279 | ||
267 | <note> | 280 | <note> |
268 | <para>Deleting the logs file from the Enea Edge Management does not | 281 | <para>Deleting the logs file from the Enea Edge Management application |
269 | affect the file located on the uCPE device.</para> | 282 | does not affect the file located on the uCPE device.</para> |
270 | </note> | 283 | </note> |
271 | </section> | 284 | </section> |
272 | 285 | ||
273 | <section condition="hidden" id="enable_disable_via_perms"> | 286 | <section condition="hidden" id="enable_disable_via_perms"> |
274 | <title>Enabling/Disabling of the Log Collector via Permissions</title> | 287 | <title>Enabling/Disabling the Log Collector via Permissions</title> |
275 | 288 | ||
276 | <para>To disable the ability to access/download the uCPE device's | 289 | <para>To disable the ability to access/download the uCPE device's |
277 | debug-log files from the Enea Edge Management, the appropriate permissions | 290 | debug-log files from the Enea Edge Management application, the |
278 | must be changed:</para> | 291 | appropriate permissions must be changed:</para> |
279 | 292 | ||
280 | <orderedlist> | 293 | <orderedlist> |
281 | <listitem> | 294 | <listitem> |
282 | <para>Access the <emphasis role="bold">Security</emphasis> menu, | 295 | <para>Access the <emphasis role="bold">Security</emphasis> menu, |
283 | then select <emphasis role="bold">Configuration</emphasis>.</para> | 296 | then select <emphasis role="bold">Configuration</emphasis>.</para> |
284 | </listitem> | 297 | </listitem> |
285 | 298 | ||
286 | <listitem> | 299 | <listitem> |
287 | <para>Click the <emphasis role="bold">Security Groups</emphasis> tab.</para> | 300 | <para>Click the <emphasis role="bold">Security Groups</emphasis> |
301 | tab.</para> | ||
288 | </listitem> | 302 | </listitem> |
289 | 303 | ||
290 | <listitem> | 304 | <listitem> |
@@ -292,18 +306,19 @@ then select <emphasis role="bold">Configuration</emphasis>.</para> | |||
292 | </listitem> | 306 | </listitem> |
293 | 307 | ||
294 | <listitem> | 308 | <listitem> |
295 | <para>Click the <emphasis role="bold">Permissions</emphasis> tab on the right | 309 | <para>Click the <emphasis role="bold">Permissions</emphasis> tab on |
296 | side.</para> | 310 | the right side.</para> |
297 | </listitem> | 311 | </listitem> |
298 | 312 | ||
299 | <listitem> | 313 | <listitem> |
300 | <para>Click the <emphasis role="bold">Devices</emphasis> tab like in the image | 314 | <para>Click the <emphasis role="bold">Devices</emphasis> tab like in |
301 | below.</para> | 315 | the image below.</para> |
302 | </listitem> | 316 | </listitem> |
303 | 317 | ||
304 | <listitem> | 318 | <listitem> |
305 | <para>Change the <emphasis role="bold">Device File Management</emphasis> option to | 319 | <para>Change the <emphasis role="bold">Device File |
306 | <emphasis role="bold">none</emphasis> to disable the feature.</para> | 320 | Management</emphasis> option to <emphasis |
321 | role="bold">none</emphasis> to disable the feature.</para> | ||
307 | </listitem> | 322 | </listitem> |
308 | </orderedlist> | 323 | </orderedlist> |
309 | 324 | ||
@@ -322,29 +337,30 @@ then select <emphasis role="bold">Configuration</emphasis>.</para> | |||
322 | <section id="download_ucpemg_logs"> | 337 | <section id="download_ucpemg_logs"> |
323 | <title>Downloading Enea Edge Management Logs</title> | 338 | <title>Downloading Enea Edge Management Logs</title> |
324 | 339 | ||
325 | <para>Often, sending the Enea Edge Management logs together with collected | 340 | <para>Often, sending the Enea Edge Management logs together with |
326 | uCPE device logs to the support team provides important information for | 341 | collected uCPE device logs to the support team provides important |
327 | troubleshooting (especially in cases of connectivity issues with the | 342 | information for troubleshooting (especially in cases of connectivity |
328 | uCPE device and error popups).</para> | 343 | issues with the uCPE device and error popups).</para> |
329 | 344 | ||
330 | <para>Enea Edge Management log files are located in | 345 | <para>Enea Edge Management log files are located in |
331 | <filename>application/logs/</filename> in the Enea Edge Management's | 346 | <filename>application/logs/</filename> in the Enea Edge Management |
332 | installation folder | 347 | application's installation folder |
333 | (e.g.<filename>/opt/ems/ucpemanager/application/logs</filename>). They | 348 | (e.g.<filename>/opt/ems/ucpemanager/application/logs</filename>). They |
334 | can be copied from that location, or they can be downloaded using the | 349 | can be copied from that location, or they can be downloaded using the |
335 | Enea Edge Management GUI by performing the following:</para> | 350 | Enea Edge Management GUI by performing the following:</para> |
336 | 351 | ||
337 | <orderedlist> | 352 | <orderedlist> |
338 | <listitem> | 353 | <listitem> |
339 | <para>Access <emphasis role="bold">Test</emphasis>, then <emphasis role="bold">Debug | 354 | <para>Access <emphasis role="bold">Test</emphasis>, then <emphasis |
340 | Settings</emphasis> and select the <emphasis role="bold">Log Files</emphasis> tab.</para> | 355 | role="bold">Debug Settings</emphasis> and select the <emphasis |
356 | role="bold">Log Files</emphasis> tab.</para> | ||
341 | </listitem> | 357 | </listitem> |
342 | 358 | ||
343 | <listitem> | 359 | <listitem> |
344 | <para>Select the desired log file | 360 | <para>Select the desired log file |
345 | (<filename>ucpemanager.log</filename> or | 361 | (<filename>ucpemanager.log</filename> or |
346 | <filename>watchdog.log</filename>) and press the | 362 | <filename>watchdog.log</filename>) and press the <emphasis |
347 | <emphasis role="bold">Download</emphasis> button.</para> | 363 | role="bold">Download</emphasis> button.</para> |
348 | </listitem> | 364 | </listitem> |
349 | 365 | ||
350 | <listitem> | 366 | <listitem> |
@@ -372,12 +388,13 @@ then select <emphasis role="bold">Configuration</emphasis>.</para> | |||
372 | </section> | 388 | </section> |
373 | 389 | ||
374 | <section id="log_collect_no_ucpem"> | 390 | <section id="log_collect_no_ucpem"> |
375 | <title>Log collecting without using the Enea Edge Management</title> | 391 | <title>Log collecting without using the Enea Edge Management |
392 | application</title> | ||
376 | 393 | ||
377 | <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 |
378 | Enea Edge Management connection. A SSH connection to uCPE Device is needed | 395 | Enea Edge Management connection. A SSH connection to the uCPE Device is |
379 | for use of the log collector script, which can be found in the uCPE Device | 396 | needed for use of the log collector script, which can be found in the uCPE |
380 | file system in <literal>/usr/local/enea/</literal>.</para> | 397 | Device file system in <literal>/usr/local/enea/</literal>.</para> |
381 | 398 | ||
382 | <para>The Log collector script takes relevant information about the system | 399 | <para>The Log collector script takes relevant information about the system |
383 | and collects it in an archive:</para> | 400 | and collects it in an archive:</para> |
@@ -385,7 +402,7 @@ then select <emphasis role="bold">Configuration</emphasis>.</para> | |||
385 | <programlisting>./log-collector.sh -p <LOG_PATHh> -n <ARCHIVE_NAME></programlisting> | 402 | <programlisting>./log-collector.sh -p <LOG_PATHh> -n <ARCHIVE_NAME></programlisting> |
386 | 403 | ||
387 | <para>Where <literal>-p</literal> is the path where the log archive will | 404 | <para>Where <literal>-p</literal> is the path where the log archive will |
388 | be saved, <literal>-n</literal> is the archive name.</para> | 405 | be saved, and <literal>-n</literal> is the archive name.</para> |
389 | 406 | ||
390 | <note> | 407 | <note> |
391 | <para>If <literal>-p</literal> is not provided, the default path will be | 408 | <para>If <literal>-p</literal> is not provided, the default path will be |
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 344b79b..ff513c9 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,24 +1,24 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
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 | ||
5 | <para>Various Advanced Network Configuration options can be done from Enea | 5 | <para>Various Advanced Network Configuration options can be done from the |
6 | Edge Management GUI.</para> | 6 | Enea Edge Management application GUI.</para> |
7 | 7 | ||
8 | <section id="device_callhome_nat"> | 8 | <section id="device_callhome_nat"> |
9 | <title>Device Call Home Connection for Deployment behind NAT</title> | 9 | <title>Device Call Home Connection for Deployment behind NAT</title> |
10 | 10 | ||
11 | <para>The Device Call Home option enables the initiation of the connection | 11 | <para>The Device Call Home option enables the initiation of the connection |
12 | between the uCPE Device and the Enea Edge Management, from the uCPE | 12 | between the uCPE Device and the Enea Edge Management application, from the |
13 | device. The Device Call Home option is required when deploying a uCPE | 13 | uCPE device. The Device Call Home option is required when deploying a uCPE |
14 | device behind NAT since the IP address of the uCPE device is hidden for | 14 | device behind NAT since the IP address of the uCPE device is hidden for |
15 | the Enea Edge Management.</para> | 15 | the Enea Edge Management application.</para> |
16 | 16 | ||
17 | <para>Enable Device Call Home by marking the Device Call Home checkbox | 17 | <para>Enable Device Call Home by marking the Device Call Home checkbox |
18 | when registering the uCPE device in Enea Edge Management. When using this | 18 | when registering the uCPE device in Enea Edge Management application. When |
19 | mechanism, the device will initiate a connection to the Enea Edge | 19 | using this mechanism, the device will initiate a connection to the Enea |
20 | Management for NETCONF traffic (over SSH), while the Enea Edge Management | 20 | Edge Management application for NETCONF traffic (over SSH), while the |
21 | waits for a device connection.</para> | 21 | application waits for a device connection.</para> |
22 | </section> | 22 | </section> |
23 | 23 | ||
24 | <section id="device_net_config"> | 24 | <section id="device_net_config"> |
@@ -30,7 +30,7 @@ | |||
30 | selecting physical interfaces to be used by virtualized networking and | 30 | selecting physical interfaces to be used by virtualized networking and |
31 | creating different types of bridges to enable VNF communication.</para> | 31 | creating different types of bridges to enable VNF communication.</para> |
32 | 32 | ||
33 | <para>The Zero Touch Provisioning mechanism is also touched upon, as | 33 | <para>The Zero Touch Provisioning mechanism is also touched upon, as an |
34 | alternative to manual configuration of the virtualization | 34 | alternative to manual configuration of the virtualization |
35 | infrastructure.</para> | 35 | infrastructure.</para> |
36 | 36 | ||
@@ -52,9 +52,9 @@ | |||
52 | configurations have been made.</para> | 52 | configurations have been made.</para> |
53 | </note> | 53 | </note> |
54 | 54 | ||
55 | <para>In <emphasis role="bold">Configuration</emphasis>, select | 55 | <para>In the <emphasis role="bold">Configuration</emphasis> menu, select |
56 | <emphasis role="bold">DPDK</emphasis> where DPDK resources can also be | 56 | <emphasis role="bold">DPDK</emphasis>, here DPDK resources can also be |
57 | configured such as:</para> | 57 | configured:</para> |
58 | 58 | ||
59 | <itemizedlist> | 59 | <itemizedlist> |
60 | <listitem> | 60 | <listitem> |
@@ -90,8 +90,8 @@ | |||
90 | virtualization infrastructure and VNFs, they must be configured into the | 90 | virtualization infrastructure and VNFs, they must be configured into the |
91 | management system.</para> | 91 | management system.</para> |
92 | 92 | ||
93 | <para>To add an interface into the Enea Edge Management, select the uCPE | 93 | <para>To add an interface into the Enea Edge Management application, |
94 | device, then from the top toolbar select <emphasis | 94 | select the uCPE device, then from the top toolbar select <emphasis |
95 | role="bold">Configuration</emphasis>, then <emphasis | 95 | role="bold">Configuration</emphasis>, then <emphasis |
96 | role="bold">External Interfaces</emphasis>, <emphasis | 96 | role="bold">External Interfaces</emphasis>, <emphasis |
97 | role="bold">Configuration</emphasis>, and click the <emphasis | 97 | role="bold">Configuration</emphasis>, and click the <emphasis |
@@ -191,10 +191,10 @@ | |||
191 | <title>Wan Interface Type</title> | 191 | <title>Wan Interface Type</title> |
192 | 192 | ||
193 | <para>WAN interfaces configured during the installation of the uCPE | 193 | <para>WAN interfaces configured during the installation of the uCPE |
194 | device are automatically added in the Enea Edge Management as type | 194 | device are automatically added in the Enea Edge Management application |
195 | <literal>wan</literal>. The WAN interface used for management of the | 195 | as type <literal>wan</literal>. The WAN interface used for management |
196 | uCPE device is marked with the <literal>Management</literal> property | 196 | of the uCPE device is marked with the <literal>Management</literal> |
197 | set to <literal>True</literal>.</para> | 197 | property set to <literal>True</literal>.</para> |
198 | 198 | ||
199 | <para>If a WAN interface is to be assigned for use by a VNF, it must | 199 | <para>If a WAN interface is to be assigned for use by a VNF, it must |
200 | be changed into another interface type depending on the type of | 200 | be changed into another interface type depending on the type of |
@@ -305,9 +305,10 @@ | |||
305 | <note> | 305 | <note> |
306 | <para>Correct <emphasis role="bold">Country Code</emphasis> | 306 | <para>Correct <emphasis role="bold">Country Code</emphasis> |
307 | selection is mandatory. All configuration options are available in | 307 | selection is mandatory. All configuration options are available in |
308 | the Enea Edge Management GUI but only the Radio Settings that | 308 | the Enea Edge Management application GUI but only the Radio Settings |
309 | conform with the selected country's official regulatory laws will be | 309 | that conform with the selected country's official regulatory laws |
310 | applied when the Wireless AP is started on the uCPE Device.</para> | 310 | will be applied when the Wireless AP is started on the uCPE |
311 | Device.</para> | ||
311 | </note> | 312 | </note> |
312 | </section> | 313 | </section> |
313 | 314 | ||
@@ -429,7 +430,8 @@ | |||
429 | <itemizedlist> | 430 | <itemizedlist> |
430 | <listitem> | 431 | <listitem> |
431 | <para><emphasis role="bold">Device management</emphasis>. Part of | 432 | <para><emphasis role="bold">Device management</emphasis>. Part of |
432 | the device configuration done by the Enea Edge Management.</para> | 433 | the device configuration done by the Enea Edge Management |
434 | application.</para> | ||
433 | </listitem> | 435 | </listitem> |
434 | 436 | ||
435 | <listitem> | 437 | <listitem> |
@@ -558,7 +560,8 @@ | |||
558 | <para>If the offline configuration is not configured for a uCPE device, | 560 | <para>If the offline configuration is not configured for a uCPE device, |
559 | an alarm will be raised: <literal>Day-0 Config:ZTP:Major</literal>, | 561 | an alarm will be raised: <literal>Day-0 Config:ZTP:Major</literal>, |
560 | which occurs when the uCPE device connects to the Enea Edge Management | 562 | which occurs when the uCPE device connects to the Enea Edge Management |
561 | informing that the ZTP setup failed for the specific uCPE device.</para> | 563 | application informing that the ZTP setup failed for the specific uCPE |
564 | device.</para> | ||
562 | 565 | ||
563 | <para>To create an offline configuration, select from the top toolbar | 566 | <para>To create an offline configuration, select from the top toolbar |
564 | the <emphasis role="bold">Applications</emphasis> menu, then <emphasis | 567 | the <emphasis role="bold">Applications</emphasis> menu, then <emphasis |
@@ -602,10 +605,10 @@ | |||
602 | Edge version of the uCPE device and the Device ID will be set to the | 605 | Edge version of the uCPE device and the Device ID will be set to the |
603 | previously set identifier of the uCPE device.</para> | 606 | previously set identifier of the uCPE device.</para> |
604 | 607 | ||
605 | <para>When a device connects to the Enea Edge Management for the first | 608 | <para>When a device connects to the Enea Edge Management application for |
606 | time, it checks the device to see if it has been Zero Touch Provisioned | 609 | the first time, it checks the device to see if it has been Zero Touch |
607 | (ZTP). If not, it looks for an offline configuration that matches these | 610 | Provisioned (ZTP). If not, it looks for an offline configuration that |
608 | values, in the following order:</para> | 611 | matches these values, in the following order:</para> |
609 | 612 | ||
610 | <itemizedlist> | 613 | <itemizedlist> |
611 | <listitem> | 614 | <listitem> |
@@ -633,9 +636,9 @@ | |||
633 | 636 | ||
634 | <note> | 637 | <note> |
635 | <para>The ZTP will only be triggered the first time a uCPE device | 638 | <para>The ZTP will only be triggered the first time a uCPE device |
636 | connects to the Enea Edge Management. Just changing an offline | 639 | connects to the Enea Edge Management application. Just changing an |
637 | configuration will not push the new changes to the device. If an | 640 | offline configuration will not push the new changes to the device. If |
638 | offline configuration is changed after uCPE device registration, a | 641 | an offline configuration is changed after uCPE device registration, a |
639 | factory reset can be executed to force a new ZTP to execute. Select | 642 | factory reset can be executed to force a new ZTP to execute. Select |
640 | the device, then access the <emphasis | 643 | the device, then access the <emphasis |
641 | role="bold">Operations</emphasis> menu and select <emphasis | 644 | role="bold">Operations</emphasis> menu and select <emphasis |
@@ -655,9 +658,9 @@ | |||
655 | <section id="upload_scripts"> | 658 | <section id="upload_scripts"> |
656 | <title>Uploading Scripts</title> | 659 | <title>Uploading Scripts</title> |
657 | 660 | ||
658 | <para>The scripts need to be uploaded to the Enea Edge Management prior | 661 | <para>The scripts need to be uploaded to the Enea Edge Management |
659 | to use. When uploading scripts to the Enea Edge Management make sure to | 662 | application prior to use. When uploading scripts to the Enea Edge |
660 | select the right script type.</para> | 663 | Management application make sure to select the right script type.</para> |
661 | 664 | ||
662 | <para>The following script types are supported:</para> | 665 | <para>The following script types are supported:</para> |
663 | 666 | ||
@@ -736,7 +739,7 @@ | |||
736 | <para>Select the script you want to delete from the <emphasis | 739 | <para>Select the script you want to delete from the <emphasis |
737 | role="bold">Uploaded Scripts</emphasis> tab and then click <emphasis | 740 | role="bold">Uploaded Scripts</emphasis> tab and then click <emphasis |
738 | role="bold">Delete</emphasis>, which will remove the script | 741 | role="bold">Delete</emphasis>, which will remove the script |
739 | immediately from the Enea Edge Management.</para> | 742 | immediately from the Enea Edge Management application.</para> |
740 | </listitem> | 743 | </listitem> |
741 | </orderedlist> | 744 | </orderedlist> |
742 | </section> | 745 | </section> |
@@ -907,4 +910,4 @@ | |||
907 | Interfaces</emphasis>.</para> | 910 | Interfaces</emphasis>.</para> |
908 | </note> | 911 | </note> |
909 | </section> | 912 | </section> |
910 | </chapter> | 913 | </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 4984a35..fcf991e 100644 --- a/doc/book-enea-edge-getting-started/doc/troubleshooting.xml +++ b/doc/book-enea-edge-getting-started/doc/troubleshooting.xml | |||
@@ -1,24 +1,24 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="troubleshooting"> | 2 | <chapter id="troubleshooting"> |
3 | <title>Troubleshooting and Recovery</title> | 3 | <title>Troubleshooting and Recovery</title> |
4 | 4 | ||
5 | <para>In all scenarios where possible, collect the logs for debugging. More | 5 | <para>In all scenarios where possible, collect the logs for debugging. More |
6 | information on log collecting can be found in <olink | 6 | information on log collecting can be found in <olink |
7 | targetdoc="book_enea_nfv_access_getting_started" | 7 | targetdoc="book_enea_edge_getting_started" targetptr="log_collector">Using |
8 | targetptr="log_collector">Using the Log Collector in the <xi:include | 8 | the Log Collector in the <xi:include |
9 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 9 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
10 | xmlns:xi="http://www.w3.org/2001/XInclude" | 10 | xmlns:xi="http://www.w3.org/2001/XInclude" |
11 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 11 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
12 | Manual.</para> | 12 | Manual.</para> |
13 | 13 | ||
14 | <para>The following is a small list of possible Enea Edge problems, and | 14 | <para>The following is a small list of possible Enea Edge problems, and |
15 | their solutions. If you encounter other issues or can't get Enea Edge to | 15 | their solutions. If you encounter other issues or can't get Enea Edge to |
16 | work successfully after consulting the information below, please use the | 16 | work successfully after consulting the information below, please use the |
17 | <olink targetdoc="book_enea_nfv_access_release_info" | 17 | <olink targetdoc="book_enea_edge_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_edge_release_info/1)" /></olink> Manual |
22 | downloaded with your release.</para> | 22 | downloaded with your release.</para> |
23 | 23 | ||
24 | <table> | 24 | <table> |
@@ -38,18 +38,18 @@ | |||
38 | <tbody> | 38 | <tbody> |
39 | <row> | 39 | <row> |
40 | <entry>A uCPE device fails to connect to the Enea Edge Management | 40 | <entry>A uCPE device fails to connect to the Enea Edge Management |
41 | after installation.</entry> | 41 | application after installation.</entry> |
42 | 42 | ||
43 | <entry>If the uCPE device is not able to connect to the Enea Edge | 43 | <entry>If the uCPE device is not able to connect to the Enea Edge |
44 | Management after an installation, the Web-installer application is | 44 | Management application after an installation, the Web-installer |
45 | started automatically on the uCPE device to change the configuration | 45 | application is started automatically on the uCPE device to change |
46 | via a web browser. Please see <olink | 46 | the configuration via a web browser. Please see <olink |
47 | targetdoc="book_enea_nfv_access_getting_started" | 47 | targetdoc="book_enea_edge_getting_started" |
48 | targetptr="boot_device_add_map">Booting the uCPE device and adding | 48 | targetptr="boot_device_add_map">Booting the uCPE device and adding |
49 | it to the Map in the <xi:include | 49 | it to the Map in the <xi:include |
50 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 50 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
51 | xmlns:xi="http://www.w3.org/2001/XInclude" | 51 | xmlns:xi="http://www.w3.org/2001/XInclude" |
52 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 52 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
53 | Manual.</entry> | 53 | Manual.</entry> |
54 | </row> | 54 | </row> |
55 | 55 | ||
@@ -65,12 +65,11 @@ | |||
65 | 65 | ||
66 | <listitem> | 66 | <listitem> |
67 | <para>Reinitiate the Upgrade procedure according to the steps | 67 | <para>Reinitiate the Upgrade procedure according to the steps |
68 | in section <olink | 68 | in section <olink targetdoc="book_enea_edge_getting_started" |
69 | targetdoc="book_enea_nfv_access_getting_started" | ||
70 | targetptr="upgrade_devices">uCPE device upgrades in the | 69 | targetptr="upgrade_devices">uCPE device upgrades in the |
71 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 70 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
72 | xmlns:xi="http://www.w3.org/2001/XInclude" | 71 | xmlns:xi="http://www.w3.org/2001/XInclude" |
73 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 72 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
74 | Manual.</para> | 73 | Manual.</para> |
75 | </listitem> | 74 | </listitem> |
76 | </orderedlist></entry> | 75 | </orderedlist></entry> |
@@ -78,22 +77,22 @@ | |||
78 | 77 | ||
79 | <row> | 78 | <row> |
80 | <entry>After a failed uCPE device upgrade the previous Enea Edge | 79 | <entry>After a failed uCPE device upgrade the previous Enea Edge |
81 | image (from the GRUB menu) does not boot.</entry> | 80 | Runtime image (from the GRUB menu) does not boot.</entry> |
82 | 81 | ||
83 | <entry>Reinstall Enea Edge on the uCPE device and redeploy the | 82 | <entry>Reinstall Enea Edge Runtime on the uCPE device and redeploy |
84 | initial configuration and virtualized services, by following the | 83 | the initial configuration and virtualized services, by following the |
85 | steps in <olink targetdoc="book_enea_nfv_access_getting_started" | 84 | steps in <olink targetdoc="book_enea_edge_getting_started" |
86 | targetptr="install_ena_device">Installing Enea Edge - uCPE Device | 85 | targetptr="install_ena_device">Installing Enea Edge - uCPE Device |
87 | installation in the <xi:include | 86 | installation in the <xi:include |
88 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 87 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
89 | xmlns:xi="http://www.w3.org/2001/XInclude" | 88 | xmlns:xi="http://www.w3.org/2001/XInclude" |
90 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 89 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
91 | Manual.</entry> | 90 | Manual.</entry> |
92 | </row> | 91 | </row> |
93 | 92 | ||
94 | <row> | 93 | <row> |
95 | <entry>The Enea Edge Management upgrade fails and a working snapshot | 94 | <entry>The Enea Edge Management application upgrade fails and a |
96 | is available.</entry> | 95 | working snapshot is available.</entry> |
97 | 96 | ||
98 | <entry>If a working snapshot obtained during a previous Upgrade or | 97 | <entry>If a working snapshot obtained during a previous Upgrade or |
99 | Uninstall is available | 98 | Uninstall is available |
@@ -107,20 +106,21 @@ | |||
107 | 106 | ||
108 | <listitem> | 107 | <listitem> |
109 | <para>Restore the previous installation as described in <olink | 108 | <para>Restore the previous installation as described in <olink |
110 | targetdoc="book_enea_nfv_access_getting_started" | 109 | targetdoc="book_enea_edge_getting_started" |
111 | targetptr="restore_prev_ucpe_install">Restoring a previous | 110 | targetptr="restore_prev_ucpe_install">Restoring a previous |
112 | Enea Edge Management installation in the <xi:include | 111 | Enea Edge Management installation in the <xi:include |
113 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 112 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
114 | xmlns:xi="http://www.w3.org/2001/XInclude" | 113 | xmlns:xi="http://www.w3.org/2001/XInclude" |
115 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 114 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
116 | Manual.</para> | 115 | Manual.</para> |
117 | </listitem> | 116 | </listitem> |
118 | </orderedlist></entry> | 117 | </orderedlist></entry> |
119 | </row> | 118 | </row> |
120 | 119 | ||
121 | <row> | 120 | <row> |
122 | <entry>The Enea Edge Management upgrade fails and no working | 121 | <entry>The Enea Edge Management application upgrade fails and no |
123 | snapshot is available, but a System Back-up file exists.</entry> | 122 | working snapshot is available, but a System Back-up file |
123 | exists.</entry> | ||
124 | 124 | ||
125 | <entry><orderedlist> | 125 | <entry><orderedlist> |
126 | <listitem> | 126 | <listitem> |
@@ -132,20 +132,21 @@ | |||
132 | <listitem> | 132 | <listitem> |
133 | <para>Perform an installation with the restore option of a | 133 | <para>Perform an installation with the restore option of a |
134 | previous Enea Edge Management configuration as described in | 134 | previous Enea Edge Management configuration as described in |
135 | <olink targetdoc="book_enea_nfv_access_getting_started" | 135 | <olink targetdoc="book_enea_edge_getting_started" |
136 | targetptr="install_ucpemg_from_backup">Installation of the | 136 | targetptr="install_ucpemg_from_backup">Installation of the |
137 | Enea Edge Management using a System Back-up in the <xi:include | 137 | Enea Edge Management application using a System Back-up in the |
138 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 138 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
139 | xmlns:xi="http://www.w3.org/2001/XInclude" | 139 | xmlns:xi="http://www.w3.org/2001/XInclude" |
140 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 140 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
141 | Manual.</para> | 141 | Manual.</para> |
142 | </listitem> | 142 | </listitem> |
143 | </orderedlist></entry> | 143 | </orderedlist></entry> |
144 | </row> | 144 | </row> |
145 | 145 | ||
146 | <row> | 146 | <row> |
147 | <entry>The uCPE device is booted, the ssh connection is available | 147 | <entry>The uCPE device is booted, the SSH connection is available |
148 | but the device is not connected to the Enea Edge Management.</entry> | 148 | but the device is not connected to the Enea Edge Management |
149 | application.</entry> | ||
149 | 150 | ||
150 | <entry><orderedlist> | 151 | <entry><orderedlist> |
151 | <listitem> | 152 | <listitem> |
@@ -155,12 +156,13 @@ | |||
155 | 156 | ||
156 | <listitem> | 157 | <listitem> |
157 | <para>Use the <emphasis role="bold">Reconnect</emphasis> | 158 | <para>Use the <emphasis role="bold">Reconnect</emphasis> |
158 | button from the Enea Edge Management's GUI.</para> | 159 | button from the Enea Edge Management applications's |
160 | GUI.</para> | ||
159 | </listitem> | 161 | </listitem> |
160 | 162 | ||
161 | <listitem> | 163 | <listitem> |
162 | <para>Connect to uCPE Device console and run the factory reset | 164 | <para>Connect to the uCPE Device console and run the factory |
163 | script:</para> | 165 | reset script:</para> |
164 | 166 | ||
165 | <programlisting>/usr/local/odm/bin/factory_reset.sh</programlisting> | 167 | <programlisting>/usr/local/odm/bin/factory_reset.sh</programlisting> |
166 | </listitem> | 168 | </listitem> |
@@ -168,12 +170,12 @@ | |||
168 | <listitem> | 170 | <listitem> |
169 | <para>If the above actions do not work, reinstall and | 171 | <para>If the above actions do not work, reinstall and |
170 | reconfigure the device using the steps provided in <olink | 172 | reconfigure the device using the steps provided in <olink |
171 | targetdoc="book_enea_nfv_access_getting_started" | 173 | targetdoc="book_enea_edge_getting_started" |
172 | targetptr="install_ena_device">Installing Enea Edge - uCPE | 174 | targetptr="install_ena_device">Installing Enea Edge - uCPE |
173 | Device installation in the <xi:include | 175 | Device installation in the <xi:include |
174 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 176 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
175 | xmlns:xi="http://www.w3.org/2001/XInclude" | 177 | xmlns:xi="http://www.w3.org/2001/XInclude" |
176 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 178 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
177 | Manual.</para> | 179 | Manual.</para> |
178 | </listitem> | 180 | </listitem> |
179 | </orderedlist></entry> | 181 | </orderedlist></entry> |
@@ -185,12 +187,12 @@ | |||
185 | 187 | ||
186 | <entry>Perform a hardware reboot on the uCPE device. If the problem | 188 | <entry>Perform a hardware reboot on the uCPE device. If the problem |
187 | is not fixed, reinstall and reconfigure the device using the steps | 189 | is not fixed, reinstall and reconfigure the device using the steps |
188 | provided in <olink targetdoc="book_enea_nfv_access_getting_started" | 190 | provided in <olink targetdoc="book_enea_edge_getting_started" |
189 | targetptr="install_ena_device">Installing Enea Edge - uCPE Device | 191 | targetptr="install_ena_device">Installing Enea Edge - uCPE Device |
190 | installation in the <xi:include | 192 | installation in the <xi:include |
191 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 193 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
192 | xmlns:xi="http://www.w3.org/2001/XInclude" | 194 | xmlns:xi="http://www.w3.org/2001/XInclude" |
193 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 195 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
194 | Manual.</entry> | 196 | Manual.</entry> |
195 | </row> | 197 | </row> |
196 | 198 | ||
@@ -208,7 +210,7 @@ | |||
208 | <para>Reboot the device by accessing <emphasis | 210 | <para>Reboot the device by accessing <emphasis |
209 | role="bold">Operations</emphasis> and then selecting <emphasis | 211 | role="bold">Operations</emphasis> and then selecting <emphasis |
210 | role="bold">Reboot</emphasis> from within the Enea Edge | 212 | role="bold">Reboot</emphasis> from within the Enea Edge |
211 | Management.</para> | 213 | Management application.</para> |
212 | </listitem> | 214 | </listitem> |
213 | 215 | ||
214 | <listitem> | 216 | <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 9680a0c..80473cb 100644 --- a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml | |||
@@ -1,19 +1,20 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="upgrade_ena"> | 2 | <chapter id="upgrade_ena"> |
3 | <title>Upgrading Enea Edge</title> | 3 | <title>Upgrading Enea Edge</title> |
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 | Edge components. The Enea Edge Management must be upgraded first, followed | 6 | Edge components. The Enea Edge Management application must be upgraded |
7 | by upgrading the Enea Edge Runtime on the uCPE devices.</para> | 7 | first, followed by upgrading the Enea Edge Runtime on the uCPE |
8 | devices.</para> | ||
8 | 9 | ||
9 | <section id="upgrade_mg"> | 10 | <section id="upgrade_mg"> |
10 | <title>Upgrading the Enea Edge Management</title> | 11 | <title>Upgrading the Enea Edge Management application</title> |
11 | 12 | ||
12 | <note> | 13 | <note> |
13 | <para>It is recommended to create a system backup by accessing <emphasis | 14 | <para>It is recommended to create a system backup by accessing the |
14 | role="bold">System</emphasis> and selecting <emphasis role="bold">System | 15 | <emphasis role="bold">System</emphasis> menu and selecting <emphasis |
15 | Backup</emphasis> from the Enea Edge Management GUI, for recovery in | 16 | role="bold">System Backup</emphasis> from the Enea Edge Management GUI, |
16 | case of an upgrade failure.</para> | 17 | for recovery in case of an upgrade failure.</para> |
17 | </note> | 18 | </note> |
18 | 19 | ||
19 | <orderedlist> | 20 | <orderedlist> |
@@ -23,11 +24,11 @@ | |||
23 | folder.</para> | 24 | folder.</para> |
24 | 25 | ||
25 | <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 |
26 | denoted as <literal><uCPEM-installdir></literal>.</para> | 27 | denoted as <literal><uCPEM-installerdir></literal>.</para> |
27 | </listitem> | 28 | </listitem> |
28 | 29 | ||
29 | <listitem> | 30 | <listitem> |
30 | <para>Enter <literal><uCPEM-installdir>/dist</literal>.</para> | 31 | <para>Enter <literal><uCPEM-installerdir>/dist</literal>.</para> |
31 | </listitem> | 32 | </listitem> |
32 | 33 | ||
33 | <listitem> | 34 | <listitem> |
@@ -53,11 +54,11 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
53 | application folder | 54 | application folder |
54 | (<filename>ucpemanager-Back-up-YYYYddMMHHmm.tar.gz</filename>), which | 55 | (<filename>ucpemanager-Back-up-YYYYddMMHHmm.tar.gz</filename>), which |
55 | contains a snapshot of the existing installation in the | 56 | contains a snapshot of the existing installation in the |
56 | <literal><uCPEM-installdir>/dist</literal> directory.</para> | 57 | <literal><uCPEM-installerdir>/dist</literal> directory.</para> |
57 | 58 | ||
58 | <note> | 59 | <note> |
59 | <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 |
60 | restoring the Enea Edge Management.</para> | 61 | restoring the Enea Edge Management application.</para> |
61 | </note> | 62 | </note> |
62 | </listitem> | 63 | </listitem> |
63 | 64 | ||
@@ -71,23 +72,22 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
71 | </listitem> | 72 | </listitem> |
72 | </itemizedlist> | 73 | </itemizedlist> |
73 | 74 | ||
74 | <para><olink targetdoc="book_enea_nfv_access_getting_started" | 75 | <para><olink targetdoc="book_enea_edge_getting_started" |
75 | targetptr="fresh_ucpemg_install">Fresh Installation of the Enea Edge Management | 76 | targetptr="fresh_ucpemg_install">Fresh Installation of the Enea Edge |
76 | in the <ns:include | 77 | Management in the <ns:include |
77 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 78 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
78 | xmlns:ns="http://www.w3.org/2001/XInclude" | 79 | xmlns:ns="http://www.w3.org/2001/XInclude" |
79 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 80 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> Manual |
80 | Manual contains information about the input required to be entered during | 81 | contains information about the input required to be entered during the |
81 | the execution of the upgrade script.</para> | 82 | execution of the upgrade script.</para> |
82 | 83 | ||
83 | 84 | <para condition="hidden">For an example on how to upgrade an Enea Edge | |
84 | <para condition="hidden">For an example on how to upgrade an Enea Edge Management installation | 85 | Management installation in a High Availability setup, consult <olink |
85 | in a High Availability setup, consult <olink | 86 | targetdoc="book_enea_edge_getting_started" |
86 | targetdoc="book_enea_nfv_access_getting_started" | ||
87 | targetptr="ha_upgrade">Upgrading a High Availability Deployment in the | 87 | targetptr="ha_upgrade">Upgrading a High Availability Deployment in the |
88 | <ns:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 88 | <ns:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
89 | xmlns:ns="http://www.w3.org/2001/XInclude" | 89 | xmlns:ns="http://www.w3.org/2001/XInclude" |
90 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | 90 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
91 | Manual.</para> | 91 | Manual.</para> |
92 | 92 | ||
93 | <section id="restore_prev_ucpe_install"> | 93 | <section id="restore_prev_ucpe_install"> |
@@ -104,7 +104,7 @@ 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-installdir></literal>.</para> | 107 | denoted as <literal><uCPEM-installerdir></literal>.</para> |
108 | </listitem> | 108 | </listitem> |
109 | 109 | ||
110 | <listitem> | 110 | <listitem> |
@@ -112,11 +112,12 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
112 | (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) | 112 | (<filename>ucpemanager-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-installdir></literal> directory.</para> | 115 | <literal><uCPEM-installerdir>/dist</literal> directory.</para> |
116 | </listitem> | 116 | </listitem> |
117 | 117 | ||
118 | <listitem> | 118 | <listitem> |
119 | <para>Enter <literal><uCPEM-installdir>/dist</literal>.</para> | 119 | <para>Enter |
120 | <literal><uCPEM-installerdir>/dist</literal>.</para> | ||
120 | </listitem> | 121 | </listitem> |
121 | 122 | ||
122 | <listitem> | 123 | <listitem> |
@@ -156,9 +157,15 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
156 | 157 | ||
157 | <orderedlist> | 158 | <orderedlist> |
158 | <listitem> | 159 | <listitem> |
159 | <para>Navigate to the folder where the Enea Edge Management is | 160 | <para>Navigate to the folder where the Enea Edge Management |
160 | installed: <filename><uCPEM-installdir></filename>.</para> | 161 | application is unpacked: |
162 | <filename><uCPEM-installerdir></filename>.</para> | ||
161 | </listitem> | 163 | </listitem> |
164 | |||
165 | <listitem> | ||
166 | <para>Enter | ||
167 | <literal><uCPEM-installerdir>/dist</literal>.</para> | ||
168 | </listitem> | ||
162 | 169 | ||
163 | <listitem> | 170 | <listitem> |
164 | <para>Run the following command with the root user and change | 171 | <para>Run the following command with the root user and change |
@@ -186,7 +193,7 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
186 | 193 | ||
187 | <note> | 194 | <note> |
188 | <para>The snapshot file created during the uninstall can be used | 195 | <para>The snapshot file created during the uninstall can be used |
189 | for restoring Enea Edge Management.</para> | 196 | for restoring the Enea Edge Management application.</para> |
190 | </note> | 197 | </note> |
191 | </listitem> | 198 | </listitem> |
192 | 199 | ||
@@ -205,8 +212,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
205 | </listitem> | 212 | </listitem> |
206 | </itemizedlist> | 213 | </itemizedlist> |
207 | 214 | ||
208 | <para>After these steps, the Enea Edge Management is completely removed | 215 | <para>After these steps, the Enea Edge Management application is |
209 | from the system.</para> | 216 | completely removed from the system.</para> |
210 | </section> | 217 | </section> |
211 | </section> | 218 | </section> |
212 | 219 | ||
@@ -241,11 +248,12 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
241 | 248 | ||
242 | <note> | 249 | <note> |
243 | <para>Upgrading from Enea NFV Access 2.3.0 is not possible when using | 250 | <para>Upgrading from Enea NFV Access 2.3.0 is not possible when using |
244 | the Enea uCPE Manager in HTTPS mode. Either switch to HTTP by accessing | 251 | the Enea Edge Management application in HTTPS mode. Either switch to |
245 | <emphasis role="bold">System</emphasis>, <emphasis | 252 | HTTP by accessing the <emphasis role="bold">System</emphasis> menu, |
246 | role="bold">Configuration</emphasis>, <emphasis role="bold">Web | 253 | clicking on <emphasis role="bold">Configuration</emphasis>, then |
247 | Access</emphasis> and checking the <emphasis role="bold">Enable | 254 | <emphasis role="bold">Web Access</emphasis> and checking the <emphasis |
248 | HTTP</emphasis> box, or install Edge Enea 2.4.0 on the device manually.</para> | 255 | role="bold">Enable HTTP</emphasis> box, or by installing Edge Enea |
256 | 2.4.0 on the device manually.</para> | ||
249 | </note> | 257 | </note> |
250 | </section> | 258 | </section> |
251 | 259 | ||
@@ -379,8 +387,8 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
379 | when to run the upgrade.</para> | 387 | when to run the upgrade.</para> |
380 | 388 | ||
381 | <note> | 389 | <note> |
382 | <para>The hour represents the local Enea Edge Management server | 390 | <para>The hour represents the local Enea Edge Management |
383 | hour.</para> | 391 | application server hour.</para> |
384 | </note> | 392 | </note> |
385 | </listitem> | 393 | </listitem> |
386 | 394 | ||
@@ -577,8 +585,9 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
577 | Files</emphasis> tab by selecting the image file from the list and | 585 | Files</emphasis> tab by selecting the image file from the list and |
578 | clicking the <emphasis role="bold">Install on Device</emphasis> | 586 | clicking the <emphasis role="bold">Install on Device</emphasis> |
579 | button. The Image files that appear in the <emphasis role="bold">Image | 587 | button. The Image files that appear in the <emphasis role="bold">Image |
580 | Library</emphasis> tab can be uploaded to the Enea Edge Management Application | 588 | Library</emphasis> tab can be uploaded to the Enea Edge Management |
581 | by following the steps listed in <link linkend="image_lib">Image Library</link>.</para> | 589 | Application by following the steps listed in <link |
590 | linkend="image_lib">Image Library</link>.</para> | ||
582 | 591 | ||
583 | <para>Once an image is installed on the uCPE device, the image will be | 592 | <para>Once an image is installed on the uCPE device, the image will be |
584 | available on the uCPE device and be visible in the <emphasis | 593 | available on the uCPE device and be visible in the <emphasis |
@@ -588,16 +597,18 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
588 | <itemizedlist> | 597 | <itemizedlist> |
589 | <listitem> | 598 | <listitem> |
590 | <para>Select it from the list and then start the upgrade by | 599 | <para>Select it from the list and then start the upgrade by |
591 | clicking the <emphasis role="bold">Upgrade</emphasis> button.</para> | 600 | clicking the <emphasis role="bold">Upgrade</emphasis> |
601 | button.</para> | ||
592 | </listitem> | 602 | </listitem> |
593 | 603 | ||
594 | <listitem> | 604 | <listitem> |
595 | <para>Select <emphasis role="bold">Operations</emphasis>, then | 605 | <para>Select <emphasis role="bold">Operations</emphasis>, then |
596 | <emphasis role="bold">Upgrade</emphasis>, enter the | 606 | <emphasis role="bold">Upgrade</emphasis>, enter the |
597 | <literal>Release Name</literal> and press <emphasis | 607 | <literal>Release Name</literal> and press <emphasis |
598 | role="bold">Execute</emphasis>. Filling in the <literal>Restore Archive</literal> | 608 | role="bold">Execute</emphasis>. Filling in the <literal>Restore |
599 | text field is optional and should be left unset if the | 609 | Archive</literal> text field is optional and should be left unset |
600 | <literal>NFVi Snapshot</literal> feature is disabled.</para> | 610 | if the <literal>NFVi Snapshot</literal> feature is |
611 | disabled.</para> | ||
601 | </listitem> | 612 | </listitem> |
602 | </itemizedlist> | 613 | </itemizedlist> |
603 | 614 | ||
@@ -610,4 +621,4 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
610 | </section> | 621 | </section> |
611 | </section> | 622 | </section> |
612 | </section> | 623 | </section> |
613 | </chapter> | 624 | </chapter> \ No newline at end of file |
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 e3fcde2..058be40 100644 --- a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml +++ b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml | |||
@@ -1,18 +1,18 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="vnf_mg"> | 2 | <chapter id="vnf_mg"> |
3 | <title>VNF Management</title> | 3 | <title>VNF Management</title> |
4 | 4 | ||
5 | <para>The Enea Edge Management is responsible for onboarding, configuring | 5 | <para>The Enea Edge Management application is responsible for onboarding, |
6 | (e.g. CloudInit) and ensuring life cycle management of VNFs that are | 6 | configuring (e.g. CloudInit) and ensuring life cycle management of VNFs that |
7 | instantiated and run on the various uCPE devices.</para> | 7 | are instantiated and run on various uCPE devices.</para> |
8 | 8 | ||
9 | <section id="onboarding_a_vnf"> | 9 | <section id="onboarding_a_vnf"> |
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 | VNF Catalogue and preparing it for instantiation (deployment on connected | 13 | application VNF Catalogue and preparing it for instantiation (deployment |
14 | uCPE devices). This is accomplished using the Enea Edge Management | 14 | on connected uCPE devices). This is accomplished using the Enea Edge |
15 | Onboarding graphical user interface.</para> | 15 | Management Onboarding graphical user interface.</para> |
16 | 16 | ||
17 | <para>Typically, the Getting Started Guide of a VNF, provided by the VNF | 17 | <para>Typically, the Getting Started Guide of a VNF, provided by the VNF |
18 | vendor, contains all necessary information needed to onboard a VNF.</para> | 18 | vendor, contains all necessary information needed to onboard a VNF.</para> |
@@ -36,7 +36,8 @@ | |||
36 | <para>There are no standard ways of managing VNF licenses, | 36 | <para>There are no standard ways of managing VNF licenses, |
37 | therefore no general guidelines can be provided. One example of | 37 | therefore no general guidelines can be provided. One example of |
38 | license handling that can be employed in the Enea Edge Management | 38 | license handling that can be employed in the Enea Edge Management |
39 | is the adding of a license during the Cloud-Init setup.</para> | 39 | application is the adding of a license during the Cloud-Init |
40 | setup.</para> | ||
40 | </note> | 41 | </note> |
41 | </listitem> | 42 | </listitem> |
42 | 43 | ||
@@ -109,10 +110,10 @@ | |||
109 | </section> | 110 | </section> |
110 | 111 | ||
111 | <section id="onboard_in_ucpemg"> | 112 | <section id="onboard_in_ucpemg"> |
112 | <title>Onboarding into the Enea Edge Management</title> | 113 | <title>Onboarding into the Enea Edge Management application</title> |
113 | 114 | ||
114 | <para><emphasis role="bold">How to onboard a VNF into the Enea Edge | 115 | <para><emphasis role="bold">How to onboard a VNF into the Enea Edge |
115 | Management </emphasis></para> | 116 | Management application</emphasis></para> |
116 | 117 | ||
117 | <orderedlist> | 118 | <orderedlist> |
118 | <listitem> | 119 | <listitem> |
@@ -122,15 +123,15 @@ | |||
122 | </listitem> | 123 | </listitem> |
123 | 124 | ||
124 | <listitem> | 125 | <listitem> |
125 | <para>Click the <emphasis role="bold">On-board</emphasis> | 126 | <para>Click the <emphasis role="bold">Onboard</emphasis> |
126 | button.</para> | 127 | button.</para> |
127 | </listitem> | 128 | </listitem> |
128 | </orderedlist> | 129 | </orderedlist> |
129 | 130 | ||
130 | <para>This window contains data fields where both necessary and optional | 131 | <para>This window contains data fields where both necessary and optional |
131 | information about the VNF can be supplied. After doing so, press the | 132 | information about the VNF can be supplied. After doing so, press the |
132 | Onboard button, the Enea Edge Management will create the VNF descriptor | 133 | Onboard button and the Enea Edge Management application will create the |
133 | and add it to its VNF Catalog.</para> | 134 | VNF descriptor and add it to its VNF Catalog.</para> |
134 | 135 | ||
135 | <figure> | 136 | <figure> |
136 | <title>Onboard a VNF</title> | 137 | <title>Onboard a VNF</title> |
@@ -167,7 +168,7 @@ | |||
167 | <listitem> | 168 | <listitem> |
168 | <para><emphasis role="bold">Description</emphasis>. This field | 169 | <para><emphasis role="bold">Description</emphasis>. This field |
169 | contains any description provided and is only displayed in the GUI | 170 | contains any description provided and is only displayed in the GUI |
170 | tables in the Enea Edge Management.</para> | 171 | tables in the Enea Edge Management application.</para> |
171 | </listitem> | 172 | </listitem> |
172 | 173 | ||
173 | <listitem> | 174 | <listitem> |
@@ -206,11 +207,12 @@ | |||
206 | configured, when creating an instance. Consult the VNF vendor to | 207 | configured, when creating an instance. Consult the VNF vendor to |
207 | determine which and how many are required. Each interface requires a | 208 | determine which and how many are required. Each interface requires a |
208 | name, and optionally a description, used only by the Enea Edge | 209 | name, and optionally a description, used only by the Enea Edge |
209 | Management.</para> | 210 | Management application.</para> |
210 | 211 | ||
211 | <note> | 212 | <note> |
212 | <para>CAUTION: The user MUST conserve the same order for the virtual | 213 | <para>CAUTION: The user MUST save and use the same order for the |
213 | interfaces during both onboarding and instantiation phases.</para> | 214 | virtual interfaces during both the onboarding and instantiation |
215 | phases.</para> | ||
214 | </note> | 216 | </note> |
215 | 217 | ||
216 | <para><emphasis role="bold">Cloud Init Tab</emphasis></para> | 218 | <para><emphasis role="bold">Cloud Init Tab</emphasis></para> |
@@ -242,7 +244,7 @@ | |||
242 | 244 | ||
243 | <listitem> | 245 | <listitem> |
244 | <para><emphasis role="bold">NoCloud</emphasis>. This is a | 246 | <para><emphasis role="bold">NoCloud</emphasis>. This is a |
245 | simpler method that uses only one cloud init file | 247 | simpler method that uses only one cloud-init file |
246 | (User-Data).</para> | 248 | (User-Data).</para> |
247 | </listitem> | 249 | </listitem> |
248 | 250 | ||
@@ -269,14 +271,14 @@ | |||
269 | <para>The <literal>Content Files Table</literal> is ONLY used if | 271 | <para>The <literal>Content Files Table</literal> is ONLY used if |
270 | <literal>ConfigDrive</literal> is chosen as the Cloud-Init | 272 | <literal>ConfigDrive</literal> is chosen as the Cloud-Init |
271 | Datasource. For each content file added, a <literal>Path</literal> | 273 | Datasource. For each content file added, a <literal>Path</literal> |
272 | must be provided. When the Enea Edge Management is used to create an | 274 | must be provided. When the Enea Edge Management application is used |
273 | instance for multiple VNFs, the user will be prompted to provide a | 275 | to create an instance for multiple VNFs, the user will be prompted |
274 | data file for each entry in this table. Each type of VNF will | 276 | to provide a data file for each entry in this table. Each type of |
275 | require different cloud-init files, e.g.: a license file. The data | 277 | VNF will require different cloud-init files, e.g.: a license file. |
276 | files will be added to the cloud-init image that the user provides | 278 | The data files will be added to the cloud-init image that the user |
277 | at the instantiation of the VNF. If the cloud-init image is not | 279 | provides at the instantiation of the VNF. If the cloud-init image is |
278 | provided, no Cloud-Init Data Source will be created for that VNF and | 280 | not provided, no Cloud-Init Data Source will be created for that VNF |
279 | there will be no warning.</para> | 281 | and there will be no warning.</para> |
280 | </listitem> | 282 | </listitem> |
281 | </orderedlist> | 283 | </orderedlist> |
282 | 284 | ||
@@ -407,8 +409,9 @@ | |||
407 | </listitem> | 409 | </listitem> |
408 | </orderedlist> | 410 | </orderedlist> |
409 | 411 | ||
410 | <para>Selecting the <emphasis role="bold">VNF</emphasis> menu then choosing <emphasis role="bold">Events</emphasis> | 412 | <para>Selecting the <emphasis role="bold">VNF</emphasis> menu then |
411 | will show that the VNF was created and a connection was established.</para> | 413 | choosing <emphasis role="bold">Events</emphasis> will show that the VNF |
414 | was created and a connection was established.</para> | ||
412 | </section> | 415 | </section> |
413 | 416 | ||
414 | <section id="vm_operations"> | 417 | <section id="vm_operations"> |
@@ -430,7 +433,7 @@ | |||
430 | <listitem> | 433 | <listitem> |
431 | <para>Depending on the desired action, click the <emphasis | 434 | <para>Depending on the desired action, click the <emphasis |
432 | role="bold">Delete/ Force Delete / Start / Stop / Pause / | 435 | role="bold">Delete/ Force Delete / Start / Stop / Pause / |
433 | Resume</emphasis> button respectively.</para> | 436 | Resume</emphasis> button, respectively.</para> |
434 | </listitem> | 437 | </listitem> |
435 | </orderedlist> | 438 | </orderedlist> |
436 | 439 | ||
@@ -443,15 +446,15 @@ | |||
443 | 446 | ||
444 | <listitem> | 447 | <listitem> |
445 | <para>Depending on the desired action, choosing <emphasis | 448 | <para>Depending on the desired action, choosing <emphasis |
446 | role="bold">Destroy / Start / Stop / Pause / Resume | 449 | role="bold">Destroy / Start / Stop / Pause / Resume VM</emphasis> |
447 | VM</emphasis> respectively.</para> | 450 | respectively.</para> |
448 | </listitem> | 451 | </listitem> |
449 | 452 | ||
450 | <listitem> | 453 | <listitem> |
451 | <para>The <literal>Id</literal> of the VM that should be modified can | 454 | <para>The <literal>Id</literal> of the VM that should be modified can |
452 | be found by selecting <emphasis role="bold">Configuration</emphasis>, then | 455 | be found by selecting <emphasis role="bold">Configuration</emphasis>, |
453 | <emphasis role="bold">Virtual Machines</emphasis>, and then accessing the <emphasis | 456 | then <emphasis role="bold">Virtual Machines</emphasis>, and then |
454 | role="bold">VMs</emphasis> tab.</para> | 457 | accessing the <emphasis role="bold">VMs</emphasis> tab.</para> |
455 | </listitem> | 458 | </listitem> |
456 | 459 | ||
457 | <listitem> | 460 | <listitem> |
@@ -471,9 +474,9 @@ | |||
471 | 474 | ||
472 | <orderedlist> | 475 | <orderedlist> |
473 | <listitem> | 476 | <listitem> |
474 | <para>SSH to the uCPE device from the Enea Edge Management (Access the | 477 | <para>SSH to the uCPE device from the Enea Edge Management application |
475 | <emphasis role="bold">Device</emphasis> menu and select <emphasis | 478 | (access the <emphasis role="bold">Device</emphasis> menu and select |
476 | role="bold">SSH</emphasis>) using:</para> | 479 | <emphasis role="bold">SSH</emphasis>) using:</para> |
477 | 480 | ||
478 | <itemizedlist> | 481 | <itemizedlist> |
479 | <listitem> | 482 | <listitem> |
@@ -484,13 +487,13 @@ | |||
484 | </listitem> | 487 | </listitem> |
485 | 488 | ||
486 | <listitem> | 489 | <listitem> |
487 | <para>For reverse ssh connections (ssh to a uCPE device behind | 490 | <para>For reverse SSH connections (SSH to a uCPE device behind |
488 | NAT): the <literal>Username</literal> (default: root) and the | 491 | NAT): the <literal>Username</literal> (default: root) and the |
489 | <literal>Reverse ssh</literal> checkbox checked. The port will be | 492 | <literal>Reverse SSH</literal> checkbox checked. The port will be |
490 | automatically chosen by the Enea Edge Management in the range | 493 | automatically chosen by the Enea Edge Management application in |
491 | defined in the <emphasis role="bold">SSH</emphasis> configuration | 494 | the range defined in the <emphasis role="bold">SSH</emphasis> |
492 | panel, available when accessing <emphasis | 495 | configuration panel, available when accessing the <emphasis |
493 | role="bold">System</emphasis>, then <emphasis | 496 | role="bold">System</emphasis> menu, then <emphasis |
494 | role="bold">Configuration</emphasis> and choosing <emphasis | 497 | role="bold">Configuration</emphasis> and choosing <emphasis |
495 | role="bold">Reverse SSH</emphasis> . By default, the start port | 498 | role="bold">Reverse SSH</emphasis> . By default, the start port |
496 | will be <literal>7000</literal> and the maximum number of ports | 499 | will be <literal>7000</literal> and the maximum number of ports |
@@ -523,4 +526,4 @@ | |||
523 | </listitem> | 526 | </listitem> |
524 | </orderedlist> | 527 | </orderedlist> |
525 | </section> | 528 | </section> |
526 | </chapter> | 529 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-edge-management-open-source/doc/about.xml b/doc/book-enea-edge-management-open-source/doc/about.xml index 758efc9..e13cd41 100644 --- a/doc/book-enea-edge-management-open-source/doc/about.xml +++ b/doc/book-enea-edge-management-open-source/doc/about.xml | |||
@@ -5,8 +5,8 @@ | |||
5 | <title>About this Report</title> | 5 | <title>About this Report</title> |
6 | 6 | ||
7 | <para>This document contains the open source and license information | 7 | <para>This document contains the open source and license information |
8 | pertaining to packages relating to the Enea Edge Management provided | 8 | pertaining to packages relating to the Enea Edge Management application |
9 | with Enea Edge <xi:include | 9 | provided with Enea Edge <xi:include |
10 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" | 10 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" |
11 | xmlns:xi="http://www.w3.org/2001/XInclude" | 11 | xmlns:xi="http://www.w3.org/2001/XInclude" |
12 | xpointer="element(EneaLinux_REL_VER/1)" />.</para> | 12 | xpointer="element(EneaLinux_REL_VER/1)" />.</para> |
diff --git a/doc/book-enea-edge-release-info/doc/about_release.xml b/doc/book-enea-edge-release-info/doc/about_release.xml index 766c02a..349c955 100644 --- a/doc/book-enea-edge-release-info/doc/about_release.xml +++ b/doc/book-enea-edge-release-info/doc/about_release.xml | |||
@@ -4,26 +4,28 @@ | |||
4 | <chapter id="relinfo-about-release"> | 4 | <chapter id="relinfo-about-release"> |
5 | <title>About This Release</title> | 5 | <title>About This Release</title> |
6 | 6 | ||
7 | <para>Enea Edge is a complete NFVI software platform designed for deployment | 7 | <para>Enea Edge is a complete Virtualization Infrastructure software |
8 | on any white box uCPE device, and optimized for common use cases. Enea Edge | 8 | platform designed for deployment on any white box uCPE device, and optimized |
9 | includes both the Enea Edge Runtime deployed on a white box, and a | 9 | for common use-cases. It includes the Enea Edge Runtime deployed |
10 | management component with automation tools deployed in a private or public | 10 | on a white box, the Enea Edge Management application and the Enea Edge |
11 | cloud.</para> | 11 | Automation, management and automation tools deployed in a |
12 | private or public cloud.</para> | ||
12 | 13 | ||
13 | <para>The Enea Edge <xi:include | 14 | <para>The Enea Edge <xi:include |
14 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" | 15 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" |
15 | xmlns:xi="http://www.w3.org/2001/XInclude" | 16 | xmlns:xi="http://www.w3.org/2001/XInclude" |
16 | xpointer="element(EneaLinux_REL_VER/1)" /> Release includes a new version of | 17 | xpointer="element(EneaLinux_REL_VER/1)" /> Release includes new features, |
17 | the major components as well as other features and optimizations, and | 18 | optimizations, corrections, and updates to the user documentation.. |
18 | documentation updates. A list of new features and improvements can be found | 19 | A list of major new features and improvements can be found in |
19 | in <xref linkend="relinfo-changes-other">Section 2.1 New Features and | 20 | <xref linkend="relinfo-changes-other">Section 2.1 New Features and Improvements</xref>.</para> |
20 | Improvements</xref>.</para> | 21 | |
21 | |||
22 | <section id="release-content"> | 22 | <section id="release-content"> |
23 | <title>Enea Edge Release Content</title> | 23 | <title>Enea Edge Release Content</title> |
24 | 24 | ||
25 | <para>The release content is detailed below:</para> | 25 | <para>The release content is detailed below:</para> |
26 | 26 | ||
27 | <para>Main Components</para> | ||
28 | |||
27 | <itemizedlist> | 29 | <itemizedlist> |
28 | <listitem> | 30 | <listitem> |
29 | <para>Enea_Edge_Runtime_C3000_<version>-build<build_number>.tar.gz</para> | 31 | <para>Enea_Edge_Runtime_C3000_<version>-build<build_number>.tar.gz</para> |
@@ -42,17 +44,21 @@ | |||
42 | </listitem> | 44 | </listitem> |
43 | 45 | ||
44 | <listitem> | 46 | <listitem> |
45 | <para>Enea_Edge_Telemetry_Deploy_<version>-build<build_number>.tar.gz</para> | 47 | <para>Enea_Edge_AF-TH_<version>-build<build_number>.zip |
48 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New | ||
49 | Features and Improvements</xref>.)</para> | ||
46 | </listitem> | 50 | </listitem> |
51 | </itemizedlist> | ||
47 | 52 | ||
53 | <para>Example Deployments:</para> | ||
54 | |||
55 | <itemizedlist> | ||
48 | <listitem> | 56 | <listitem> |
49 | <para>VNF_example_configurations.tar.gz</para> | 57 | <para>Enea_Edge_Telemetry_Deploy_<version>-build<build_number>.tar.gz</para> |
50 | </listitem> | 58 | </listitem> |
51 | 59 | ||
52 | <listitem> | 60 | <listitem> |
53 | <para>Enea_Edge_AF-TH_<version>-build<build_number>.zip | 61 | <para>VNF_example_configurations.tar.gz</para> |
54 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New | ||
55 | Features and Improvements</xref>.)</para> | ||
56 | </listitem> | 62 | </listitem> |
57 | </itemizedlist> | 63 | </itemizedlist> |
58 | 64 | ||
@@ -135,17 +141,17 @@ | |||
135 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 141 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
136 | xmlns:xi="http://www.w3.org/2001/XInclude" | 142 | xmlns:xi="http://www.w3.org/2001/XInclude" |
137 | xpointer="element(book_enea_edge_automation_user_guide/1)" />. | 143 | xpointer="element(book_enea_edge_automation_user_guide/1)" />. |
138 | Describes the Enea Edge Automation and provides instructions regarding | 144 | Describes the Enea Edge Automation and provides instructions regarding |
139 | the necessary steps to configure and run the tool.</para> | 145 | the necessary steps to configure and run the tool.</para> |
140 | </listitem> | 146 | </listitem> |
141 | 147 | ||
142 | <listitem> | 148 | <listitem> |
143 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 149 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
144 | xmlns:xi="http://www.w3.org/2001/XInclude" | 150 | xmlns:xi="http://www.w3.org/2001/XInclude" |
145 | xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" />. | 151 | xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" />. |
146 | Describes the Automation Framework and Test Harness for Enea Edge | 152 | Describes the Automation Framework and Test Harness for Enea Edge |
147 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 | 153 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New |
148 | New Features and Improvements</xref>).</para> | 154 | Features and Improvements</xref>).</para> |
149 | </listitem> | 155 | </listitem> |
150 | 156 | ||
151 | <listitem> | 157 | <listitem> |
@@ -167,15 +173,15 @@ | |||
167 | 173 | ||
168 | <itemizedlist> | 174 | <itemizedlist> |
169 | <listitem> | 175 | <listitem> |
170 | <para>Google Chrome (tested with version 86).</para> | 176 | <para>Google Chrome (tested with version 89).</para> |
171 | </listitem> | 177 | </listitem> |
172 | 178 | ||
173 | <listitem> | 179 | <listitem> |
174 | <para>Mozilla Firefox (tested with version 82).</para> | 180 | <para>Mozilla Firefox (tested with version 87).</para> |
175 | </listitem> | 181 | </listitem> |
176 | 182 | ||
177 | <listitem> | 183 | <listitem> |
178 | <para>Microsoft Edge (tested with version 84).</para> | 184 | <para>Microsoft Edge (tested with version 89).</para> |
179 | </listitem> | 185 | </listitem> |
180 | </itemizedlist> | 186 | </itemizedlist> |
181 | </section> | 187 | </section> |
diff --git a/doc/book-enea-edge-release-info/doc/book.xml b/doc/book-enea-edge-release-info/doc/book.xml index b886ee1..0b77f41 100644 --- a/doc/book-enea-edge-release-info/doc/book.xml +++ b/doc/book-enea-edge-release-info/doc/book.xml | |||
@@ -1,4 +1,4 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
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,9 +7,10 @@ | |||
7 | <title><trademark class="registered">Enea</trademark> Edge Release | 7 | <title><trademark class="registered">Enea</trademark> Edge Release |
8 | Information</title> | 8 | Information</title> |
9 | 9 | ||
10 | <subtitle>Release Version | 10 | <subtitle>Release Version <xi:include |
11 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" | 11 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" |
12 | xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> | 12 | xmlns:xi="http://www.w3.org/2001/XInclude" |
13 | xpointer="element(EneaLinux_REL_VER/1)" /></subtitle> | ||
13 | 14 | ||
14 | <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> | 15 | <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> |
15 | 16 | ||
@@ -27,4 +28,4 @@ | |||
27 | 28 | ||
28 | <xi:include href="../../s_docbuild/template/docsrc_common/contacting_enea_nfva.xml" | 29 | <xi:include href="../../s_docbuild/template/docsrc_common/contacting_enea_nfva.xml" |
29 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 30 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
30 | </book> | 31 | </book> \ No newline at end of file |
diff --git a/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml index 4f3eb7a..0fdb9aa 100644 --- a/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml +++ b/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml | |||
@@ -20,14 +20,20 @@ | |||
20 | 20 | ||
21 | <listitem> | 21 | <listitem> |
22 | <para><remark>ELCCR-527</remark>Cancelling a file upload in the Enea | 22 | <para><remark>ELCCR-527</remark>Cancelling a file upload in the Enea |
23 | Edge Management will require the user to close and reopen the upload window | 23 | Edge Management will require the user to close and reopen the upload |
24 | for the next upload to work.</para> | 24 | window for the next upload to work.</para> |
25 | </listitem> | 25 | </listitem> |
26 | 26 | ||
27 | <listitem> | 27 | <listitem> |
28 | <para><remark>ELCCR-577</remark>If Enea Edge Management is restored from a backup | 28 | <para><remark>ELCCR-577</remark>If the Enea Edge Management application |
29 | made on a release version older than Enea NFV Access 2.2.3, VNFs cannot be instantiated | 29 | is restored from a backup made on a release version older than Enea NFV |
30 | from the GUI.</para> | 30 | Access 2.2.3, VNFs cannot be instantiated from the GUI.</para> |
31 | </listitem> | ||
32 | |||
33 | <listitem> | ||
34 | <para><remark>ELCCR-1134</remark>In order to avoid an incorrect boot | ||
35 | order after a failed upgrade, the user should remove the upgrade | ||
36 | image before attempting again.</para> | ||
31 | </listitem> | 37 | </listitem> |
32 | 38 | ||
33 | <listitem> | 39 | <listitem> |
@@ -45,7 +51,8 @@ | |||
45 | <listitem> | 51 | <listitem> |
46 | <para><remark>ELCCR-847</remark>The Juniper vSRX VNF cannot be | 52 | <para><remark>ELCCR-847</remark>The Juniper vSRX VNF cannot be |
47 | instantiated on the Xeon-D architectures due to missing CPU features in | 53 | instantiated on the Xeon-D architectures due to missing CPU features in |
48 | the VNF's domain XML. This impacts all example use cases where the Juniper VNF is used.</para> | 54 | the VNF's domain XML. This impacts all example use cases where the |
55 | Juniper VNF is used.</para> | ||
49 | </listitem> | 56 | </listitem> |
50 | 57 | ||
51 | <listitem> | 58 | <listitem> |
@@ -60,64 +67,53 @@ | |||
60 | to be connected to a network with at least a router/gateway installed | 67 | to be connected to a network with at least a router/gateway installed |
61 | for next-hop communication.</para> | 68 | for next-hop communication.</para> |
62 | </listitem> | 69 | </listitem> |
70 | |||
71 | <listitem> | ||
72 | <para><remark>ELCCR-1504</remark>To change the type of an interface | ||
73 | from DPDK to SR-IOV, first delete the existing interface, then | ||
74 | recreate it with the desired type.</para> | ||
75 | </listitem> | ||
63 | 76 | ||
64 | <listitem> | 77 | <listitem> |
65 | <para><remark>LXCR-9992</remark>Depending on hardware capabilities, | 78 | <para><remark>LXCR-9992</remark>Depending on hardware capabilities, |
66 | there are certain limitations regarding the <literal>vfio-pci</literal> | 79 | there are certain limitations regarding the <literal>vfio-pci</literal> |
67 | and <literal>igb_uio</literal> drivers. While the Enea Edge | 80 | and <literal>igb_uio</literal> drivers. While the Enea Edge Runtime uses |
68 | Runtime uses the <literal>vfio-pci</literal> driver by default, | 81 | the <literal>vfio-pci</literal> driver by default, for certain hardware |
69 | for certain hardware configurations, <literal>igb_uio</literal> should | 82 | configurations, <literal>igb_uio</literal> should be used instead, by |
70 | be used instead, by providing custom scripting. Please contact Enea for | 83 | providing custom scripting. Please contact Enea for further |
71 | further details.</para> | 84 | details.</para> |
72 | </listitem> | 85 | </listitem> |
73 | 86 | ||
74 | <listitem> | 87 | <listitem> |
75 | <para><remark>STCR-6224</remark>The Enea Edge Automation | 88 | <para><remark>STCR-6224</remark>The Enea Edge Automation and the Enea |
76 | and the Enea Edge Automation Framework and Test Harness do not | 89 | Edge Automation Framework and Test Harness do not support multiple |
77 | support multiple custom scripts uploaded to a uCPE device at the same | 90 | custom scripts uploaded to a uCPE device at the same time.</para> |
78 | time.</para> | ||
79 | </listitem> | 91 | </listitem> |
80 | 92 | ||
81 | <listitem> | 93 | <listitem> |
82 | <para><remark>STCR-6292</remark>Management of WAN Interfaces is not | 94 | <para><remark>STCR-6292</remark>Management of WAN Interfaces is not |
83 | implemented in the Enea Edge Automation Framework and Test Harness.</para> | 95 | implemented in the Enea Edge Automation Framework and Test |
84 | </listitem> | 96 | Harness.</para> |
85 | |||
86 | <listitem> | ||
87 | <para><remark>USERDOCAP-628</remark>Enea Edge Automation Framework | ||
88 | and Test Harness does not have support for product features implemented | ||
89 | in Enea Edge 2.4.0 or newer.</para> | ||
90 | </listitem> | 97 | </listitem> |
91 | 98 | ||
92 | <listitem> | 99 | <listitem> |
93 | <para><remark>ELCCR-912</remark>When the Enea Edge Management is installed | 100 | <para><remark>USERDOCAP-628</remark>Enea Edge Automation Framework and |
94 | on CentOS 7, prior to C7.1804 (kernel version 3.10.0-862), adding an | 101 | Test Harness does not have support for product features implemented in |
95 | upgrade image fails. As a workaround, please update | 102 | Enea Edge 2.4.0 or newer.</para> |
96 | <literal>glib2</literal> to version 2.54.2 or later, using <literal>#yum | ||
97 | update glib2</literal>.</para> | ||
98 | </listitem> | 103 | </listitem> |
99 | 104 | ||
100 | <listitem> | 105 | <listitem> |
101 | <para><remark>ELCCR-854</remark>Changing the management interface IP | 106 | <para><remark>ELCCR-912</remark>When the Enea Edge Management |
102 | address will result in a temporary loss of connection with the uCPE | 107 | application is installed on CentOS 7, prior to C7.1804 (kernel version |
103 | device. If the device is behind a NAT, while using the Call Home | 108 | 3.10.0-862), adding an upgrade image fails. As a workaround, please |
104 | connection, reestablishing the connection automatically could take up to | 109 | update <literal>glib2</literal> to version 2.54.2 or later, using |
105 | 20 minutes. Restarting the vCPE Overlay will immediately reestablish the | 110 | <literal>#yum update glib2</literal>.</para> |
106 | connection, but that implies the existence of an alternate way to | ||
107 | trigger the vCPE restart operation on the device.</para> | ||
108 | </listitem> | 111 | </listitem> |
109 | 112 | ||
110 | <listitem> | 113 | <listitem> |
111 | <para><remark>USERDOCAP-641</remark>Enea Edge does not have | 114 | <para><remark>USERDOCAP-641</remark>Enea Edge does not have support for |
112 | support for IPv6 addresses on both uCPE devices and the Enea Edge | 115 | IPv6 addresses on both uCPE devices and the Enea Edge Management |
113 | Management installation.</para> | 116 | installation.</para> |
114 | </listitem> | ||
115 | |||
116 | <listitem> | ||
117 | <para><remark>ELCCR-1428</remark>Wireless AP creation through the REST | ||
118 | API does not validate that the wireless interface and LAN bridge are | ||
119 | configured. Using these parameters may result in undefined | ||
120 | behavior.</para> | ||
121 | </listitem> | 117 | </listitem> |
122 | 118 | ||
123 | <listitem> | 119 | <listitem> |
@@ -128,6 +124,11 @@ | |||
128 | </listitem> | 124 | </listitem> |
129 | 125 | ||
130 | <listitem> | 126 | <listitem> |
127 | <para><remark>ELCCR-1518</remark>The Wireless AP's wpa2psk password | ||
128 | should not contain white space characters.</para> | ||
129 | </listitem> | ||
130 | |||
131 | <listitem> | ||
131 | <para><remark>ELCCR-1351</remark>The updated | 132 | <para><remark>ELCCR-1351</remark>The updated |
132 | <filename>.Keystore</filename> and <filename>server.xml</filename> files | 133 | <filename>.Keystore</filename> and <filename>server.xml</filename> files |
133 | from the | 134 | from the |
@@ -142,10 +143,10 @@ | |||
142 | 143 | ||
143 | <listitem> | 144 | <listitem> |
144 | <para><remark>ELCCR-1371</remark>The current self-signed certificate for | 145 | <para><remark>ELCCR-1371</remark>The current self-signed certificate for |
145 | the Enea Edge Management is generated at build time, with a hard-coded | 146 | the Enea Edge Management application is generated at build time, with a |
146 | common-name causing the uCPE device upgrade to fail in HTTPS mode. As a | 147 | hard-coded common-name causing the uCPE device upgrade to fail in HTTPS |
147 | workaround, another certificate (containing an IP based common-name) | 148 | mode. As a workaround, another certificate (containing an IP based |
148 | must be generated.</para> | 149 | common-name) must be generated.</para> |
149 | 150 | ||
150 | <para>Perform the following the steps to generate the | 151 | <para>Perform the following the steps to generate the |
151 | certificate:</para> | 152 | certificate:</para> |
@@ -165,8 +166,8 @@ | |||
165 | </listitem> | 166 | </listitem> |
166 | 167 | ||
167 | <listitem> | 168 | <listitem> |
168 | <para>Start the Enea Edge Management, the new certificate should now | 169 | <para>Start the Enea Edge Management application, the new |
169 | take effect.</para> | 170 | certificate should now take effect.</para> |
170 | </listitem> | 171 | </listitem> |
171 | </orderedlist> | 172 | </orderedlist> |
172 | </listitem> | 173 | </listitem> |
@@ -177,14 +178,24 @@ | |||
177 | to delete the old interfaces and recreate them with the desired | 178 | to delete the old interfaces and recreate them with the desired |
178 | type.</para> | 179 | type.</para> |
179 | </listitem> | 180 | </listitem> |
180 | 181 | ||
182 | <listitem> | ||
183 | <para><remark>ELCCR-1497</remark>If the Enea Edge Management application | ||
184 | has an incorrect database configuration, when performing an uninstallation, | ||
185 | the Tomcat instance and Watchdog service will not be stopped automatically. | ||
186 | Instead, they must be killed explicitly.</para> | ||
187 | </listitem> | ||
188 | |||
181 | <listitem> | 189 | <listitem> |
182 | <para><remark>ELCCR-907</remark>At times the VIP address is not acquired | 190 | <para><remark>ELCCR-1468</remark>When using the Enea Edge Management |
183 | by any of the backup nodes if a power failure happens on primary node in | 191 | application in HTTPS mode, upgrading a device from NFV Access 2.3.0 is |
184 | a High Availability setup. To recover, follow the official documentation | 192 | not possible. Either switch to HTTP mode (for more details see <olink |
185 | available at <ulink | 193 | targetdoc="book_enea_edge_getting_started" |
186 | url="https://mariadb.com/kb/en/galera-cluster-recovery/">Galera Cluster | 194 | targetptr="device_up_process">The uCPE device Upgrade Process in the |
187 | Recovery</ulink>.</para> | 195 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
196 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
197 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> Manual) | ||
198 | or install it manually.</para> | ||
188 | </listitem> | 199 | </listitem> |
189 | 200 | ||
190 | <listitem condition="hidden"> | 201 | <listitem condition="hidden"> |
@@ -196,18 +207,6 @@ | |||
196 | in an external PDF reader. As a workaround, open the HTML version of the | 207 | in an external PDF reader. As a workaround, open the HTML version of the |
197 | document.</para> | 208 | document.</para> |
198 | </listitem> | 209 | </listitem> |
199 | |||
200 | <listitem> | ||
201 | <para><remark>ELCCR-1468</remark>When using the Enea Edge Management in | ||
202 | HTTPS mode, upgrading a device from NFV Access 2.3.0 is not possible. | ||
203 | Either switch to HTTP mode (for more details see <olink | ||
204 | targetdoc="book_enea_edge_getting_started" | ||
205 | targetptr="device_up_process">The uCPE device Upgrade Process in the | ||
206 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
207 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
208 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> | ||
209 | Manual) or install it manually.</para> | ||
210 | </listitem> | ||
211 | </itemizedlist> | 210 | </itemizedlist> |
212 | 211 | ||
213 | <!-- The file with a section below is autocreated by make init --> | 212 | <!-- The file with a section below is autocreated by make init --> |
diff --git a/doc/book-enea-edge-release-info/doc/main_changes.xml b/doc/book-enea-edge-release-info/doc/main_changes.xml index 63c2216..aafb31c 100644 --- a/doc/book-enea-edge-release-info/doc/main_changes.xml +++ b/doc/book-enea-edge-release-info/doc/main_changes.xml | |||
@@ -16,35 +16,59 @@ | |||
16 | <itemizedlist> | 16 | <itemizedlist> |
17 | <listitem> | 17 | <listitem> |
18 | <para><remark>CPDX-3496</remark>Embedded WiFi support for all-in-one | 18 | <para><remark>CPDX-3496</remark>Embedded WiFi support for all-in-one |
19 | store/home office deployment.</para> | 19 | store/home office deployment. For more details please see the <olink |
20 | targetdoc="book_enea_edge_getting_started" | ||
21 | targetptr="wap_interface_type">Wap Interface Type in the <xi:include | ||
22 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
23 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
24 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> | ||
25 | Manual.</para> | ||
20 | </listitem> | 26 | </listitem> |
21 | 27 | ||
22 | <listitem> | 28 | <listitem> |
23 | <para><remark>CPDX-3499</remark>Expanded hardware, OS and network | 29 | <para><remark>CPDX-3499</remark>Expanded hardware, OS and network |
24 | monitoring capability with Grafana integration.</para> | 30 | monitoring capability with Grafana integration. For more details |
31 | please see <olink targetdoc="book_enea_edge_getting_started" | ||
32 | targetptr="grafana">Using Grafana and InfluxDB in the <xi:include | ||
33 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
34 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
35 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> | ||
36 | Manual.</para> | ||
25 | </listitem> | 37 | </listitem> |
26 | 38 | ||
27 | <listitem> | 39 | <listitem> |
28 | <para><remark>CPDX-3407</remark>HTTPS based downloads of VNFs for | 40 | <para><remark>CPDX-3407</remark>HTTPS based downloads of VNFs for |
29 | simplified deployment of the Enea Edge Management in cloud | 41 | simplified deployment of the Enea Edge Management application in cloud |
30 | environments.</para> | 42 | environments. For more details please see <olink |
43 | targetdoc="book_enea_edge_getting_started" | ||
44 | targetptr="fresh_ucpemg_install">Fresh Installation of the Enea uCPE | ||
45 | Manager in the <xi:include | ||
46 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
47 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
48 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> | ||
49 | Manual.</para> | ||
31 | </listitem> | 50 | </listitem> |
32 | 51 | ||
33 | <listitem> | 52 | <listitem> |
34 | <para><remark>CPDX-3500</remark>The Enea Edge Automation, a tool for | 53 | <para><remark>CPDX-3500</remark>Enea Edge Automation, a tool for |
35 | automatic system configuration based on Python scripting that will | 54 | automatic system configuration based on Python scripting that will |
36 | replace the existing Enea Edge Automation Framework and Test Harness | 55 | replace the existing Enea Edge Automation Framework and Test Harness |
37 | in the next major release.</para> | 56 | in the next major release. For more details please see the <ns:include |
38 | |||
39 | <para>The Enea Edge Automation Framework and Test Harness, and its | ||
40 | related documentation the <xi:include | ||
41 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | 57 | href="../../s_docbuild/olinkdb/pardoc-common.xml" |
42 | xmlns:xi="http://www.w3.org/2001/XInclude" | 58 | xmlns:ns="http://www.w3.org/2001/XInclude" |
43 | xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" /> and the | 59 | xpointer="element(book_enea_edge_automation_user_guide/1)" />.</para> |
44 | <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | 60 | |
45 | xmlns:xi="http://www.w3.org/2001/XInclude" | 61 | <note> |
46 | xpointer="element(book_enea_edge_system_test_specification/1)" /> are | 62 | <para>The Enea Edge Automation Framework and Test Harness, and its |
47 | deprecated starting with Enea Edge 2.4.0.</para> | 63 | related documentation the <ns:include |
64 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
65 | xmlns:ns="http://www.w3.org/2001/XInclude" | ||
66 | xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" /> and | ||
67 | the <ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
68 | xmlns:ns="http://www.w3.org/2001/XInclude" | ||
69 | xpointer="element(book_enea_edge_system_test_specification/1)" /> | ||
70 | are deprecated starting with Enea Edge 2.4.0.</para> | ||
71 | </note> | ||
48 | </listitem> | 72 | </listitem> |
49 | </itemizedlist> | 73 | </itemizedlist> |
50 | 74 | ||
@@ -87,22 +111,22 @@ | |||
87 | </listitem> | 111 | </listitem> |
88 | 112 | ||
89 | <listitem> | 113 | <listitem> |
90 | <para>Platform and VNF Snapshots (made originally available starting | 114 | <para>Platform and VNF Snapshots (made originally available starting |
91 | with Enea NFV Access 2.3.0).</para> | 115 | with Enea NFV Access 2.3.0).</para> |
92 | 116 | ||
93 | <para>Platform Snapshots allow users to store, manage and restore | 117 | <para>Platform Snapshots allow users to store, manage and restore |
94 | snapshots of the Enea Edge Runtime configuration, with the purpose | 118 | snapshots of the Enea Edge Runtime configuration, with the purpose of |
95 | of recovering after a failed reconfiguration. This feature is | 119 | recovering after a failed reconfiguration. This feature is disabled by |
96 | disabled by default.</para> | 120 | default.</para> |
97 | 121 | ||
98 | <para>VNF Snapshots allow users to store, manage and restore | 122 | <para>VNF Snapshots allow users to store, manage and restore snapshots |
99 | snapshots of VNFs deployed on the Enea Edge Runtime, with the | 123 | of VNFs deployed on the Enea Edge Runtime, with the purpose of |
100 | purpose of restoring the VNF after a persistent VNF failure. This | 124 | restoring the VNF after a persistent VNF failure. This feature is |
101 | feature is disabled by default.</para> | 125 | disabled by default.</para> |
102 | 126 | ||
103 | <note> | 127 | <note> |
104 | <para>Users that would like to try out the Snapshot features should | 128 | <para>Users that would like to try out the Early Access features |
105 | contact Enea Support for additional documentation and | 129 | should contact Enea Support for additional documentation and |
106 | assistance.</para> | 130 | assistance.</para> |
107 | </note> | 131 | </note> |
108 | </listitem> | 132 | </listitem> |
diff --git a/doc/docsrc_common/pardoc-distro.xml b/doc/docsrc_common/pardoc-distro.xml index fce0543..b6bc8bb 100644 --- a/doc/docsrc_common/pardoc-distro.xml +++ b/doc/docsrc_common/pardoc-distro.xml | |||
@@ -1,31 +1,57 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 2 | <!DOCTYPE section 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 | |||
5 | <!-- Declarations to inherit by xi:include | 4 | <!-- Declarations to inherit by xi:include |
6 | ========================================== --> | 5 | ========================================== --> |
7 | <section id="pardoc_names"> | 6 | <section id="pardoc_names"> |
8 | <title>Enea NFV Access DocBook XML Based UserDoc Names and Parameters</title> | 7 | <title>Enea NFV Access DocBook XML Based UserDoc Names and |
8 | Parameters</title> | ||
9 | 9 | ||
10 | <para>NOTE: DO NOT EDIT THIS FILE IN xmlmind but you can open it to see any errors, don't save!!!!</para> | 10 | <para>NOTE: DO NOT EDIT THIS FILE IN xmlmind but you can open it to see any |
11 | errors, don't save!!!</para> | ||
11 | 12 | ||
12 | <para>NOTE: Use xi:include to include parameters into a docbook XML file. | 13 | <para>NOTE: Use xi:include to include parameters into a docbook XML file. |
13 | Note: Only full elements can be included and the included element must | 14 | Note: Only full elements can be included and the included element must be |
14 | be allowed in that place. Example: For ulink, entire ulink elements | 15 | allowed in that place. Example: For ulink, entire ulink elements must be |
15 | must be included, not just parts of them.</para> | 16 | included, not just parts of them.</para> |
16 | 17 | ||
17 | <para>**** The phrase elements below can be used as variables in several | 18 | <para>**** The phrase elements below can be used as variables in several |
18 | places in XML files and/or in make script files ****</para> | 19 | places in XML files and/or in make script files ****</para> |
20 | |||
21 | <!-- Distribution and release --> | ||
19 | 22 | ||
20 | <!-- Distribution and release --> | 23 | <!-- |
21 | <!-- | ||
22 | The parameter 'prev_baseline' is intentionally undefined here since this | 24 | The parameter 'prev_baseline' is intentionally undefined here since this |
23 | is the first release of the networking profile. The line must be removed. | 25 | is the first release of the networking profile. The line must be removed. |
24 | --> | 26 | --> |
25 | <para id="prev_lic_file"><phrase>doc/book-enea-nfv-access-open-source/doc/licenses.xml</phrase></para> | 27 | |
26 | <para id="new_lic_file"><phrase>doc/book-enea-nfv-access-open-source/doc/licenses.xml</phrase></para> | 28 | <para |
27 | <para id="prev_lic_file"><phrase>doc/book-enea-nfv-access-openstack-open-source/doc/licenses.xml</phrase></para> | 29 | id="prev_lic_file"><phrase>doc/book_enea_edge_runtime_open_source/doc/licenses.xml</phrase></para> |
28 | <para id="new_lic_file"><phrase>book-enea-nfv-access-openstack-open-source/doc/licenses.xml</phrase></para> | 30 | |
29 | <para id="prev_lic_file"><phrase>doc/book-enea-nfv-access-dev-open-source/doc/licenses.xml</phrase></para> | 31 | <para |
30 | <para id="new_lic_file"><phrase>doc/book-enea-nfv-access-dev-open-source/doc/licenses.xml</phrase></para> | 32 | id="new_lic_file"><phrase>doc/book_enea_edge_runtime_open_source/doc/licenses.xml</phrase></para> |
31 | </section> | 33 | |
34 | <para | ||
35 | id="prev_lic_file"><phrase>doc/book_enea_edge_management_open_source/doc/licenses.xml</phrase></para> | ||
36 | |||
37 | <para | ||
38 | id="new_lic_file"><phrase>doc/book_enea_edge_management_open_source/doc/licenses.xml</phrase></para> | ||
39 | |||
40 | <para | ||
41 | id="prev_lic_file"><phrase>doc/book_enea_edge_telemetry_open_source/licenses.xml</phrase></para> | ||
42 | |||
43 | <para | ||
44 | id="new_lic_file"><phrase>doc/book_enea_edge_telemetry_open_source/doc/licenses.xml</phrase></para> | ||
45 | |||
46 | <para | ||
47 | id="prev_lic_file"><phrase>doc/book_enea_edge_automation_open_source/licenses.xml</phrase></para> | ||
48 | |||
49 | <para | ||
50 | id="new_lic_file"><phrase>doc/book_enea_edge_automation_open_source/doc/licenses.xml</phrase></para> | ||
51 | |||
52 | <para | ||
53 | id="prev_lic_file"><phrase>doc/book_enea_edge_auto_fw_th_open_source/licenses.xml</phrase></para> | ||
54 | |||
55 | <para | ||
56 | id="new_lic_file"><phrase>doc/book_enea_edge_auto_fw_th_open_source/doc/licenses.xml</phrase></para> | ||
57 | </section> \ No newline at end of file | ||