summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-edge-release-info
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-edge-release-info')
-rw-r--r--doc/book-enea-edge-release-info/doc/about_release.xml21
-rw-r--r--doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml64
-rw-r--r--doc/book-enea-edge-release-info/doc/main_changes.xml182
3 files changed, 58 insertions, 209 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 076538f..9d65de6 100644
--- a/doc/book-enea-edge-release-info/doc/about_release.xml
+++ b/doc/book-enea-edge-release-info/doc/about_release.xml
@@ -42,11 +42,6 @@
42 <listitem> 42 <listitem>
43 <para>Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</para> 43 <para>Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</para>
44 </listitem> 44 </listitem>
45
46 <listitem>
47 <para>Enea_Edge_AF-TH_&lt;version&gt;-build&lt;build_number&gt;.zip
48 (deprecated as of version 2.4.0.)</para>
49 </listitem>
50 </itemizedlist> 45 </itemizedlist>
51 46
52 <para>Example Deployments:</para> 47 <para>Example Deployments:</para>
@@ -143,22 +138,6 @@
143 Describes the Enea Edge Automation and provides instructions regarding 138 Describes the Enea Edge Automation and provides instructions regarding
144 the necessary steps to configure and run the tool.</para> 139 the necessary steps to configure and run the tool.</para>
145 </listitem> 140 </listitem>
146
147 <listitem>
148 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
149 xmlns:xi="http://www.w3.org/2001/XInclude"
150 xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" />.
151 Describes the Automation Framework and Test Harness for Enea Edge
152 (deprecated).</para>
153 </listitem>
154
155 <listitem>
156 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
157 xmlns:xi="http://www.w3.org/2001/XInclude"
158 xpointer="element(book_enea_edge_system_test_specification/1)" />.
159 Describes a sample Test Suite for System Testing of Enea Edge.
160 (deprecated).</para>
161 </listitem>
162 </itemizedlist> 141 </itemizedlist>
163 </section> 142 </section>
164</chapter> \ No newline at end of file 143</chapter> \ 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 13a8c23..ee56256 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
@@ -5,7 +5,7 @@
5 <title>Known Issues and Limitations in this Release</title> 5 <title>Known Issues and Limitations in this Release</title>
6 6
7 <note> 7 <note>
8 <para>All issues may also affect previous releases.</para> 8 <para>No new limitations or issues were detected in this release.</para>
9 </note> 9 </note>
10 10
11 <itemizedlist> 11 <itemizedlist>
@@ -17,33 +17,25 @@
17 </listitem> 17 </listitem>
18 18
19 <listitem> 19 <listitem>
20 <para><remark>ELCCR-1733</remark>Logging into the Enea Edge Management
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>
25 </listitem>
26
27 <listitem>
28 <para><remark>ELCCR-1753</remark>When using tap interfaces for 20 <para><remark>ELCCR-1753</remark>When using tap interfaces for
29 communicating over the bridge, port numbers assigned to VM interfaces 21 communicating over the bridge, port numbers assigned to VM interfaces
30 can change when the VMs are restarted. The only currently known 22 can change when the VMs are restarted. The only currently known
31 workaround is rebooting the uCPE device.</para> 23 workaround is rebooting the uCPE device.</para>
32 </listitem> 24 </listitem>
33 25
34 <listitem> 26 <listitem>
35 <para><remark>ELCCR-1999</remark>Attempting to upload multiple files 27 <para><remark>ELCCR-1999</remark>Attempting to upload multiple files
36 simultaneously (e.g. a VNF image and custom scripts) in the Enea Edge 28 simultaneously (e.g. a VNF image and custom scripts) in the Enea Edge
37 Management application will cause all upload operations to be canceled. 29 Management application will cause all upload operations to be canceled.
38 In order to avoid this limitation, please wait until any previous 30 In order to avoid this limitation, please wait until any previous upload
39 upload finishes before initiating a new one.</para> 31 finishes before initiating a new one.</para>
40 </listitem> 32 </listitem>
41 33
42 <listitem> 34 <listitem>
43 <para><remark>LXCR-10922</remark>A very rare error on some Atom C3000 35 <para><remark>LXCR-10922</remark>A very rare error on certain Atom C3000
44 boards makes X553 SFP+ Ethernet ports unusable until a target cold reset 36 boards makes X553 SFP+ Ethernet ports unusable until a target cold reset
45 is performed. When the error occurs in Enea Edge Runtime 2.5.0, there 37 is performed. When the error occurs in Enea Edge Runtime 2.5.0 or later,
46 will be a warning printed into the console by the 38 there will be a warning printed into the console by the
47 <literal>ixgbe</literal> driver:</para> 39 <literal>ixgbe</literal> driver:</para>
48 40
49 <programlisting>[11.361580] ixgbe 0000:0a:00.0: Warning firmware error detected FWSM: 0x8010801A</programlisting> 41 <programlisting>[11.361580] ixgbe 0000:0a:00.0: Warning firmware error detected FWSM: 0x8010801A</programlisting>
@@ -51,12 +43,7 @@
51 <para>The only currently known workaround for this issue is a cold 43 <para>The only currently known workaround for this issue is a cold
52 reset.</para> 44 reset.</para>
53 </listitem> 45 </listitem>
54 </itemizedlist>
55
56 <para><emphasis role="bold">Limitations detected in previous releases,
57 that still affect this release:</emphasis></para>
58 46
59 <itemizedlist>
60 <listitem> 47 <listitem>
61 <para><remark>ELCCR-474</remark>Deleting VNF instances with flows 48 <para><remark>ELCCR-474</remark>Deleting VNF instances with flows
62 configured on the OVS bridges can be done only after removing the 49 configured on the OVS bridges can be done only after removing the
@@ -160,12 +147,6 @@
160 </listitem> 147 </listitem>
161 148
162 <listitem> 149 <listitem>
163 <para><remark>LXCR-10750</remark>In order to avoid an incorrect boot
164 order after a failed upgrade, the user should remove the upgrade image
165 before attempting again.</para>
166 </listitem>
167
168 <listitem>
169 <para><remark>USERDOCAP-641</remark>Enea Edge does not have support for 150 <para><remark>USERDOCAP-641</remark>Enea Edge does not have support for
170 IPv6 addresses on both uCPE devices and the Enea Edge Management 151 IPv6 addresses on both uCPE devices and the Enea Edge Management
171 installation.</para> 152 installation.</para>
@@ -186,31 +167,6 @@
186 </listitem> 167 </listitem>
187 </itemizedlist> 168 </itemizedlist>
188 169
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
214 <!-- The file with a section below is autocreated by make init --> 170 <!-- The file with a section below is autocreated by make init -->
215 171
216 <!-- <xi:include href="jiraissues_generated.xml" 172 <!-- <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 629a892..145972b 100644
--- a/doc/book-enea-edge-release-info/doc/main_changes.xml
+++ b/doc/book-enea-edge-release-info/doc/main_changes.xml
@@ -15,22 +15,11 @@
15 15
16 <itemizedlist> 16 <itemizedlist>
17 <listitem> 17 <listitem>
18 <para>Support for Fully Qualified Domain Names (FQDN) for the Enea 18 <para>Support for Multi-Factor Authentication in the Enea Edge
19 Edge Management application address. For more details please see 19 Management. For more details please see <olink
20 <olink targetdoc="book_enea_edge_getting_started"
21 targetptr="prep_deploy">Preparing the Deployment 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>
26 </listitem>
27
28 <listitem>
29 <para>Support for a DNS servers list for WAN interfaces with a static
30 IP configuration. For more details please see <olink
31 targetdoc="book_enea_edge_getting_started" 20 targetdoc="book_enea_edge_getting_started"
32 targetptr="install_ena_device">Installing Enea Edge - uCPE Device 21 targetptr="mfa_security">Authenticating using Multi-Factor
33 Installation in the <xi:include 22 Authentication in the <xi:include
34 href="../../s_docbuild/olinkdb/pardoc-names.xml" 23 href="../../s_docbuild/olinkdb/pardoc-names.xml"
35 xmlns:xi="http://www.w3.org/2001/XInclude" 24 xmlns:xi="http://www.w3.org/2001/XInclude"
36 xpointer="element(book_enea_edge_getting_started/1)" /></olink> 25 xpointer="element(book_enea_edge_getting_started/1)" /></olink>
@@ -38,109 +27,44 @@
38 </listitem> 27 </listitem>
39 28
40 <listitem> 29 <listitem>
41 <para>Support for NFV Infrastructure backup and restore to allow for 30 <para>Support for White-labeling of the Enea Edge Management
42 recovery to a previously known state. For more details please see 31 application to replace Enea branding elements with custom logos. For
43 <olink targetdoc="book_enea_edge_getting_started" 32 more details please see <olink
44 targetptr="nfvi_backup">NFV Infrastructure Backup Operations in the 33 targetdoc="book_enea_edge_getting_started"
45 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" 34 targetptr="whitelabel">White-labeling the Enea Edge Management Login in
35 the <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
46 xmlns:xi="http://www.w3.org/2001/XInclude" 36 xmlns:xi="http://www.w3.org/2001/XInclude"
47 xpointer="element(book_enea_edge_getting_started/1)" /></olink> 37 xpointer="element(book_enea_edge_getting_started/1)" /></olink>
48 Manual.</para> 38 Manual.</para>
49 </listitem> 39 </listitem>
50 40
51 <listitem> 41 <listitem>
52 <para>Support for VNF snapshotting to allow for storing, managing and 42 <para>Support for Automated Deployment Reporting to gather information
53 restoring snapshots of VNFs deployed on Enea Edge Runtime. For more 43 about all uCPE devices enrolled in a deployment. For more details
54 details please see <olink targetdoc="book_enea_edge_getting_started" 44 please see <olink targetdoc="book_enea_edge_automation_user_guide"
55 targetptr="vnf_snapshots">VNF Snapshots in the <xi:include 45 targetptr="auto_deploy_reporting">Automated Deployment Reporting in
56 href="../../s_docbuild/olinkdb/pardoc-names.xml" 46 the <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
57 xmlns:xi="http://www.w3.org/2001/XInclude" 47 xmlns:xi="http://www.w3.org/2001/XInclude"
58 xpointer="element(book_enea_edge_getting_started/1)" /></olink> 48 xpointer="element(book_enea_edge_automation_user_guide/1)" /></olink>.</para>
59 Manual.</para>
60 </listitem> 49 </listitem>
61 </itemizedlist> 50 </itemizedlist>
62 51
63 <para><emphasis role="bold">Improvements:</emphasis></para> 52 <para><emphasis role="bold">Removed Features:</emphasis></para>
64
65 <itemizedlist>
66 <listitem>
67 <para>Documented and hardened support for Factory Reset allowing
68 reverting of the Enea Edge Runtime to its initial state.
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>
96 </listitem>
97
98 <listitem>
99 <para>Improved the upgrade and uninstall processes of the Enea Edge
100 Management component: the database information is no longer requested
101 during an upgrade or an uninstall.</para>
102 </listitem>
103
104 <listitem>
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 53
116 <listitem> 54 <para>The deprecated Enea Edge Automation Framework and Test Harness
117 <para>QEMU 5.2.0</para> 55 component is no longer supported and has been removed. It is replaced by
118 </listitem> 56 the new Automation Framework included with this release.</para>
119 57
120 <listitem> 58 <para><emphasis role="bold">Early Access Features:</emphasis></para>
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 59
133 <para>Further information about what open source versions are used in 60 <para>Early Access features are provided for evaluation and early
134 Enea Edge Runtime, can be found in the Enea Edge Runtime Open Source 61 feedback. They are not allowed to be used for business-critical
135 Report.</para> 62 deployment, unless previously approved by Enea. Support cases reported on
136 </listitem> 63 Early Access features may only be set to a Minor Priority, with the intent
137 </itemizedlist> 64 of addressing them in upcoming GA releases.</para>
138
139 <para></para>
140 <para></para>
141 <para></para>
142 65
143 <para><emphasis role="bold">Early Access Features:</emphasis></para> 66 <para>Early Access Features are not described in the standard
67 documentation. Please contact Enea Support for documentation.</para>
144 68
145 <para>The following Early Access features are included in this 69 <para>The following Early Access features are included in this
146 release:</para> 70 release:</para>
@@ -149,8 +73,8 @@
149 <listitem> 73 <listitem>
150 <para><remark>CPDX-3498</remark>High Availability support with 74 <para><remark>CPDX-3498</remark>High Availability support with
151 redundant Enea Edge Management applications in active standby 75 redundant Enea Edge Management applications in active standby
152 configuration. This EA feature has remained unchanged since the 76 configuration. This EA feature has remained unchanged since the Enea
153 Enea Edge 2.4.0 release.</para> 77 Edge 2.4.0 release.</para>
154 78
155 <para>In order to increase resiliency on the uCPE management side, the 79 <para>In order to increase resiliency on the uCPE management side, the
156 Enea Edge Management application can be installed in High-Availability 80 Enea Edge Management application can be installed in High-Availability
@@ -159,13 +83,12 @@
159 Centers and geographical locations, and with multiple MariaDB servers 83 Centers and geographical locations, and with multiple MariaDB servers
160 for each location.</para> 84 for each location.</para>
161 </listitem> 85 </listitem>
162 </itemizedlist>
163 86
164 <para>Early Access features are provided for evaluation and early 87 <listitem>
165 feedback. They are not allowed to be used for business-critical 88 <para>Support in the Enea Edge Management application to display uCPE
166 deployment, unless previously approved by Enea. Support cases reported on 89 devices on a geographical map.<remark>CPDX-3512</remark></para>
167 Early Access features may only be set to a Minor Priority, with the intent 90 </listitem>
168 of addressing them in upcoming GA releases.</para> 91 </itemizedlist>
169 </section> 92 </section>
170 93
171 <section id="open_source"> 94 <section id="open_source">
@@ -178,33 +101,27 @@
178 101
179 <itemizedlist> 102 <itemizedlist>
180 <listitem> 103 <listitem>
181 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" 104 <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
182 xmlns:xi="http://www.w3.org/2001/XInclude" 105 xmlns:ns="http://www.w3.org/2001/XInclude"
183 xpointer="element(book_enea_edge_runtime_open_source/1)" />.</para> 106 xpointer="element(book_enea_edge_runtime_open_source/1)" /></para>
184 </listitem>
185
186 <listitem>
187 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
188 xmlns:xi="http://www.w3.org/2001/XInclude"
189 xpointer="element(book_enea_edge_management_open_source/1)" />.</para>
190 </listitem> 107 </listitem>
191 108
192 <listitem> 109 <listitem>
193 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" 110 <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
194 xmlns:xi="http://www.w3.org/2001/XInclude" 111 xmlns:ns="http://www.w3.org/2001/XInclude"
195 xpointer="element(book_enea_edge_telemetry_open_source/1)" />.</para> 112 xpointer="element(book_enea_edge_management_open_source/1)" /></para>
196 </listitem> 113 </listitem>
197 114
198 <listitem> 115 <listitem>
199 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" 116 <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
200 xmlns:xi="http://www.w3.org/2001/XInclude" 117 xmlns:ns="http://www.w3.org/2001/XInclude"
201 xpointer="element(book_enea_edge_automation_open_source/1)" />.</para> 118 xpointer="element(book_enea_edge_telemetry_open_source/1)" /></para>
202 </listitem> 119 </listitem>
203 120
204 <listitem> 121 <listitem>
205 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" 122 <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
206 xmlns:xi="http://www.w3.org/2001/XInclude" 123 xmlns:ns="http://www.w3.org/2001/XInclude"
207 xpointer="element(book_enea_edge_auto_fw_th_open_source/1)" />.</para> 124 xpointer="element(book_enea_edge_automation_open_source/1)" /></para>
208 </listitem> 125 </listitem>
209 </itemizedlist> 126 </itemizedlist>
210 </section> 127 </section>
@@ -213,9 +130,6 @@
213 <title>Compatibility</title> 130 <title>Compatibility</title>
214 131
215 <para>This release does not contain any public API changes impacting 132 <para>This release does not contain any public API changes impacting
216 backwards compatibility. However, Python 2 support in Enea Edge Runtime 133 backwards compatibility.</para>
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>
220 </section> 134 </section>
221</chapter> \ No newline at end of file 135</chapter> \ No newline at end of file