diff options
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml | 51 | ||||
-rw-r--r-- | doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml | 167 |
2 files changed, 128 insertions, 90 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml index 69e3b5d..9f9a50d 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml | |||
@@ -71,22 +71,24 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
71 | <para>Start the <literal>ucpemanager</literal> service.</para> | 71 | <para>Start the <literal>ucpemanager</literal> service.</para> |
72 | </listitem> | 72 | </listitem> |
73 | </itemizedlist> | 73 | </itemizedlist> |
74 | |||
75 | <para><olink | ||
76 | targetdoc="book_enea_nfv_access_getting_started" | ||
77 | targetptr="fresh_ucpemg_install">Fresh Installation of the Enea uCPE Manager in the | ||
78 | <ns:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
79 | xpointer="element(book_enea_nfv_access_getting_started/1)" | ||
80 | xmlns:ns="http://www.w3.org/2001/XInclude" /></olink> Manual contains information | ||
81 | about the input required to be entered during the execution of the upgrade script.</para> | ||
82 | 74 | ||
83 | <para>For an example on how to upgrade an Enea uCPE Manager installation in a | 75 | <para><olink targetdoc="book_enea_nfv_access_getting_started" |
84 | High Availability setup, consult <olink | 76 | targetptr="fresh_ucpemg_install">Fresh Installation of the Enea uCPE |
77 | Manager in the <ns:include | ||
78 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
79 | xmlns:ns="http://www.w3.org/2001/XInclude" | ||
80 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | ||
81 | Manual contains information about the input required to be entered during | ||
82 | the execution of the upgrade script.</para> | ||
83 | |||
84 | <para>For an example on how to upgrade an Enea uCPE Manager installation | ||
85 | in a High Availability setup, consult <olink | ||
85 | targetdoc="book_enea_nfv_access_getting_started" | 86 | targetdoc="book_enea_nfv_access_getting_started" |
86 | targetptr="ha_upgrade">Upgrading a High Availability Deployment in the | 87 | targetptr="ha_upgrade">Upgrading a High Availability Deployment in the |
87 | <ns:include href="../../s_docbuild/olinkdb/pardoc-names.xml" | 88 | <ns:include href="../../s_docbuild/olinkdb/pardoc-names.xml" |
88 | xpointer="element(book_enea_nfv_access_getting_started/1)" | 89 | xmlns:ns="http://www.w3.org/2001/XInclude" |
89 | xmlns:ns="http://www.w3.org/2001/XInclude" /></olink> Manual.</para> | 90 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> |
91 | Manual.</para> | ||
90 | 92 | ||
91 | <section id="restore_prev_ucpe_install"> | 93 | <section id="restore_prev_ucpe_install"> |
92 | <title>Restoring a previous Enea uCPE Manager Installation</title> | 94 | <title>Restoring a previous Enea uCPE Manager Installation</title> |
@@ -235,6 +237,15 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
235 | upgrades the uCPE device to a newer version.</para> | 237 | upgrades the uCPE device to a newer version.</para> |
236 | </listitem> | 238 | </listitem> |
237 | </orderedlist> | 239 | </orderedlist> |
240 | |||
241 | <note> | ||
242 | <para>Upgrading from Enea NFV Access 2.3.0 is not possible when using | ||
243 | the Enea uCPE Manager in HTTPS mode. Either switch to HTTP by accessing | ||
244 | <emphasis role="bold">System</emphasis>, <emphasis | ||
245 | role="bold">Configuration</emphasis>, <emphasis role="bold">Web | ||
246 | Access</emphasis> and checking the <emphasis role="bold">Enable | ||
247 | HTTP</emphasis> box, or installing it manually.</para> | ||
248 | </note> | ||
238 | </section> | 249 | </section> |
239 | 250 | ||
240 | <section id="mg_upgrade"> | 251 | <section id="mg_upgrade"> |
@@ -390,10 +401,10 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
390 | can accept an image file is populated when the image file is | 401 | can accept an image file is populated when the image file is |
391 | chosen.</para> | 402 | chosen.</para> |
392 | 403 | ||
393 | <para>Mark the uCPE devices that you wish to upgrade and | 404 | <para>Mark the uCPE devices that you wish to upgrade and press the |
394 | press the <emphasis role="bold">></emphasis> button to | 405 | <emphasis role="bold">></emphasis> button to move the uCPE |
395 | move the uCPE devices to the right side of the selector. Those | 406 | devices to the right side of the selector. Those chosen form the |
396 | chosen form the list of uCPE devices that will be upgraded.</para> | 407 | list of uCPE devices that will be upgraded.</para> |
397 | </listitem> | 408 | </listitem> |
398 | 409 | ||
399 | <listitem> | 410 | <listitem> |
@@ -420,9 +431,11 @@ Enea_NFV_Access_uCPEManager_<version>-build<build_number>.tar.gz</pr | |||
420 | </listitem> | 431 | </listitem> |
421 | </itemizedlist> | 432 | </itemizedlist> |
422 | </listitem> | 433 | </listitem> |
423 | 434 | ||
424 | <listitem><para>To start the upgrade, click | 435 | <listitem> |
425 | <emphasis role="bold">ok</emphasis>.</para></listitem> | 436 | <para>To start the upgrade, click <emphasis |
437 | role="bold">ok</emphasis>.</para> | ||
438 | </listitem> | ||
426 | </itemizedlist> | 439 | </itemizedlist> |
427 | 440 | ||
428 | <note> | 441 | <note> |
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 31d3a03..a1a5db3 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,80 +84,94 @@ | |||
84 | </listitem> | 84 | </listitem> |
85 | 85 | ||
86 | <listitem> | 86 | <listitem> |
87 | <para><remark>ELCCR-912</remark>When the Enea uCPE Manager is installed | 87 | <para><remark>ELCCR-912</remark>When the Enea uCPE Manager is installed |
88 | on CentOS 7, prior to C7.1804 (kernel version 3.10.0-862), adding an | 88 | on CentOS 7, prior to C7.1804 (kernel version 3.10.0-862), adding an |
89 | upgrade image fails. As a workaround, please update <literal>glib2</literal> | 89 | upgrade image fails. As a workaround, please update |
90 | to version 2.54.2 or later, using <literal>#yum update glib2</literal>.</para> | 90 | <literal>glib2</literal> to version 2.54.2 or later, using <literal>#yum |
91 | update glib2</literal>.</para> | ||
92 | </listitem> | ||
93 | |||
94 | <listitem> | ||
95 | <para><remark>ELCCR-854</remark>Changing the management interface IP | ||
96 | address will result in a temporary loss of connection with the uCPE | ||
97 | device. If the device is behind a NAT, while using the Call Home | ||
98 | connection, reestablishing the connection automatically could take up to | ||
99 | 20 minutes. Restarting the vCPE Overlay will immediately reestablish the | ||
100 | connection, but that implies the existence of an alternate way to | ||
101 | trigger the vCPE restart operation on the device.</para> | ||
102 | </listitem> | ||
103 | |||
104 | <listitem> | ||
105 | <para><remark>USERDOCAP-641</remark>Enea NFV Access does not have | ||
106 | support for IPv6 addresses on both uCPE devices and the Enea uCPE | ||
107 | Manager installation.</para> | ||
108 | </listitem> | ||
109 | |||
110 | <listitem> | ||
111 | <para><remark>ELCCR-1428</remark>Wireless AP creation through the REST | ||
112 | API does not validate that the wireless interface and LAN bridge are | ||
113 | configured. Using these parameters may result in undefined | ||
114 | behavior.</para> | ||
115 | </listitem> | ||
116 | |||
117 | <listitem> | ||
118 | <para><remark>ELCCR-1351</remark>The updated | ||
119 | <filename>.Keystore</filename> and <filename>server.xml</filename> files | ||
120 | from the | ||
121 | <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/</literal> | ||
122 | folder are overwritten during a product upgrade. As a workaround for | ||
123 | this issue, after an upgrade, copy the updated | ||
124 | <filename>.Keystore</filename> and <filename>server.xml</filename> files | ||
125 | into the | ||
126 | <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/</literal> | ||
127 | folder and restart the ucpemanager service.</para> | ||
128 | </listitem> | ||
129 | |||
130 | <listitem> | ||
131 | <para><remark>ELCCR-1371</remark>The current self-signed certificate for | ||
132 | the Enea uCPE Manager is generated at build time, with a hard-coded | ||
133 | common-name causing the uCPE device upgrade to fail in HTTPS mode. As a | ||
134 | workaround, another certificate (containing an IP based common-name) | ||
135 | must be generated.</para> | ||
136 | |||
137 | <para>Perform the following the steps to generate the | ||
138 | certificate:</para> | ||
139 | |||
140 | <orderedlist> | ||
141 | <listitem> | ||
142 | <para>Stop the uCPE Manager service.</para> | ||
143 | </listitem> | ||
144 | |||
145 | <listitem> | ||
146 | <para>Create the certificate using the | ||
147 | <filename>createCertificate.sh</filename> script from distribution | ||
148 | folder. This will create a new <filename>.Keystore</filename> file | ||
149 | and copy it into the | ||
150 | <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config/certificates</literal> | ||
151 | folder.</para> | ||
152 | </listitem> | ||
153 | |||
154 | <listitem> | ||
155 | <para>Start the Enea uCPE Manager, the new certificate should now | ||
156 | take effect.</para> | ||
91 | </listitem> | 157 | </listitem> |
158 | </orderedlist> | ||
159 | </listitem> | ||
160 | |||
161 | <listitem> | ||
162 | <para><remark>ELCCR-1378</remark>Modifying the type of the external | ||
163 | interfaces can lead to errors. Instead of modifying, it is recommended | ||
164 | to delete the old interfaces and recreate them with the desired | ||
165 | type.</para> | ||
166 | </listitem> | ||
92 | 167 | ||
93 | <listitem> | 168 | <listitem> |
94 | <para><remark>ELCCR-854</remark>Changing the management interface IP address | 169 | <para><remark>ELCCR-907</remark>At times the VIP address is not acquired |
95 | will result in a temporary loss of connection with the uCPE device. If the | 170 | by any of the backup nodes if a power failure happens on primary node in |
96 | device is behind a NAT, while using the Call Home connection, | 171 | a High Availability setup. To recover, follow the official documentation |
97 | reestablishing the connection automatically could take up to 20 minutes. | 172 | available at <ulink |
98 | Restarting the vCPE Overlay will immediately reestablish the connection, | 173 | url="https://mariadb.com/kb/en/galera-cluster-recovery/">Galera Cluster |
99 | but that implies the existence of an alternate way to trigger the vCPE | 174 | Recovery</ulink>.</para> |
100 | restart operation on the device.</para> | ||
101 | </listitem> | ||
102 | |||
103 | <listitem> | ||
104 | <para><remark>USERDOCAP-641</remark>Enea NFV Access does not have support | ||
105 | for IPv6 addresses on both uCPE devices and the Enea uCPE Manager | ||
106 | installation.</para> | ||
107 | </listitem> | ||
108 | |||
109 | <listitem> | ||
110 | <para><remark>ELCCR-1428</remark>Wireless AP creation through the REST | ||
111 | API does not validate that the wireless interface and LAN bridge are | ||
112 | configured. Using these parameters may result in undefined behavior.</para> | ||
113 | </listitem> | ||
114 | |||
115 | <listitem> | ||
116 | <para><remark>ELCCR-1351</remark>The updated <filename>.Keystore</filename> | ||
117 | and <filename>server.xml</filename> files from the | ||
118 | <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/</literal> | ||
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> | ||
161 | </listitem> | 175 | </listitem> |
162 | 176 | ||
163 | <listitem condition="hidden"> | 177 | <listitem condition="hidden"> |
@@ -168,6 +182,17 @@ | |||
168 | configured to open PDF files in an external PDF reader. As a workaround, | 182 | configured to open PDF files in an external PDF reader. As a workaround, |
169 | open the HTML version of the document.<remark>LXCR-3283</remark></para> | 183 | open the HTML version of the document.<remark>LXCR-3283</remark></para> |
170 | </listitem> | 184 | </listitem> |
185 | |||
186 | <listitem> | ||
187 | <para><remark>ELCCR-1468</remark>When using the Enea uCPE Manager in HTTPS | ||
188 | mode, upgrading a device from NFV Access 2.3.0 is not possible. Either | ||
189 | switch to HTTP mode (for more details see <olink targetdoc="book_enea_nfv_access_getting_started" | ||
190 | targetptr="device_up_process">The uCPE device Upgrade Process in the <xi:include | ||
191 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
192 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
193 | xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> | ||
194 | Manual) or install it manually.</para> | ||
195 | </listitem> | ||
171 | </itemizedlist> | 196 | </itemizedlist> |
172 | 197 | ||
173 | <!-- The file with a section below is autocreated by make init --> | 198 | <!-- The file with a section below is autocreated by make init --> |