summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-edge-getting-started/doc/installation_guide.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-edge-getting-started/doc/installation_guide.xml')
-rw-r--r--doc/book-enea-edge-getting-started/doc/installation_guide.xml198
1 files changed, 123 insertions, 75 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 477b5c4..da62568 100644
--- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml
+++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml
@@ -92,14 +92,14 @@
92 <para>One or more uCPE devices.</para> 92 <para>One or more uCPE devices.</para>
93 93
94 <para>Whitebox devices where the Enea Edge Runtime will be installed, 94 <para>Whitebox devices where the Enea Edge Runtime will be installed,
95 containing a minimum of 2 cores and 4 GB RAM and at least two ethernet 95 containing a minimum of 2 cores and 2 GB RAM and at least two ethernet
96 ports that will be configured as WAN and LAN during deployment.</para> 96 ports that will be configured as WAN and LAN during deployment.</para>
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. During a typical evaluation, a dual VNF service on the Enea 100 more VNFs. A dual VNF service on the Enea Edge Runtime typically needs
101 Edge Runtime 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>
@@ -121,12 +121,13 @@
121 121
122 <listitem> 122 <listitem>
123 <para>Connecting to the GUI of the Enea Edge Management 123 <para>Connecting to the GUI of the Enea Edge Management
124 application for management and configuration. Network access 124 application for management and configuration.</para>
125 between the CentOS 7 server and the laptop is required. Please see 125
126 the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" 126 <note>
127 xmlns:xi="http://www.w3.org/2001/XInclude" 127 <para>Network access between the CentOS 7 server and the laptop
128 xpointer="element(book_enea_edge_release_info/1)" /> Manual 128 is required. The recommended browser for the current release is
129 available with your release, for recommended browsers.</para> 129 Google Chrome.</para>
130 </note>
130 </listitem> 131 </listitem>
131 </itemizedlist> 132 </itemizedlist>
132 </listitem> 133 </listitem>
@@ -479,12 +480,12 @@ userdel postgres</programlisting>
479 <literal>Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</literal></para> 480 <literal>Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</literal></para>
480 481
481 <para>The directory in which the archive has been unpacked will be 482 <para>The directory in which the archive has been unpacked will be
482 denoted as: <literal>&lt;uCPEM-installerdir&gt;</literal>.</para> 483 denoted as: <literal>&lt;EEMg-installerdir&gt;</literal>.</para>
483 </listitem> 484 </listitem>
484 485
485 <listitem> 486 <listitem>
486 <para>Enter 487 <para>Enter
487 <literal>&lt;uCPEM-installerdir&gt;/dist</literal>.</para> 488 <literal>&lt;EEMg-installerdir&gt;/dist</literal>.</para>
488 </listitem> 489 </listitem>
489 490
490 <listitem> 491 <listitem>
@@ -503,7 +504,7 @@ userdel postgres</programlisting>
503 <para>Run the following interactive command:</para> 504 <para>Run the following interactive command:</para>
504 505
505 <programlisting>./install.sh /opt/ems \ 506 <programlisting>./install.sh /opt/ems \
506Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programlisting> 507Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programlisting>
507 508
508 <para>The default configuration values are specified in brackets. 509 <para>The default configuration values are specified in brackets.
509 If no other value is preferred and typed in, pressing 510 If no other value is preferred and typed in, pressing
@@ -565,12 +566,12 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
565 <itemizedlist spacing="compact"> 566 <itemizedlist spacing="compact">
566 <listitem> 567 <listitem>
567 <para>Specify a service username 568 <para>Specify a service username
568 <literal>[ucpemanager]:</literal></para> 569 <literal>[EneaEdgeManagement]</literal>:</para>
569 </listitem> 570 </listitem>
570 571
571 <listitem> 572 <listitem>
572 <para>Specify a service password 573 <para>Specify a service password
573 <literal>[ucpemanager]</literal>:</para> 574 <literal>[EneaEdgeManagement]</literal>:</para>
574 </listitem> 575 </listitem>
575 </itemizedlist> 576 </itemizedlist>
576 </listitem> 577 </listitem>
@@ -593,35 +594,51 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
593 </listitem> 594 </listitem>
594 595
595 <listitem> 596 <listitem>
596 <para>Create the self-signed certificate: <literal>Specify IP or domain name</literal> 597 <para>Create the self-signed certificate: <literal>Specify IP
597 (or press <literal>Enter</literal> to skip):</para> 598 or domain name</literal> (or press <literal>Enter</literal> to
598 599 skip):</para>
599 <para>The Tomcat self-signed certificate can be generated 600
600 again by running the 601 <para>The Tomcat self-signed certificate can be generated
601 <filename>createCertificate.sh</filename>. For more details, please see <olink 602 again by running the
602 targetdoc="book_enea_edge_getting_started" 603 <filename>createCertificate.sh</filename>. For more details,
603 targetptr="create_certificate">Tomcat Certificate 604 please see <olink targetdoc="book_enea_edge_getting_started"
604 Generation in the <ns:include 605 targetptr="create_certificate">Tomcat Certificate Generation
605 href="../../s_docbuild/olinkdb/pardoc-names.xml" 606 in the <ns:include
606 xpointer="element(book_enea_edge_getting_started/1)" 607 href="../../s_docbuild/olinkdb/pardoc-names.xml"
607 xmlns:ns="http://www.w3.org/2001/XInclude" /></olink> Manual.</para> 608 xmlns:ns="http://www.w3.org/2001/XInclude"
608 609 xpointer="element(book_enea_edge_getting_started/1)" /></olink>
610 Manual.</para>
611
609 <note> 612 <note>
610 <para>The generation of the Tomcat self-signed cerificate 613 <para>The generation of the Tomcat self-signed certificate
611 should be skipped only if another certifcate will be 614 should be skipped only if another certificate will be
612 provided.</para> 615 provided. In case a custom certificate is used, not
616 generated with the <literal>createCertificate.sh</literal>
617 script, the keystore file containing the certificate must be
618 manually copied to the <literal>
619 /opt/ems/ucpemanager/application/config/certificates</literal>
620 folder, after the installation is done. The application must
621 then be restarted in order for the certificate to take
622 effect. The default name of the file is
623 <filename>.Keystore</filename>.</para>
624
625 <para>To change the default name, the configuration file
626 <filename>server.xml</filename> from the
627 <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config</literal>
628 folder must be copied to
629 <literal>/opt/ems/ucpemanager/application/config/</literal>.
630 The <literal>keystoreFile</literal> attribute from the
631 <literal>&lt;Connector executor="tomcatThreadPool"</literal>
632 tag must also be changed. Similarly, if a password has been
633 set, it should be added to the
634 <literal>keystorePass</literal> attribute:
635 <literal>keystorePass="NEW_PASSWORD"</literal>.</para>
613 </note> 636 </note>
614 </listitem> 637 </listitem>
615 638
616 <listitem> 639 <listitem>
617 <para>Heap Configuration:</para> 640 <para>Heap Configuration: <literal>Please enter the new
618 641 Maximum Heap Size [4g]</literal>:</para>
619 <itemizedlist spacing="compact">
620 <listitem>
621 <para>Please enter the new Maximum Heap Size
622 [4g]:</para>
623 </listitem>
624 </itemizedlist>
625 </listitem> 642 </listitem>
626 </itemizedlist> 643 </itemizedlist>
627 644
@@ -649,16 +666,17 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
649 </listitem> 666 </listitem>
650 667
651 <listitem> 668 <listitem>
652 <para>Using the IPv4 address of the CentOS 7 Server in a web 669 <para>Using the IPv4 address or the FQDN of the CentOS 7 Server in
653 browser, running on the laptop, log into the Enea Edge Management 670 a web browser, running on the laptop, log into the Enea Edge
654 GUI using the default username and password: 671 Management GUI using the default username and password:
655 <literal>admin/admin</literal>.</para> 672 <literal>admin/admin</literal>.</para>
656 </listitem> 673 </listitem>
657 </orderedlist> 674 </orderedlist>
658 675
659 <note> 676 <note>
660 <para>The IPv4 address of the CentOS 7 Server will be used as a configuration 677 <para>The IPv4 address or the FQDN of the CentOS 7 Server will be
661 parameter when setting up the uCPE devices.</para> 678 used as a configuration parameter when setting up the uCPE
679 devices.</para>
662 680
663 <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
664 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
@@ -692,9 +710,9 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
692 GUI (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is 710 GUI (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is
693 different from the snapshot obtained during an Enea Edge Management 711 different from the snapshot obtained during an Enea Edge Management
694 Upgrade or Uninstall operation 712 Upgrade or Uninstall operation
695 (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) needed 713 (<filename>EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz</filename>)
696 for recovery of the Enea Edge Management application. For more 714 needed for recovery of the Enea Edge Management application. For
697 details, see <olink targetdoc="book_enea_edge_getting_started" 715 more details, see <olink targetdoc="book_enea_edge_getting_started"
698 targetptr="restore_prev_ucpe_install">Restoring a previous Enea Edge 716 targetptr="restore_prev_ucpe_install">Restoring a previous Enea Edge
699 Management installation in the <xi:include 717 Management installation in the <xi:include
700 href="../../s_docbuild/olinkdb/pardoc-names.xml" 718 href="../../s_docbuild/olinkdb/pardoc-names.xml"
@@ -708,7 +726,7 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
708 installation:</para> 726 installation:</para>
709 727
710 <programlisting>./install.sh \ 728 <programlisting>./install.sh \
711/opt/ems Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz \ 729/opt/ems Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz \
712SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting> 730SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting>
713 </section> 731 </section>
714 </section> 732 </section>
@@ -754,10 +772,11 @@ sdb 8:0 0 111.8G 0 disk
754 <para>Copy the <filename>.hddimg</filename> image onto the USB 772 <para>Copy the <filename>.hddimg</filename> image onto the USB
755 stick, e.g:</para> 773 stick, e.g:</para>
756 774
757 <programlisting>sudo dd if=./enea-nfv-access-&lt;machine&gt;.hddimg \ 775 <programlisting>sudo dd if=./enea-edge-runtime-&lt;processor&gt;.hddimg \
758of=/dev/sdb bs=4M conv=fsync</programlisting> 776of=/dev/sdb bs=4M conv=fsync</programlisting>
759 777
760 <para>Where <filename>enea-nfv-access-&lt;machine&gt;.hddimg</filename> is 778 <para>Where
779 <filename>enea-edge-runtime-&lt;processor&gt;.hddimg</filename> is
761 the <filename>.hddimg</filename> file and <literal>sdb</literal> is 780 the <filename>.hddimg</filename> file and <literal>sdb</literal> is
762 the assigned USB device name.</para> 781 the assigned USB device name.</para>
763 </listitem> 782 </listitem>
@@ -767,7 +786,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
767 <section id="prep_phys_deploy"> 786 <section id="prep_phys_deploy">
768 <title>Preparing Physical Deployment for Installation</title> 787 <title>Preparing Physical Deployment for Installation</title>
769 788
770 <figure> 789 <figure id="prep_hw_installation">
771 <title>Preparing for Hardware Installation</title> 790 <title>Preparing for Hardware Installation</title>
772 791
773 <mediaobject> 792 <mediaobject>
@@ -911,15 +930,16 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
911 be entered here (if needed), are the tag(s) specified when 930 be entered here (if needed), are the tag(s) specified when
912 creating an offline configuration in the Enea Edge Management 931 creating an offline configuration in the Enea Edge Management
913 application. A later addition of customer tags can only be done 932 application. A later addition of customer tags can only be done
914 by reinstalling the uCPE devices.</para> 933 by re-installing the uCPE devices.</para>
915 </listitem> 934 </listitem>
916 </itemizedlist> 935 </itemizedlist>
917 </listitem> 936 </listitem>
918 937
919 <listitem> 938 <listitem>
920 <para>Connect the WAN cable to the uCPE device (see Figure 2). This 939 <para>Connect the WAN cable to the uCPE device (see <link
921 will be used as the uCPE management network interface, as described 940 linkend="prep_hw_installation">Figure 2.1 Preparing for Hardware
922 below.</para> 941 Installation</link>). This will be used as the uCPE management
942 network interface, as described below.</para>
923 </listitem> 943 </listitem>
924 944
925 <listitem> 945 <listitem>
@@ -934,8 +954,31 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
934 </listitem> 954 </listitem>
935 955
936 <listitem> 956 <listitem>
937 <para>Plug-in additional WAN interfaces (if applicable) and 957 <para>Plug in additional WAN interfaces (if applicable) and
938 provide their Layer 3 configuration.</para> 958 provide their Layer 3 configuration. An interface can be
959 configured in <literal>dhcp</literal> or
960 <literal>static</literal> mode. When configured in static mode,
961 the following options are available:</para>
962
963 <itemizedlist spacing="compact">
964 <listitem>
965 <para>Static IP (mandatory)</para>
966 </listitem>
967
968 <listitem>
969 <para>Netmask (mandatory)</para>
970 </listitem>
971
972 <listitem>
973 <para>Gateway (mandatory)</para>
974 </listitem>
975
976 <listitem>
977 <para>DNS Server List (a comma separated list of IPv4
978 addresses) (optional). If left empty it will use the Gateway
979 as the DNS, with 1.1.1.1 as fallback.</para>
980 </listitem>
981 </itemizedlist>
939 </listitem> 982 </listitem>
940 </itemizedlist> 983 </itemizedlist>
941 </listitem> 984 </listitem>
@@ -963,7 +1006,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
963 <section id="prep_phys_exec"> 1006 <section id="prep_phys_exec">
964 <title>Preparing Physical Deployment for Execution</title> 1007 <title>Preparing Physical Deployment for Execution</title>
965 1008
966 <figure> 1009 <figure id="prep_deploy_execution">
967 <title>Preparing for Deployment Execution</title> 1010 <title>Preparing for Deployment Execution</title>
968 1011
969 <mediaobject> 1012 <mediaobject>
@@ -1138,8 +1181,9 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
1138 (disconnected) in the Enea Edge Management application. The uCPE device 1181 (disconnected) in the Enea Edge Management application. The uCPE device
1139 configuration can be corrected by removing the WAN cable(s), 1182 configuration can be corrected by removing the WAN cable(s),
1140 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
1141 rebooting it. At this point, the Web-installer can be accessed from the 1184 rebooting it. After a timeout of a few minutes, the Web-installer can be
1142 laptop as described in <olink targetdoc="book_enea_edge_getting_started" 1185 accessed from the laptop as described in <olink
1186 targetdoc="book_enea_edge_getting_started"
1143 targetptr="install_ena_device">Installing Enea Edge - uCPE Device 1187 targetptr="install_ena_device">Installing Enea Edge - uCPE Device
1144 installation in the <xi:include 1188 installation in the <xi:include
1145 href="../../s_docbuild/olinkdb/pardoc-names.xml" 1189 href="../../s_docbuild/olinkdb/pardoc-names.xml"
@@ -1156,7 +1200,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
1156 application, it is ready for central management. Two important functions 1200 application, it is ready for central management. Two important functions
1157 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
1158 allocation. Additionally, the device can be rebooted, the factory settings 1202 allocation. Additionally, the device can be rebooted, the factory settings
1159 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>
1160 1205
1161 <section id="check_alarms"> 1206 <section id="check_alarms">
1162 <title>Checking Alarms</title> 1207 <title>Checking Alarms</title>
@@ -1182,17 +1227,17 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
1182 in use.</para> 1227 in use.</para>
1183 1228
1184 <para>To check CPU, RAM and disk utilization simply select the uCPE 1229 <para>To check CPU, RAM and disk utilization simply select the uCPE
1185 device and go to the <emphasis role="bold">Virtual Machines</emphasis> 1230 device and go to the device view tab (the tab bears the device name
1186 tab in the map view. The same view will show active VNFs running on the 1231 as its title). The same view will show active VNFs running on the
1187 uCPE device once instantiated.</para> 1232 uCPE device once instantiated.</para>
1188 </section> 1233 </section>
1189 1234
1190 <section id="basic_oper_device"> 1235 <section id="basic_oper_device">
1191 <title>Basic operations for uCPE device Managememt</title> 1236 <title>Basic operations for uCPE device Management</title>
1192 1237
1193 <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
1194 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
1195 simply the vCPE service can be restarted.</para> 1240 simply the Enea Edge Management Agent service can be restarted.</para>
1196 1241
1197 <para>Select the uCPE device and go to the <emphasis 1242 <para>Select the uCPE device and go to the <emphasis
1198 role="bold">Operations</emphasis> menu, where the following options are 1243 role="bold">Operations</emphasis> menu, where the following options are
@@ -1207,20 +1252,23 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
1207 <listitem> 1252 <listitem>
1208 <para><emphasis role="bold">Factory reset</emphasis>. Resets the 1253 <para><emphasis role="bold">Factory reset</emphasis>. Resets the
1209 device to its default factory settings. All current configuration 1254 device to its default factory settings. All current configuration
1210 settings are lost. All running VNFs are destroyed. Any installed 1255 settings are lost. All running VNFs are destroyed. All uploaded VM
1211 custom scripts will be removed and they will need to be 1256 image files are deleted. Existing log files will be kept.</para>
1212 reinstalled.</para>
1213 1257
1214 <para>Only the vCPE service will be restarted, the device will not 1258 <para>This command will only restart the Enea Edge Management Agent
1215 be rebooted. No reboot is needed.</para> 1259 service, the device will not be rebooted. No reboot is
1260 needed.</para>
1216 1261
1217 <para>Once the vCPE service restart completes, appropriate day-0 1262 <para>Once the service restart completes, appropriate day-0
1218 provisioning will take place.</para> 1263 provisioning will take place. Previously installed custom scripts
1264 will be reinstalled on the uCPE device, and upon receiving the
1265 custom script(s), the device will reboot.</para>
1219 </listitem> 1266 </listitem>
1220 1267
1221 <listitem> 1268 <listitem>
1222 <para><emphasis role="bold">Restart Vcpe</emphasis>. Restarts the 1269 <para><emphasis role="bold">Restart Vcpe</emphasis>. Restarts the
1223 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>
1224 </listitem> 1272 </listitem>
1225 </itemizedlist> 1273 </itemizedlist>
1226 </section> 1274 </section>
@@ -1252,4 +1300,4 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
1252 </note> 1300 </note>
1253 </section> 1301 </section>
1254 </section> 1302 </section>
1255</chapter> 1303</chapter> \ No newline at end of file