summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml')
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml1010
1 files changed, 0 insertions, 1010 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml
deleted file mode 100644
index b82d48b..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml
+++ /dev/null
@@ -1,1010 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="installation_guide">
3 <title>Setting up and Installing the Enea NFV Access Base
4 Configuration</title>
5
6 <para>The setup and installation steps detailed below will deploy a base
7 configuration which will be used as a reference for more complex deployment
8 scenarios.</para>
9
10 <section id="hw_reqs">
11 <title>Hardware Requirements</title>
12
13 <para>The following hardware is needed for deploying the base
14 configuration:</para>
15
16 <itemizedlist>
17 <listitem>
18 <para>One server running the CentOS 7 distribution</para>
19
20 <para>Minimal Requirement: 4 Cores, 16 GB RAM and 300 GB single disk
21 storage. Make sure the CentOS 7 server is updated to the latest
22 revision before installing Enea NFV Access.</para>
23
24 <para>The purpose of the CentOS 7 server is to host the Enea uCPE
25 Manager. Network access between the CentOS 7 server and the uCPE
26 devices is required. The Enea uCPE Manager and the uCPE devices will
27 be connected on separate subnets to avoid inconsistencies.</para>
28 </listitem>
29
30 <listitem>
31 <para>One or more uCPE devices.</para>
32
33 <para>Whitebox devices where the Enea NFV Access Runtime Platform
34 will be installed, containing a minimum of 2 cores and 4 GB RAM and at
35 least two ethernet ports that will be configured as WAN and LAN during
36 deployment.</para>
37
38 <para>When hosting an entire solution including one or several network
39 services, the hardware must also have the resources to host one or
40 more VNFs. During a typical evaluation, a dual VNF service on the Enea
41 NFV Access Runtime Platform needs a CPU with 4-8 cores and at least 8
42 GB RAM. The supported Intel CPUs of Enea NFV Access are documented in
43 the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
44 xmlns:xi="http://www.w3.org/2001/XInclude"
45 xpointer="element(book_enea_nfv_access_release_info/1)" />
46 manual.</para>
47
48 <para>Enea NFV Access needs EFI support in BIOS to boot. When
49 configuring the uCPE device BIOS a serial connection is
50 required.</para>
51 </listitem>
52
53 <listitem>
54 <para>A laptop.</para>
55
56 <para>The laptop is used for 2 scenarios:</para>
57
58 <itemizedlist>
59 <listitem>
60 <para>Installing the Enea NFV Access Runtime Platform on uCPE
61 Devices.</para>
62 </listitem>
63
64 <listitem>
65 <para>Connecting to the GUI of the Enea uCPE Manager for
66 management and configuration. Network access between the CentOS 7
67 server and the laptop is required. Please see the <xi:include
68 href="../../s_docbuild/olinkdb/pardoc-common.xml"
69 xmlns:xi="http://www.w3.org/2001/XInclude"
70 xpointer="element(book_enea_nfv_access_release_info/1)" /> manual
71 available with your release, for recommended browsers.</para>
72 </listitem>
73 </itemizedlist>
74 </listitem>
75
76 <listitem>
77 <para>A 16 GB USB stick used for the uCPE Device Installation.</para>
78 </listitem>
79 </itemizedlist>
80 </section>
81
82 <section id="sw_config">
83 <title>Software Configuration</title>
84
85 <para>The CentOS 7 server requires a specific configuration for the setup
86 to work.</para>
87
88 <section id="firewall_config">
89 <title>Firewall Configuration</title>
90
91 <para>Any firewall running on the CentOS 7 server may block the
92 management protocols required to communicate between the uCPE device and
93 the Enea uCPE Manager as well as between the Enea uCPE Manager and its
94 northbound clients. Quick handling of a blocking firewall would be to
95 disable it, typical for a lab environment, through:</para>
96
97 <programlisting>sudo systemctl stop firewalld
98sudo systemctl disable firewalld
99sudo systemctl mask now firewalld</programlisting>
100
101 <para>For an advanced firewall configuration, the following ports need
102 to be opened:</para>
103
104 <table>
105 <title>Ports to be Activated</title>
106
107 <tgroup cols="3">
108 <colspec align="left" />
109
110 <tbody>
111 <row>
112 <entry>80</entry>
113
114 <entry>TCP</entry>
115
116 <entry>Required for GUI Access.</entry>
117 </row>
118
119 <row>
120 <entry>443</entry>
121
122 <entry>TCP</entry>
123
124 <entry>Required for GUI Access and Device Connectivity.</entry>
125 </row>
126
127 <row>
128 <entry>54327</entry>
129
130 <entry>UDP</entry>
131
132 <entry>Required for the Enea uCPE Manager High Availability
133 Configuration.</entry>
134 </row>
135
136 <row>
137 <entry>5701:5708</entry>
138
139 <entry>TCP</entry>
140
141 <entry>Required for the Enea uCPE Manager High Availability
142 Configuration.</entry>
143 </row>
144
145 <row>
146 <entry>4334</entry>
147
148 <entry>TCP</entry>
149
150 <entry>Required for Call Home.</entry>
151 </row>
152
153 <row>
154 <entry>2021:2040</entry>
155
156 <entry>TCP</entry>
157
158 <entry>Required for Call Home.</entry>
159 </row>
160
161 <row>
162 <entry>7000:7010</entry>
163
164 <entry>TCP</entry>
165
166 <entry>Required for Reverse SSH.</entry>
167 </row>
168 </tbody>
169 </tgroup>
170 </table>
171
172 <para>Use the following command sequence to enable the required ports
173 for deployment of the Enea uCPE Manager:</para>
174
175 <programlisting>sudo firewall-cmd --permanent --add-port=80/tcp
176sudo firewall-cmd --permanent --add-port=443/tcp
177sudo firewall-cmd --permanent --add-port=54327/udp
178sudo firewall-cmd --permanent --add-port=5701-5708/tcp
179sudo firewall-cmd --permanent --add-port=4334/tcp
180sudo firewall-cmd --permanent --add-port=2021-2040/tcp
181sudo firewall-cmd --permanent --add-port=7000-7010/tcp
182sudo firewall-cmd --reload</programlisting>
183 </section>
184
185 <section id="openjdk_postgresql_config">
186 <title>Configuring OpenJDK and PostgreSQL</title>
187
188 <para>The Enea uCPE Manager requires a specific Java version (OpenJDK
189 11) and a PostgreSQL version to operate correctly.</para>
190
191 <para><emphasis role="bold">Installing OpenJDK</emphasis></para>
192
193 <orderedlist>
194 <listitem>
195 <para>Install OpenJDK 11 using the root account:</para>
196
197 <programlisting>yum install java-11-openjdk-devel</programlisting>
198 </listitem>
199
200 <listitem>
201 <para>Verify the installation:</para>
202
203 <programlisting>java -version
204openjdk version "11.0.3" 2019-04-16 LTS
205OpenJDK Run Time Environment 18.9 (build 11.0.3+7-LTS)
206OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing) </programlisting>
207
208 <note>
209 <para>If there are multiple java versions installed, switch
210 between them using the following command:</para>
211
212 <programlisting>alternatives --config java</programlisting>
213
214 <para>Optionally, the user can switch between the
215 <literal>javac</literal> versions using:</para>
216
217 <programlisting>alternatives --config javac</programlisting>
218 </note>
219 </listitem>
220
221 <listitem>
222 <para>The following system variables need to point to the OpenJDK 11
223 installation:</para>
224
225 <programlisting>export JAVA_HOME=$(dirname $(dirname $(readlink $(readlink $(which java)))))
226export PATH=$PATH:$JAVA_HOME/bin
227export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</programlisting>
228
229 <note>
230 <para>In order to make these system variables persistent, the
231 commands given above should be added to a script in the
232 <literal>/etc/profile.d/</literal> folder. <emphasis
233 role="bold">Sudo</emphasis> access is needed for this
234 operation.</para>
235 </note>
236 </listitem>
237 </orderedlist>
238
239 <para>The Enea uCPE Manager requires a specific PostgreeSQL version.
240 This is embedded in the Enea uCPE Manager installation. In order to
241 avoid conflicts, any existing PostgreeSQL installation needs to be
242 uninstalled.</para>
243
244 <para><emphasis role="bold">Uninstalling PostgreSQL</emphasis></para>
245
246 <orderedlist>
247 <listitem>
248 <para>Open a terminal with administrative rights, i.e. log into a
249 bash shell with root privileges.</para>
250 </listitem>
251
252 <listitem>
253 <para>Execute the following command to check if you have a currently
254 running the PostgreSQL database server:</para>
255
256 <programlisting>ps -ef | grep post</programlisting>
257 </listitem>
258
259 <listitem>
260 <para>Remove the currently installed PostgreSQL server (including
261 the existing postgres user):</para>
262
263 <programlisting>yum remove postgres\*
264rm -rf /var/lib/pgsql
265rm -f /etc/postgres-reg.ini
266userdel postgres</programlisting>
267
268 <note>
269 <para>This step is not necessary if the Enea uCPE Manager will be
270 using an external database (like MariaDB).</para>
271 </note>
272 </listitem>
273 </orderedlist>
274
275 <para>If you have multiple spindles, it is recommended to let the
276 application run off one and the database off the other. This will result
277 in optimum performance. It is also recommended that the swap disk be the
278 same as the one used for the application.</para>
279
280 <para>Assuming another spindle is used (<literal>/drive2</literal>) do
281 the following:</para>
282
283 <orderedlist>
284 <listitem>
285 <para>Create a folder which will host the database (e.g.
286 <literal>emsDatabase</literal>).</para>
287 </listitem>
288
289 <listitem>
290 <para>Create a soft-link that will point to this folder:</para>
291
292 <programlisting>ln -s /opt/ems/elementcenter/database /drive2/emsDatabase</programlisting>
293 </listitem>
294
295 <listitem>
296 <para>Follow the installation steps for the Enea uCPE Manager
297 available in <olink targetdoc="book_enea_nfv_access_getting_started"
298 targetptr="install_ucpe_mg">Installing the uCPE Manager in the
299 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
300 xmlns:xi="http://www.w3.org/2001/XInclude"
301 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
302 Manual.</para>
303 </listitem>
304 </orderedlist>
305 </section>
306 </section>
307
308 <section id="ucpe_config">
309 <title>uCPE Device Configuration</title>
310
311 <section id="wan_lan_ports">
312 <title>Determining the WAN and LAN ports</title>
313
314 <para>A typical whitebox comes with multiple physical network ports,
315 ready to be used. The user must determine the purpose and allocation of
316 each port. The allocation is later aligned with the software
317 configuration within the Enea NFV Access installer.</para>
318
319 <para>A common way is to allocate the left ports to WANs and the right
320 ports to LANs. At least one port must be allocated to WAN and one to
321 LAN.</para>
322 </section>
323
324 <section id="ucpe_identifier">
325 <title>Determining the Device ID</title>
326
327 <para>Each uCPE device needs a unique identifier. This identifier is
328 used to match the registration in the Enea uCPE Manager and the offline
329 configuration of the uCPE device during ZTP (Zero Touch
330 Provisioning)</para>
331
332 <para>Select a text string to represent the uCPE device, e.g.
333 <literal>uCPE-1</literal> or
334 <literal>fwa-t1012vc_boston_1234</literal>.</para>
335 </section>
336
337 <section id="bios_config">
338 <title>Configuring the BIOS</title>
339
340 <para>The factory configuration of the BIOS may not match the
341 requirements of Enea NFV Access. The BIOS configuration needs to be
342 reviewed and potentially reconfigured to prepare for a successful
343 installation.</para>
344
345 <para>Access the BIOS using a serial cable between the uCPE device and
346 the laptop, to review and configure the BIOS correctly. The whitebox
347 vendor is expected to provide the right serial cable for the box. A
348 terminal emulator (such as putty) is needed on the laptop.</para>
349
350 <para>Enable the following BIOS features/configurations:</para>
351
352 <itemizedlist>
353 <listitem>
354 <para>EFI</para>
355 </listitem>
356
357 <listitem>
358 <para>Intel Virtualization Technology (VT-x)</para>
359 </listitem>
360
361 <listitem>
362 <para>Intel Virtualization Technology for Directed I/O (VT-d)</para>
363 </listitem>
364
365 <listitem>
366 <para>SR-IOV</para>
367 </listitem>
368 </itemizedlist>
369
370 <para>The boot order may also need to be modified to support
371 installation and execution of the Enea NFV Access Runtime Platform on
372 the uCPE device.</para>
373
374 <para>The following boot order is recommended for a base
375 configuration:</para>
376
377 <orderedlist>
378 <listitem>
379 <para>Boot from USB</para>
380 </listitem>
381
382 <listitem>
383 <para>Boot from Disk</para>
384 </listitem>
385 </orderedlist>
386
387 <para>With the above boot order there is no need for a configuration of
388 the BIOS during installation and deployment.</para>
389 </section>
390 </section>
391
392 <section id="prep_deploy">
393 <title>Preparing the Deployment</title>
394
395 <section id="install_ucpe_mg">
396 <title>Installing the Enea uCPE Manager</title>
397
398 <para>The Enea uCPE Manager can be installed using as a fresh/first-time
399 configuration or using a backup file of a previous installation, created
400 within the Enea uCPE Manager GUI.</para>
401
402 <section id="fresh_ucpemg_install">
403 <title>Fresh Installation of the Enea uCPE Manager</title>
404
405 <para>On the CentOS 7 server open a terminal, log into a bash shell
406 with the root account and perform the following:</para>
407
408 <orderedlist>
409 <listitem>
410 <para>Extract
411 <literal>Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</literal></para>
412
413 <para>The directory in which the archive has been unpacked will be
414 denoted as: <literal>&lt;uCPEM-installdir&gt;</literal>.</para>
415 </listitem>
416
417 <listitem>
418 <para>Enter <literal>&lt;uCPEM-installdir&gt;</literal>.</para>
419 </listitem>
420
421 <listitem>
422 <para>Choose the target installation folder, e.g.
423 <literal>/opt/ems</literal>. Everything will be installed under a
424 folder called <literal>/ucpemanager</literal> within the target
425 installation folder.</para>
426
427 <para>The application files will be installed in
428 <literal>/opt/ems/ucpemanager/application</literal>. The database
429 will be installed in
430 <literal>/opt/ems/ucpemanager/database</literal>.</para>
431 </listitem>
432
433 <listitem>
434 <para>Run the following interactive command:</para>
435
436 <programlisting>./install.sh /opt/ems \
437Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programlisting>
438
439 <para>The default configuration values are specified in brackets.
440 If no other value is preferred and typed in, pressing
441 <literal>ENTER</literal> will keep the default values. When there
442 is an option within parentheses (i.e.Y/N), a value must be
443 specified.</para>
444
445 <note>
446 <para>The same configuration values set now will need to be
447 provided when upgrading or uninstalling the Enea uCPE
448 Manager.</para>
449 </note>
450
451 <itemizedlist>
452 <listitem>
453 <para>Database Configurations:</para>
454
455 <itemizedlist spacing="compact">
456 <listitem>
457 <para>Are you using the embedded PostgreSQL database?
458 [Y/N]: <literal>Y</literal>.</para>
459 </listitem>
460
461 <listitem>
462 <para>Specify the database process password
463 <literal>[postgres]:</literal></para>
464 </listitem>
465
466 <listitem>
467 <para>Specify the database ID (or name)
468 <literal>[ucpemanager]:</literal></para>
469 </listitem>
470
471 <listitem>
472 <para>Specify the database server port
473 <literal>[5432]:</literal></para>
474 </listitem>
475
476 <listitem>
477 <para>Specify a database user name
478 <literal>[postgres]:</literal></para>
479 </listitem>
480
481 <listitem>
482 <para>Specify a database password
483 <literal>[postgres]:</literal></para>
484 </listitem>
485
486 <listitem>
487 <para>Specify the database startup thread pool size
488 <literal>[1]:</literal></para>
489 </listitem>
490 </itemizedlist>
491 </listitem>
492
493 <listitem>
494 <para>Service Configurations:</para>
495
496 <itemizedlist spacing="compact">
497 <listitem>
498 <para>Specify a service username
499 [<literal>ucpemanager</literal>]:</para>
500 </listitem>
501
502 <listitem>
503 <para>Specify a service password
504 <literal>[ucpemanager</literal>]:</para>
505 </listitem>
506 </itemizedlist>
507 </listitem>
508
509 <listitem>
510 <para>High Availability Configurations:</para>
511
512 <itemizedlist spacing="compact">
513 <listitem>
514 <para>Specify the IP address of the local interface: The
515 CentOS 7 Server loopback address:
516 <literal>127.0.0.1</literal>.</para>
517 </listitem>
518
519 <listitem>
520 <para>Is this server part of a cluster? [Y/N]:
521 <literal>N</literal>.</para>
522 </listitem>
523 </itemizedlist>
524 </listitem>
525
526 <listitem>
527 <para>Heap Configuration:</para>
528
529 <itemizedlist spacing="compact">
530 <listitem>
531 <para>Please enter the new Maximum Heap Size
532 [<literal>4g]</literal>:</para>
533 </listitem>
534 </itemizedlist>
535 </listitem>
536 </itemizedlist>
537
538 <para>This command will:</para>
539
540 <itemizedlist spacing="compact">
541 <listitem>
542 <para>Extract the application files from the compressed
543 installation kit.</para>
544 </listitem>
545
546 <listitem>
547 <para>Install the bundled database.</para>
548 </listitem>
549
550 <listitem>
551 <para>Install the Enea uCPE Manager as a service with the name
552 <literal>ucpemanager</literal>.</para>
553 </listitem>
554
555 <listitem>
556 <para>Start the <literal>ucpemanager</literal> service</para>
557 </listitem>
558 </itemizedlist>
559 </listitem>
560
561 <listitem>
562 <para>Using the IPv4 address of the CentOS 7 Server in a web
563 browser, running on the laptop, log into the Enea uCPE Manager GUI
564 using the default username and password:
565 <literal>admin/admin</literal>.</para>
566 </listitem>
567 </orderedlist>
568
569 <note>
570 <para>The IPv4 address of the CentOS 7 Server, connected to the same
571 network as the uCPE Devices, will be used as a configuration
572 parameter both when setting up the uCPE devices.</para>
573 </note>
574 </section>
575
576 <section id="install_ucpemg_from_backup">
577 <title>Installation of the Enea uCPE Manager using a System
578 Back-up</title>
579
580 <para>The Enea uCPE Manager can be restored if a back-up file has been
581 previously created.</para>
582
583 <para>A backup file can be created by accessing:
584 <literal>System</literal> -&gt; <literal>System Backup</literal> from
585 the Enea uCPE Manager GUI. The resulting zip archive will be located
586 in the <filename>/opt/ems/ucpemanager/application/backup</filename>
587 folder and will be named
588 <literal>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</literal> (e.g
589 System-Backup_Feb19_2013_2257_42.zip). Save the archive to another
590 location outside the Enea uCPE Manager installation folder for future
591 use.</para>
592
593 <note>
594 <para>The System Back-up file obtained from the Enea uCPE Manager
595 GUI (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is
596 different from the Enea uCPE Manager snapshot obtained during a Enea
597 uCPE Manager Upgrade or Uninstall operation
598 (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) needed
599 for recovery of the Enea uCPE Manager. For more details please see
600 <olink targetdoc="book_enea_nfv_access_getting_started"
601 targetptr="restore_prev_ucpe_install">Restoring a previous uCPE
602 Manager installation in the <xi:include
603 href="../../s_docbuild/olinkdb/pardoc-names.xml"
604 xmlns:xi="http://www.w3.org/2001/XInclude"
605 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
606 Manual.</para>
607 </note>
608
609 <para>To install the Enea uCPE Manager with the restore option provide
610 an additional argument as shown below during installation:</para>
611
612 <programlisting>./install.sh \
613/opt/ems Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz \
614SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting>
615 </section>
616 </section>
617
618 <section id="prep_usb_ena">
619 <title>Preparing the USB stick for installation of the Enea NFV Access
620 Runtime Platform</title>
621
622 <para>To install the Enea NFV Access Runtime Platform, create a
623 bootable USB stick with the image you intend to install.</para>
624
625 <para>In the example below, step by step instructions are provided for
626 the CentOS 7 distribution. It's possible with the appropriate tools to
627 also use Windows OS or MacOS.</para>
628
629 <note>
630 <para>The .hddimg image is available in the
631 <filename>Enea_NFV_Access_Run_Time_Platform_
632 &lt;processor&gt;_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</filename>
633 file you downloaded with your release.</para>
634 </note>
635
636 <para><emphasis role="bold">Create a bootable USB stick
637 image</emphasis></para>
638
639 <orderedlist>
640 <listitem>
641 <para>Copy the <filename>.hddimg</filename> image file provided by
642 Enea, into the CentOS 7 server.</para>
643 </listitem>
644
645 <listitem>
646 <para>Connect the USB stick to the CentOS 7 Server and identify the
647 USB device name given by the system with
648 <literal>lsblk</literal>:</para>
649
650 <programlisting>NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
651sda 8:0 1 28.7G 0 disk
652sdb 8:0 0 111.8G 0 disk
653|-sdb1 8:1 0 111.8G 0 part</programlisting>
654 </listitem>
655
656 <listitem>
657 <para>Copy the <filename>.hddimg</filename> image onto the USB
658 stick, e.g:</para>
659
660 <programlisting>sudo dd if=./enea-nfv-access-&lt;machine&gt;.hddimg \
661of=/dev/sdb bs=4M conv=fsync</programlisting>
662
663 <para>Where
664 <filename>enea-nfv-access-&lt;machine&gt;.hddimg</filename> is the
665 <filename>.hddimg</filename> file and <literal>sdb</literal> is the
666 assigned USB device name.</para>
667 </listitem>
668 </orderedlist>
669 </section>
670
671 <section id="prep_phys_deploy">
672 <title>Preparing Physical Deployment for Installation</title>
673
674 <figure>
675 <title>Preparing for Hardware Installation</title>
676
677 <mediaobject>
678 <imageobject>
679 <imagedata contentwidth="600" fileref="images/prep_deploy.png" />
680 </imageobject>
681 </mediaobject>
682 </figure>
683
684 <para>While the uCPE device is powered off, in order to install and
685 configure the Enea NFV Access Runtime using the prepared USB stick,
686 connect the laptop to a uCPE device LAN port. For this purpose, a Layer
687 2 switch or direct cable connection can be used.</para>
688 </section>
689
690 <section id="install_ena_device">
691 <title>Installing Enea NFV Access - uCPE Device Installation</title>
692
693 <para>To initiate the installation of the Enea NFV Access Runtime
694 Platform do the following:</para>
695
696 <orderedlist>
697 <listitem>
698 <para>Plug the USB stick into the uCPE device.</para>
699 </listitem>
700
701 <listitem>
702 <para>Power up the uCPE device and boot the USB stick.</para>
703 </listitem>
704
705 <listitem>
706 <para>The Web-installer application will start automatically and can
707 be accessed in a web browser on the laptop at
708 <literal>http://172.16.1.1</literal> (port 80).</para>
709 </listitem>
710
711 <listitem>
712 <para>On the first page of the Web-installer, the user must fill
713 in:</para>
714
715 <itemizedlist>
716 <listitem>
717 <para>The static Enea uCPE Manager IP Address.</para>
718 </listitem>
719
720 <listitem>
721 <para>The unique identifier of the uCPE device (called
722 "DeviceId" in this guide).</para>
723 </listitem>
724
725 <listitem>
726 <para>Customer Tags. They are used for Zero Touch Provisining
727 (ZTP) and can be left empty for a base configuration. What can
728 be entered here (if needed), are the tag(s) specified when
729 creating an offline configuration in the Enea uCPE Manager. A
730 later addition of customer tags can only be done by reinstalling
731 the uCPE devices.</para>
732 </listitem>
733 </itemizedlist>
734 </listitem>
735
736 <listitem>
737 <para>Connect the WAN cable to the uCPE device (see Figure 2). This
738 will be used as the uCPE management network interface, as described
739 below.</para>
740 </listitem>
741
742 <listitem>
743 <para>On the second page of the Web-installer, the user must do the
744 following:</para>
745
746 <itemizedlist>
747 <listitem>
748 <para>Configure the management network interface. This interface
749 is used by the Enea uCPE Manager to communicate with the uCPE
750 device.</para>
751 </listitem>
752
753 <listitem>
754 <para>Plug-in additional WAN interfaces (if applicable) and
755 provide their Layer 3 configuration.</para>
756 </listitem>
757 </itemizedlist>
758 </listitem>
759 </orderedlist>
760
761 <para>When the user has completed the configuration steps in the
762 Web-installer, Enea NFV Access is installed on the hard drive. At this
763 stage, user should remove the USB stick and LAN cable and shutdown the
764 uCPE device. It will be started after necessary configurations are done
765 on the Enea uCPE Manager, as described below.</para>
766
767 <note>
768 <para>If the USB stick was booted in UEFI mode, an UEFI boot entry is
769 automatically created and the system will start booting from the hard
770 drive without further user configuration.</para>
771 </note>
772 </section>
773
774 <section id="prep_phys_exec">
775 <title>Preparing Physical Deployment for Execution</title>
776
777 <figure>
778 <title>Preparing for Deployment Execution</title>
779
780 <mediaobject>
781 <imageobject>
782 <imagedata contentwidth="600" fileref="images/prep_execution.png" />
783 </imageobject>
784 </mediaobject>
785 </figure>
786
787 <para>The following network configuration is needed for managing the
788 uCPE device and service deployment:</para>
789
790 <itemizedlist>
791 <listitem>
792 <para>Network connection between the server running the Enea uCPE
793 Manager and the laptop.</para>
794 </listitem>
795
796 <listitem>
797 <para>Network connection between the server running the Enea uCPE
798 Manager and the uCPE device.</para>
799 </listitem>
800 </itemizedlist>
801 </section>
802 </section>
803
804 <section id="mg_ucpe_devices">
805 <title>Management of uCPE Devices</title>
806
807 <para>When the installation is complete the uCPE device can be managed in
808 the Enea uCPE Manager.</para>
809
810 <section id="add_offline_config">
811 <title>Add a default Offline Configuration</title>
812
813 <para>Zero Touch Provisioning is always turned on when a uCPE device
814 connects to the Enea uCPE Manager. To enable it in the Enea uCPE
815 Manager, an offline configuration needs to be registered for Day-0
816 configuration.</para>
817
818 <note>
819 <para>Day-0 configuration is a software lifecycle term referring to
820 early configurations to put the uCPE device in an active state. Day-1
821 Configurations are applied after Day-0 and set the uCPE device and its
822 service in an active state. Day-2 Configurations are live
823 configurations on the uCPE and its service, applied after the uCPE
824 device and its service have been activated.</para>
825 </note>
826
827 <para>The offline configuration consists of data and parameters that are
828 meant to be automatically set when a uCPE device connects to the Enea
829 uCPE Manager for the first time. The configuration is typically focused
830 on setting up the network management of the uCPE device, e.g.
831 configuring network interfaces, WAN and LAN networking and service
832 chains.</para>
833
834 <para>For this base configuration, the offline configuration will be
835 left blank. The blank offline configuration can be filled with
836 user-specific values and data once the service is created, which is done
837 after installation is complete.</para>
838
839 <note>
840 <para>If the offline configuration is not configured, an alarm will be
841 raised: <literal>Day-0 Config:ZTP:Major</literal> when the uCPE device
842 tries to connect to Enea uCPE Manager, informing the user that the ZTP
843 setup failed for the uCPE device.</para>
844 </note>
845
846 <para><emphasis role="bold">To create an offline
847 configuration</emphasis> <orderedlist>
848 <listitem>
849 <para>In a browser access the Enea uCPE Manager, then
850 <literal>Applications</literal>-&gt;<literal>Offline
851 Config</literal>.</para>
852 </listitem>
853
854 <listitem>
855 <para>Create a new offline configuration in the GUI by clicking
856 <literal>Add</literal> and filling in the mandatory fields:
857 <literal>name</literal>, <literal>deviceVersion</literal> and
858 <literal>deviceId</literal>.</para>
859
860 <para>The name is user defined and can be set to any unique text
861 string identifying the configuration. The
862 <literal>deviceVersion</literal> must match the Enea NFV Access
863 version of the uCPE device and the <literal>deviceId</literal>
864 must be the previously set identifier of the uCPE device
865 (DeviceId).</para>
866 </listitem>
867 </orderedlist></para>
868 </section>
869
870 <section id="add_ucpe_mg">
871 <title>Add a uCPE device to the Management System</title>
872
873 <para>In order to enroll a uCPE device in the management system and
874 establish a management connection, the user will add uCPE device
875 information in the Enea uCPE Manager. This is accomplished by selecting
876 <literal>Devices</literal> -&gt; <literal>Manage</literal> -&gt;
877 <literal>Add</literal>.</para>
878
879 <para>The relevant parameters are:</para>
880
881 <itemizedlist>
882 <listitem>
883 <para><emphasis role="bold">Type.</emphasis> The type of device to
884 be added, i.e Enea universal CPE.</para>
885 </listitem>
886
887 <listitem>
888 <para><emphasis role="bold">Name.</emphasis> The name by which the
889 uCPE device is referred to in the Enea uCPE Manager.
890 (Mandatory).</para>
891 </listitem>
892
893 <listitem>
894 <para><emphasis role="bold">SSH Port.</emphasis> The NETCONF Port
895 used for communications. Default is set to 830.</para>
896 </listitem>
897
898 <listitem>
899 <para><emphasis role="bold">SSH User Name.</emphasis> The user name
900 for SSH connectivity. Default user is root.</para>
901 </listitem>
902
903 <listitem>
904 <para><emphasis role="bold">SSH Password.</emphasis> Leave this
905 blank.</para>
906 </listitem>
907
908 <listitem>
909 <para><emphasis role="bold">Device Calls Home.</emphasis> This
910 checkbox indicates the direction of uCPE device communications. For
911 a base configuration, leave this flag unchecked.</para>
912 </listitem>
913
914 <listitem>
915 <para><emphasis role="bold">Device ID.</emphasis> The unique
916 identifier of the uCPE device. (Mandatory).</para>
917 </listitem>
918 </itemizedlist>
919 </section>
920
921 <section id="boot_device_add_map">
922 <title>Booting the uCPE device and adding it to the Map</title>
923
924 <para>When connectivity is established with the Enea uCPE Manager and a
925 uCPE device is already registered with a matching <literal>Device
926 ID</literal>, the installation is complete, and the connection is
927 established.</para>
928
929 <para>When a uCPE device is registered it can be manually added to the
930 map for overview. Right-click on the map and select <literal>Place
931 Device</literal> to put the uCPE device on the map.</para>
932
933 <para>In case of management connection failure (e.g. due to a
934 misconfiguration), the uCPE device status will be seen as RED
935 (disconnected) in the Enea uCPE Manager. The uCPE device configuration
936 can be corrected by removing the WAN cable(s), reconnecting the laptop
937 to the LAN interface of the uCPE device and rebooting it. At this point,
938 the Web-installer can be accessed from the laptop as described in <olink
939 targetdoc="book_enea_nfv_access_getting_started"
940 targetptr="install_ena_device">Installing Enea NFV Access - uCPE Device
941 installation in the <xi:include
942 href="../../s_docbuild/olinkdb/pardoc-names.xml"
943 xmlns:xi="http://www.w3.org/2001/XInclude"
944 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
945 Manual.</para>
946 </section>
947 </section>
948
949 <section id="ucpe_monitor">
950 <title>uCPE Device Monitorization and Control</title>
951
952 <para>Once the uCPE device is connected to the Enea uCPE Manager, it is
953 ready for central management. Two important functions available in the
954 Enea uCPE Manager GUI are alarm checking and resource allocation.</para>
955
956 <section id="check_alarms">
957 <title>Checking Alarms</title>
958
959 <para>The Enea uCPE Manager dashboard presents alarms in a specific
960 window on the front page.</para>
961
962 <para>An alarm can be easily triggered by disconnecting and reconnecting
963 the WAN ethernet cable from the uCPE device. The management system will
964 detect the broken link and raise an alarm: <literal>Device
965 Disconnected::Critical</literal>.</para>
966
967 <para>A separate Alarm Management window can be accessed from the Enea
968 uCPE Manager menu for in-depth access and programming of Alarms and
969 Events.</para>
970 </section>
971
972 <section id="ck_resource_alloc">
973 <title>Checking uCPE device Resource Allocation</title>
974
975 <para>When the uCPE device is connected to the Enea uCPE Manager it is
976 of interest to check the amount of hardware resources in use.</para>
977
978 <para>To check CPU, RAM and disk utilization simply select the uCPE
979 device and click the <literal>Virtual Machines</literal> tab in the map
980 view. The same view will show active VNFs running on the uCPE device
981 once instantiated.</para>
982 </section>
983
984 <section id="access_device_cli">
985 <title>Accessing the uCPE device CLI</title>
986
987 <para>As a final check to make sure the uCPE device was installed and
988 configured correctly, access the uCPE device Linux CLI by selecting the
989 uCPE device on the map and using the SSH button from the panel. A new
990 window will appear for CLI access. The default user and password are
991 <literal>root</literal> and blank, respectively.</para>
992
993 <para>The Enea NFV Access CLI is a pure Linux CLI providing access to
994 standard Linux CLI commands. The CLI is a central feature for running
995 custom scripting.</para>
996
997 <note>
998 <para>In case the uCPE was installed behind a NAT device, reverse SSH
999 connection will be used. For more details, please see <olink
1000 targetdoc="book_enea_nfv_access_getting_started"
1001 targetptr="device_callhome_nat">Device Call Home Connection for
1002 deployment behind NAT in the <xi:include
1003 href="../../s_docbuild/olinkdb/pardoc-names.xml"
1004 xmlns:xi="http://www.w3.org/2001/XInclude"
1005 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
1006 Manual.</para>
1007 </note>
1008 </section>
1009 </section>
1010</chapter> \ No newline at end of file
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-07-08 10:55:37 +0000