diff options
-rw-r--r-- | doc/book-enea-edge-release-info/doc/about_release.xml | 28 | ||||
-rw-r--r-- | doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml | 114 | ||||
-rw-r--r-- | doc/book-enea-edge-release-info/doc/main_changes.xml | 92 | ||||
-rw-r--r-- | doc/eltf_params_updated.xml | 6 |
4 files changed, 120 insertions, 120 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 1f98ce6..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="../../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(EneaEdge_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 | ||
@@ -149,8 +149,7 @@ | |||
149 | xmlns:xi="http://www.w3.org/2001/XInclude" | 149 | xmlns:xi="http://www.w3.org/2001/XInclude" |
150 | xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" />. | 150 | xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" />. |
151 | Describes the Automation Framework and Test Harness for Enea Edge | 151 | Describes the Automation Framework and Test Harness for Enea Edge |
152 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New | 152 | (deprecated).</para> |
153 | Features and Improvements</xref>).</para> | ||
154 | </listitem> | 153 | </listitem> |
155 | 154 | ||
156 | <listitem> | 155 | <listitem> |
@@ -158,8 +157,7 @@ | |||
158 | xmlns:xi="http://www.w3.org/2001/XInclude" | 157 | xmlns:xi="http://www.w3.org/2001/XInclude" |
159 | xpointer="element(book_enea_edge_system_test_specification/1)" />. | 158 | xpointer="element(book_enea_edge_system_test_specification/1)" />. |
160 | Describes a sample Test Suite for System Testing of Enea Edge. | 159 | Describes a sample Test Suite for System Testing of Enea Edge. |
161 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New | 160 | (deprecated).</para> |
162 | Features and Improvements</xref>).</para> | ||
163 | </listitem> | 161 | </listitem> |
164 | </itemizedlist> | 162 | </itemizedlist> |
165 | </section> | 163 | </section> |
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 53d3849..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,10 +4,9 @@ | |||
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><emphasis role="bold">Issues and limitations found in the Enea Edge | 7 | <note> |
8 | <xi:include href="../../eltf_params_updated.xml" | 8 | <para>All issues may also affect previous releases.</para> |
9 | xmlns:xi="http://www.w3.org/2001/XInclude" | 9 | </note> |
10 | xpointer="element(EneaEdge_REL_VER/1)" /> release:</emphasis></para> | ||
11 | 10 | ||
12 | <itemizedlist> | 11 | <itemizedlist> |
13 | <listitem> | 12 | <listitem> |
@@ -18,34 +17,44 @@ | |||
18 | </listitem> | 17 | </listitem> |
19 | 18 | ||
20 | <listitem> | 19 | <listitem> |
21 | <para><remark>ELCCR-1733</remark>Logging into the Enea Edge Management | 20 | <para><remark>ELCCR-1733</remark>Logging into the Enea Edge Management |
22 | application over HTTP can fail, producing the error | 21 | application over HTTP can fail, producing the error <literal>You have |
23 | <literal>You have been automatically logged out</literal>. If this | 22 | been automatically logged out</literal>. If this happens, the user |
24 | happens, the user should clear the <literal>JSESSIONID</literal> | 23 | should clear the <literal>JSESSIONID</literal> browser's cookie or close |
25 | browser's cookie or close and restart the browser.</para> | 24 | and restart the browser.</para> |
26 | </listitem> | 25 | </listitem> |
27 | 26 | ||
28 | <listitem> | 27 | <listitem> |
29 | <para><remark>ELCCR-1753</remark>For tap interfaces, port numbers | 28 | <para><remark>ELCCR-1753</remark>When using tap interfaces for |
30 | assigned to VM bridge interfaces can change when the VMs are | 29 | communicating over the bridge, port numbers assigned to VM interfaces |
31 | restarted.</para> | 30 | can change when the VMs are restarted. The only currently known |
31 | workaround is rebooting the uCPE device.</para> | ||
32 | </listitem> | ||
33 | |||
34 | <listitem> | ||
35 | <para><remark>ELCCR-1999</remark>Attempting to upload multiple files | ||
36 | simultaneously (e.g. a VNF image and custom scripts) in the Enea Edge | ||
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> | ||
32 | </listitem> | 40 | </listitem> |
33 | 41 | ||
34 | <listitem> | 42 | <listitem> |
35 | <para><remark>LXCR-10922</remark>There is a very rare sporadic error on | 43 | <para><remark>LXCR-10922</remark>A very rare error on some Atom C3000 |
36 | the X553 SFP+ ethernet ports on Atom C3000 boards. This has been | 44 | boards makes X553 SFP+ Ethernet ports unusable until a target cold reset |
37 | verified on Supermicro A2SDi-TP8F boards. This sporadic error makes X553 | 45 | is performed. When the error occurs in Enea Edge Runtime 2.5.0, there |
38 | ethernet ports unusable until a target cold reset is performed. When the | 46 | will be a warning printed into the console by the |
39 | error occurs in Enea Edge Runtime 2.5.0, there will be a warning printed | 47 | <literal>ixgbe</literal> driver:</para> |
40 | into console by the ixgbe driver as follows: | 48 | |
41 | <programlisting>[ 11.361580] ixgbe 0000:0a:00.0: Warning firmware error detected FWSM: 0x8010801A</programlisting> | 49 | <programlisting>[11.361580] ixgbe 0000:0a:00.0: Warning firmware error detected FWSM: 0x8010801A</programlisting> |
42 | The only currently known workaround for this issue is a cold reset.</para> | 50 | |
51 | <para>The only currently known workaround for this issue is a cold | ||
52 | reset.</para> | ||
43 | </listitem> | 53 | </listitem> |
44 | </itemizedlist> | 54 | </itemizedlist> |
45 | 55 | ||
46 | <para><emphasis role="bold">Issues and limitations found in previous | 56 | <para><emphasis role="bold">Limitations detected in previous releases, |
47 | releases of Enea Edge that still affect this current | 57 | that still affect this release:</emphasis></para> |
48 | release:</emphasis></para> | ||
49 | 58 | ||
50 | <itemizedlist> | 59 | <itemizedlist> |
51 | <listitem> | 60 | <listitem> |
@@ -78,7 +87,7 @@ | |||
78 | 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 |
79 | Juniper VNF is used.</para> | 88 | Juniper VNF is used.</para> |
80 | </listitem> | 89 | </listitem> |
81 | 90 | ||
82 | <listitem> | 91 | <listitem> |
83 | <para><remark>ELCCR-912</remark>When the Enea Edge Management | 92 | <para><remark>ELCCR-912</remark>When the Enea Edge Management |
84 | application is installed on CentOS 7, prior to C7.1804 (kernel version | 93 | application is installed on CentOS 7, prior to C7.1804 (kernel version |
@@ -105,7 +114,7 @@ | |||
105 | uninstallation, the Tomcat instance and Watchdog service will not be | 114 | uninstallation, the Tomcat instance and Watchdog service will not be |
106 | stopped automatically. Instead, they must be killed explicitly.</para> | 115 | stopped automatically. Instead, they must be killed explicitly.</para> |
107 | </listitem> | 116 | </listitem> |
108 | 117 | ||
109 | <listitem> | 118 | <listitem> |
110 | <para><remark>ELCCR-1565</remark>Before starting an Enea Edge Management | 119 | <para><remark>ELCCR-1565</remark>Before starting an Enea Edge Management |
111 | upgrade, any owned Tomcat certificates should be manually copied into | 120 | upgrade, any owned Tomcat certificates should be manually copied into |
@@ -157,36 +166,6 @@ | |||
157 | </listitem> | 166 | </listitem> |
158 | 167 | ||
159 | <listitem> | 168 | <listitem> |
160 | <para><remark>STCR-6224</remark>The Enea Edge Automation Framework and | ||
161 | Test Harness do not support multiple custom scripts uploaded to a uCPE | ||
162 | device at the same time.</para> | ||
163 | |||
164 | <note> | ||
165 | <para>This limitation does not apply to Enea Edge Automation. It only | ||
166 | affects the Enea Edge Automation Framework and Test Harness.</para> | ||
167 | </note> | ||
168 | </listitem> | ||
169 | |||
170 | <listitem> | ||
171 | <para><remark>STCR-6292</remark>Management of WAN Interfaces is not | ||
172 | implemented in the Enea Edge Automation Framework and Test | ||
173 | Harness.</para> | ||
174 | </listitem> | ||
175 | |||
176 | <listitem> | ||
177 | <para><remark>USERDOCAP-628</remark>The Enea Edge Automation Framework | ||
178 | and Test Harness do not have support for product features implemented in | ||
179 | Enea Edge 2.4.0 or newer.</para> | ||
180 | |||
181 | <note> | ||
182 | <para>This limitation does not apply to Enea Edge Automation. It only | ||
183 | affects the Enea Edge Automation Framework and Test Harness. Please | ||
184 | use the new Enea Edge Automation component if you want support for | ||
185 | newer features.</para> | ||
186 | </note> | ||
187 | </listitem> | ||
188 | |||
189 | <listitem> | ||
190 | <para><remark>USERDOCAP-641</remark>Enea Edge does not have support for | 169 | <para><remark>USERDOCAP-641</remark>Enea Edge does not have support for |
191 | IPv6 addresses on both uCPE devices and the Enea Edge Management | 170 | IPv6 addresses on both uCPE devices and the Enea Edge Management |
192 | installation.</para> | 171 | installation.</para> |
@@ -207,6 +186,31 @@ | |||
207 | </listitem> | 186 | </listitem> |
208 | </itemizedlist> | 187 | </itemizedlist> |
209 | 188 | ||
189 | <para><emphasis role="bold">The following limitations affect deprecated | ||
190 | components and their documentation:</emphasis></para> | ||
191 | |||
192 | <itemizedlist> | ||
193 | <listitem> | ||
194 | <para><remark>STCR-6224</remark>The Enea Edge Automation Framework and | ||
195 | Test Harness do not support multiple custom scripts uploaded to a uCPE | ||
196 | device at the same time. This limitation does not apply to Enea Edge | ||
197 | Automation.</para> | ||
198 | </listitem> | ||
199 | |||
200 | <listitem> | ||
201 | <para><remark>STCR-6292</remark>Management of WAN Interfaces is not | ||
202 | implemented in the Enea Edge Automation Framework and Test | ||
203 | Harness. This limitation does not apply to the Enea Edge Automation.</para> | ||
204 | </listitem> | ||
205 | |||
206 | <listitem> | ||
207 | <para><remark>USERDOCAP-628</remark>The Enea Edge Automation Framework | ||
208 | and Test Harness do not have support for product features implemented in | ||
209 | Enea Edge 2.4.0 or newer. Please use the new Enea Edge Automation | ||
210 | component if you want support for newer features.</para> | ||
211 | </listitem> | ||
212 | </itemizedlist> | ||
213 | |||
210 | <!-- The file with a section below is autocreated by make init --> | 214 | <!-- The file with a section below is autocreated by make init --> |
211 | 215 | ||
212 | <!-- <xi:include href="jiraissues_generated.xml" | 216 | <!-- <xi:include href="jiraissues_generated.xml" |
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 85a5e7e..629a892 100644 --- a/doc/book-enea-edge-release-info/doc/main_changes.xml +++ b/doc/book-enea-edge-release-info/doc/main_changes.xml | |||
@@ -58,23 +58,23 @@ | |||
58 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> | 58 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> |
59 | Manual.</para> | 59 | Manual.</para> |
60 | </listitem> | 60 | </listitem> |
61 | </itemizedlist> | ||
62 | |||
63 | <para><emphasis role="bold">Improvements:</emphasis></para> | ||
61 | 64 | ||
65 | <itemizedlist> | ||
62 | <listitem> | 66 | <listitem> |
63 | <para>Support for a Factory Reset to allow reverting of the Enea Edge | 67 | <para>Documented and hardened support for Factory Reset allowing |
64 | Runtime to its initial state. For more details please see <olink | 68 | reverting of the Enea Edge Runtime to its initial state. |
69 | For more details please see <olink | ||
65 | targetdoc="book_enea_edge_getting_started" | 70 | targetdoc="book_enea_edge_getting_started" |
66 | targetptr="basic_oper_device">Basic operations for uCPE device | 71 | targetptr="basic_oper_device">Basic operations for uCPE device |
67 | Management in the <xi:include | 72 | Management in the <ns:include |
68 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | 73 | href="../../s_docbuild/olinkdb/pardoc-names.xml" |
69 | xmlns:xi="http://www.w3.org/2001/XInclude" | 74 | xpointer="element(book_enea_edge_getting_started/1)" |
70 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> | 75 | xmlns:ns="http://www.w3.org/2001/XInclude" /></olink> Manual.</para> |
71 | Manual.</para> | ||
72 | </listitem> | 76 | </listitem> |
73 | </itemizedlist> | ||
74 | 77 | ||
75 | <para><emphasis role="bold">Improvements:</emphasis></para> | ||
76 | |||
77 | <itemizedlist> | ||
78 | <listitem> | 78 | <listitem> |
79 | <para>Added support for uploading multiple custom scripts on a uCPE | 79 | <para>Added support for uploading multiple custom scripts on a uCPE |
80 | Device in the Enea Edge Automation framework.</para> | 80 | Device in the Enea Edge Automation framework.</para> |
@@ -96,51 +96,49 @@ | |||
96 | </listitem> | 96 | </listitem> |
97 | 97 | ||
98 | <listitem> | 98 | <listitem> |
99 | <para>The Enea Edge Management application will wait for 10 minutes | ||
100 | instead of 5 for the Enea Edge Runtime upgrade operations to complete | ||
101 | successfully, before reporting an error.</para> | ||
102 | </listitem> | ||
103 | |||
104 | <listitem> | ||
105 | <para>Improved the upgrade and uninstall processes of the Enea Edge | 99 | <para>Improved the upgrade and uninstall processes of the Enea Edge |
106 | Management component: the database information is no longer requested | 100 | Management component: the database information is no longer requested |
107 | during an upgrade or an uninstall.</para> | 101 | during an upgrade or an uninstall.</para> |
108 | </listitem> | 102 | </listitem> |
109 | 103 | ||
110 | <listitem> | 104 | <listitem> |
111 | <para>Enea Edge Runtime key component upgrades include:</para> | 105 | <para>Enea Edge Runtime key component upgrades include:</para> |
112 | 106 | ||
113 | <itemizedlist spacing="compact"> | 107 | <itemizedlist spacing="compact"> |
114 | <listitem> | 108 | <listitem> |
115 | <para>Linux kernel 5.10</para> | 109 | <para>Linux kernel 5.10</para> |
116 | </listitem> | 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> | ||
117 | 119 | ||
118 | <listitem> | 120 | <listitem> |
119 | <para>Open vSwitch 2.15</para> | 121 | <para>libvirt 6.3.0</para> |
120 | </listitem> | 122 | </listitem> |
121 | 123 | ||
122 | <listitem> | 124 | <listitem> |
123 | <para>QEMU 5.2.0</para> | 125 | <para>DPDK 20.11.1</para> |
124 | </listitem> | 126 | </listitem> |
125 | 127 | ||
126 | <listitem> | 128 | <listitem> |
127 | <para>libvirt 6.3.0</para> | 129 | <para>Python 3.9.4</para> |
128 | </listitem> | 130 | </listitem> |
131 | </itemizedlist> | ||
129 | 132 | ||
130 | <listitem> | 133 | <para>Further information about what open source versions are used in |
131 | <para>DPDK 20.11.1</para> | 134 | Enea Edge Runtime, can be found in the Enea Edge Runtime Open Source |
132 | </listitem> | 135 | Report.</para> |
133 | |||
134 | <listitem> | ||
135 | <para>Python 3.9.4, replacing Python2 support</para> | ||
136 | </listitem> | ||
137 | </itemizedlist> | ||
138 | |||
139 | <para>Further information about what open source versions are used | ||
140 | in Enea Edge Runtime, can be found in the Enea Edge Runtime | ||
141 | Open Source Report.</para> | ||
142 | </listitem> | 136 | </listitem> |
143 | </itemizedlist> | 137 | </itemizedlist> |
138 | |||
139 | <para></para> | ||
140 | <para></para> | ||
141 | <para></para> | ||
144 | 142 | ||
145 | <para><emphasis role="bold">Early Access Features:</emphasis></para> | 143 | <para><emphasis role="bold">Early Access Features:</emphasis></para> |
146 | 144 | ||
@@ -151,7 +149,8 @@ | |||
151 | <listitem> | 149 | <listitem> |
152 | <para><remark>CPDX-3498</remark>High Availability support with | 150 | <para><remark>CPDX-3498</remark>High Availability support with |
153 | redundant Enea Edge Management applications in active standby | 151 | redundant Enea Edge Management applications in active standby |
154 | configuration.</para> | 152 | configuration. This EA feature has remained unchanged since the |
153 | Enea Edge 2.4.0 release.</para> | ||
155 | 154 | ||
156 | <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 |
157 | Enea Edge Management application can be installed in High-Availability | 156 | Enea Edge Management application can be installed in High-Availability |
@@ -214,6 +213,9 @@ | |||
214 | <title>Compatibility</title> | 213 | <title>Compatibility</title> |
215 | 214 | ||
216 | <para>This release does not contain any public API changes impacting | 215 | <para>This release does not contain any public API changes impacting |
217 | backwards 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> | ||
218 | </section> | 220 | </section> |
219 | </chapter> \ No newline at end of file | 221 | </chapter> \ No newline at end of file |
diff --git a/doc/eltf_params_updated.xml b/doc/eltf_params_updated.xml index f5f3f7d..39755ef 100644 --- a/doc/eltf_params_updated.xml +++ b/doc/eltf_params_updated.xml | |||
@@ -10,7 +10,7 @@ | |||
10 | <bridgehead>Several phrase elements, various IDs. Ensure EL_REL_VER is | 10 | <bridgehead>Several phrase elements, various IDs. Ensure EL_REL_VER is |
11 | correct also compared to the "previous" REL VER in pardoc-distro.xml | 11 | correct also compared to the "previous" REL VER in pardoc-distro.xml |
12 | "prev_baseline".</bridgehead> | 12 | "prev_baseline".</bridgehead> |
13 | 13 | ||
14 | <para id="EneaEdge_REL_VER"><phrase>2.5.0</phrase></para> | 14 | <para id="EneaEdge_REL_VER"><phrase>2.5.0</phrase></para> |
15 | 15 | ||
16 | <para id="ENA_BUILD_VER"><phrase>1</phrase></para> | 16 | <para id="ENA_BUILD_VER"><phrase>1</phrase></para> |
@@ -159,10 +159,6 @@ | |||
159 | <entry>Supermicro SuperServer 5019A-12TN4 (Intel Atom | 159 | <entry>Supermicro SuperServer 5019A-12TN4 (Intel Atom |
160 | C3850)</entry> | 160 | C3850)</entry> |
161 | </row> | 161 | </row> |
162 | |||
163 | <row> | ||
164 | <entry>Silicom C3000 (Intel Atom 3558)</entry> | ||
165 | </row> | ||
166 | </tbody> | 162 | </tbody> |
167 | </entrytbl> | 163 | </entrytbl> |
168 | </row> | 164 | </row> |