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.xml188
-rw-r--r--doc/book-enea-edge-release-info/doc/book.xml31
-rw-r--r--doc/book-enea-edge-release-info/doc/getting_enea_nfv_access.xml54
-rw-r--r--doc/book-enea-edge-release-info/doc/jiraissues_override.xml36
-rw-r--r--doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml179
-rw-r--r--doc/book-enea-edge-release-info/doc/main_changes.xml189
-rw-r--r--doc/book-enea-edge-release-info/doc/system_requirements_prerequisites.xml62
-rw-r--r--doc/book-enea-edge-release-info/swcomp.mk10
8 files changed, 749 insertions, 0 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
new file mode 100644
index 0000000..349c955
--- /dev/null
+++ b/doc/book-enea-edge-release-info/doc/about_release.xml
@@ -0,0 +1,188 @@
1<?xml version="1.0" encoding="UTF-8"?>
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-about-release">
5 <title>About This Release</title>
6
7 <para>Enea Edge is a complete Virtualization Infrastructure software
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
10 on a white box, the Enea Edge Management application and the Enea Edge
11 Automation, management and automation tools deployed in a
12 private or public cloud.</para>
13
14 <para>The Enea Edge <xi:include
15 href="../../s_doceneacommon/doc/eltf_params_updated.xml"
16 xmlns:xi="http://www.w3.org/2001/XInclude"
17 xpointer="element(EneaLinux_REL_VER/1)" /> Release includes new features,
18 optimizations, corrections, and updates to the user documentation..
19 A list of major new features and improvements can be found in
20 <xref linkend="relinfo-changes-other">Section 2.1 New Features and Improvements</xref>.</para>
21
22 <section id="release-content">
23 <title>Enea Edge Release Content</title>
24
25 <para>The release content is detailed below:</para>
26
27 <para>Main Components</para>
28
29 <itemizedlist>
30 <listitem>
31 <para>Enea_Edge_Runtime_C3000_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</para>
32 </listitem>
33
34 <listitem>
35 <para>Enea_Edge_Runtime_XeonD_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</para>
36 </listitem>
37
38 <listitem>
39 <para>Enea_Edge_Automation_&lt;version&gt;-build&lt;build_number&gt;.zip</para>
40 </listitem>
41
42 <listitem>
43 <para>Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</para>
44 </listitem>
45
46 <listitem>
47 <para>Enea_Edge_AF-TH_&lt;version&gt;-build&lt;build_number&gt;.zip
48 (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New
49 Features and Improvements</xref>.)</para>
50 </listitem>
51 </itemizedlist>
52
53 <para>Example Deployments:</para>
54
55 <itemizedlist>
56 <listitem>
57 <para>Enea_Edge_Telemetry_Deploy_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</para>
58 </listitem>
59
60 <listitem>
61 <para>VNF_example_configurations.tar.gz</para>
62 </listitem>
63 </itemizedlist>
64
65 <programlisting condition="arm">-- documentation/
66 /* Enea Edge documentation */
67-- README
68-- aarch64 /* architecture */
69 -- cn8304/
70 /* artifacts for the host side */
71 -- deb/
72 /* deb packages */
73 -- images/
74 -- enea-nfv-access
75 /* precompiled artifacts for the platform release image */
76 -- various artifacts (rootfs, kernel, config etc.)
77 -- enea-nfv-access-dev
78 /* precompiled artifacts for the development process. The image
79 contains userspace tools and kernel configurations necessary
80 for developing, debugging and profiling applications and
81 kernel modules */
82 -- various artifacts
83 -- qemuarm64
84 /* artifacts for the guest side */
85 -- deb/
86 /* deb packages */
87 -- images/
88 -- enea-nfv-access-guest
89 /* precompiled artifacts for the QEMU/Docker release image */
90 -- various artifacts
91 -- enea-nfv-access-guest-dev
92 /* precompiled artifacts for the development process. The image
93 contains userspace tools and kernel configurations necessary
94 for developing, debugging and profiling applications and
95 kernel modules */
96 -- various artifacts</programlisting>
97 </section>
98
99 <remark>INFO Below is a complete section with ID
100 "eltf-target-tables-section" included from elft_params_updated.xml. It
101 contains a variable number of target tables and the section title should be
102 "Supported Targets with Parameters". It has have a short sentence about what
103 it is in the beginning. The subtitles shall have the directory name of the
104 target in the manifest.</remark>
105
106 <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml"
107 xmlns:xi="http://www.w3.org/2001/XInclude"
108 xpointer="element(eltf-target-tables-section)" />
109
110 <section id="relinfo-documentation">
111 <title>User Documentation</title>
112
113 <para>This release of Enea Edge contains the following set of
114 documents:</para>
115
116 <itemizedlist>
117 <listitem>
118 <para>Enea Edge Release Information. Describes the Enea Edge release
119 content, main changes, the list of known issues and
120 limitations.</para>
121 </listitem>
122
123 <listitem>
124 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
125 xmlns:xi="http://www.w3.org/2001/XInclude"
126 xpointer="element(book_enea_edge_getting_started/1)" />. Describes how
127 to deploy and upgrade an Enea Edge base configuration, advanced
128 configurations of the system as well as troubleshooting
129 information.</para>
130 </listitem>
131
132 <listitem>
133 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
134 xmlns:xi="http://www.w3.org/2001/XInclude"
135 xpointer="element(book_enea_edge_example_usecases/1)" />. Describes
136 examples of onboarding, instantiating and configuring various
137 VNFs.</para>
138 </listitem>
139
140 <listitem>
141 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
142 xmlns:xi="http://www.w3.org/2001/XInclude"
143 xpointer="element(book_enea_edge_automation_user_guide/1)" />.
144 Describes the Enea Edge Automation and provides instructions regarding
145 the necessary steps to configure and run the tool.</para>
146 </listitem>
147
148 <listitem>
149 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
150 xmlns:xi="http://www.w3.org/2001/XInclude"
151 xpointer="element(book_enea_edge_auto_fw_th_user_guide/1)" />.
152 Describes the Automation Framework and Test Harness for Enea Edge
153 (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New
154 Features and Improvements</xref>).</para>
155 </listitem>
156
157 <listitem>
158 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
159 xmlns:xi="http://www.w3.org/2001/XInclude"
160 xpointer="element(book_enea_edge_system_test_specification/1)" />.
161 Describes a sample Test Suite for System Testing of Enea Edge.
162 (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New
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>
186 </itemizedlist>
187 </section>
188</chapter> \ No newline at end of file
diff --git a/doc/book-enea-edge-release-info/doc/book.xml b/doc/book-enea-edge-release-info/doc/book.xml
new file mode 100644
index 0000000..0b77f41
--- /dev/null
+++ b/doc/book-enea-edge-release-info/doc/book.xml
@@ -0,0 +1,31 @@
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED">
5]>
6<book id="book_enea_edge_release_info">
7 <title><trademark class="registered">Enea</trademark> Edge Release
8 Information</title>
9
10 <subtitle>Release Version <xi:include
11 href="../../s_doceneacommon/doc/eltf_params_updated.xml"
12 xmlns:xi="http://www.w3.org/2001/XInclude"
13 xpointer="element(EneaLinux_REL_VER/1)" /></subtitle>
14
15 <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb -->
16
17 <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml"
18 xmlns:xi="http://www.w3.org/2001/XInclude" />
19
20 <xi:include href="about_release.xml"
21 xmlns:xi="http://www.w3.org/2001/XInclude" />
22
23 <xi:include href="main_changes.xml"
24 xmlns:xi="http://www.w3.org/2001/XInclude" />
25
26 <xi:include href="known_bugs_and_limitations.xml"
27 xmlns:xi="http://www.w3.org/2001/XInclude" />
28
29 <xi:include href="../../s_docbuild/template/docsrc_common/contacting_enea_nfva.xml"
30 xmlns:xi="http://www.w3.org/2001/XInclude" />
31</book> \ No newline at end of file
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
new file mode 100644
index 0000000..9eecd3c
--- /dev/null
+++ b/doc/book-enea-edge-release-info/doc/getting_enea_nfv_access.xml
@@ -0,0 +1,54 @@
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/jiraissues_override.xml b/doc/book-enea-edge-release-info/doc/jiraissues_override.xml
new file mode 100644
index 0000000..7282d0f
--- /dev/null
+++ b/doc/book-enea-edge-release-info/doc/jiraissues_override.xml
@@ -0,0 +1,36 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<section id="relinfo-extracted-from-jira">
5 <title>Release-Specific Problems</title>
6
7 <informaltable>
8 <tgroup cols="2">
9 <colspec colwidth="6*" colname="c1"/>
10
11 <colspec align="center" colwidth="1*" colname="c2"/>
12
13 <thead>
14 <row>
15 <entry align="center">Summary</entry>
16
17 <entry>Enea Ref</entry>
18 </row>
19 </thead>
20
21 <tbody>
22 <row>
23 <entry>Eclipse Plug-Ins for Perf and Latencytop are not functioning properly on P2041RDB target.</entry>
24
25 <entry>LXCR-6936</entry>
26 </row>
27
28 <row>
29 <entry><para>LTTng kernel tracing from Eclipse does not work due to RSE connectivity problems.</para><para>As a workaround, traces can be collected on target and visualized on Eclipse, after copying the files on the host system.</para></entry>
30
31 <entry>LXCR-7166</entry>
32 </row>
33 </tbody>
34 </tgroup>
35 </informaltable>
36</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
new file mode 100644
index 0000000..81816a5
--- /dev/null
+++ b/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml
@@ -0,0 +1,179 @@
1<?xml version="1.0" encoding="UTF-8"?>
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="bugs-limitations">
5 <title>Known Issues and Limitations in this Release</title>
6
7 <para>This chapter lists the known general issues and limitations that
8 affect the current release.</para>
9
10 <itemizedlist>
11 <listitem>
12 <para><remark>LXCR-9904</remark>Enea Edge Runtime cannot be installed on
13 USB storage devices.</para>
14 </listitem>
15
16 <listitem>
17 <para><remark>LXCR-9799</remark>Proper boot order is not ensured if a
18 uCPE device has more than one HDD attached.</para>
19 </listitem>
20
21 <listitem>
22 <para><remark>ELCCR-527</remark>Cancelling a file upload in the Enea
23 Edge Management will require the user to close and reopen the upload
24 window for the next upload to work.</para>
25 </listitem>
26
27 <listitem>
28 <para><remark>ELCCR-577</remark>If the Enea Edge Management application
29 is restored from a backup made on a release version older than Enea NFV
30 Access 2.2.3, VNFs cannot be instantiated from the GUI.</para>
31 </listitem>
32
33 <listitem>
34 <para><remark>ELCCR-1134</remark>In order to avoid an incorrect boot
35 order after a failed upgrade, the user should remove the upgrade
36 image before attempting again.</para>
37 </listitem>
38
39 <listitem>
40 <para><remark>ELCCR-474</remark>Deleting VNF instances with flows
41 configured on the OVS bridges can be done only after removing the
42 flows.</para>
43 </listitem>
44
45 <listitem>
46 <para><remark>ELCCR-572</remark>Sometimes when selecting and deleting
47 more than one VNF instance simultaneously, an error message might be
48 triggered, even if the delete operation succeeds.</para>
49 </listitem>
50
51 <listitem>
52 <para><remark>ELCCR-847</remark>The Juniper vSRX VNF cannot be
53 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
55 Juniper VNF is used.</para>
56 </listitem>
57
58 <listitem>
59 <para><remark>USERDOCAP-648</remark>The <literal>storage size</literal>
60 parameter on the VNF onboarding page is ignored. The default storage
61 size specified when creating the VM image is used when instantiating the
62 VM and when presenting VM information.</para>
63 </listitem>
64
65 <listitem>
66 <para><remark>LXCR-9853</remark>The WAN interface of a uCPE device needs
67 to be connected to a network with at least a router/gateway installed
68 for next-hop communication.</para>
69 </listitem>
70
71 <listitem>
72 <para><remark>ELCCR-1504</remark>To change the type of an interface
73 from DPDK to SR-IOV, first delete the existing interface, then
74 recreate it with the desired type.</para>
75 </listitem>
76
77 <listitem>
78 <para><remark>LXCR-9992</remark>Depending on hardware capabilities,
79 there are certain limitations regarding the <literal>vfio-pci</literal>
80 and <literal>igb_uio</literal> drivers. While the Enea Edge Runtime uses
81 the <literal>vfio-pci</literal> driver by default, for certain hardware
82 configurations, <literal>igb_uio</literal> should be used instead, by
83 providing custom scripting. Please contact Enea for further
84 details.</para>
85 </listitem>
86
87 <listitem>
88 <para><remark>STCR-6224</remark>The Enea Edge Automation and the Enea
89 Edge Automation Framework and Test Harness do not support multiple
90 custom scripts uploaded to a uCPE device at the same time.</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>
112
113 <listitem>
114 <para><remark>USERDOCAP-641</remark>Enea Edge does not have support for
115 IPv6 addresses on both uCPE devices and the Enea Edge Management
116 installation.</para>
117 </listitem>
118
119 <listitem>
120 <para><remark>USERDOCAP-651</remark>Wireless AP configuration is
121 optimized for wireless modules that use the <literal>ath10k</literal>
122 driver. Using other wireless modules may result in undefined
123 behavior.</para>
124 </listitem>
125
126 <listitem>
127 <para><remark>ELCCR-1518</remark>The Wireless AP's wpa2psk password
128 should not contain white space characters.</para>
129 </listitem>
130
131 <listitem>
132 <para><remark>ELCCR-1561</remark>Before starting an Enea Edge Management
133 upgrade, any owned Tomcat certificates should be manually copied into the
134 <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config/certificates</literal>
135 folder.</para>
136 </listitem>
137
138 <listitem>
139 <para><remark>ELCCR-1378</remark>Modifying the type of the external
140 interfaces can lead to errors. Instead of modifying, it is recommended
141 to delete the old interfaces and recreate them with the desired
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>
163
164 <listitem condition="hidden">
165 <para><remark>LXCR-3283</remark><emphasis role="bold">PDF
166 navigation</emphasis>: When using links to open other PDFs, or jump to
167 another place in the same PDF, jumping back sometimes fails. This has
168 been observed when opening a PDF in Adobe Reader, inside a browser with
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>
173 </itemizedlist>
174
175 <!-- The file with a section below is autocreated by make init -->
176
177 <!-- <xi:include href="jiraissues_generated.xml"
178 xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
179</chapter>
diff --git a/doc/book-enea-edge-release-info/doc/main_changes.xml b/doc/book-enea-edge-release-info/doc/main_changes.xml
new file mode 100644
index 0000000..8824aa3
--- /dev/null
+++ b/doc/book-enea-edge-release-info/doc/main_changes.xml
@@ -0,0 +1,189 @@
1<?xml version="1.0" encoding="UTF-8"?>
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-changes">
5 <title>Main Changes</title>
6
7 <para>Below you'll find information about the new features and updates made
8 in this release, as well as details on the provided packages and the
9 backwards compatibility with previous versions.</para>
10
11 <section id="relinfo-changes-other">
12 <title>New Features and Improvements</title>
13
14 <para><emphasis role="bold">New Features:</emphasis></para>
15
16 <itemizedlist>
17 <listitem>
18 <para><remark>CPDX-3496</remark>Embedded WiFi support for all-in-one
19 store/home office deployment. For more details please see the <olink
20 targetdoc="book_enea_edge_getting_started"
21 targetptr="wap_interface_type">Wap Interface Type in the <xi:include
22 href="../../s_docbuild/olinkdb/pardoc-names.xml"
23 xmlns:xi="http://www.w3.org/2001/XInclude"
24 xpointer="element(book_enea_edge_getting_started/1)" /></olink>
25 Manual.</para>
26 </listitem>
27
28 <listitem>
29 <para><remark>CPDX-3499</remark>Expanded hardware, OS and network
30 monitoring capability with Grafana integration. For more details
31 please see <olink targetdoc="book_enea_edge_getting_started"
32 targetptr="grafana">Using Grafana and InfluxDB in the <xi:include
33 href="../../s_docbuild/olinkdb/pardoc-names.xml"
34 xmlns:xi="http://www.w3.org/2001/XInclude"
35 xpointer="element(book_enea_edge_getting_started/1)" /></olink>
36 Manual.</para>
37 </listitem>
38
39 <listitem>
40 <para><remark>CPDX-3407</remark>HTTPS based downloads of VNFs for
41 simplified deployment of the Enea Edge Management application in cloud
42 environments. For more details please see <olink
43 targetdoc="book_enea_edge_getting_started"
44 targetptr="fresh_ucpemg_install">Fresh Installation of the Enea Edge
45 Management application in the <xi:include
46 href="../../s_docbuild/olinkdb/pardoc-names.xml"
47 xmlns:xi="http://www.w3.org/2001/XInclude"
48 xpointer="element(book_enea_edge_getting_started/1)" /></olink>
49 Manual.</para>
50 </listitem>
51
52 <listitem>
53 <para><remark>CPDX-3500</remark>Enea Edge Automation, a tool for
54 automatic system configuration based on Python scripting that will
55 replace the existing Enea Edge Automation Framework and Test Harness
56 in the next major release. For more details please see the <ns:include
57 href="../../s_docbuild/olinkdb/pardoc-common.xml"
58 xmlns:ns="http://www.w3.org/2001/XInclude"
59 xpointer="element(book_enea_edge_automation_user_guide/1)" />.</para>
60
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>
73 </itemizedlist>
74
75 <para><emphasis role="bold">Improvements:</emphasis></para>
76
77 <itemizedlist>
78 <listitem>
79 <para>A new <emphasis role="bold">Requirements</emphasis> page has
80 been added to the Web-installer, displaying device characteristics and
81 checking minimal hardware requirements.</para>
82 </listitem>
83
84 <listitem>
85 <para>A Web-installer's log is displayed on the last page in case the
86 installation process has failed.</para>
87 </listitem>
88
89 <listitem>
90 <para>Extended Web-installer support for NVME disks.</para>
91 </listitem>
92 </itemizedlist>
93
94 <para><emphasis role="bold">Early Access Features:</emphasis></para>
95
96 <para>The following Early Access features are included in this
97 release:</para>
98
99 <itemizedlist>
100 <listitem>
101 <para><remark>CPDX-3498</remark>High Availability support with
102 redundant Enea Edge Management applications in active standby
103 configuration.</para>
104
105 <para>In order to increase resiliency on the uCPE management side, the
106 Enea Edge Management application can be installed in High-Availability
107 mode. Deployment consists of multiple instances of the Enea Edge
108 Management application, which can be distributed across different Data
109 Centers and geographical locations, and with multiple MariaDB servers
110 for each location.</para>
111 </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>
134
135 <para>Early Access features are provided for evaluation and early
136 feedback. They are not allowed to be used for business-critical
137 deployment, unless previously approved by Enea. Support cases reported on
138 Early Access features may only be set to a Minor Priority, with the intent
139 of addressing them in upcoming GA releases.</para>
140 </section>
141
142 <section id="open_source">
143 <title>Open Source</title>
144
145 <para>For more information about the Open Source packages included, please
146 refer to the Enea Edge Open Source Reports listed below. Each report
147 contains open source and license information pertaining to packages
148 provided with this release, for their respective component.</para>
149
150 <itemizedlist>
151 <listitem>
152 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
153 xmlns:xi="http://www.w3.org/2001/XInclude"
154 xpointer="element(book_enea_edge_runtime_open_source/1)" />.</para>
155 </listitem>
156
157 <listitem>
158 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
159 xmlns:xi="http://www.w3.org/2001/XInclude"
160 xpointer="element(book_enea_edge_management_open_source/1)" />.</para>
161 </listitem>
162
163 <listitem>
164 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
165 xmlns:xi="http://www.w3.org/2001/XInclude"
166 xpointer="element(book_enea_edge_telemetry_open_source/1)" />.</para>
167 </listitem>
168
169 <listitem>
170 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
171 xmlns:xi="http://www.w3.org/2001/XInclude"
172 xpointer="element(book_enea_edge_automation_open_source/1)" />.</para>
173 </listitem>
174
175 <listitem>
176 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
177 xmlns:xi="http://www.w3.org/2001/XInclude"
178 xpointer="element(book_enea_edge_auto_fw_th_open_source/1)" />.</para>
179 </listitem>
180 </itemizedlist>
181 </section>
182
183 <section id="relinfo-backward-compat">
184 <title>Compatibility</title>
185
186 <para>This release does not contain any change impacting
187 compatibility.</para>
188 </section>
189</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
new file mode 100644
index 0000000..b0317b3
--- /dev/null
+++ b/doc/book-enea-edge-release-info/doc/system_requirements_prerequisites.xml
@@ -0,0 +1,62 @@
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
diff --git a/doc/book-enea-edge-release-info/swcomp.mk b/doc/book-enea-edge-release-info/swcomp.mk
new file mode 100644
index 0000000..892f097
--- /dev/null
+++ b/doc/book-enea-edge-release-info/swcomp.mk
@@ -0,0 +1,10 @@
1# Component build specification
2
3# Version of THIS book
4BOOK_VER ?= $(REL_VER)-dev
5
6DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print)
7
8BOOKPACKAGES := book-enea-edge-release-info
9BOOKDESC_$(BOOKPACKAGES) := "Enea Edge $(PROD_VER) Release Information"
10BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS)