summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormrpa <miruna.paun@enea.com>2021-02-25 00:52:09 +0100
committerMiruna Paun <mrpa@enea.se>2021-02-25 14:55:45 +0100
commit58507abed96e1bfd96cbd6d2689774b5b87fa14e (patch)
treec8dd52aa973ae0c5a2e1951861342a3fc18ba50c
parent0e1f14feda9b1105b4a0e4a3258f203631f31fae (diff)
downloadnfv-access-documentation-58507abed96e1bfd96cbd6d2689774b5b87fa14e.tar.gz
Updated the release info with needed fixes and infoEnea_NFV_Access_2.4.0_RC2feature_CPDX-3521
Updated overflow issue in advanced config. Change-Id: Ia9329872ea444de1f1acad3e921c09a8f2f3779f Signed-off-by: mrpa <miruna.paun@enea.com>
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml8
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/about_release.xml47
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml107
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/main_changes.xml64
4 files changed, 140 insertions, 86 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml b/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
index 2a479b9..cb0ae5b 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
@@ -760,12 +760,14 @@ galera-4-26.4.6-1.el7.centos.x86_64</programlisting>
760<emphasis role="bold">wsrep_cluster_address="gcomm://192.168.10.11,192.168.10.12,..,192.168.10.16"</emphasis> 760<emphasis role="bold">wsrep_cluster_address="gcomm://192.168.10.11,192.168.10.12,..,192.168.10.16"</emphasis>
761 761
762# Human-readable node name (non-unique). Hostname by default. 762# Human-readable node name (non-unique). Hostname by default.
763<emphasis role="bold">wsrep_node_name=Node1</emphasis> # current node's name. set node name for each server in the cluster 763<emphasis role="bold">wsrep_node_name=Node1</emphasis> # current node's name. set node name for each server in \
764the cluster
764 765
765# Base replication &lt;address|hostname&gt;[:port] of the node. 766# Base replication &lt;address|hostname&gt;[:port] of the node.
766# The values supplied will be used as defaults for state transfer receiving, 767# The values supplied will be used as defaults for state transfer receiving,
767# listening ports and so on. Default: address of the first network interface. 768# listening ports and so on. Default: address of the first network interface.\
768<emphasis role="bold">wsrep_node_address=192.168.10.11</emphasis> #current node's interface IP . must be set for each node in the cluster</programlisting> 769<emphasis role="bold">wsrep_node_address=192.168.10.11</emphasis>
770#current node's interface IP . must be set for each node in the cluster</programlisting>
769 771
770 <note> 772 <note>
771 <para>Steps 2, 3 and 4 must be performed for each MariaDB node 773 <para>Steps 2, 3 and 4 must be performed for each MariaDB node
diff --git a/doc/book-enea-nfv-access-release-info/doc/about_release.xml b/doc/book-enea-nfv-access-release-info/doc/about_release.xml
index 6141d1e..2078a30 100644
--- a/doc/book-enea-nfv-access-release-info/doc/about_release.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/about_release.xml
@@ -38,10 +38,6 @@
38 </listitem> 38 </listitem>
39 39
40 <listitem> 40 <listitem>
41 <para>Enea_NFV_Access_AF-TH_&lt;version&gt;-build&lt;build_number&gt;.zip</para>
42 </listitem>
43
44 <listitem>
45 <para>Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</para> 41 <para>Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</para>
46 </listitem> 42 </listitem>
47 43
@@ -52,6 +48,12 @@
52 <listitem> 48 <listitem>
53 <para>VNF_example_configurations.tar.gz</para> 49 <para>VNF_example_configurations.tar.gz</para>
54 </listitem> 50 </listitem>
51
52 <listitem>
53 <para>Enea_NFV_Access_AF-TH_&lt;version&gt;-build&lt;build_number&gt;.zip
54 (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1 New Features and
55 Improvements</xref>.)</para>
56 </listitem>
55 </itemizedlist> 57 </itemizedlist>
56 58
57 <programlisting condition="arm">-- documentation/ 59 <programlisting condition="arm">-- documentation/
@@ -132,45 +134,50 @@
132 <listitem> 134 <listitem>
133 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" 135 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
134 xmlns:xi="http://www.w3.org/2001/XInclude" 136 xmlns:xi="http://www.w3.org/2001/XInclude"
135 xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" />. 137 xpointer="element(book_enea_nfv_access_auto_fw_user_guide/1)" />.
136 Describes the Automation Framework and Test Harness for Enea NFV 138 Describes the Automation Framework for Enea NFV Access.</para>
137 Access and provides instructions regarding the necessary steps to run
138 these software tools.</para>
139 </listitem> 139 </listitem>
140 140
141 <listitem> 141 <listitem>
142 <para>Enea NFV Access Automation Framework User Guide. Describes the 142 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
143 Automation Framework for Enea NFV Access.</para> 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 NFV Access 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>
144 </listitem> 150 </listitem>
145 151
146 <listitem> 152 <listitem>
147 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" 153 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
148 xmlns:xi="http://www.w3.org/2001/XInclude" 154 xmlns:xi="http://www.w3.org/2001/XInclude"
149 xpointer="element(book_enea_nfv_access_system_test_specification/1)" />. 155 xpointer="element(book_enea_nfv_access_system_test_specification/1)" />.
150 Describes a sample Test Suite for System Testing of Enea NFV 156 Describes a sample Test Suite for System Testing of Enea NFV Access.
151 Access.</para> 157 (deprecated, see <xref linkend="relinfo-changes-other">Section 2.1
158 New Features and Improvements</xref>).</para>
152 </listitem> 159 </listitem>
153 </itemizedlist> 160 </itemizedlist>
154 </section> 161 </section>
155 162
156 <section id="release-browsers"> 163 <section id="release-browsers">
157 <title>Supported Web Browsers<remark>These need to be 164 <title>Supported Web Browsers</title>
158 updated</remark></title> 165
166 <remark>These need to be updated</remark>
159 167
160 <para>The current release has been tested using the following web 168 <para>The current release supports using the following web browsers:</para>
161 browsers:</para>
162 169
163 <itemizedlist> 170 <itemizedlist>
164 <listitem> 171 <listitem>
165 <para>Google Chrome v86</para> 172 <para>Google Chrome (tested with version 86).</para>
166 </listitem> 173 </listitem>
167 174
168 <listitem> 175 <listitem>
169 <para>Mozilla Firefox v82</para> 176 <para>Mozilla Firefox (tested with version 82).</para>
170 </listitem> 177 </listitem>
171 178
172 <listitem> 179 <listitem>
173 <para>Microsoft Edge v84</para> 180 <para>Microsoft Edge (tested with version 84).</para>
174 </listitem> 181 </listitem>
175 </itemizedlist> 182 </itemizedlist>
176 </section> 183 </section>
diff --git a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml
index 8282f23..31d3a03 100644
--- a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml
@@ -84,39 +84,80 @@
84 </listitem> 84 </listitem>
85 85
86 <listitem> 86 <listitem>
87 <para><remark>ELCCR-912</remark>Adding an upgrade image into the Enea 87 <para><remark>ELCCR-912</remark>When the Enea uCPE Manager is installed
88 uCPE Manager (<literal>Device &gt; Upgrade &gt; Add</literal>) fails, 88 on CentOS 7, prior to C7.1804 (kernel version 3.10.0-862), adding an
89 producing the following error <literal>ostree: symbol lookup error: 89 upgrade image fails. As a workaround, please update <literal>glib2</literal>
90 /usr/local/lib/libostree-1.so.1: undefined symbol: 90 to version 2.54.2 or later, using <literal>#yum update glib2</literal>.</para>
91 g_utf8_make_valid</literal>. This occurs when the Enea uCPE Manager is 91 </listitem>
92 installed on CentOS 7 prior to C7.1804 (kernel version &lt; 3.10.0-862). 92
93 As a workaround, update glib2 to version 2.54.2 or later, using 93 <listitem>
94 <command>#yum update glib2</command>.</para> 94 <para><remark>ELCCR-854</remark>Changing the management interface IP address
95 </listitem> 95 will result in a temporary loss of connection with the uCPE device. If the
96 96 device is behind a NAT, while using the Call Home connection,
97 <listitem> 97 reestablishing the connection automatically could take up to 20 minutes.
98 <para><remark>ELCCR-854</remark>Changing the management interface IP 98 Restarting the vCPE Overlay will immediately reestablish the connection,
99 address would result in a loss of connection with the device. If the 99 but that implies the existence of an alternate way to trigger the vCPE
100 device is behind a NAT, while using Call Home connection, the connection 100 restart operation on the device.</para>
101 will not be reestablished until the old Call Home connection will cease 101 </listitem>
102 to exist. The exact amount of waiting time is determined by configurable 102
103 kernel parameters on the uCPE device, with the default waiting time of 103 <listitem>
104 more than 15 minutes. Restarting the vCPE Overlay will immediately 104 <para><remark>USERDOCAP-641</remark>Enea NFV Access does not have support
105 reestablish the connection, but that implies the existence of an 105 for IPv6 addresses on both uCPE devices and the Enea uCPE Manager
106 alternate way to trigger the vCPE restart operation on the 106 installation.</para>
107 device.</para> 107 </listitem>
108 </listitem> 108
109 109 <listitem>
110 <listitem> 110 <para><remark>ELCCR-1428</remark>Wireless AP creation through the REST
111 <para><remark>USERDOCAP-641</remark>Enea NFV Access does not support 111 API does not validate that the wireless interface and LAN bridge are
112 IPv6 protocol.</para> 112 configured. Using these parameters may result in undefined behavior.</para>
113 </listitem> 113 </listitem>
114 114
115 <listitem> 115 <listitem>
116 <para><remark>????</remark>On certain uCPE devices the Web-installer may 116 <para><remark>ELCCR-1351</remark>The updated <filename>.Keystore</filename>
117 fail to create an NFV Access boot entry, this is a limitation in 117 and <filename>server.xml</filename> files from the
118 firmware. The boot entry, however, will be detected automatically and 118 <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/</literal>
119 added by the firmware after a reboot.</para> 119 folder are overwritten during a product upgrade. As a workaround for
120 this issue, after an upgrade, copy the updated <filename>.Keystore</filename>
121 and <filename>server.xml</filename> files into the
122 <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/</literal>
123 folder and restart the ucpemanager service.</para>
124 </listitem>
125
126 <listitem>
127 <para><remark>ELCCR-1371</remark>The current self-signed certificate for
128 the Enea uCPE Manager is generated at build time, with a hard-coded common-name
129 causing the uCPE device upgrade to fail in HTTPS mode. As a workaround,
130 another certificate (containing an IP based common-name) must be generated.</para>
131
132 <para>Perform the following the steps to generate the certificate:</para>
133
134 <orderedlist>
135 <listitem><para>Stop the uCPE Manager service.</para></listitem>
136
137 <listitem><para>Create the certificate using the
138 <filename>createCertificate.sh</filename> script from distribution
139 folder. This will create a new <filename>.Keystore</filename> file
140 and copy it into the
141 <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config/certificates</literal>
142 folder.</para></listitem>
143
144 <listitem><para>Start the Enea uCPE Manager, the new certificate
145 should now take effect.</para></listitem>
146 </orderedlist>
147 </listitem>
148
149 <listitem>
150 <para><remark>ELCCR-1378</remark>Modifying the type of the external interfaces can lead
151 to errors. Instead of modifying, it is recommended to delete the old
152 interfaces and recreate them with the desired type.</para>
153 </listitem>
154
155 <listitem>
156 <para><remark>ELCCR-907</remark>At times the VIP address is not acquired
157 by any of the backup nodes if a power failure happens on primary node
158 in a High Availability setup. To recover, follow the official documentation
159 available at <ulink
160 url="https://mariadb.com/kb/en/galera-cluster-recovery/">Galera Cluster Recovery</ulink>.</para>
120 </listitem> 161 </listitem>
121 162
122 <listitem condition="hidden"> 163 <listitem condition="hidden">
diff --git a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml
index 8d3e56c..10faf28 100644
--- a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml
@@ -16,35 +16,18 @@
16 16
17 <itemizedlist> 17 <itemizedlist>
18 <listitem> 18 <listitem>
19 <para><remark>CPDX-3500</remark>The Enea NFV Access Automation
20 Framework, a tool for automatic system configuration based on Python
21 scripting that will replace the existing Enea NFV Access Automation
22 Framework and Test Harness in the next major release.</para>
23
24 <para>The Enea NFV Access Automation Framework and Test Harness, and
25 its related documentation the <xi:include
26 href="../../s_docbuild/olinkdb/pardoc-common.xml"
27 xmlns:xi="http://www.w3.org/2001/XInclude"
28 xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" />
29 and the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
30 xmlns:xi="http://www.w3.org/2001/XInclude"
31 xpointer="element(book_enea_nfv_access_system_test_specification/1)" />
32 are deprecated starting with Enea NFV Access 2.4.0.</para>
33 </listitem>
34
35 <listitem>
36 <para><remark>CPDX-3496</remark>Embedded WiFi support for all-in-one 19 <para><remark>CPDX-3496</remark>Embedded WiFi support for all-in-one
37 store/home office deployment.</para> 20 store/home office deployment.</para>
38 </listitem> 21 </listitem>
39 22
40 <listitem> 23 <listitem>
41 <para><remark>CPDX-3499</remark>Expanded Hardware, OS and network 24 <para><remark>CPDX-3499</remark>Expanded hardware, OS and network
42 monitoring capability with InfluxDB and Grafana.</para> 25 monitoring capability with Grafana integration.</para>
43 </listitem> 26 </listitem>
44 27
45 <listitem> 28 <listitem>
46 <para><remark>CPDX-3498</remark>Redundant Enea uCPE Managers in active 29 <para><remark>CPDX-3498</remark>High Availability support with redundant
47 standby configuration.</para> 30 Enea uCPE Managers in active standby configuration.</para>
48 </listitem> 31 </listitem>
49 32
50 <listitem> 33 <listitem>
@@ -52,6 +35,23 @@
52 simplified deployment of the Enea uCPE Manager in cloud 35 simplified deployment of the Enea uCPE Manager in cloud
53 environments.</para> 36 environments.</para>
54 </listitem> 37 </listitem>
38
39 <listitem>
40 <para><remark>CPDX-3500</remark>The Enea NFV Access Automation
41 Framework, a tool for automatic system configuration based on Python
42 scripting that will replace the existing Enea NFV Access Automation
43 Framework and Test Harness in the next major release.</para>
44
45 <para>The Enea NFV Access Automation Framework and Test Harness, and
46 its related documentation the <xi:include
47 href="../../s_docbuild/olinkdb/pardoc-common.xml"
48 xmlns:xi="http://www.w3.org/2001/XInclude"
49 xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" />
50 and the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
51 xmlns:xi="http://www.w3.org/2001/XInclude"
52 xpointer="element(book_enea_nfv_access_system_test_specification/1)" />
53 are deprecated starting with Enea NFV Access 2.4.0.</para>
54 </listitem>
55 </itemizedlist> 55 </itemizedlist>
56 56
57 <para><emphasis role="bold">Improvements:</emphasis></para> 57 <para><emphasis role="bold">Improvements:</emphasis></para>
@@ -125,28 +125,32 @@
125 <listitem> 125 <listitem>
126 <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml" 126 <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
127 xpointer="element(book_enea_nfv_access_platform_open_source/1)" 127 xpointer="element(book_enea_nfv_access_platform_open_source/1)"
128 xmlns:ns="http://www.w3.org/2001/XInclude" /></para> 128 xmlns:ns="http://www.w3.org/2001/XInclude" />.</para>
129 </listitem> 129 </listitem>
130 130
131 <listitem> 131 <listitem>
132 <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml" 132 <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
133 xpointer="element(book_enea_nfv_access_ucpem_open_source/1)" 133 xpointer="element(book_enea_nfv_access_ucpem_open_source/1)"
134 xmlns:ns="http://www.w3.org/2001/XInclude" /></para> 134 xmlns:ns="http://www.w3.org/2001/XInclude" />.</para>
135 </listitem> 135 </listitem>
136 136
137 <listitem> 137 <listitem>
138 <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml" 138 <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
139 xpointer="element(book_enea_nfv_access_auto_fw_th_open_source/1)" 139 xpointer="element(book_enea_nfv_access_telemetry_open_source/1)"
140 xmlns:ns="http://www.w3.org/2001/XInclude" /></para> 140 xmlns:ns="http://www.w3.org/2001/XInclude" />.</para>
141 </listitem> 141 </listitem>
142 142
143 <listitem> 143 <listitem>
144 <para>Enea NFV Access Automation Framework Open Source Report.</para> 144 <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
145 xpointer="element(book_enea_nfv_access_auto_fw_open_source/1)"
146 xmlns:ns="http://www.w3.org/2001/XInclude" />.</para>
145 </listitem> 147 </listitem>
146 148
147 <listitem> 149 <listitem>
148 <para>Enea NFV Access Telemetry Open Source Report.</para> 150 <para><ns:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
149 </listitem> 151 xpointer="element(book_enea_nfv_access_auto_fw_th_open_source/1)"
152 xmlns:ns="http://www.w3.org/2001/XInclude" />.</para>
153 </listitem>
150 </itemizedlist> 154 </itemizedlist>
151 </section> 155 </section>
152 156