summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLuana Mincu <lumc@enea.se>2021-08-31 13:03:09 +0300
committerLuana Mincu <lumc@enea.se>2021-09-01 12:56:51 +0300
commit6ef055c881ec4f93dbafd54912417e9efcc6925d (patch)
tree547dc09940f1a2a6d1e8ffb885e36f2432a845ba
parent01a40353d65ff7b73d507270d4c76d50886207de (diff)
downloadnfv-access-documentation-6ef055c881ec4f93dbafd54912417e9efcc6925d.tar.gz
ELCCR-1566: improve "Restart vCPE" documentation
Change-Id: Ic4eca909f6aba2910bc9ca8fd82ee10b70aff4bf
-rw-r--r--doc/book-enea-edge-getting-started/doc/installation_guide.xml77
1 files changed, 42 insertions, 35 deletions
diff --git a/doc/book-enea-edge-getting-started/doc/installation_guide.xml b/doc/book-enea-edge-getting-started/doc/installation_guide.xml
index dbf4c54..e6f8c82 100644
--- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml
+++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml
@@ -1,4 +1,4 @@
1<?xml version="1.0" encoding="UTF-8"?> 1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="installation_guide"> 2<chapter id="installation_guide">
3 <title>Setting up and Installing the Enea Edge Base Configuration</title> 3 <title>Setting up and Installing the Enea Edge Base Configuration</title>
4 4
@@ -97,9 +97,9 @@
97 97
98 <para>When hosting an entire solution including one or several network 98 <para>When hosting an entire solution including one or several network
99 services, the hardware must also have the resources to host one or 99 services, the hardware must also have the resources to host one or
100 more VNFs. A dual VNF service on the Enea 100 more VNFs. A dual VNF service on the Enea Edge Runtime typically needs
101 Edge Runtime typically needs a CPU with 4-8 cores and at least 8 GB RAM. The 101 a CPU with 4-8 cores and at least 8 GB RAM. The supported Intel CPUs
102 supported Intel CPUs of Enea Edge are documented in the <xi:include 102 of Enea Edge are documented in the <xi:include
103 href="../../s_docbuild/olinkdb/pardoc-common.xml" 103 href="../../s_docbuild/olinkdb/pardoc-common.xml"
104 xmlns:xi="http://www.w3.org/2001/XInclude" 104 xmlns:xi="http://www.w3.org/2001/XInclude"
105 xpointer="element(book_enea_edge_release_info/1)" /> Manual.</para> 105 xpointer="element(book_enea_edge_release_info/1)" /> Manual.</para>
@@ -612,24 +612,27 @@ Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programli
612 <note> 612 <note>
613 <para>The generation of the Tomcat self-signed certificate 613 <para>The generation of the Tomcat self-signed certificate
614 should be skipped only if another certificate will be 614 should be skipped only if another certificate will be
615 provided. In case a custom certificate is used, not generated with the 615 provided. In case a custom certificate is used, not
616 <literal>createCertificate.sh</literal> script, the keystore file 616 generated with the <literal>createCertificate.sh</literal>
617 containing the certificate must be manually copied 617 script, the keystore file containing the certificate must be
618 to the <literal> 618 manually copied to the <literal>
619 /opt/ems/ucpemanager/application/config/certificates</literal> folder, 619 /opt/ems/ucpemanager/application/config/certificates</literal>
620 after the installation is done. The application must then be 620 folder, after the installation is done. The application must
621 restarted in order for the certificate to take effect. The default 621 then be restarted in order for the certificate to take
622 name of the file is <filename>.Keystore</filename>.</para> 622 effect. The default name of the file is
623 <filename>.Keystore</filename>.</para>
623 624
624 <para>To change the default name, the configuration file 625 <para>To change the default name, the configuration file
625 <filename>server.xml</filename> from the 626 <filename>server.xml</filename> from the
626 <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config</literal> 627 <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config</literal>
627 folder must be copied to <literal>/opt/ems/ucpemanager/application/config/</literal>. 628 folder must be copied to
628 The <literal>keystoreFile</literal> attribute from the <literal>&lt;Connector 629 <literal>/opt/ems/ucpemanager/application/config/</literal>.
629 executor="tomcatThreadPool"</literal> tag must also be changed. Similarly, 630 The <literal>keystoreFile</literal> attribute from the
630 if a password has been set, it should be added to the 631 <literal>&lt;Connector executor="tomcatThreadPool"</literal>
631 <literal>keystorePass</literal> attribute: 632 tag must also be changed. Similarly, if a password has been
632 <literal>keystorePass="NEW_PASSWORD"</literal>.</para> 633 set, it should be added to the
634 <literal>keystorePass</literal> attribute:
635 <literal>keystorePass="NEW_PASSWORD"</literal>.</para>
633 </note> 636 </note>
634 </listitem> 637 </listitem>
635 638
@@ -663,16 +666,17 @@ Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programli
663 </listitem> 666 </listitem>
664 667
665 <listitem> 668 <listitem>
666 <para>Using the IPv4 address or the FQDN of the CentOS 7 Server in a web 669 <para>Using the IPv4 address or the FQDN of the CentOS 7 Server in
667 browser, running on the laptop, log into the Enea Edge Management 670 a web browser, running on the laptop, log into the Enea Edge
668 GUI using the default username and password: 671 Management GUI using the default username and password:
669 <literal>admin/admin</literal>.</para> 672 <literal>admin/admin</literal>.</para>
670 </listitem> 673 </listitem>
671 </orderedlist> 674 </orderedlist>
672 675
673 <note> 676 <note>
674 <para>The IPv4 address or the FQDN of the CentOS 7 Server will be used as a 677 <para>The IPv4 address or the FQDN of the CentOS 7 Server will be
675 configuration parameter when setting up the uCPE devices.</para> 678 used as a configuration parameter when setting up the uCPE
679 devices.</para>
676 680
677 <para>If the CentOS 7 Server is installed behind NAT, the IPv4 681 <para>If the CentOS 7 Server is installed behind NAT, the IPv4
678 address used will be the public IP of the NAT device and port 682 address used will be the public IP of the NAT device and port
@@ -1177,9 +1181,9 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
1177 (disconnected) in the Enea Edge Management application. The uCPE device 1181 (disconnected) in the Enea Edge Management application. The uCPE device
1178 configuration can be corrected by removing the WAN cable(s), 1182 configuration can be corrected by removing the WAN cable(s),
1179 reconnecting the laptop to the LAN interface of the uCPE device and 1183 reconnecting the laptop to the LAN interface of the uCPE device and
1180 rebooting it. After a timeout of a few minutes, 1184 rebooting it. After a timeout of a few minutes, the Web-installer can be
1181 the Web-installer can be accessed from the laptop as described in 1185 accessed from the laptop as described in <olink
1182 <olink targetdoc="book_enea_edge_getting_started" 1186 targetdoc="book_enea_edge_getting_started"
1183 targetptr="install_ena_device">Installing Enea Edge - uCPE Device 1187 targetptr="install_ena_device">Installing Enea Edge - uCPE Device
1184 installation in the <xi:include 1188 installation in the <xi:include
1185 href="../../s_docbuild/olinkdb/pardoc-names.xml" 1189 href="../../s_docbuild/olinkdb/pardoc-names.xml"
@@ -1196,7 +1200,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
1196 application, it is ready for central management. Two important functions 1200 application, it is ready for central management. Two important functions
1197 available in the Enea Edge Management GUI are alarm checking and resource 1201 available in the Enea Edge Management GUI are alarm checking and resource
1198 allocation. Additionally, the device can be rebooted, the factory settings 1202 allocation. Additionally, the device can be rebooted, the factory settings
1199 can be restored or simply the vCPE service can be restarted.</para> 1203 can be restored or simply the Enea Edge Management Agent service can be
1204 restarted.</para>
1200 1205
1201 <section id="check_alarms"> 1206 <section id="check_alarms">
1202 <title>Checking Alarms</title> 1207 <title>Checking Alarms</title>
@@ -1232,7 +1237,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
1232 1237
1233 <para>When the uCPE device is connected to the Enea Edge Management 1238 <para>When the uCPE device is connected to the Enea Edge Management
1234 application, it can be rebooted, the factory settings can be restored or 1239 application, it can be rebooted, the factory settings can be restored or
1235 simply the vCPE service can be restarted.</para> 1240 simply the Enea Edge Management Agent service can be restarted.</para>
1236 1241
1237 <para>Select the uCPE device and go to the <emphasis 1242 <para>Select the uCPE device and go to the <emphasis
1238 role="bold">Operations</emphasis> menu, where the following options are 1243 role="bold">Operations</emphasis> menu, where the following options are
@@ -1250,10 +1255,11 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
1250 settings are lost. All running VNFs are destroyed. All uploaded VM 1255 settings are lost. All running VNFs are destroyed. All uploaded VM
1251 image files are deleted. Existing log files will be kept.</para> 1256 image files are deleted. Existing log files will be kept.</para>
1252 1257
1253 <para>Only the vCPE service will be restarted, the device will not 1258 <para>This command will only restart the Enea Edge Management Agent
1254 be rebooted. No reboot is needed.</para> 1259 service, the device will not be rebooted. No reboot is
1260 needed.</para>
1255 1261
1256 <para>Once the vCPE service restart completes, appropriate day-0 1262 <para>Once the service restart completes, appropriate day-0
1257 provisioning will take place. Previously installed custom scripts 1263 provisioning will take place. Previously installed custom scripts
1258 will be reinstalled on the uCPE device, and upon receiving the 1264 will be reinstalled on the uCPE device, and upon receiving the
1259 custom script(s), the device will reboot.</para> 1265 custom script(s), the device will reboot.</para>
@@ -1261,7 +1267,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
1261 1267
1262 <listitem> 1268 <listitem>
1263 <para><emphasis role="bold">Restart Vcpe</emphasis>. Restarts the 1269 <para><emphasis role="bold">Restart Vcpe</emphasis>. Restarts the
1264 vCPE service on the device. The device will not be rebooted.</para> 1270 Enea Edge Management Agent service. The device will not be
1271 rebooted.</para>
1265 </listitem> 1272 </listitem>
1266 </itemizedlist> 1273 </itemizedlist>
1267 </section> 1274 </section>
@@ -1293,4 +1300,4 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
1293 </note> 1300 </note>
1294 </section> 1301 </section>
1295 </section> 1302 </section>
1296</chapter> 1303</chapter> \ No newline at end of file