summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormrpa <miruna.paun@enea.com>2021-11-25 01:13:02 +0100
committermrpa <miruna.paun@enea.com>2021-11-25 01:14:52 +0100
commitea95b719bc2a2daad84fa080e8855d7d34e075fc (patch)
treebb054329bab07c8148fafeda5d9ee51e11dd8f34
parentd9e7899b401156fd490783b756cc75c7c7a29614 (diff)
downloadnfv-access-documentation-ea95b719bc2a2daad84fa080e8855d7d34e075fc.tar.gz
Updated the rel notes manual for DP3, inital edits.
USERDOCAP-736 Change-Id: Ic55d11e3dc180a82cc525de5b138c5555361b20c Signed-off-by: mrpa <miruna.paun@enea.com>
-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.xml57
-rw-r--r--doc/book-enea-edge-release-info/doc/main_changes.xml93
3 files changed, 69 insertions, 102 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 866ca75..bb408d8 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
@@ -10,6 +10,15 @@
10 10
11 <itemizedlist> 11 <itemizedlist>
12 <listitem> 12 <listitem>
13 <para>???</para>
14 </listitem>
15 </itemizedlist>
16
17 <para><emphasis role="bold">Limitations detected in previous releases, that
18 still affect this release:</emphasis></para>
19
20 <itemizedlist>
21 <listitem>
13 <para><remark>ELCCR-1688, ELCCR-1809</remark>It is possible to end up 22 <para><remark>ELCCR-1688, ELCCR-1809</remark>It is possible to end up
14 with a corrupted VM image from the download operation. If that happens, 23 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 24 the VNF instantiation will fail. The corrupted image has to be manually
@@ -22,20 +31,20 @@
22 can change when the VMs are restarted. The only currently known 31 can change when the VMs are restarted. The only currently known
23 workaround is rebooting the uCPE device.</para> 32 workaround is rebooting the uCPE device.</para>
24 </listitem> 33 </listitem>
25 34
26 <listitem> 35 <listitem>
27 <para><remark>ELCCR-1999</remark>Attempting to upload multiple files 36 <para><remark>ELCCR-1999</remark>Attempting to upload multiple files
28 simultaneously (e.g. a VNF image and custom scripts) in the Enea Edge 37 simultaneously (e.g. a VNF image and custom scripts) in the Enea Edge
29 Management application will cause all upload operations to be canceled. 38 Management application will cause all upload operations to be canceled.
30 In order to avoid this limitation, please wait until any previous 39 In order to avoid this limitation, please wait until any previous upload
31 upload finishes before initiating a new one.</para> 40 finishes before initiating a new one.</para>
32 </listitem> 41 </listitem>
33 42
34 <listitem> 43 <listitem>
35 <para><remark>LXCR-10922</remark>A very rare error on some Atom C3000 44 <para><remark>LXCR-10922</remark>A very rare error on certain Atom C3000
36 boards makes X553 SFP+ Ethernet ports unusable until a target cold reset 45 boards makes X553 SFP+ Ethernet ports unusable until a target cold reset
37 is performed. When the error occurs in Enea Edge Runtime 2.5.0, there 46 is performed. When the error occurs in Enea Edge Runtime 2.5.0 or later,
38 will be a warning printed into the console by the 47 there will be a warning printed into the console by the
39 <literal>ixgbe</literal> driver:</para> 48 <literal>ixgbe</literal> driver:</para>
40 49
41 <programlisting>[11.361580] ixgbe 0000:0a:00.0: Warning firmware error detected FWSM: 0x8010801A</programlisting> 50 <programlisting>[11.361580] ixgbe 0000:0a:00.0: Warning firmware error detected FWSM: 0x8010801A</programlisting>
@@ -43,12 +52,7 @@
43 <para>The only currently known workaround for this issue is a cold 52 <para>The only currently known workaround for this issue is a cold
44 reset.</para> 53 reset.</para>
45 </listitem> 54 </listitem>
46 </itemizedlist>
47
48 <para><emphasis role="bold">Limitations detected in previous releases,
49 that still affect this release:</emphasis></para>
50 55
51 <itemizedlist>
52 <listitem> 56 <listitem>
53 <para><remark>ELCCR-474</remark>Deleting VNF instances with flows 57 <para><remark>ELCCR-474</remark>Deleting VNF instances with flows
54 configured on the OVS bridges can be done only after removing the 58 configured on the OVS bridges can be done only after removing the
@@ -178,31 +182,6 @@
178 </listitem> 182 </listitem>
179 </itemizedlist> 183 </itemizedlist>
180 184
181 <para><emphasis role="bold">The following limitations affect deprecated
182 components and their documentation:</emphasis></para>
183
184 <itemizedlist>
185 <listitem>
186 <para><remark>STCR-6224</remark>The Enea Edge Automation Framework and
187 Test Harness do not support multiple custom scripts uploaded to a uCPE
188 device at the same time. This limitation does not apply to Enea Edge
189 Automation.</para>
190 </listitem>
191
192 <listitem>
193 <para><remark>STCR-6292</remark>Management of WAN Interfaces is not
194 implemented in the Enea Edge Automation Framework and Test
195 Harness. This limitation does not apply to the Enea Edge Automation.</para>
196 </listitem>
197
198 <listitem>
199 <para><remark>USERDOCAP-628</remark>The Enea Edge Automation Framework
200 and Test Harness do not have support for product features implemented in
201 Enea Edge 2.4.0 or newer. Please use the new Enea Edge Automation
202 component if you want support for newer features.</para>
203 </listitem>
204 </itemizedlist>
205
206 <!-- The file with a section below is autocreated by make init --> 185 <!-- The file with a section below is autocreated by make init -->
207 186
208 <!-- <xi:include href="jiraissues_generated.xml" 187 <!-- <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..3727330 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,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" 20 targetdoc="book_enea_edge_getting_started"
21 targetptr="prep_deploy">Preparing the Deployment in the <xi:include 21 targetptr="mfa_security">Authenticating using Multi-Factor
22 Authentication in the <xi:include
22 href="../../s_docbuild/olinkdb/pardoc-names.xml" 23 href="../../s_docbuild/olinkdb/pardoc-names.xml"
23 xmlns:xi="http://www.w3.org/2001/XInclude" 24 xmlns:xi="http://www.w3.org/2001/XInclude"
24 xpointer="element(book_enea_edge_getting_started/1)" /></olink> 25 xpointer="element(book_enea_edge_getting_started/1)" /></olink>
@@ -26,53 +27,61 @@
26 </listitem> 27 </listitem>
27 28
28 <listitem> 29 <listitem>
29 <para>Support for a DNS servers list for WAN interfaces with a static 30 <para>Support for uCPE management plane redundancy, with automatic
30 IP configuration. For more details please see <olink 31 failover between a primary and secondary management connection. For
32 more details please see <olink
31 targetdoc="book_enea_edge_getting_started" 33 targetdoc="book_enea_edge_getting_started"
32 targetptr="install_ena_device">Installing Enea Edge - uCPE Device 34 targetptr="high_availability_ig">Installing the Enea Edge Management
33 Installation in the <xi:include 35 application in High Availability Mode in the <xi:include
34 href="../../s_docbuild/olinkdb/pardoc-names.xml" 36 href="../../s_docbuild/olinkdb/pardoc-names.xml"
35 xmlns:xi="http://www.w3.org/2001/XInclude" 37 xmlns:xi="http://www.w3.org/2001/XInclude"
36 xpointer="element(book_enea_edge_getting_started/1)" /></olink> 38 xpointer="element(book_enea_edge_getting_started/1)" /></olink>
37 Manual.</para> 39 Manual. This feature is currently available upon request.</para>
38 </listitem> 40 </listitem>
39 41
40 <listitem> 42 <listitem>
41 <para>Support for NFV Infrastructure backup and restore to allow for 43 <para>Support for Whitelabeling of the Enea Edge Management
42 recovery to a previously known state. For more details please see 44 application to replace Enea branding elements with custom logos. For
43 <olink targetdoc="book_enea_edge_getting_started" 45 more details please see <olink
44 targetptr="nfvi_backup">NFV Infrastructure Backup Operations in the 46 targetdoc="book_enea_edge_getting_started"
45 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" 47 targetptr="whitelabel">Whitelabeling the Enea Edge Management Login in
48 the <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
46 xmlns:xi="http://www.w3.org/2001/XInclude" 49 xmlns:xi="http://www.w3.org/2001/XInclude"
47 xpointer="element(book_enea_edge_getting_started/1)" /></olink> 50 xpointer="element(book_enea_edge_getting_started/1)" /></olink>
48 Manual.</para> 51 Manual.</para>
49 </listitem> 52 </listitem>
50 53
51 <listitem> 54 <listitem>
52 <para>Support for VNF snapshotting to allow for storing, managing and 55 <para>Support for Automated Deployment Reporting to gather information
53 restoring snapshots of VNFs deployed on Enea Edge Runtime. For more 56 about all uCPE devices enrolled in a deployment. For more details
54 details please see <olink targetdoc="book_enea_edge_getting_started" 57 please see <olink targetdoc="book_enea_edge_automation_user_guide"
55 targetptr="vnf_snapshots">VNF Snapshots in the <xi:include 58 targetptr="auto_deploy_reporting">Automated Deployment Reporting in
56 href="../../s_docbuild/olinkdb/pardoc-names.xml" 59 the <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
57 xmlns:xi="http://www.w3.org/2001/XInclude" 60 xmlns:xi="http://www.w3.org/2001/XInclude"
58 xpointer="element(book_enea_edge_getting_started/1)" /></olink> 61 xpointer="element(book_enea_edge_automation_user_guide/1)" /></olink>.</para>
59 Manual.</para>
60 </listitem> 62 </listitem>
61 </itemizedlist> 63 </itemizedlist>
62 64
65 <para><emphasis role="bold">Removed Features:</emphasis></para>
66
67 <para>The deprecated Enea Edge Automation Framework and Test Harness,
68 along with its User Guide and Open Source report, as well as the System
69 Test Specification Manual are no longer supported and have been removed
70 from the release.</para>
71
63 <para><emphasis role="bold">Improvements:</emphasis></para> 72 <para><emphasis role="bold">Improvements:</emphasis></para>
64 73
65 <itemizedlist> 74 <itemizedlist>
66 <listitem> 75 <listitem>
67 <para>Documented and hardened support for Factory Reset allowing 76 <para>Documented and hardened support for Factory Reset allowing
68 reverting of the Enea Edge Runtime to its initial state. 77 reverting of the Enea Edge Runtime to its initial state. For more
69 For more details please see <olink 78 details please see <olink targetdoc="book_enea_edge_getting_started"
70 targetdoc="book_enea_edge_getting_started"
71 targetptr="basic_oper_device">Basic operations for uCPE device 79 targetptr="basic_oper_device">Basic operations for uCPE device
72 Management in the <ns:include 80 Management in the <ns:include
73 href="../../s_docbuild/olinkdb/pardoc-names.xml" 81 href="../../s_docbuild/olinkdb/pardoc-names.xml"
74 xpointer="element(book_enea_edge_getting_started/1)" 82 xmlns:ns="http://www.w3.org/2001/XInclude"
75 xmlns:ns="http://www.w3.org/2001/XInclude" /></olink> Manual.</para> 83 xpointer="element(book_enea_edge_getting_started/1)" /></olink>
84 Manual.</para>
76 </listitem> 85 </listitem>
77 86
78 <listitem> 87 <listitem>
@@ -135,10 +144,6 @@
135 Report.</para> 144 Report.</para>
136 </listitem> 145 </listitem>
137 </itemizedlist> 146 </itemizedlist>
138
139 <para></para>
140 <para></para>
141 <para></para>
142 147
143 <para><emphasis role="bold">Early Access Features:</emphasis></para> 148 <para><emphasis role="bold">Early Access Features:</emphasis></para>
144 149
@@ -147,10 +152,15 @@
147 152
148 <itemizedlist> 153 <itemizedlist>
149 <listitem> 154 <listitem>
155 <para>Support in the Enea Edge Management application to display uCPE
156 devices on a geographical map.</para>
157 </listitem>
158
159 <listitem>
150 <para><remark>CPDX-3498</remark>High Availability support with 160 <para><remark>CPDX-3498</remark>High Availability support with
151 redundant Enea Edge Management applications in active standby 161 redundant Enea Edge Management applications in active standby
152 configuration. This EA feature has remained unchanged since the 162 configuration. This EA feature has remained unchanged since the Enea
153 Enea Edge 2.4.0 release.</para> 163 Edge 2.4.0 release.</para>
154 164
155 <para>In order to increase resiliency on the uCPE management side, the 165 <para>In order to increase resiliency on the uCPE management side, the
156 Enea Edge Management application can be installed in High-Availability 166 Enea Edge Management application can be installed in High-Availability
@@ -161,11 +171,13 @@
161 </listitem> 171 </listitem>
162 </itemizedlist> 172 </itemizedlist>
163 173
164 <para>Early Access features are provided for evaluation and early 174 <para>Early Access Features are not described in the standard
165 feedback. They are not allowed to be used for business-critical 175 documentation. Please contact Enea Support for documentation specific to
166 deployment, unless previously approved by Enea. Support cases reported on 176 Early Access features. They are provided for evaluation and early
167 Early Access features may only be set to a Minor Priority, with the intent 177 feedback, and are not allowed to be used for business-critical deployment,
168 of addressing them in upcoming GA releases.</para> 178 unless previously approved by Enea. Support cases reported on Early Access
179 features may only be set to a Minor Priority, with the intent of
180 addressing them in upcoming GA releases.</para>
169 </section> 181 </section>
170 182
171 <section id="open_source"> 183 <section id="open_source">
@@ -213,9 +225,6 @@
213 <title>Compatibility</title> 225 <title>Compatibility</title>
214 226
215 <para>This release does not contain any public API changes impacting 227 <para>This release does not contain any public API changes impacting
216 backwards compatibility. However, Python 2 support in Enea Edge Runtime 228 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> 229 </section>
221</chapter> \ No newline at end of file 230</chapter> \ No newline at end of file