diff options
Diffstat (limited to 'doc/book-enea-edge-release-info')
6 files changed, 240 insertions, 309 deletions
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 349c955..076538f 100644 --- a/doc/book-enea-edge-release-info/doc/about_release.xml +++ b/doc/book-enea-edge-release-info/doc/about_release.xml | |||
@@ -6,19 +6,19 @@ | |||
6 | 6 | ||
7 | <para>Enea Edge is a complete Virtualization Infrastructure software | 7 | <para>Enea Edge is a complete Virtualization Infrastructure software |
8 | platform designed for deployment on any white box uCPE device, and optimized | 8 | platform designed for deployment on any white box uCPE device, and optimized |
9 | for common use-cases. It includes the Enea Edge Runtime deployed | 9 | for common use-cases. It includes the Enea Edge Runtime deployed on a white |
10 | on a white box, the Enea Edge Management application and the Enea Edge | 10 | box, the Enea Edge Management application and the Enea Edge Automation, |
11 | Automation, management and automation tools deployed in a | 11 | management and automation tools deployed in a private or public |
12 | private or public cloud.</para> | 12 | cloud.</para> |
13 | 13 | ||
14 | <para>The Enea Edge <xi:include | 14 | <para>The Enea Edge <xi:include href="../../eltf_params_updated.xml" |
15 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" | ||
16 | xmlns:xi="http://www.w3.org/2001/XInclude" | 15 | xmlns:xi="http://www.w3.org/2001/XInclude" |
17 | xpointer="element(EneaLinux_REL_VER/1)" /> Release includes new features, | 16 | xpointer="element(EneaEdge_REL_VER/1)" /> Release includes new features, |
18 | optimizations, corrections, and updates to the user documentation.. | 17 | optimizations, corrections, and updates to the user documentation. A list of |
19 | A list of major new features and improvements can be found in | 18 | major new features and improvements can be found in <xref |
20 | <xref linkend="relinfo-changes-other">Section 2.1 New Features and Improvements</xref>.</para> | 19 | linkend="relinfo-changes-other">Section 2.1 New Features and |
21 | 20 | Improvements</xref>.</para> | |
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 | ||
@@ -45,8 +45,7 @@ | |||
45 | 45 | ||
46 | <listitem> | 46 | <listitem> |
47 | <para>Enea_Edge_AF-TH_<version>-build<build_number>.zip | 47 | <para>Enea_Edge_AF-TH_<version>-build<build_number>.zip |
48 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New | 48 | (deprecated as of version 2.4.0.)</para> |
49 | Features and Improvements</xref>.)</para> | ||
50 | </listitem> | 49 | </listitem> |
51 | </itemizedlist> | 50 | </itemizedlist> |
52 | 51 | ||
@@ -103,7 +102,7 @@ | |||
103 | it is in the beginning. The subtitles shall have the directory name of the | 102 | it is in the beginning. The subtitles shall have the directory name of the |
104 | target in the manifest.</remark> | 103 | target in the manifest.</remark> |
105 | 104 | ||
106 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" | 105 | <xi:include href="../../eltf_params_updated.xml" |
107 | xmlns:xi="http://www.w3.org/2001/XInclude" | 106 | xmlns:xi="http://www.w3.org/2001/XInclude" |
108 | xpointer="element(eltf-target-tables-section)" /> | 107 | xpointer="element(eltf-target-tables-section)" /> |
109 | 108 | ||
@@ -150,8 +149,7 @@ | |||
150 | xmlns:xi="http://www.w3.org/2001/XInclude" | 149 | xmlns:xi="http://www.w3.org/2001/XInclude" |
151 | xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" />. | 150 | xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" />. |
152 | Describes the Automation Framework and Test Harness for Enea Edge | 151 | Describes the Automation Framework and Test Harness for Enea Edge |
153 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New | 152 | (deprecated).</para> |
154 | Features and Improvements</xref>).</para> | ||
155 | </listitem> | 153 | </listitem> |
156 | 154 | ||
157 | <listitem> | 155 | <listitem> |
@@ -159,29 +157,7 @@ | |||
159 | xmlns:xi="http://www.w3.org/2001/XInclude" | 157 | xmlns:xi="http://www.w3.org/2001/XInclude" |
160 | xpointer="element(book_enea_edge_system_test_specification/1)" />. | 158 | xpointer="element(book_enea_edge_system_test_specification/1)" />. |
161 | Describes a sample Test Suite for System Testing of Enea Edge. | 159 | Describes a sample Test Suite for System Testing of Enea Edge. |
162 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New | 160 | (deprecated).</para> |
163 | Features and Improvements</xref>).</para> | ||
164 | </listitem> | ||
165 | </itemizedlist> | ||
166 | </section> | ||
167 | |||
168 | <section id="release-browsers"> | ||
169 | <title>Supported Web Browsers</title> | ||
170 | |||
171 | <para>The current release supports using the following web | ||
172 | browsers:</para> | ||
173 | |||
174 | <itemizedlist> | ||
175 | <listitem> | ||
176 | <para>Google Chrome (tested with version 89).</para> | ||
177 | </listitem> | ||
178 | |||
179 | <listitem> | ||
180 | <para>Mozilla Firefox (tested with version 87).</para> | ||
181 | </listitem> | ||
182 | |||
183 | <listitem> | ||
184 | <para>Microsoft Edge (tested with version 89).</para> | ||
185 | </listitem> | 161 | </listitem> |
186 | </itemizedlist> | 162 | </itemizedlist> |
187 | </section> | 163 | </section> |
diff --git a/doc/book-enea-edge-release-info/doc/book.xml b/doc/book-enea-edge-release-info/doc/book.xml index 0b77f41..6897c6f 100644 --- a/doc/book-enea-edge-release-info/doc/book.xml +++ b/doc/book-enea-edge-release-info/doc/book.xml | |||
@@ -8,9 +8,9 @@ | |||
8 | Information</title> | 8 | Information</title> |
9 | 9 | ||
10 | <subtitle>Release Version <xi:include | 10 | <subtitle>Release Version <xi:include |
11 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" | 11 | href="../../eltf_params_updated.xml" |
12 | xmlns:xi="http://www.w3.org/2001/XInclude" | 12 | xmlns:xi="http://www.w3.org/2001/XInclude" |
13 | xpointer="element(EneaLinux_REL_VER/1)" /></subtitle> | 13 | xpointer="element(EneaEdge_REL_VER/1)" /></subtitle> |
14 | 14 | ||
15 | <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> | 15 | <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> |
16 | 16 | ||
diff --git a/doc/book-enea-edge-release-info/doc/getting_enea_nfv_access.xml b/doc/book-enea-edge-release-info/doc/getting_enea_nfv_access.xml deleted file mode 100644 index 9eecd3c..0000000 --- a/doc/book-enea-edge-release-info/doc/getting_enea_nfv_access.xml +++ /dev/null | |||
@@ -1,54 +0,0 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
4 | <chapter id="relinfo-getting-enea-nfv-access"> | ||
5 | <title>Getting Enea NFV Access</title> | ||
6 | |||
7 | <para>Enea NFV Access releases and updates are available as binaries ready | ||
8 | for download.</para> | ||
9 | |||
10 | <para><emphasis role="bold">Downloading Enea NFV Access</emphasis></para> | ||
11 | <remark>Does the content below need to be revised to no longer make reference or mention to Enea Portal?</remark> | ||
12 | <orderedlist> | ||
13 | <listitem> | ||
14 | <para>Log in to the link above using the credentials provided by | ||
15 | Enea.</para> | ||
16 | </listitem> | ||
17 | |||
18 | <listitem> | ||
19 | <para>From the right corner of the top main menu, choose the | ||
20 | <literal>Access</literal> section.</para> | ||
21 | </listitem> | ||
22 | |||
23 | <listitem> | ||
24 | <para>The <literal>Files</literal> section on the left will display each | ||
25 | official release of Enea NFV Access, with the latest at the top.</para> | ||
26 | |||
27 | <para>Each release listing displays the dates for release and updates | ||
28 | available, along with a <literal>Download</literal> button that allows | ||
29 | you to directly save the version you wish to use.</para> | ||
30 | </listitem> | ||
31 | |||
32 | <listitem> | ||
33 | <para>By clicking on the link at the top of any listing of Enea NFV | ||
34 | Access, you'll access the changelog page for that version. At the bottom | ||
35 | of the page are clearly labeled region-specific zip files containing the | ||
36 | binary sources.</para> | ||
37 | |||
38 | <para>Documentation is also available at the bottom of the page.</para> | ||
39 | </listitem> | ||
40 | |||
41 | <listitem> | ||
42 | <para>On the right side of the main <literal>Access</literal> page is | ||
43 | the <literal>Online Documentation</literal> section, listing pdfs for | ||
44 | the latest versions of documentation. They can all be accessed for | ||
45 | indiviudual downloading without the need to download the binaries | ||
46 | first.</para> | ||
47 | </listitem> | ||
48 | </orderedlist> | ||
49 | |||
50 | <para>For details about the books delivered and their purpose, refer to | ||
51 | <xref linkend="relinfo-documentation" />. For information concerning the | ||
52 | contents of the release package, please see <xref | ||
53 | linkend="release-content" />.</para> | ||
54 | </chapter> | ||
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 81816a5..13a8c23 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 | |||
@@ -4,38 +4,59 @@ | |||
4 | <chapter id="bugs-limitations"> | 4 | <chapter id="bugs-limitations"> |
5 | <title>Known Issues and Limitations in this Release</title> | 5 | <title>Known Issues and Limitations in this Release</title> |
6 | 6 | ||
7 | <para>This chapter lists the known general issues and limitations that | 7 | <note> |
8 | affect the current release.</para> | 8 | <para>All issues may also affect previous releases.</para> |
9 | </note> | ||
9 | 10 | ||
10 | <itemizedlist> | 11 | <itemizedlist> |
11 | <listitem> | 12 | <listitem> |
12 | <para><remark>LXCR-9904</remark>Enea Edge Runtime cannot be installed on | 13 | <para><remark>ELCCR-1688, ELCCR-1809</remark>It is possible to end up |
13 | USB storage devices.</para> | 14 | with a corrupted VM image from the download operation. If that happens, |
15 | the VNF instantiation will fail. The corrupted image has to be manually | ||
16 | removed from <literal>/var/odm/vm_images/startup/</literal>.</para> | ||
14 | </listitem> | 17 | </listitem> |
15 | 18 | ||
16 | <listitem> | 19 | <listitem> |
17 | <para><remark>LXCR-9799</remark>Proper boot order is not ensured if a | 20 | <para><remark>ELCCR-1733</remark>Logging into the Enea Edge Management |
18 | uCPE device has more than one HDD attached.</para> | 21 | application over HTTP can fail, producing the error <literal>You have |
22 | been automatically logged out</literal>. If this happens, the user | ||
23 | should clear the <literal>JSESSIONID</literal> browser's cookie or close | ||
24 | and restart the browser.</para> | ||
19 | </listitem> | 25 | </listitem> |
20 | 26 | ||
21 | <listitem> | 27 | <listitem> |
22 | <para><remark>ELCCR-527</remark>Cancelling a file upload in the Enea | 28 | <para><remark>ELCCR-1753</remark>When using tap interfaces for |
23 | Edge Management will require the user to close and reopen the upload | 29 | communicating over the bridge, port numbers assigned to VM interfaces |
24 | window for the next upload to work.</para> | 30 | can change when the VMs are restarted. The only currently known |
31 | workaround is rebooting the uCPE device.</para> | ||
25 | </listitem> | 32 | </listitem> |
26 | 33 | ||
27 | <listitem> | 34 | <listitem> |
28 | <para><remark>ELCCR-577</remark>If the Enea Edge Management application | 35 | <para><remark>ELCCR-1999</remark>Attempting to upload multiple files |
29 | is restored from a backup made on a release version older than Enea NFV | 36 | simultaneously (e.g. a VNF image and custom scripts) in the Enea Edge |
30 | Access 2.2.3, VNFs cannot be instantiated from the GUI.</para> | 37 | Management application will cause all upload operations to be canceled. |
38 | In order to avoid this limitation, please wait until any previous | ||
39 | upload finishes before initiating a new one.</para> | ||
31 | </listitem> | 40 | </listitem> |
32 | 41 | ||
33 | <listitem> | 42 | <listitem> |
34 | <para><remark>ELCCR-1134</remark>In order to avoid an incorrect boot | 43 | <para><remark>LXCR-10922</remark>A very rare error on some Atom C3000 |
35 | order after a failed upgrade, the user should remove the upgrade | 44 | boards makes X553 SFP+ Ethernet ports unusable until a target cold reset |
36 | image before attempting again.</para> | 45 | is performed. When the error occurs in Enea Edge Runtime 2.5.0, there |
46 | will be a warning printed into the console by the | ||
47 | <literal>ixgbe</literal> driver:</para> | ||
48 | |||
49 | <programlisting>[11.361580] ixgbe 0000:0a:00.0: Warning firmware error detected FWSM: 0x8010801A</programlisting> | ||
50 | |||
51 | <para>The only currently known workaround for this issue is a cold | ||
52 | reset.</para> | ||
37 | </listitem> | 53 | </listitem> |
54 | </itemizedlist> | ||
38 | 55 | ||
56 | <para><emphasis role="bold">Limitations detected in previous releases, | ||
57 | that still affect this release:</emphasis></para> | ||
58 | |||
59 | <itemizedlist> | ||
39 | <listitem> | 60 | <listitem> |
40 | <para><remark>ELCCR-474</remark>Deleting VNF instances with flows | 61 | <para><remark>ELCCR-474</remark>Deleting VNF instances with flows |
41 | configured on the OVS bridges can be done only after removing the | 62 | configured on the OVS bridges can be done only after removing the |
@@ -43,12 +64,24 @@ | |||
43 | </listitem> | 64 | </listitem> |
44 | 65 | ||
45 | <listitem> | 66 | <listitem> |
67 | <para><remark>ELCCR-527</remark>Canceling a file upload in the Enea Edge | ||
68 | Management application will require the user to close and reopen the | ||
69 | upload window for the next upload to work.</para> | ||
70 | </listitem> | ||
71 | |||
72 | <listitem> | ||
46 | <para><remark>ELCCR-572</remark>Sometimes when selecting and deleting | 73 | <para><remark>ELCCR-572</remark>Sometimes when selecting and deleting |
47 | more than one VNF instance simultaneously, an error message might be | 74 | more than one VNF instance simultaneously, an error message might be |
48 | triggered, even if the delete operation succeeds.</para> | 75 | triggered, even if the delete operation succeeds.</para> |
49 | </listitem> | 76 | </listitem> |
50 | 77 | ||
51 | <listitem> | 78 | <listitem> |
79 | <para><remark>ELCCR-577</remark>If the Enea Edge Management application | ||
80 | is restored from a backup made on a release version older than Enea NFV | ||
81 | Access 2.2.3, VNFs cannot be instantiated from the GUI.</para> | ||
82 | </listitem> | ||
83 | |||
84 | <listitem> | ||
52 | <para><remark>ELCCR-847</remark>The Juniper vSRX VNF cannot be | 85 | <para><remark>ELCCR-847</remark>The Juniper vSRX VNF cannot be |
53 | instantiated on the Xeon-D architectures due to missing CPU features in | 86 | instantiated on the Xeon-D architectures due to missing CPU features in |
54 | the VNF's domain XML. This impacts all example use cases where the | 87 | the VNF's domain XML. This impacts all example use cases where the |
@@ -56,10 +89,53 @@ | |||
56 | </listitem> | 89 | </listitem> |
57 | 90 | ||
58 | <listitem> | 91 | <listitem> |
59 | <para><remark>USERDOCAP-648</remark>The <literal>storage size</literal> | 92 | <para><remark>ELCCR-912</remark>When the Enea Edge Management |
60 | parameter on the VNF onboarding page is ignored. The default storage | 93 | application is installed on CentOS 7, prior to C7.1804 (kernel version |
61 | size specified when creating the VM image is used when instantiating the | 94 | 3.10.0-862), adding an upgrade image fails. As a workaround, please |
62 | VM and when presenting VM information.</para> | 95 | update <literal>glib2</literal> to version 2.54.2 or later, using |
96 | <literal>#yum update glib2</literal>.</para> | ||
97 | </listitem> | ||
98 | |||
99 | <listitem> | ||
100 | <para><remark>ELCCR-1468</remark>When using the Enea Edge Management | ||
101 | application in HTTPS mode, upgrading a device from NFV Access 2.3.0 is | ||
102 | not possible. Either switch to HTTP mode (for more details see <olink | ||
103 | targetdoc="book_enea_edge_getting_started" | ||
104 | targetptr="device_up_process">The uCPE device Upgrade Process in the | ||
105 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
106 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
107 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> Manual) | ||
108 | or install it manually.</para> | ||
109 | </listitem> | ||
110 | |||
111 | <listitem> | ||
112 | <para><remark>ELCCR-1497</remark>If the Enea Edge Management application | ||
113 | has an incorrect database configuration, when performing an | ||
114 | uninstallation, the Tomcat instance and Watchdog service will not be | ||
115 | stopped automatically. Instead, they must be killed explicitly.</para> | ||
116 | </listitem> | ||
117 | |||
118 | <listitem> | ||
119 | <para><remark>ELCCR-1565</remark>Before starting an Enea Edge Management | ||
120 | upgrade, any owned Tomcat certificates should be manually copied into | ||
121 | the | ||
122 | <literal>/opt/ems/ucpemanager/application/config/certificates</literal> | ||
123 | folder.</para> | ||
124 | </listitem> | ||
125 | |||
126 | <listitem condition="hidden"> | ||
127 | <para><remark>LXCR-3283</remark><emphasis role="bold">PDF | ||
128 | navigation</emphasis>: When using links to open other PDFs, or jump to | ||
129 | another place in the same PDF, jumping back sometimes fails. This has | ||
130 | been observed when opening a PDF in Adobe Reader, inside a browser with | ||
131 | PDF add-on, as well as when the browser is configured to open PDF files | ||
132 | in an external PDF reader. As a workaround, open the HTML version of the | ||
133 | document.</para> | ||
134 | </listitem> | ||
135 | |||
136 | <listitem> | ||
137 | <para><remark>LXCR-9799</remark>Proper boot order is not ensured if a | ||
138 | uCPE device has more than one HDD attached.</para> | ||
63 | </listitem> | 139 | </listitem> |
64 | 140 | ||
65 | <listitem> | 141 | <listitem> |
@@ -67,11 +143,10 @@ | |||
67 | to be connected to a network with at least a router/gateway installed | 143 | to be connected to a network with at least a router/gateway installed |
68 | for next-hop communication.</para> | 144 | for next-hop communication.</para> |
69 | </listitem> | 145 | </listitem> |
70 | 146 | ||
71 | <listitem> | 147 | <listitem> |
72 | <para><remark>ELCCR-1504</remark>To change the type of an interface | 148 | <para><remark>LXCR-9904</remark>Enea Edge Runtime cannot be installed on |
73 | from DPDK to SR-IOV, first delete the existing interface, then | 149 | USB storage devices.</para> |
74 | recreate it with the desired type.</para> | ||
75 | </listitem> | 150 | </listitem> |
76 | 151 | ||
77 | <listitem> | 152 | <listitem> |
@@ -85,29 +160,9 @@ | |||
85 | </listitem> | 160 | </listitem> |
86 | 161 | ||
87 | <listitem> | 162 | <listitem> |
88 | <para><remark>STCR-6224</remark>The Enea Edge Automation and the Enea | 163 | <para><remark>LXCR-10750</remark>In order to avoid an incorrect boot |
89 | Edge Automation Framework and Test Harness do not support multiple | 164 | order after a failed upgrade, the user should remove the upgrade image |
90 | custom scripts uploaded to a uCPE device at the same time.</para> | 165 | before attempting again.</para> |
91 | </listitem> | ||
92 | |||
93 | <listitem> | ||
94 | <para><remark>STCR-6292</remark>Management of WAN Interfaces is not | ||
95 | implemented in the Enea Edge Automation Framework and Test | ||
96 | Harness.</para> | ||
97 | </listitem> | ||
98 | |||
99 | <listitem> | ||
100 | <para><remark>USERDOCAP-628</remark>Enea Edge Automation Framework and | ||
101 | Test Harness does not have support for product features implemented in | ||
102 | Enea Edge 2.4.0 or newer.</para> | ||
103 | </listitem> | ||
104 | |||
105 | <listitem> | ||
106 | <para><remark>ELCCR-912</remark>When the Enea Edge Management | ||
107 | application is installed on CentOS 7, prior to C7.1804 (kernel version | ||
108 | 3.10.0-862), adding an upgrade image fails. As a workaround, please | ||
109 | update <literal>glib2</literal> to version 2.54.2 or later, using | ||
110 | <literal>#yum update glib2</literal>.</para> | ||
111 | </listitem> | 166 | </listitem> |
112 | 167 | ||
113 | <listitem> | 168 | <listitem> |
@@ -117,58 +172,42 @@ | |||
117 | </listitem> | 172 | </listitem> |
118 | 173 | ||
119 | <listitem> | 174 | <listitem> |
175 | <para><remark>USERDOCAP-648</remark>The <literal>storage size</literal> | ||
176 | parameter on the VNF onboarding page is ignored. The default storage | ||
177 | size specified when creating the VM image is used when instantiating the | ||
178 | VM and when presenting VM information.</para> | ||
179 | </listitem> | ||
180 | |||
181 | <listitem> | ||
120 | <para><remark>USERDOCAP-651</remark>Wireless AP configuration is | 182 | <para><remark>USERDOCAP-651</remark>Wireless AP configuration is |
121 | optimized for wireless modules that use the <literal>ath10k</literal> | 183 | optimized for wireless modules that use the <literal>ath10k</literal> |
122 | driver. Using other wireless modules may result in undefined | 184 | driver. Using other wireless modules may result in undefined |
123 | behavior.</para> | 185 | behavior.</para> |
124 | </listitem> | 186 | </listitem> |
187 | </itemizedlist> | ||
125 | 188 | ||
126 | <listitem> | 189 | <para><emphasis role="bold">The following limitations affect deprecated |
127 | <para><remark>ELCCR-1518</remark>The Wireless AP's wpa2psk password | 190 | components and their documentation:</emphasis></para> |
128 | should not contain white space characters.</para> | ||
129 | </listitem> | ||
130 | 191 | ||
192 | <itemizedlist> | ||
131 | <listitem> | 193 | <listitem> |
132 | <para><remark>ELCCR-1561</remark>Before starting an Enea Edge Management | 194 | <para><remark>STCR-6224</remark>The Enea Edge Automation Framework and |
133 | upgrade, any owned Tomcat certificates should be manually copied into the | 195 | Test Harness do not support multiple custom scripts uploaded to a uCPE |
134 | <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config/certificates</literal> | 196 | device at the same time. This limitation does not apply to Enea Edge |
135 | folder.</para> | 197 | Automation.</para> |
136 | </listitem> | 198 | </listitem> |
137 | 199 | ||
138 | <listitem> | 200 | <listitem> |
139 | <para><remark>ELCCR-1378</remark>Modifying the type of the external | 201 | <para><remark>STCR-6292</remark>Management of WAN Interfaces is not |
140 | interfaces can lead to errors. Instead of modifying, it is recommended | 202 | implemented in the Enea Edge Automation Framework and Test |
141 | to delete the old interfaces and recreate them with the desired | 203 | Harness. This limitation does not apply to the Enea Edge Automation.</para> |
142 | type.</para> | ||
143 | </listitem> | ||
144 | |||
145 | <listitem> | ||
146 | <para><remark>ELCCR-1497</remark>If the Enea Edge Management application | ||
147 | has an incorrect database configuration, when performing an uninstallation, | ||
148 | the Tomcat instance and Watchdog service will not be stopped automatically. | ||
149 | Instead, they must be killed explicitly.</para> | ||
150 | </listitem> | ||
151 | |||
152 | <listitem> | ||
153 | <para><remark>ELCCR-1468</remark>When using the Enea Edge Management | ||
154 | application in HTTPS mode, upgrading a device from NFV Access 2.3.0 is | ||
155 | not possible. Either switch to HTTP mode (for more details see <olink | ||
156 | targetdoc="book_enea_edge_getting_started" | ||
157 | targetptr="device_up_process">The uCPE device Upgrade Process in the | ||
158 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
159 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
160 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> Manual) | ||
161 | or install it manually.</para> | ||
162 | </listitem> | 204 | </listitem> |
163 | 205 | ||
164 | <listitem condition="hidden"> | 206 | <listitem> |
165 | <para><remark>LXCR-3283</remark><emphasis role="bold">PDF | 207 | <para><remark>USERDOCAP-628</remark>The Enea Edge Automation Framework |
166 | navigation</emphasis>: When using links to open other PDFs, or jump to | 208 | and Test Harness do not have support for product features implemented in |
167 | another place in the same PDF, jumping back sometimes fails. This has | 209 | Enea Edge 2.4.0 or newer. Please use the new Enea Edge Automation |
168 | been observed when opening a PDF in Adobe Reader, inside a browser with | 210 | component if you want support for newer features.</para> |
169 | PDF add-on, as well as when the browser is configured to open PDF files | ||
170 | in an external PDF reader. As a workaround, open the HTML version of the | ||
171 | document.</para> | ||
172 | </listitem> | 211 | </listitem> |
173 | </itemizedlist> | 212 | </itemizedlist> |
174 | 213 | ||
@@ -176,4 +215,4 @@ | |||
176 | 215 | ||
177 | <!-- <xi:include href="jiraissues_generated.xml" | 216 | <!-- <xi:include href="jiraissues_generated.xml" |
178 | xmlns:xi="http://www.w3.org/2001/XInclude" /> --> | 217 | xmlns:xi="http://www.w3.org/2001/XInclude" /> --> |
179 | </chapter> | 218 | </chapter> \ No newline at end of file |
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 8824aa3..629a892 100644 --- a/doc/book-enea-edge-release-info/doc/main_changes.xml +++ b/doc/book-enea-edge-release-info/doc/main_changes.xml | |||
@@ -15,10 +15,10 @@ | |||
15 | 15 | ||
16 | <itemizedlist> | 16 | <itemizedlist> |
17 | <listitem> | 17 | <listitem> |
18 | <para><remark>CPDX-3496</remark>Embedded WiFi support for all-in-one | 18 | <para>Support for Fully Qualified Domain Names (FQDN) for the Enea |
19 | store/home office deployment. For more details please see the <olink | 19 | Edge Management application address. For more details please see |
20 | targetdoc="book_enea_edge_getting_started" | 20 | <olink targetdoc="book_enea_edge_getting_started" |
21 | targetptr="wap_interface_type">Wap Interface Type in the <xi:include | 21 | targetptr="prep_deploy">Preparing the Deployment in the <xi:include |
22 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 22 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
23 | xmlns:xi="http://www.w3.org/2001/XInclude" | 23 | xmlns:xi="http://www.w3.org/2001/XInclude" |
24 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> | 24 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
@@ -26,10 +26,11 @@ | |||
26 | </listitem> | 26 | </listitem> |
27 | 27 | ||
28 | <listitem> | 28 | <listitem> |
29 | <para><remark>CPDX-3499</remark>Expanded hardware, OS and network | 29 | <para>Support for a DNS servers list for WAN interfaces with a static |
30 | monitoring capability with Grafana integration. For more details | 30 | IP configuration. For more details please see <olink |
31 | please see <olink targetdoc="book_enea_edge_getting_started" | 31 | targetdoc="book_enea_edge_getting_started" |
32 | targetptr="grafana">Using Grafana and InfluxDB in the <xi:include | 32 | targetptr="install_ena_device">Installing Enea Edge - uCPE Device |
33 | Installation in the <xi:include | ||
33 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 34 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
34 | xmlns:xi="http://www.w3.org/2001/XInclude" | 35 | xmlns:xi="http://www.w3.org/2001/XInclude" |
35 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> | 36 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
@@ -37,38 +38,25 @@ | |||
37 | </listitem> | 38 | </listitem> |
38 | 39 | ||
39 | <listitem> | 40 | <listitem> |
40 | <para><remark>CPDX-3407</remark>HTTPS based downloads of VNFs for | 41 | <para>Support for NFV Infrastructure backup and restore to allow for |
41 | simplified deployment of the Enea Edge Management application in cloud | 42 | recovery to a previously known state. For more details please see |
42 | environments. For more details please see <olink | 43 | <olink targetdoc="book_enea_edge_getting_started" |
43 | targetdoc="book_enea_edge_getting_started" | 44 | targetptr="nfvi_backup">NFV Infrastructure Backup Operations in the |
44 | targetptr="fresh_ucpemg_install">Fresh Installation of the Enea Edge | 45 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
45 | Management application in the <xi:include | ||
46 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
47 | xmlns:xi="http://www.w3.org/2001/XInclude" | 46 | xmlns:xi="http://www.w3.org/2001/XInclude" |
48 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> | 47 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
49 | Manual.</para> | 48 | Manual.</para> |
50 | </listitem> | 49 | </listitem> |
51 | 50 | ||
52 | <listitem> | 51 | <listitem> |
53 | <para><remark>CPDX-3500</remark>Enea Edge Automation, a tool for | 52 | <para>Support for VNF snapshotting to allow for storing, managing and |
54 | automatic system configuration based on Python scripting that will | 53 | restoring snapshots of VNFs deployed on Enea Edge Runtime. For more |
55 | replace the existing Enea Edge Automation Framework and Test Harness | 54 | details please see <olink targetdoc="book_enea_edge_getting_started" |
56 | in the next major release. For more details please see the <ns:include | 55 | targetptr="vnf_snapshots">VNF Snapshots in the <xi:include |
57 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | 56 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
58 | xmlns:ns="http://www.w3.org/2001/XInclude" | 57 | xmlns:xi="http://www.w3.org/2001/XInclude" |
59 | xpointer="element(book_enea_edge_automation_user_guide/1)" />.</para> | 58 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
60 | 59 | Manual.</para> | |
61 | <note> | ||
62 | <para>The Enea Edge Automation Framework and Test Harness, and its | ||
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> | ||
72 | </listitem> | 60 | </listitem> |
73 | </itemizedlist> | 61 | </itemizedlist> |
74 | 62 | ||
@@ -76,20 +64,81 @@ | |||
76 | 64 | ||
77 | <itemizedlist> | 65 | <itemizedlist> |
78 | <listitem> | 66 | <listitem> |
79 | <para>A new <emphasis role="bold">Requirements</emphasis> page has | 67 | <para>Documented and hardened support for Factory Reset allowing |
80 | been added to the Web-installer, displaying device characteristics and | 68 | reverting of the Enea Edge Runtime to its initial state. |
81 | checking minimal hardware requirements.</para> | 69 | For more details please see <olink |
70 | targetdoc="book_enea_edge_getting_started" | ||
71 | targetptr="basic_oper_device">Basic operations for uCPE device | ||
72 | Management in the <ns:include | ||
73 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
74 | xpointer="element(book_enea_edge_getting_started/1)" | ||
75 | xmlns:ns="http://www.w3.org/2001/XInclude" /></olink> Manual.</para> | ||
76 | </listitem> | ||
77 | |||
78 | <listitem> | ||
79 | <para>Added support for uploading multiple custom scripts on a uCPE | ||
80 | Device in the Enea Edge Automation framework.</para> | ||
81 | </listitem> | ||
82 | |||
83 | <listitem> | ||
84 | <para>Python APIs from the Enea Edge Automation framework can now be | ||
85 | run with a limited set of optional parameters.</para> | ||
86 | </listitem> | ||
87 | |||
88 | <listitem> | ||
89 | <para>Configuration files from the Enea Edge Automation framework can | ||
90 | now be generated in a non-interactive way with a limited set of | ||
91 | optional parameters.</para> | ||
92 | </listitem> | ||
93 | |||
94 | <listitem> | ||
95 | <para>Improved support for large deployments of Enea Edge.</para> | ||
82 | </listitem> | 96 | </listitem> |
83 | 97 | ||
84 | <listitem> | 98 | <listitem> |
85 | <para>A Web-installer's log is displayed on the last page in case the | 99 | <para>Improved the upgrade and uninstall processes of the Enea Edge |
86 | installation process has failed.</para> | 100 | Management component: the database information is no longer requested |
101 | during an upgrade or an uninstall.</para> | ||
87 | </listitem> | 102 | </listitem> |
88 | 103 | ||
89 | <listitem> | 104 | <listitem> |
90 | <para>Extended Web-installer support for NVME disks.</para> | 105 | <para>Enea Edge Runtime key component upgrades include:</para> |
106 | |||
107 | <itemizedlist spacing="compact"> | ||
108 | <listitem> | ||
109 | <para>Linux kernel 5.10</para> | ||
110 | </listitem> | ||
111 | |||
112 | <listitem> | ||
113 | <para>Open vSwitch 2.15</para> | ||
114 | </listitem> | ||
115 | |||
116 | <listitem> | ||
117 | <para>QEMU 5.2.0</para> | ||
118 | </listitem> | ||
119 | |||
120 | <listitem> | ||
121 | <para>libvirt 6.3.0</para> | ||
122 | </listitem> | ||
123 | |||
124 | <listitem> | ||
125 | <para>DPDK 20.11.1</para> | ||
126 | </listitem> | ||
127 | |||
128 | <listitem> | ||
129 | <para>Python 3.9.4</para> | ||
130 | </listitem> | ||
131 | </itemizedlist> | ||
132 | |||
133 | <para>Further information about what open source versions are used in | ||
134 | Enea Edge Runtime, can be found in the Enea Edge Runtime Open Source | ||
135 | Report.</para> | ||
91 | </listitem> | 136 | </listitem> |
92 | </itemizedlist> | 137 | </itemizedlist> |
138 | |||
139 | <para></para> | ||
140 | <para></para> | ||
141 | <para></para> | ||
93 | 142 | ||
94 | <para><emphasis role="bold">Early Access Features:</emphasis></para> | 143 | <para><emphasis role="bold">Early Access Features:</emphasis></para> |
95 | 144 | ||
@@ -100,7 +149,8 @@ | |||
100 | <listitem> | 149 | <listitem> |
101 | <para><remark>CPDX-3498</remark>High Availability support with | 150 | <para><remark>CPDX-3498</remark>High Availability support with |
102 | redundant Enea Edge Management applications in active standby | 151 | redundant Enea Edge Management applications in active standby |
103 | configuration.</para> | 152 | configuration. This EA feature has remained unchanged since the |
153 | Enea Edge 2.4.0 release.</para> | ||
104 | 154 | ||
105 | <para>In order to increase resiliency on the uCPE management side, the | 155 | <para>In order to increase resiliency on the uCPE management side, the |
106 | Enea Edge Management application can be installed in High-Availability | 156 | Enea Edge Management application can be installed in High-Availability |
@@ -109,27 +159,6 @@ | |||
109 | Centers and geographical locations, and with multiple MariaDB servers | 159 | Centers and geographical locations, and with multiple MariaDB servers |
110 | for each location.</para> | 160 | for each location.</para> |
111 | </listitem> | 161 | </listitem> |
112 | |||
113 | <listitem> | ||
114 | <para>Platform and VNF Snapshots (made originally available starting | ||
115 | with Enea NFV Access 2.3.0).</para> | ||
116 | |||
117 | <para>Platform Snapshots allow users to store, manage and restore | ||
118 | snapshots of the Enea Edge Runtime configuration, with the purpose of | ||
119 | recovering after a failed reconfiguration. This feature is disabled by | ||
120 | default.</para> | ||
121 | |||
122 | <para>VNF Snapshots allow users to store, manage and restore snapshots | ||
123 | of VNFs deployed on the Enea Edge Runtime, with the purpose of | ||
124 | restoring the VNF after a persistent VNF failure. This feature is | ||
125 | disabled by default.</para> | ||
126 | |||
127 | <note> | ||
128 | <para>Users that would like to try out the Early Access features | ||
129 | should contact Enea Support for additional documentation and | ||
130 | assistance.</para> | ||
131 | </note> | ||
132 | </listitem> | ||
133 | </itemizedlist> | 162 | </itemizedlist> |
134 | 163 | ||
135 | <para>Early Access features are provided for evaluation and early | 164 | <para>Early Access features are provided for evaluation and early |
@@ -183,7 +212,10 @@ | |||
183 | <section id="relinfo-backward-compat"> | 212 | <section id="relinfo-backward-compat"> |
184 | <title>Compatibility</title> | 213 | <title>Compatibility</title> |
185 | 214 | ||
186 | <para>This release does not contain any change impacting | 215 | <para>This release does not contain any public API changes impacting |
187 | compatibility.</para> | 216 | backwards compatibility. However, Python 2 support in Enea Edge Runtime |
217 | has been discontinued starting with the current version of Enea Edge. | ||
218 | This could affect existing custom scripts using Python 2 syntax. Please | ||
219 | update these scripts accordingly in order to run in a Python 3 environment.</para> | ||
188 | </section> | 220 | </section> |
189 | </chapter> \ No newline at end of file | 221 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-edge-release-info/doc/system_requirements_prerequisites.xml b/doc/book-enea-edge-release-info/doc/system_requirements_prerequisites.xml deleted file mode 100644 index b0317b3..0000000 --- a/doc/book-enea-edge-release-info/doc/system_requirements_prerequisites.xml +++ /dev/null | |||
@@ -1,62 +0,0 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
4 | <chapter id="sys-req-prerequisites"> | ||
5 | <title>Host Requirements</title> | ||
6 | |||
7 | <para>Using Enea NFV Access or compiling applications requires certain | ||
8 | packages to be installed on your build host. The requirements listed below | ||
9 | are extensive to allow getting Enea NFV Access to be booted on target | ||
10 | machines and for building applications.</para> | ||
11 | |||
12 | <informaltable> | ||
13 | <tgroup cols="2"> | ||
14 | <colspec align="left" colname="1" colwidth="1*" /> | ||
15 | |||
16 | <colspec align="left" colname="2" colwidth="3*" /> | ||
17 | |||
18 | <spanspec nameend="2" namest="1" spanname="onetwo" /> | ||
19 | |||
20 | <tbody> | ||
21 | <row> | ||
22 | <entry spanname="onetwo"><emphasis role="bold"> Build Host | ||
23 | Requirements<indexterm> | ||
24 | <primary>host requirements</primary> | ||
25 | </indexterm></emphasis></entry> | ||
26 | </row> | ||
27 | |||
28 | <row> | ||
29 | <entry>Linux distribution</entry> | ||
30 | |||
31 | <entry>The downloaded product can installed on the target machine | ||
32 | using a Linux host. For information about supported hosts and | ||
33 | targets, see <xref | ||
34 | linkend="relinfo-supported-host-environment" />.</entry> | ||
35 | </row> | ||
36 | |||
37 | <row> | ||
38 | <entry>Packages</entry> | ||
39 | |||
40 | <entry>Depending on the Linux distribution and version of the host, | ||
41 | certain packages may be required. See details on what packages are | ||
42 | needed and how to install them in the following sections.</entry> | ||
43 | </row> | ||
44 | |||
45 | <row> | ||
46 | <entry>Disk space</entry> | ||
47 | |||
48 | <entry>Your build host should have at least 50 GB of free disk space | ||
49 | for installing the SDK, eSDK or cross-compiling | ||
50 | applications.</entry> | ||
51 | </row> | ||
52 | |||
53 | <row> | ||
54 | <entry>Recommended RAM</entry> | ||
55 | |||
56 | <entry>Your build host must have at least 4 GB available | ||
57 | RAM.</entry> | ||
58 | </row> | ||
59 | </tbody> | ||
60 | </tgroup> | ||
61 | </informaltable> | ||
62 | </chapter> \ No newline at end of file | ||