diff options
author | iosc <ioana.scurt@enea.com> | 2021-03-24 11:45:57 +0100 |
---|---|---|
committer | iosc <ioana.scurt@enea.com> | 2021-03-24 11:46:17 +0100 |
commit | 94a8e44c0fa2554018b33f34dd22ec4b9571e97c (patch) | |
tree | 4f5a60d740a72f0242f3ce758fb38596ddb06d02 /doc/book-enea-edge-release-info | |
parent | 6ae21d1d4d049dc5f87ed29050c18d6c3a7458d6 (diff) | |
parent | 4a4215c0c2e1d64d70d07f0f7e47b7395b72c013 (diff) | |
download | nfv-access-documentation-94a8e44c0fa2554018b33f34dd22ec4b9571e97c.tar.gz |
USERDOCAP-636 - sync to develop
Change-Id: I2f0f7698ecfc55fd8ba228663a691291f6a6bc31
Diffstat (limited to 'doc/book-enea-edge-release-info')
8 files changed, 768 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..960f136 --- /dev/null +++ b/doc/book-enea-edge-release-info/doc/about_release.xml | |||
@@ -0,0 +1,184 @@ | |||
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 NFVI software platform designed for | ||
8 | deployment on any white box uCPE device, and optimized for common use cases. | ||
9 | Enea Edge includes both the Enea Edge Runtime deployed on a white box, | ||
10 | and a management component with automation tools deployed in a private or | ||
11 | public cloud.</para> | ||
12 | |||
13 | <para>The Enea Edge <xi:include | ||
14 | href="../../s_doceneacommon/doc/eltf_params_updated.xml" | ||
15 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
16 | xpointer="element(EneaLinux_REL_VER/1)" /> Release includes a new version of | ||
17 | the major components as well as other features and optimizations, and | ||
18 | documentation updates. A list of new features and improvements can be found | ||
19 | in <xref linkend="relinfo-changes-other">Section 2.1 New Features and | ||
20 | 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 | <itemizedlist> | ||
28 | <listitem> | ||
29 | <para>Enea_Edge_Runtime_C3000_<version>-build<build_number>.tar.gz</para> | ||
30 | </listitem> | ||
31 | |||
32 | <listitem> | ||
33 | <para>Enea_Edge_Runtime_XeonD_<version>-build<build_number>.tar.gz</para> | ||
34 | </listitem> | ||
35 | |||
36 | <listitem> | ||
37 | <para>Enea_Edge_Automation_<version>-build<build_number>.zip</para> | ||
38 | </listitem> | ||
39 | |||
40 | <listitem> | ||
41 | <para>Enea_Edge_Management_<version>-build<build_number>.tar.gz</para> | ||
42 | </listitem> | ||
43 | |||
44 | <listitem> | ||
45 | <para>Enea_Edge_Telemetry_Deploy_<version>-build<build_number>.tar.gz</para> | ||
46 | </listitem> | ||
47 | |||
48 | <listitem> | ||
49 | <para>VNF_example_configurations.tar.gz</para> | ||
50 | </listitem> | ||
51 | |||
52 | <listitem> | ||
53 | <para>Enea_Edge_AF-TH_<version>-build<build_number>.zip | ||
54 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New Features and | ||
55 | Improvements</xref>.)</para> | ||
56 | </listitem> | ||
57 | </itemizedlist> | ||
58 | |||
59 | <programlisting condition="arm">-- documentation/ | ||
60 | /* Enea Edge documentation */ | ||
61 | -- README | ||
62 | -- aarch64 /* architecture */ | ||
63 | -- cn8304/ | ||
64 | /* artifacts for the host side */ | ||
65 | -- deb/ | ||
66 | /* deb packages */ | ||
67 | -- images/ | ||
68 | -- enea-nfv-access | ||
69 | /* precompiled artifacts for the platform release image */ | ||
70 | -- various artifacts (rootfs, kernel, config etc.) | ||
71 | -- enea-nfv-access-dev | ||
72 | /* precompiled artifacts for the development process. The image | ||
73 | contains userspace tools and kernel configurations necessary | ||
74 | for developing, debugging and profiling applications and | ||
75 | kernel modules */ | ||
76 | -- various artifacts | ||
77 | -- qemuarm64 | ||
78 | /* artifacts for the guest side */ | ||
79 | -- deb/ | ||
80 | /* deb packages */ | ||
81 | -- images/ | ||
82 | -- enea-nfv-access-guest | ||
83 | /* precompiled artifacts for the QEMU/Docker release image */ | ||
84 | -- various artifacts | ||
85 | -- enea-nfv-access-guest-dev | ||
86 | /* precompiled artifacts for the development process. The image | ||
87 | contains userspace tools and kernel configurations necessary | ||
88 | for developing, debugging and profiling applications and | ||
89 | kernel modules */ | ||
90 | -- various artifacts</programlisting> | ||
91 | </section> | ||
92 | |||
93 | <remark>INFO Below is a complete section with ID | ||
94 | "eltf-target-tables-section" included from elft_params_updated.xml. It | ||
95 | contains a variable number of target tables and the section title should be | ||
96 | "Supported Targets with Parameters". It has have a short sentence about what | ||
97 | it is in the beginning. The subtitles shall have the directory name of the | ||
98 | target in the manifest.</remark> | ||
99 | |||
100 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" | ||
101 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
102 | xpointer="element(eltf-target-tables-section)" /> | ||
103 | |||
104 | <section id="relinfo-documentation"> | ||
105 | <title>User Documentation</title> | ||
106 | |||
107 | <para>This release of Enea Edge contains the following set of | ||
108 | documents:</para> | ||
109 | |||
110 | <itemizedlist> | ||
111 | <listitem> | ||
112 | <para>Enea Edge Release Information. Describes the Enea Edge | ||
113 | release content, main changes, the list of known issues and | ||
114 | limitations.</para> | ||
115 | </listitem> | ||
116 | |||
117 | <listitem> | ||
118 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
119 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
120 | xpointer="element(book_enea_nfv_access_getting_started/1)" />. | ||
121 | Describes how to deploy and upgrade an Enea Edge base | ||
122 | configuration, advanced configurations of the system and | ||
123 | troubleshooting information.</para> | ||
124 | </listitem> | ||
125 | |||
126 | <listitem> | ||
127 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
128 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
129 | xpointer="element(book_enea_nfv_access_example_usecases/1)" />. | ||
130 | Describes examples of onboarding, instantiating and configuring | ||
131 | various VNFs.</para> | ||
132 | </listitem> | ||
133 | |||
134 | <listitem> | ||
135 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
136 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
137 | xpointer="element(book_enea_nfv_access_auto_fw_user_guide/1)" />. | ||
138 | Describes the Automation Framework for Enea Edge.</para> | ||
139 | </listitem> | ||
140 | |||
141 | <listitem> | ||
142 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
143 | xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" | ||
144 | xmlns:xi="http://www.w3.org/2001/XInclude" />. Describes the | ||
145 | Automation Framework and Test Harness for Enea Edge and | ||
146 | provides instructions regarding the necessary steps to run these | ||
147 | software tools (deprecated, see | ||
148 | <xref linkend="relinfo-changes-other">Section 2.1 New Features | ||
149 | and Improvements</xref>).</para> | ||
150 | </listitem> | ||
151 | |||
152 | <listitem> | ||
153 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
154 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
155 | xpointer="element(book_enea_nfv_access_system_test_specification/1)" />. | ||
156 | Describes a sample Test Suite for System Testing of Enea Edge. | ||
157 | (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 | ||
158 | New Features and Improvements</xref>).</para> | ||
159 | </listitem> | ||
160 | </itemizedlist> | ||
161 | </section> | ||
162 | |||
163 | <section id="release-browsers"> | ||
164 | <title>Supported Web Browsers</title> | ||
165 | |||
166 | <remark>These need to be updated</remark> | ||
167 | |||
168 | <para>The current release supports using the following web browsers:</para> | ||
169 | |||
170 | <itemizedlist> | ||
171 | <listitem> | ||
172 | <para>Google Chrome (tested with version 86).</para> | ||
173 | </listitem> | ||
174 | |||
175 | <listitem> | ||
176 | <para>Mozilla Firefox (tested with version 82).</para> | ||
177 | </listitem> | ||
178 | |||
179 | <listitem> | ||
180 | <para>Microsoft Edge (tested with version 84).</para> | ||
181 | </listitem> | ||
182 | </itemizedlist> | ||
183 | </section> | ||
184 | </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..b886ee1 --- /dev/null +++ b/doc/book-enea-edge-release-info/doc/book.xml | |||
@@ -0,0 +1,30 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
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 | ||
11 | <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" | ||
12 | xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> | ||
13 | |||
14 | <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> | ||
15 | |||
16 | <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml" | ||
17 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
18 | |||
19 | <xi:include href="about_release.xml" | ||
20 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
21 | |||
22 | <xi:include href="main_changes.xml" | ||
23 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
24 | |||
25 | <xi:include href="known_bugs_and_limitations.xml" | ||
26 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
27 | |||
28 | <xi:include href="../../s_docbuild/template/docsrc_common/contacting_enea_nfva.xml" | ||
29 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
30 | </book> | ||
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..1f5fb0c --- /dev/null +++ b/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml | |||
@@ -0,0 +1,217 @@ | |||
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 window | ||
24 | for the next upload to work.</para> | ||
25 | </listitem> | ||
26 | |||
27 | <listitem> | ||
28 | <para><remark>ELCCR-577</remark>If Enea Edge Management is restored from a backup | ||
29 | made on a release version older than Enea NFV Access 2.2.3, VNFs cannot be instantiated | ||
30 | from the GUI.</para> | ||
31 | </listitem> | ||
32 | |||
33 | <listitem> | ||
34 | <para><remark>ELCCR-474</remark>Deleting VNF instances with flows | ||
35 | configured on the OVS bridges can be done only after removing the | ||
36 | flows.</para> | ||
37 | </listitem> | ||
38 | |||
39 | <listitem> | ||
40 | <para><remark>ELCCR-572</remark>Sometimes when selecting and deleting | ||
41 | more than one VNF instance simultaneously, an error message might be | ||
42 | triggered, even if the delete operation succeeds.</para> | ||
43 | </listitem> | ||
44 | |||
45 | <listitem> | ||
46 | <para><remark>ELCCR-847</remark>The Juniper vSRX VNF cannot be | ||
47 | instantiated on the Xeon-D architectures due to missing CPU features in | ||
48 | the VNF's domain XML. This impacts all example use cases where the Juniper VNF is used.</para> | ||
49 | </listitem> | ||
50 | |||
51 | <listitem> | ||
52 | <para><remark>USERDOCAP-648</remark>The <literal>storage size</literal> | ||
53 | parameter on the VNF onboarding page is ignored. The default storage | ||
54 | size specified when creating the VM image is used when instantiating the | ||
55 | VM and when presenting VM information.</para> | ||
56 | </listitem> | ||
57 | |||
58 | <listitem> | ||
59 | <para><remark>LXCR-9853</remark>The WAN interface of a uCPE device needs | ||
60 | to be connected to a network with at least a router/gateway installed | ||
61 | for next-hop communication.</para> | ||
62 | </listitem> | ||
63 | |||
64 | <listitem> | ||
65 | <para><remark>LXCR-9992</remark>Depending on hardware capabilities, | ||
66 | there are certain limitations regarding the <literal>vfio-pci</literal> | ||
67 | and <literal>igb_uio</literal> drivers. While the Enea Edge | ||
68 | Runtime uses the <literal>vfio-pci</literal> driver by default, | ||
69 | for certain hardware configurations, <literal>igb_uio</literal> should | ||
70 | be used instead, by providing custom scripting. Please contact Enea for | ||
71 | further details.</para> | ||
72 | </listitem> | ||
73 | |||
74 | <listitem> | ||
75 | <para><remark>STCR-6224</remark>The Enea Edge Automation | ||
76 | and the Enea Edge Automation Framework and Test Harness do not | ||
77 | support multiple custom scripts uploaded to a uCPE device at the same | ||
78 | time.</para> | ||
79 | </listitem> | ||
80 | |||
81 | <listitem> | ||
82 | <para><remark>STCR-6292</remark>Management of WAN Interfaces is not | ||
83 | implemented in the Enea Edge Automation Framework and Test Harness.</para> | ||
84 | </listitem> | ||
85 | |||
86 | <listitem> | ||
87 | <para><remark>USERDOCAP-628</remark>Enea Edge Automation Framework | ||
88 | and Test Harness does not have support for product features implemented | ||
89 | in Enea Edge 2.4.0 or newer.</para> | ||
90 | </listitem> | ||
91 | |||
92 | <listitem> | ||
93 | <para><remark>ELCCR-912</remark>When the Enea Edge Management is installed | ||
94 | on CentOS 7, prior to C7.1804 (kernel version 3.10.0-862), adding an | ||
95 | upgrade image fails. As a workaround, please update | ||
96 | <literal>glib2</literal> to version 2.54.2 or later, using <literal>#yum | ||
97 | update glib2</literal>.</para> | ||
98 | </listitem> | ||
99 | |||
100 | <listitem> | ||
101 | <para><remark>ELCCR-854</remark>Changing the management interface IP | ||
102 | address will result in a temporary loss of connection with the uCPE | ||
103 | device. If the device is behind a NAT, while using the Call Home | ||
104 | connection, reestablishing the connection automatically could take up to | ||
105 | 20 minutes. Restarting the vCPE Overlay will immediately reestablish the | ||
106 | connection, but that implies the existence of an alternate way to | ||
107 | trigger the vCPE restart operation on the device.</para> | ||
108 | </listitem> | ||
109 | |||
110 | <listitem> | ||
111 | <para><remark>USERDOCAP-641</remark>Enea Edge does not have | ||
112 | support for IPv6 addresses on both uCPE devices and the Enea Edge | ||
113 | Management installation.</para> | ||
114 | </listitem> | ||
115 | |||
116 | <listitem> | ||
117 | <para><remark>ELCCR-1428</remark>Wireless AP creation through the REST | ||
118 | API does not validate that the wireless interface and LAN bridge are | ||
119 | configured. Using these parameters may result in undefined | ||
120 | behavior.</para> | ||
121 | </listitem> | ||
122 | |||
123 | <listitem> | ||
124 | <para><remark>USERDOCAP-651</remark>Wireless AP configuration is | ||
125 | optimized for wireless modules that use the <literal>ath10k</literal> | ||
126 | driver. Using other wireless modules may result in undefined | ||
127 | behavior.</para> | ||
128 | </listitem> | ||
129 | |||
130 | <listitem> | ||
131 | <para><remark>ELCCR-1351</remark>The updated | ||
132 | <filename>.Keystore</filename> and <filename>server.xml</filename> files | ||
133 | from the | ||
134 | <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/</literal> | ||
135 | folder are overwritten during a product upgrade. As a workaround for | ||
136 | this issue, after an upgrade, copy the updated | ||
137 | <filename>.Keystore</filename> and <filename>server.xml</filename> files | ||
138 | into the | ||
139 | <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/</literal> | ||
140 | folder and restart the ucpemanager service.</para> | ||
141 | </listitem> | ||
142 | |||
143 | <listitem> | ||
144 | <para><remark>ELCCR-1371</remark>The current self-signed certificate for | ||
145 | the Enea Edge Management is generated at build time, with a hard-coded | ||
146 | common-name causing the uCPE device upgrade to fail in HTTPS mode. As a | ||
147 | workaround, another certificate (containing an IP based common-name) | ||
148 | must be generated.</para> | ||
149 | |||
150 | <para>Perform the following the steps to generate the | ||
151 | certificate:</para> | ||
152 | |||
153 | <orderedlist> | ||
154 | <listitem> | ||
155 | <para>Stop the Edge Management service.</para> | ||
156 | </listitem> | ||
157 | |||
158 | <listitem> | ||
159 | <para>Create the certificate using the | ||
160 | <filename>createCertificate.sh</filename> script from distribution | ||
161 | folder. This will create a new <filename>.Keystore</filename> file | ||
162 | and copy it into the | ||
163 | <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config/certificates</literal> | ||
164 | folder.</para> | ||
165 | </listitem> | ||
166 | |||
167 | <listitem> | ||
168 | <para>Start the Enea Edge Management, the new certificate should now | ||
169 | take effect.</para> | ||
170 | </listitem> | ||
171 | </orderedlist> | ||
172 | </listitem> | ||
173 | |||
174 | <listitem> | ||
175 | <para><remark>ELCCR-1378</remark>Modifying the type of the external | ||
176 | interfaces can lead to errors. Instead of modifying, it is recommended | ||
177 | to delete the old interfaces and recreate them with the desired | ||
178 | type.</para> | ||
179 | </listitem> | ||
180 | |||
181 | <listitem> | ||
182 | <para><remark>ELCCR-907</remark>At times the VIP address is not acquired | ||
183 | by any of the backup nodes if a power failure happens on primary node in | ||
184 | a High Availability setup. To recover, follow the official documentation | ||
185 | available at <ulink | ||
186 | url="https://mariadb.com/kb/en/galera-cluster-recovery/">Galera Cluster | ||
187 | Recovery</ulink>.</para> | ||
188 | </listitem> | ||
189 | |||
190 | <listitem condition="hidden"> | ||
191 | <para><remark>LXCR-3283</remark><emphasis role="bold">PDF | ||
192 | navigation</emphasis>: When using links to open other PDFs, or jump to | ||
193 | another place in the same PDF, jumping back sometimes fails. This has | ||
194 | been observed when opening a PDF in Adobe Reader, inside a browser with | ||
195 | PDF add-on, as well as when the browser is configured to open PDF files | ||
196 | in an external PDF reader. As a workaround, open the HTML version of the | ||
197 | document.</para> | ||
198 | </listitem> | ||
199 | |||
200 | <listitem> | ||
201 | <para><remark>ELCCR-1468</remark>When using the Enea Edge Management in | ||
202 | HTTPS mode, upgrading a device from NFV Access 2.3.0 is not possible. | ||
203 | Either switch to HTTP mode (for more details see <olink | ||
204 | targetdoc="book_enea_nfv_access_getting_started" | ||
205 | targetptr="device_up_process">The uCPE device Upgrade Process in the | ||
206 | <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
207 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
208 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | ||
209 | Manual) or install it manually.</para> | ||
210 | </listitem> | ||
211 | </itemizedlist> | ||
212 | |||
213 | <!-- The file with a section below is autocreated by make init --> | ||
214 | |||
215 | <!-- <xi:include href="jiraissues_generated.xml" | ||
216 | xmlns:xi="http://www.w3.org/2001/XInclude" /> --> | ||
217 | </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 new file mode 100644 index 0000000..10e36a6 --- /dev/null +++ b/doc/book-enea-edge-release-info/doc/main_changes.xml | |||
@@ -0,0 +1,175 @@ | |||
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.</para> | ||
20 | </listitem> | ||
21 | |||
22 | <listitem> | ||
23 | <para><remark>CPDX-3499</remark>Expanded hardware, OS and network | ||
24 | monitoring capability with Grafana integration.</para> | ||
25 | </listitem> | ||
26 | |||
27 | <listitem> | ||
28 | <para><remark>CPDX-3407</remark>HTTPS based downloads of VNFs for | ||
29 | simplified deployment of the Enea Edge Management in cloud | ||
30 | environments.</para> | ||
31 | </listitem> | ||
32 | |||
33 | <listitem> | ||
34 | <para><remark>CPDX-3500</remark>The Enea Edge Automation, | ||
35 | a tool for automatic system configuration based on Python | ||
36 | scripting that will replace the existing Enea Edge Automation | ||
37 | Framework and Test Harness in the next major release.</para> | ||
38 | |||
39 | <para>The Enea Edge Automation Framework and Test Harness, and | ||
40 | its related documentation the <xi:include | ||
41 | href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
42 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
43 | xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" /> | ||
44 | and the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
45 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
46 | xpointer="element(book_enea_nfv_access_system_test_specification/1)" /> | ||
47 | are deprecated starting with Enea Edge 2.4.0.</para> | ||
48 | </listitem> | ||
49 | </itemizedlist> | ||
50 | |||
51 | <para><emphasis role="bold">Improvements:</emphasis></para> | ||
52 | |||
53 | <itemizedlist> | ||
54 | <listitem> | ||
55 | <para>A new <emphasis role="bold">Requirements</emphasis> page has | ||
56 | been added to the Web-installer, displaying device characteristics and | ||
57 | checking minimal hardware requirements.</para> | ||
58 | </listitem> | ||
59 | |||
60 | <listitem> | ||
61 | <para>A Web-installer's log is displayed on the last page in case the | ||
62 | installation process has failed.</para> | ||
63 | </listitem> | ||
64 | |||
65 | <listitem> | ||
66 | <para>Extended Web-installer support for NVME disks.</para> | ||
67 | </listitem> | ||
68 | </itemizedlist> | ||
69 | |||
70 | <para><emphasis role="bold">Early Access Features:</emphasis></para> | ||
71 | |||
72 | <para>The following Early Access features are included in this | ||
73 | release:</para> | ||
74 | |||
75 | <itemizedlist> | ||
76 | <listitem> | ||
77 | <para><remark>CPDX-3498</remark>High Availability support with | ||
78 | redundant Enea uCPE Managers in active standby configuration.</para> | ||
79 | |||
80 | <para>In order to increase resiliency on the uCPE management side, | ||
81 | the Enea uCPE Manager can be installed in High-Availability mode. | ||
82 | Deployment consists of multiple instances of the Enea uCPE Manager, | ||
83 | which can be distributed across different Data Centers and | ||
84 | geographical locations, and with multiple MariaDB servers for | ||
85 | each location.</para> | ||
86 | </listitem> | ||
87 | |||
88 | <listitem> | ||
89 | <para>Platform and VNF Snapshots:</para> | ||
90 | |||
91 | <note> | ||
92 | <para>Made originally available with Enea NFV Access 2.3.0.</para> | ||
93 | </note> | ||
94 | |||
95 | <itemizedlist> | ||
96 | <listitem> | ||
97 | <para>Platform Snapshots allow users to store, manage and restore | ||
98 | snapshots of the Enea Edge Runtime configuration, | ||
99 | with the purpose of recovering after a failed reconfiguration. | ||
100 | This feature is disabled by default.</para> | ||
101 | </listitem> | ||
102 | |||
103 | <listitem> | ||
104 | <para>VNF Snapshots allow users to store, manage and restore | ||
105 | snapshots of VNFs deployed on the Enea Edge | ||
106 | Runtime, with the purpose of restoring the VNF after a persistent | ||
107 | VNF failure. This feature is disabled by default.</para> | ||
108 | </listitem> | ||
109 | </itemizedlist> | ||
110 | |||
111 | <note> | ||
112 | <para>Users that would like to try out the Snapshot features should | ||
113 | contact Enea Support for additional documentation and | ||
114 | assistance.</para> | ||
115 | </note> | ||
116 | </listitem> | ||
117 | </itemizedlist> | ||
118 | |||
119 | <para>Early Access features are provided for evaluation and early | ||
120 | feedback. They are not allowed to be used for business-critical | ||
121 | deployment, unless previously approved by Enea. Support cases reported on | ||
122 | Early Access features may only be set to a Minor Priority, with the intent | ||
123 | of addressing them in upcoming GA releases.</para> | ||
124 | </section> | ||
125 | |||
126 | <section id="open_source"> | ||
127 | <title>Open Source</title> | ||
128 | |||
129 | <para>For more information about the Open Source packages included, please | ||
130 | refer to the Enea Edge Open Source Reports listed below. Each report | ||
131 | contains open source and license information pertaining to packages | ||
132 | provided with this release, for their respective component.</para> | ||
133 | |||
134 | <itemizedlist> | ||
135 | <listitem> | ||
136 | |||
137 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
138 | xpointer="element(book_enea_nfv_access_platform_open_source/1)" | ||
139 | xmlns:xi="http://www.w3.org/2001/XInclude" />.</para> | ||
140 | </listitem> | ||
141 | |||
142 | <listitem> | ||
143 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
144 | xpointer="element(book_enea_nfv_access_ucpem_open_source/1)" | ||
145 | xmlns:xi="http://www.w3.org/2001/XInclude" />.</para> | ||
146 | </listitem> | ||
147 | |||
148 | <listitem> | ||
149 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
150 | xpointer="element(book_enea_nfv_access_telemetry_open_source/1)" | ||
151 | xmlns:xi="http://www.w3.org/2001/XInclude" />.</para> | ||
152 | </listitem> | ||
153 | |||
154 | <listitem> | ||
155 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
156 | xpointer="element(book_enea_nfv_access_auto_fw_open_source/1)" | ||
157 | xmlns:xi="http://www.w3.org/2001/XInclude" />.</para> | ||
158 | </listitem> | ||
159 | |||
160 | <listitem> | ||
161 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" | ||
162 | xpointer="element(book_enea_nfv_access_auto_fw_th_open_source/1)" | ||
163 | xmlns:xi="http://www.w3.org/2001/XInclude" />.</para> | ||
164 | </listitem> | ||
165 | |||
166 | </itemizedlist> | ||
167 | </section> | ||
168 | |||
169 | <section id="relinfo-backward-compat"> | ||
170 | <title>Compatibility</title> | ||
171 | |||
172 | <para>This release does not contain any change impacting | ||
173 | compatibility.</para> | ||
174 | </section> | ||
175 | </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 | ||
4 | BOOK_VER ?= $(REL_VER)-dev | ||
5 | |||
6 | DOCBOOK_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 | |||
8 | BOOKPACKAGES := book-enea-edge-release-info | ||
9 | BOOKDESC_$(BOOKPACKAGES) := "Enea Edge $(PROD_VER) Release Information" | ||
10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) | ||