summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml26
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.pngbin125599 -> 322979 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/prep_execution.pngbin116871 -> 312054 bytes
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml385
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/introduction.xml45
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/log_collector.xml63
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml1024
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml55
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml56
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml67
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/about_release.xml12
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml24
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/main_changes.xml14
13 files changed, 876 insertions, 895 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 bd51b21..8925498 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
@@ -5,9 +5,8 @@
5 <title>Advanced Configurations</title> 5 <title>Advanced Configurations</title>
6 6
7 <para>This chapter describes possible configurations for advanced features 7 <para>This chapter describes possible configurations for advanced features
8 such as the Hugepage Reservation Service, UEFI Secure Boot and Bare Metal 8 such as the Hugepage Reservation Service customization, UEFI Secure Boot and
9 Provisioning. These features are optional in the Enea NFV Access platform. 9 Bare Metal Provisioning.</para>
10 If you do not intend to use these features, skip this chapter.</para>
11 10
12 <section id="bare_meta_prov"> 11 <section id="bare_meta_prov">
13 <title>Bare Metal Provisioning</title> 12 <title>Bare Metal Provisioning</title>
@@ -62,9 +61,18 @@
62 </listitem> 61 </listitem>
63 62
64 <listitem> 63 <listitem>
65 <para>A remote management tool is available that can be used to set 64 <para>CSM support and Dual Boot must be enabled in BIOS (i.e. PXE
66 the next boot option to PXE and reboot the uCPE devices in order to 65 booting in legacy mode), while the final Enea NFV Access image will
67 begin the installation.</para> 66 boot in UEFI mode. Doing a mass deployment using legacy PXE booting
67 usually means that SecureBoot is disabled, SecureBoot will need to
68 be enabled afterwards.</para>
69 </listitem>
70
71 <listitem>
72 <para>A remote management tool such as <literal>ipmitool</literal>
73 (or a vendor-specific tool) is available for use to set the next
74 boot option to PXE and reboot the uCPE devices in order to begin the
75 installation.</para>
68 </listitem> 76 </listitem>
69 </itemizedlist> 77 </itemizedlist>
70 </section> 78 </section>
@@ -265,9 +273,9 @@ ipmitool -U &lt;user&gt; -P &lt;password&gt; -H &lt;uCPE device IPMI IP address&
265 <section id="hugepage_reservation"> 273 <section id="hugepage_reservation">
266 <title>Hugepage Reservation Service</title> 274 <title>Hugepage Reservation Service</title>
267 275
268 <para>NFV Access implements an automatic hugepage allocation service that 276 <para>Enea NFV Access implements an automatic hugepage allocation service
269 is triggered at each startup. The service is skipped if hugepages have 277 that is triggered at each startup. The service is skipped if hugepages
270 been allocated in the kernel boot command line.</para> 278 have been allocated in the kernel boot command line.</para>
271 279
272 <para>There are two strategies outlined for hugepage allocation:</para> 280 <para>There are two strategies outlined for hugepage allocation:</para>
273 281
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.png b/doc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.png
index e93e7f1..e75275e 100755
--- a/doc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.png
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.png
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/prep_execution.png b/doc/book-enea-nfv-access-getting-started/doc/images/prep_execution.png
index 5d5a355..2917cd6 100755
--- a/doc/book-enea-nfv-access-getting-started/doc/images/prep_execution.png
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/prep_execution.png
Binary files differ
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
index 80ae36b..9e0ccb8 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml
@@ -1,6 +1,7 @@
1<?xml version="1.0" encoding="ISO-8859-1"?> 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 NFV Access Base Configuration</title> 3 <title>Setting up and Installing the Enea NFV Access Base
4 Configuration</title>
4 5
5 <para>The setup and installation steps detailed below will deploy a base 6 <para>The setup and installation steps detailed below will deploy a base
6 configuration which will be used as a reference for more complex deployment 7 configuration which will be used as a reference for more complex deployment
@@ -14,45 +15,22 @@
14 15
15 <itemizedlist> 16 <itemizedlist>
16 <listitem> 17 <listitem>
17 <para>One CentOS 7 server</para> 18 <para>One server running the CentOS 7 distribution</para>
18 19
19 <para>Minimal Requirement: 4 Cores, 16 GB RAM and 300 GB single disk 20 <para>Minimal Requirement: 4 Cores, 16 GB RAM and 300 GB single disk
20 storage. Make sure the CentOS 7 server is updated to the latest 21 storage. Make sure the CentOS 7 server is updated to the latest
21 revision before installing Enea NFV Access.</para> 22 revision before installing Enea NFV Access.</para>
22 23
23 <para>The purpose of the CentOS 7 server is to host the uCPE Manager. 24 <para>The purpose of the CentOS 7 server is to host the Enea uCPE
24 Network access between the CentOS 7 server and the uCPE devices is 25 Manager. Network access between the CentOS 7 server and the uCPE
25 required. The uCPE Manager and the uCPE devices will be connected on 26 devices is required. The Enea uCPE Manager and the uCPE devices will
26 separate subnets to avoid inconsistencies.</para> 27 be connected on separate subnets to avoid inconsistencies.</para>
27 </listitem>
28
29 <listitem>
30 <para>A laptop.</para>
31
32 <para>The laptop is used for 2 scenarios:</para>
33
34 <itemizedlist>
35 <listitem>
36 <para>Installing the NFV Access Run Time Platform on uCPE
37 Devices.</para>
38 </listitem>
39
40 <listitem>
41 <para>Connecting to the GUI of the uCPE Manager for management and
42 configuration. Network access between the CentOS 7 server and the
43 laptop is required. Please see the <xi:include
44 href="../../s_docbuild/olinkdb/pardoc-common.xml"
45 xmlns:xi="http://www.w3.org/2001/XInclude"
46 xpointer="element(book_enea_nfv_access_release_info/1)" /> manual
47 available with your release, for recommended browsers.</para>
48 </listitem>
49 </itemizedlist>
50 </listitem> 28 </listitem>
51 29
52 <listitem> 30 <listitem>
53 <para>One or more uCPE devices.</para> 31 <para>One or more uCPE devices.</para>
54 32
55 <para>White Box devices where the Enea NFV Access Runtime Platform 33 <para>Whitebox devices where the Enea NFV Access Run Time Platform
56 will be installed, containing a minimum of 2 cores and 4 GB RAM and at 34 will be installed, containing a minimum of 2 cores and 4 GB RAM and at
57 least two ethernet ports that will be configured as WAN and LAN during 35 least two ethernet ports that will be configured as WAN and LAN during
58 deployment.</para> 36 deployment.</para>
@@ -73,6 +51,29 @@
73 </listitem> 51 </listitem>
74 52
75 <listitem> 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 Run Time 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>
76 <para>A 16 GB USB stick used for the uCPE Device Installation.</para> 77 <para>A 16 GB USB stick used for the uCPE Device Installation.</para>
77 </listitem> 78 </listitem>
78 </itemizedlist> 79 </itemizedlist>
@@ -89,9 +90,9 @@
89 90
90 <para>Any firewall running on the CentOS 7 server may block the 91 <para>Any firewall running on the CentOS 7 server may block the
91 management protocols required to communicate between the uCPE device and 92 management protocols required to communicate between the uCPE device and
92 the uCPE Manager as well as between the uCPE Manager and its northbound 93 the Enea uCPE Manager as well as between the Enea uCPE Manager and its
93 clients. Quick handling of a blocking firewall would be to disable it, 94 northbound clients. Quick handling of a blocking firewall would be to
94 typical for a lab environment, through:</para> 95 disable it, typical for a lab environment, through:</para>
95 96
96 <programlisting>sudo systemctl stop firewalld 97 <programlisting>sudo systemctl stop firewalld
97sudo systemctl disable firewalld 98sudo systemctl disable firewalld
@@ -128,7 +129,7 @@ sudo systemctl mask -now firewalld</programlisting>
128 129
129 <entry>UDP</entry> 130 <entry>UDP</entry>
130 131
131 <entry>Required for the uCPE Manager High Availability 132 <entry>Required for the Enea uCPE Manager High Availability
132 Configuration.</entry> 133 Configuration.</entry>
133 </row> 134 </row>
134 135
@@ -137,7 +138,7 @@ sudo systemctl mask -now firewalld</programlisting>
137 138
138 <entry>TCP</entry> 139 <entry>TCP</entry>
139 140
140 <entry>Required for the uCPE Manager High Availability 141 <entry>Required for the Enea uCPE Manager High Availability
141 Configuration.</entry> 142 Configuration.</entry>
142 </row> 143 </row>
143 144
@@ -169,7 +170,7 @@ sudo systemctl mask -now firewalld</programlisting>
169 </table> 170 </table>
170 171
171 <para>Use the following command sequence to enable the required ports 172 <para>Use the following command sequence to enable the required ports
172 for deployment of the uCPE Manager:</para> 173 for deployment of the Enea uCPE Manager:</para>
173 174
174 <programlisting>sudo firewall-cmd --permanent --add-service=80/tcp 175 <programlisting>sudo firewall-cmd --permanent --add-service=80/tcp
175sudo firewall-cmd --permanent --add-service=443/tcp 176sudo firewall-cmd --permanent --add-service=443/tcp
@@ -184,8 +185,8 @@ sudo firewall-cmd --reload</programlisting>
184 <section id="openjdk_postgresql_config"> 185 <section id="openjdk_postgresql_config">
185 <title>Configuring OpenJDK and PostgreSQL</title> 186 <title>Configuring OpenJDK and PostgreSQL</title>
186 187
187 <para>The uCPE Manager requires a specific Java version (OpenJDK 11) and 188 <para>The Enea uCPE Manager requires a specific Java version (OpenJDK
188 a PostgreSQL version to operate correctly.</para> 189 11) and a PostgreSQL version to operate correctly.</para>
189 190
190 <para><emphasis role="bold">Installing OpenJDK</emphasis></para> 191 <para><emphasis role="bold">Installing OpenJDK</emphasis></para>
191 192
@@ -201,7 +202,7 @@ sudo firewall-cmd --reload</programlisting>
201 202
202 <programlisting>java -version 203 <programlisting>java -version
203openjdk version "11.0.3" 2019-04-16 LTS 204openjdk version "11.0.3" 2019-04-16 LTS
204OpenJDK Runtime Environment 18.9 (build 11.0.3+7-LTS) 205OpenJDK Run Time Environment 18.9 (build 11.0.3+7-LTS)
205OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing) </programlisting> 206OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing) </programlisting>
206 207
207 <note> 208 <note>
@@ -235,9 +236,10 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</p
235 </listitem> 236 </listitem>
236 </orderedlist> 237 </orderedlist>
237 238
238 <para>The uCPE Manager requires a specific PostgreeSQL version. This is 239 <para>The Enea uCPE Manager requires a specific PostgreeSQL version.
239 embedded in the uCPE Manager installation. In order to avoid conflicts, 240 This is embedded in the Enea uCPE Manager installation. In order to
240 any existing PostgreeSQL installation needs to be uninstalled.</para> 241 avoid conflicts, any existing PostgreeSQL installation needs to be
242 uninstalled.</para>
241 243
242 <para><emphasis role="bold">Uninstalling PostgreSQL</emphasis></para> 244 <para><emphasis role="bold">Uninstalling PostgreSQL</emphasis></para>
243 245
@@ -264,8 +266,8 @@ rm -f /etc/postgres-reg.ini
264userdel postgres</programlisting> 266userdel postgres</programlisting>
265 267
266 <note> 268 <note>
267 <para>This step is not necessary if the uCPE Manager will be using 269 <para>This step is not necessary if the Enea uCPE Manager will be
268 an external database (like MariaDB).</para> 270 using an external database (like MariaDB).</para>
269 </note> 271 </note>
270 </listitem> 272 </listitem>
271 </orderedlist> 273 </orderedlist>
@@ -291,8 +293,8 @@ userdel postgres</programlisting>
291 </listitem> 293 </listitem>
292 294
293 <listitem> 295 <listitem>
294 <para>Follow the installation steps for the uCPE Manager available 296 <para>Follow the installation steps for the Enea uCPE Manager
295 in <olink targetdoc="book_enea_nfv_access_getting_started" 297 available in <olink targetdoc="book_enea_nfv_access_getting_started"
296 targetptr="install_ucpe_mg">Installing the uCPE Manager in the 298 targetptr="install_ucpe_mg">Installing the uCPE Manager in the
297 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" 299 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
298 xmlns:xi="http://www.w3.org/2001/XInclude" 300 xmlns:xi="http://www.w3.org/2001/XInclude"
@@ -309,7 +311,7 @@ userdel postgres</programlisting>
309 <section id="wan_lan_ports"> 311 <section id="wan_lan_ports">
310 <title>Determining the WAN and LAN ports</title> 312 <title>Determining the WAN and LAN ports</title>
311 313
312 <para>A typical White box comes with multiple physical network ports, 314 <para>A typical whitebox comes with multiple physical network ports,
313 ready to be used. The user must determine the purpose and allocation of 315 ready to be used. The user must determine the purpose and allocation of
314 each port. The allocation is later aligned with the software 316 each port. The allocation is later aligned with the software
315 configuration within the Enea NFV Access installer.</para> 317 configuration within the Enea NFV Access installer.</para>
@@ -320,10 +322,10 @@ userdel postgres</programlisting>
320 </section> 322 </section>
321 323
322 <section id="ucpe_identifier"> 324 <section id="ucpe_identifier">
323 <title>Determining the uCPE Identifier</title> 325 <title>Determining the DeviceId</title>
324 326
325 <para>Each uCPE device needs a unique identifier. This identifier is 327 <para>Each uCPE device needs a unique identifier. This identifier is
326 used to match the registration in the uCPE Manager and the offline 328 used to match the registration in the Enea uCPE Manager and the offline
327 configuration of the uCPE device during ZTP (Zero Touch 329 configuration of the uCPE device during ZTP (Zero Touch
328 Provisioning)</para> 330 Provisioning)</para>
329 331
@@ -341,7 +343,7 @@ userdel postgres</programlisting>
341 installation.</para> 343 installation.</para>
342 344
343 <para>Access the BIOS using a serial cable between the uCPE device and 345 <para>Access the BIOS using a serial cable between the uCPE device and
344 the laptop, to review and configure the BIOS correctly. The White box 346 the laptop, to review and configure the BIOS correctly. The whitebox
345 vendor is expected to provide the right serial cable for the box. A 347 vendor is expected to provide the right serial cable for the box. A
346 terminal emulator (such as putty) is needed on the laptop.</para> 348 terminal emulator (such as putty) is needed on the laptop.</para>
347 349
@@ -366,7 +368,7 @@ userdel postgres</programlisting>
366 </itemizedlist> 368 </itemizedlist>
367 369
368 <para>The boot order may also need to be modified to support 370 <para>The boot order may also need to be modified to support
369 installation and execution of the Enea NFV Access Runtime Platform on 371 installation and execution of the Enea NFV Access Run Time Platform on
370 the uCPE device.</para> 372 the uCPE device.</para>
371 373
372 <para>The following boot order is recommended for a base 374 <para>The following boot order is recommended for a base
@@ -391,14 +393,14 @@ userdel postgres</programlisting>
391 <title>Preparing the deployment</title> 393 <title>Preparing the deployment</title>
392 394
393 <section id="install_ucpe_mg"> 395 <section id="install_ucpe_mg">
394 <title>Installing the uCPE Manager</title> 396 <title>Installing the Enea uCPE Manager</title>
395 397
396 <para>The uCPE Manager can be installed using as a fresh/first-time 398 <para>The Enea uCPE Manager can be installed using as a fresh/first-time
397 configuration or using a backup file of a previous installation, created 399 configuration or using a backup file of a previous installation, created
398 within the uCPE Manager GUI.</para> 400 within the Enea uCPE Manager GUI.</para>
399 401
400 <section id="fresh_ucpemg_install"> 402 <section id="fresh_ucpemg_install">
401 <title>Fresh Installation of the uCPE Manager</title> 403 <title>Fresh Installation of the Enea uCPE Manager</title>
402 404
403 <para>On the CentOS 7 server open a terminal, log into a bash shell 405 <para>On the CentOS 7 server open a terminal, log into a bash shell
404 with the root account and perform the following:</para> 406 with the root account and perform the following:</para>
@@ -442,7 +444,8 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
442 444
443 <note> 445 <note>
444 <para>The same configuration values set now will need to be 446 <para>The same configuration values set now will need to be
445 provided when upgrading or uninstalling the uCPE Manager.</para> 447 provided when upgrading or uninstalling the Enea uCPE
448 Manager.</para>
446 </note> 449 </note>
447 450
448 <itemizedlist> 451 <itemizedlist>
@@ -545,7 +548,7 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
545 </listitem> 548 </listitem>
546 549
547 <listitem> 550 <listitem>
548 <para>Install the uCPE Manager as a service with the name 551 <para>Install the Enea uCPE Manager as a service with the name
549 <literal>ucpemanager</literal>.</para> 552 <literal>ucpemanager</literal>.</para>
550 </listitem> 553 </listitem>
551 554
@@ -556,44 +559,45 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
556 </listitem> 559 </listitem>
557 560
558 <listitem> 561 <listitem>
559 <para>Open the IP Address of the CentOS 7 Server in a web browser 562 <para>Using the IPv4 address of the CentOS 7 Server in a web
560 on the laptop and log in with the username and password: 563 browser, running on the laptop, log into the Enea uCPE Manager GUI
561 <literal>admin</literal>/<literal>admin</literal>.</para> 564 using the default username and password:
565 <literal>admin/admin</literal>.</para>
562 </listitem> 566 </listitem>
563 </orderedlist> 567 </orderedlist>
564 568
565 <note> 569 <note>
566 <para>The IPv4 address of the CentOS 7 server, connected to the same 570 <para>The IPv4 address of the CentOS 7 Server, connected to the same
567 network as the uCPE Devices, will be used as a configuration 571 network as the uCPE Devices, will be used as a configuration
568 parameter both when setting up the uCPE devices and when accessing 572 parameter both when setting up the uCPE devices.</para>
569 the uCPE Manager GUI.</para>
570 </note> 573 </note>
571 </section> 574 </section>
572 575
573 <section id="install_ucpemg_from_backup"> 576 <section id="install_ucpemg_from_backup">
574 <title>Installation of the uCPE Manager using a System Back-up</title> 577 <title>Installation of the Enea uCPE Manager using a System
578 Back-up</title>
575 579
576 <para>The uCPE Manager can be restored if a back-up file has been 580 <para>The Enea uCPE Manager can be restored if a back-up file has been
577 previously created.</para> 581 previously created.</para>
578 582
579 <para>A backup file can be created by accessing: 583 <para>A backup file can be created by accessing:
580 <literal>System</literal> -&gt; <literal>System Backup</literal> from 584 <literal>System</literal> -&gt; <literal>System Backup</literal> from
581 the uCPE Manager GUI. The resulting zip archive will be located in the 585 the Enea uCPE Manager GUI. The resulting zip archive will be located
582 <filename>/opt/ems/ucpemanager/application/backup</filename> folder 586 in the <filename>/opt/ems/ucpemanager/application/backup</filename>
583 and will be named 587 folder and will be named
584 <literal>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</literal> (e.g 588 <literal>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</literal> (e.g
585 System-Backup_Feb19_2013_2257_42.zip). Save the archive to another 589 System-Backup_Feb19_2013_2257_42.zip). Save the archive to another
586 location outside the uCPE Manager installation folder for future 590 location outside the Enea uCPE Manager installation folder for future
587 use.</para> 591 use.</para>
588 592
589 <note> 593 <note>
590 <para>The System Back-up file obtained from the uCPE Manager GUI 594 <para>The System Back-up file obtained from the Enea uCPE Manager
591 (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is 595 GUI (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is
592 different from the uCPE Manager snapshot obtained during a uCPE 596 different from the Enea uCPE Manager snapshot obtained during a Enea
593 Manager Upgrade or Uninstall operation 597 uCPE Manager Upgrade or Uninstall operation
594 (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) needed 598 (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) needed
595 for recovery of the uCPE Manager. For more details please see <olink 599 for recovery of the Enea uCPE Manager. For more details please see
596 targetdoc="book_enea_nfv_access_getting_started" 600 <olink targetdoc="book_enea_nfv_access_getting_started"
597 targetptr="restore_prev_ucpe_install">Restoring a previous uCPE 601 targetptr="restore_prev_ucpe_install">Restoring a previous uCPE
598 Manager installation in the <xi:include 602 Manager installation in the <xi:include
599 href="../../s_docbuild/olinkdb/pardoc-names.xml" 603 href="../../s_docbuild/olinkdb/pardoc-names.xml"
@@ -602,8 +606,8 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
602 Manual.</para> 606 Manual.</para>
603 </note> 607 </note>
604 608
605 <para>To install the uCPE Manager with the restore option provide an 609 <para>To install the Enea uCPE Manager with the restore option provide
606 additional argument as shown below during installation:</para> 610 an additional argument as shown below during installation:</para>
607 611
608 <programlisting>./install.sh \ 612 <programlisting>./install.sh \
609/opt/ems Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz \ 613/opt/ems Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz \
@@ -612,12 +616,15 @@ SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting>
612 </section> 616 </section>
613 617
614 <section id="prep_usb_ena"> 618 <section id="prep_usb_ena">
615 <title>Preparing the USB stick for installation of the NFV Access Run 619 <title>Preparing the USB stick for installation of the Enea NFV Access
616 Time Platform</title> 620 Run Time Platform</title>
617 621
618 <para>To install the Enea NFV Access Run Time Platform, create a 622 <para>To install the Enea NFV Access Run Time Platform, create a
619 bootable USB stick with the image you intend to install. Follow the 623 bootable USB stick with the image you intend to install. </para>
620 example below to proceed.</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>
621 628
622 <note> 629 <note>
623 <para>The .hddimg image is available in the 630 <para>The .hddimg image is available in the
@@ -674,31 +681,17 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
674 </mediaobject> 681 </mediaobject>
675 </figure> 682 </figure>
676 683
677 <para>The following hardware configuration is needed to install uCPE 684 <para>While the uCPE device is powered off, in order to install and
678 devices:</para> 685 configure the Enea NFV Access Run Time using the prepared USB stick,
679 686 connect the laptop to a uCPE device LAN port. For this purpose, a Layer
680 <orderedlist> 687 2 switch or direct cable connection can be used.</para>
681 <listitem>
682 <para>Network connection between the CentOS 7 server and the
683 laptop.</para>
684 </listitem>
685
686 <listitem>
687 <para>The uCPE device is powered off.</para>
688 </listitem>
689
690 <listitem>
691 <para>Direct Ethernet cable connection between the uCPE Device LAN
692 and the laptop.</para>
693 </listitem>
694 </orderedlist>
695 </section> 688 </section>
696 689
697 <section id="install_ena_device"> 690 <section id="install_ena_device">
698 <title>Installing Enea NFV Access - uCPE Device installation</title> 691 <title>Installing Enea NFV Access - uCPE Device installation</title>
699 692
700 <para>To initiate the installation of the NFV Access Run Time Platform 693 <para>To initiate the installation of the Enea NFV Access Run Time
701 do the following:</para> 694 Platform do the following:</para>
702 695
703 <orderedlist> 696 <orderedlist>
704 <listitem> 697 <listitem>
@@ -706,12 +699,6 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
706 </listitem> 699 </listitem>
707 700
708 <listitem> 701 <listitem>
709 <para>Connect a laptop directly into one of the uCPE device ports.
710 This can't be used as a WAN port at a later moment. No other ports
711 should be connected.</para>
712 </listitem>
713
714 <listitem>
715 <para>Power up the uCPE device and boot the USB stick.</para> 702 <para>Power up the uCPE device and boot the USB stick.</para>
716 </listitem> 703 </listitem>
717 704
@@ -727,42 +714,49 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
727 714
728 <itemizedlist> 715 <itemizedlist>
729 <listitem> 716 <listitem>
730 <para>The static uCPE Manager IP Address.</para> 717 <para>The static Enea uCPE Manager IP Address.</para>
731 </listitem> 718 </listitem>
732 719
733 <listitem> 720 <listitem>
734 <para>The unique identifier of the uCPE device (called "uCPE 721 <para>The unique identifier of the uCPE device (called
735 Identifier" in this guide).</para> 722 "DeviceId" in this guide).</para>
736 </listitem> 723 </listitem>
737 724
738 <listitem> 725 <listitem>
739 <para>Customer Tags. They are used for Zero Touch Provisining 726 <para>Customer Tags. They are used for Zero Touch Provisining
740 (ZTP) and can be left empty for a base configuration. What can 727 (ZTP) and can be left empty for a base configuration. What can
741 be entered here (if needed), are the tag(s) specified when 728 be entered here (if needed), are the tag(s) specified when
742 creating an offline configuration in the uCPE Manager. A later 729 creating an offline configuration in the Enea uCPE Manager. A
743 addition of customer tags can only be done by reinstalling the 730 later addition of customer tags can only be done by reinstalling
744 uCPE devices.</para> 731 the uCPE devices.</para>
745 </listitem> 732 </listitem>
746 </itemizedlist> 733 </itemizedlist>
747 </listitem> 734 </listitem>
748 735
749 <listitem> 736 <listitem>
750 <para>On the second page of the Web-installer, the user must fill 737 <para>Connect the WAN cable to the uCPE device (see Figure 2). This
751 in:</para> 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>
752 745
753 <itemizedlist> 746 <itemizedlist>
754 <listitem> 747 <listitem>
755 <para>The Management Interface. The network interface used by 748 <para>Configure the management network interface. This interface
756 the uCPE Manager to communicate with the uCPE device.</para> 749 is used by the Enea uCPE Manager to communicate with the uCPE
750 device.</para>
757 </listitem> 751 </listitem>
758 752
759 <listitem> 753 <listitem>
760 <para>During network configuration, WAN cables are plugged into 754 <para>Plug-in additional WAN interfaces (if applicable) and
761 the uCPE device to identify ports and make them available for 755 provide their Layer 3 configuration.</para>
762 configuration. The user needs to connect the same number of 756 </listitem>
763 cables as the number of WAN ports that he wishes to configure 757
764 (DHCP is the default setting). The configured WAN cables cannot 758 <listitem>
765 be removed after being configured.</para> 759 <para>The Static or Dynamic IP.</para>
766 760
767 <note> 761 <note>
768 <para>No LAN ports should be connected nor configured at this 762 <para>No LAN ports should be connected nor configured at this
@@ -771,22 +765,15 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
771 Web-Installer.</para> 765 Web-Installer.</para>
772 </note> 766 </note>
773 </listitem> 767 </listitem>
774
775 <listitem>
776 <para>The Layer 3 configuration of WAN Interface(s).</para>
777 </listitem>
778
779 <listitem>
780 <para>The Static or Dynamic IP.</para>
781 </listitem>
782 </itemizedlist> 768 </itemizedlist>
783 </listitem> 769 </listitem>
784 </orderedlist> 770 </orderedlist>
785 771
786 <para>When the user has completed the configuration steps in the 772 <para>When the user has completed the configuration steps in the
787 Web-installer, NFV Access is installed on the hard drive (the largest 773 Web-installer, Enea NFV Access is installed on the hard drive. At this
788 drive found on the uCPE device will be used for installation. Now the 774 stage, user should remove the USB stick and LAN cable and shutdown the
789 user must remove USB stick and reboot the device.</para> 775 uCPE device. It will be started after necessary configurations are done
776 on the Enea uCPE Manager, as described below.</para>
790 </section> 777 </section>
791 778
792 <section id="prep_phys_exec"> 779 <section id="prep_phys_exec">
@@ -802,26 +789,18 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
802 </mediaobject> 789 </mediaobject>
803 </figure> 790 </figure>
804 791
805 <para>The following hardware configuration is needed for service 792 <para>The following network configuration is needed for managing the
806 deployment:</para> 793 uCPE device and service deployment:</para>
807 794
808 <itemizedlist> 795 <itemizedlist>
809 <listitem> 796 <listitem>
810 <para>Network connection between the CentOS 7 server and the 797 <para>Network connection between the server running the Enea uCPE
811 laptop.</para> 798 Manager and the laptop.</para>
812 </listitem>
813
814 <listitem>
815 <para>Network connection between the CentOS 7 server and the uCPE
816 device WAN port.</para>
817 </listitem> 799 </listitem>
818 800
819 <listitem> 801 <listitem>
820 <para>The USB is removed from the uCPE device.</para> 802 <para>Network connection between the server running the Enea uCPE
821 </listitem> 803 Manager and the uCPE device.</para>
822
823 <listitem>
824 <para>The uCPE device powered off.</para>
825 </listitem> 804 </listitem>
826 </itemizedlist> 805 </itemizedlist>
827 </section> 806 </section>
@@ -830,15 +809,15 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
830 <section id="mg_ucpe_devices"> 809 <section id="mg_ucpe_devices">
831 <title>Management of uCPE Devices</title> 810 <title>Management of uCPE Devices</title>
832 811
833 <para>When the installation is complete the uCPE Device can be connected 812 <para>When the installation is complete the uCPE device can be managed in
834 to uCPE Manager.</para> 813 the Enea uCPE Manager.</para>
835 814
836 <section id="add_offline_config"> 815 <section id="add_offline_config">
837 <title>Add a default Offline Configuration</title> 816 <title>Add a default Offline Configuration</title>
838 817
839 <para>Zero Touch Provisioning is always turned on when a uCPE device 818 <para>Zero Touch Provisioning is always turned on when a uCPE device
840 connects to the uCPE Manager. To enable it in the uCPE Manager, an 819 connects to the Enea uCPE Manager. To enable it in the Enea uCPE
841 offline configuration needs to be registered for Day-0 820 Manager, an offline configuration needs to be registered for Day-0
842 configuration.</para> 821 configuration.</para>
843 822
844 <note> 823 <note>
@@ -851,10 +830,11 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
851 </note> 830 </note>
852 831
853 <para>The offline configuration consists of data and parameters that are 832 <para>The offline configuration consists of data and parameters that are
854 meant to be automatically set when a uCPE device connects to the uCPE 833 meant to be automatically set when a uCPE device connects to the Enea
855 Manager for the first time. The configuration is typically focused on 834 uCPE Manager for the first time. The configuration is typically focused
856 setting up the network management of the uCPE device, e.g. configuring 835 on setting up the network management of the uCPE device, e.g.
857 network interfaces, WAN and LAN networking and service chains.</para> 836 configuring network interfaces, WAN and LAN networking and service
837 chains.</para>
858 838
859 <para>For this base configuration, the offline configuration will be 839 <para>For this base configuration, the offline configuration will be
860 left blank. The blank offline configuration can be filled with 840 left blank. The blank offline configuration can be filled with
@@ -864,14 +844,14 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
864 <note> 844 <note>
865 <para>If the offline configuration is not configured, an alarm will be 845 <para>If the offline configuration is not configured, an alarm will be
866 raised: <literal>Day-0 Config:ZTP:Major</literal> when the uCPE device 846 raised: <literal>Day-0 Config:ZTP:Major</literal> when the uCPE device
867 tries to connect to uCPE Manager, informing the user that the ZTP 847 tries to connect to Enea uCPE Manager, informing the user that the ZTP
868 setup failed for the uCPE device.</para> 848 setup failed for the uCPE device.</para>
869 </note> 849 </note>
870 850
871 <para><emphasis role="bold">To create an offline 851 <para><emphasis role="bold">To create an offline
872 configuration</emphasis> <orderedlist> 852 configuration</emphasis> <orderedlist>
873 <listitem> 853 <listitem>
874 <para>In a browser access the uCPE Manager, then 854 <para>In a browser access the Enea uCPE Manager, then
875 <literal>Applications</literal>-&gt;<literal>Offline 855 <literal>Applications</literal>-&gt;<literal>Offline
876 Config</literal>.</para> 856 Config</literal>.</para>
877 </listitem> 857 </listitem>
@@ -886,8 +866,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
886 string identifying the configuration. The 866 string identifying the configuration. The
887 <literal>deviceVersion</literal> must match the Enea NFV Access 867 <literal>deviceVersion</literal> must match the Enea NFV Access
888 version of the uCPE device and the <literal>deviceId</literal> 868 version of the uCPE device and the <literal>deviceId</literal>
889 must be the previously set identifier of the uCPE device (uCPE 869 must be the previously set identifier of the uCPE device
890 Identifier).</para> 870 (DeviceId).</para>
891 </listitem> 871 </listitem>
892 </orderedlist></para> 872 </orderedlist></para>
893 </section> 873 </section>
@@ -895,15 +875,11 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
895 <section id="add_ucpe_mg"> 875 <section id="add_ucpe_mg">
896 <title>Add a uCPE device to the Management System</title> 876 <title>Add a uCPE device to the Management System</title>
897 877
898 <para>The uCPE Manager will periodically poll the uCPE device based on 878 <para>In order to enroll a uCPE device in the management system and
899 the IP address broadcasted by the uCPE device, attempting to establish a 879 establish a management connection, the user will add uCPE device
900 management connection.</para> 880 information in the Enea uCPE Manager. This is accomplished by selecting
901
902 <para>For the connection to succeed, add the uCPE device running the NFV
903 Access Run Time Platform to the management system:
904 <literal>Devices</literal> -&gt; <literal>Manage</literal> -&gt; 881 <literal>Devices</literal> -&gt; <literal>Manage</literal> -&gt;
905 <literal>Add</literal>. Supply information about the uCPE device and set 882 <literal>Add</literal>. </para>
906 the parameters that will be used to connect to it.</para>
907 883
908 <para>The relevant parameters are:</para> 884 <para>The relevant parameters are:</para>
909 885
@@ -915,7 +891,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
915 891
916 <listitem> 892 <listitem>
917 <para><emphasis role="bold">Name.</emphasis> The name by which the 893 <para><emphasis role="bold">Name.</emphasis> The name by which the
918 uCPE device is referred to in the uCPE Manager.</para> 894 uCPE device is referred to in the Enea uCPE Manager.
895 (Mandatory).</para>
919 </listitem> 896 </listitem>
920 897
921 <listitem> 898 <listitem>
@@ -941,7 +918,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
941 918
942 <listitem> 919 <listitem>
943 <para><emphasis role="bold">Device ID.</emphasis> The unique 920 <para><emphasis role="bold">Device ID.</emphasis> The unique
944 identifier of the uCPE device.</para> 921 identifier of the uCPE device. (Mandatory).</para>
945 </listitem> 922 </listitem>
946 </itemizedlist> 923 </itemizedlist>
947 </section> 924 </section>
@@ -949,18 +926,36 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
949 <section id="boot_device_add_map"> 926 <section id="boot_device_add_map">
950 <title>Booting the uCPE device and adding it to the Map</title> 927 <title>Booting the uCPE device and adding it to the Map</title>
951 928
952 <para>When connectivity is established with the uCPE Manager and a uCPE 929 <para>When connectivity is established with the Enea uCPE Manager and a
953 device is already registered with a matching <literal>Device 930 uCPE device is already registered with a matching <literal>Device
954 ID</literal>, the installation is complete, and the connection is 931 ID</literal>, the installation is complete, and the connection is
955 established.</para> 932 established.</para>
956 933
957 <note> 934 <note>
958 <para>In case of failure due to a misconfiguration or if a uCPE device 935 <para>In case of failure due to a misconfiguration or if a uCPE device
959 does not appear in the uCPE Manager, a reinstallation is needed .The 936 does not appear in the Enea uCPE Manager, a reinstallation is needed
960 user should remove all WAN cables, reinsert the USB stick, reconnect 937 .The user should remove all WAN cables, reinsert the USB stick,
961 the laptop using the ethernet cable, reboot the uCPE device and then 938 reconnect the laptop using the ethernet cable, reboot the uCPE device
962 access the Web-installer 939 and then access the Web-installer
963 (<literal>http://172.16.1.1</literal>).</para> 940 (<literal>http://172.16.1.1</literal>).</para>
941
942 <para>In case of management connection failure (e.g. due to a
943 misconfiguration), the uCPE device status will be seen as RED
944 (disconnected) in Enea uCPE Manager. Please check the accuracy of the
945 information provided when the uCPE device was registered in the Enea
946 uCPE Manager. </para>
947
948 <para>The uCPE device configuration can be amended. In order to do
949 that, please remove the WAN cable(s), reconnect the laptop to the LAN
950 interface of the uCPE device and reboot it. At this point, the
951 Web-installer can be accessed from the laptop as described in <olink
952 targetdoc="book_enea_nfv_access_getting_started"
953 targetptr="install_ena_device">Installing Enea NFV Access - uCPE
954 Device installation in the <xi:include
955 href="../../s_docbuild/olinkdb/pardoc-names.xml"
956 xmlns:xi="http://www.w3.org/2001/XInclude"
957 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
958 Manual.</para>
964 </note> 959 </note>
965 960
966 <para>When a uCPE device is registered it can be manually added to the 961 <para>When a uCPE device is registered it can be manually added to the
@@ -972,31 +967,31 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
972 <section id="ucpe_monitor"> 967 <section id="ucpe_monitor">
973 <title>uCPE Device Monitorization and Control</title> 968 <title>uCPE Device Monitorization and Control</title>
974 969
975 <para>Once the uCPE device is connected to the uCPE Manager, it is ready 970 <para>Once the uCPE device is connected to the Enea uCPE Manager, it is
976 for central management. Two important functions available in the uCPE 971 ready for central management. Two important functions available in the
977 Manager GUI are alarm checking and resource allocation.</para> 972 Enea uCPE Manager GUI are alarm checking and resource allocation.</para>
978 973
979 <section id="check_alarms"> 974 <section id="check_alarms">
980 <title>Checking Alarms</title> 975 <title>Checking Alarms</title>
981 976
982 <para>The uCPE Manager dashboard presents alarms in a specific window on 977 <para>The Enea uCPE Manager dashboard presents alarms in a specific
983 the front page.</para> 978 window on the front page.</para>
984 979
985 <para>An alarm can be easily triggered by disconnecting and reconnecting 980 <para>An alarm can be easily triggered by disconnecting and reconnecting
986 the WAN ethernet cable from the uCPE device. The management system will 981 the WAN ethernet cable from the uCPE device. The management system will
987 detect the broken link and raise an alarm: <literal>Device 982 detect the broken link and raise an alarm: <literal>Device
988 Disconnected::Critical</literal>.</para> 983 Disconnected::Critical</literal>.</para>
989 984
990 <para>A separate Alarm Management window can be accessed from the uCPE 985 <para>A separate Alarm Management window can be accessed from the Enea
991 Manager menu for in-depth access and programming of Alarms and 986 uCPE Manager menu for in-depth access and programming of Alarms and
992 Events.</para> 987 Events.</para>
993 </section> 988 </section>
994 989
995 <section id="ck_resource_alloc"> 990 <section id="ck_resource_alloc">
996 <title>Checking uCPE device Resource Allocation</title> 991 <title>Checking uCPE device Resource Allocation</title>
997 992
998 <para>When the uCPE device is connected to the uCPE Manager it is of 993 <para>When the uCPE device is connected to the Enea uCPE Manager it is
999 interest to check the amount of hardware resources in use.</para> 994 of interest to check the amount of hardware resources in use.</para>
1000 995
1001 <para>To check CPU, RAM and disk utilization simply select the uCPE 996 <para>To check CPU, RAM and disk utilization simply select the uCPE
1002 device and click the <literal>Virtual Machines</literal> tab in the map 997 device and click the <literal>Virtual Machines</literal> tab in the map
@@ -1007,15 +1002,27 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
1007 <section id="access_device_cli"> 1002 <section id="access_device_cli">
1008 <title>Accessing the uCPE device CLI</title> 1003 <title>Accessing the uCPE device CLI</title>
1009 1004
1010 <para>As a final check to make sure the uCPE device was installed 1005 <para>As a final check to make sure the uCPE device was installed and
1011 correctly, access its Linux CLI by marking the uCPE device on the map 1006 configured correctly, access the uCPE device Linux CLI by selecting the
1012 and selecting <literal>SSH</literal> from the panel. A new window will 1007 uCPE device on the map and using the SSH button from the panel. A new
1013 appear for CLI access. The default user and password are 1008 window will appear for CLI access. The default user and password are
1014 <literal>root</literal> and blank, respectively.</para> 1009 <literal>root</literal> and blank, respectively.</para>
1015 1010
1016 <para>The Enea NFV Access CLI is a pure Linux CLI providing access to 1011 <para>The Enea NFV Access CLI is a pure Linux CLI providing access to
1017 standard Linux CLI commands. The CLI is a central feature for running 1012 standard Linux CLI commands. The CLI is a central feature for running
1018 custom scripting.</para> 1013 custom scripting.</para>
1014
1015 <note>
1016 <para>In case the uCPE was installed behind a NAT device, reverse SSH
1017 connection will be used. For more details, please see <olink
1018 targetdoc="book_enea_nfv_access_getting_started"
1019 targetptr="device_callhome_nat">Device Call Home Connection for
1020 deployment behind NAT in the <xi:include
1021 href="../../s_docbuild/olinkdb/pardoc-names.xml"
1022 xmlns:xi="http://www.w3.org/2001/XInclude"
1023 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
1024 Manual.</para>
1025 </note>
1019 </section> 1026 </section>
1020 </section> 1027 </section>
1021</chapter> \ No newline at end of file 1028</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml
index 0509566..c303902 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml
@@ -17,11 +17,6 @@
17 <para>One or several managed uCPE devices, ready to host network 17 <para>One or several managed uCPE devices, ready to host network
18 services, using one wired WAN and one wired LAN connection.</para> 18 services, using one wired WAN and one wired LAN connection.</para>
19 </listitem> 19 </listitem>
20
21 <listitem>
22 <para>One laptop accessing both the uCPE Manager and the uCPE
23 device.</para>
24 </listitem>
25 </itemizedlist> 20 </itemizedlist>
26 21
27 <para>Extended deployment and configuration options are also detailed in the 22 <para>Extended deployment and configuration options are also detailed in the
@@ -65,17 +60,19 @@
65 <section id="nfv_access"> 60 <section id="nfv_access">
66 <title>Enea NFV Access Run Time Platform</title> 61 <title>Enea NFV Access Run Time Platform</title>
67 62
68 <para>The Enea NFV Access Run Time Platform is a lightweight, 63 <para>Enea NFV Access Runtime Platform is a lightweight,
69 multi-architecture virtualization platform, supporting Virtual Machines 64 multi-architecture virtualization platform built on de-facto standards
70 (KVM / QEMU) and container(s) (Docker). Designed for a low footprint and 65 in an SDN/NFV ecosystem. It is designed for a high networking
71 fast boot by only providing essential functionality.</para> 66 performance with minimal hardware footprint, by only providing relevant
72 67 functionalties and technologies.</para>
73 <para>The NFV Access virtualized data plane has DPDK and accelerated OVS
74 as its primary components. The data plane is highly optimized for
75 scenarios where high throughput and low latency are needed.</para>
76 68
77 <para>VNF Runtime Management, orchestration integration, and FCAPS are 69 <para>Virtualization methods include Virtual Machines (KVM / QEMU) and
78 provided through NETCONF.</para> 70 container(s) (Docker). High networking throughput and low latency are
71 ensured by accelerated data plane relying on technologies like DPDK,
72 OVS-DPDK and SR-IOV/PCI-Passthrough. Key functionalities, such as
73 platform software management, virtualized networking, VNFs life-cycle
74 management and FCAPS are provided through the YANG-modelled NETCONF
75 protocol.</para>
79 76
80 <figure> 77 <figure>
81 <title>VNF Space</title> 78 <title>VNF Space</title>
@@ -92,10 +89,10 @@
92 <section id="ucpe_manager"> 89 <section id="ucpe_manager">
93 <title>Enea uCPE Manager</title> 90 <title>Enea uCPE Manager</title>
94 91
95 <para>The Enea uCPE Manager is a control center application providing a 92 <para>The Enea uCPE Manager is centralized control system providing
96 full FCAPS and VNF management experience through a GUI and REST API. It 93 uCPEs domain management capabilities through a GUI and REST API. It can
97 can be deployed on a host or a virtual machine running 64-bit CentOS 7 94 be deployed on a host or a virtual machine running 64-bit CentOS 7 on an
98 on an x86 platform. The uCPE Manager uses a southbound NETCONF protocol 95 x86 platform. The Enea uCPE Manager uses a southbound NETCONF protocol
99 to connect and manage uCPE devices.</para> 96 to connect and manage uCPE devices.</para>
100 97
101 <para>The Enea uCPE Manager provides the following key features:</para> 98 <para>The Enea uCPE Manager provides the following key features:</para>
@@ -142,7 +139,7 @@
142 <row> 139 <row>
143 <entry>Enea NFV Access</entry> 140 <entry>Enea NFV Access</entry>
144 141
145 <entry>The Enea NFV Access Run Time Platform and the uCPE 142 <entry>The Enea NFV Access Run Time Platform and the Enea uCPE
146 Manager.</entry> 143 Manager.</entry>
147 </row> 144 </row>
148 145
@@ -161,14 +158,6 @@
161 </row> 158 </row>
162 159
163 <row> 160 <row>
164 <entry>PCI Passthrough</entry>
165
166 <entry>PCI Passthrough allows for use of a physical PCI device,
167 e.g. a network card inside a VM. If you "PCI passthrough" a
168 device, the device is not available to the host anymore.</entry>
169 </row>
170
171 <row>
172 <entry>uCPE device</entry> 161 <entry>uCPE device</entry>
173 162
174 <entry>A whitebox running the Enea NFV Access Run Time 163 <entry>A whitebox running the Enea NFV Access Run Time
diff --git a/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml b/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml
index 22b67b9..1c66db0 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml
@@ -3,15 +3,15 @@
3 <title>Using the Log Collector</title> 3 <title>Using the Log Collector</title>
4 4
5 <para>Troubleshooting problems on the uCPE device require an analysis of a 5 <para>Troubleshooting problems on the uCPE device require an analysis of a
6 set of information i.e. logs collected from the uCPE device and/or uCPE 6 set of information i.e. logs collected from the uCPE device and/or Enea uCPE
7 Manager. The following describe how the log collection mechanism 7 Manager. The following describe how the log collection mechanism
8 works.</para> 8 works.</para>
9 9
10 <section id="log_collect_ucpem"> 10 <section id="log_collect_ucpem">
11 <title>Log collecting using the uCPE Manager</title> 11 <title>Log collecting using the Enea uCPE Manager</title>
12 12
13 <para>The uCPE Manager allows for collection of the relevant logs from the 13 <para>The Enea uCPE Manager allows for collecting a set of logs and state
14 GUI.</para> 14 information from a uCPE device.</para>
15 15
16 <section id="log_collect"> 16 <section id="log_collect">
17 <title>Collecting the Logs</title> 17 <title>Collecting the Logs</title>
@@ -53,9 +53,9 @@
53 <note> 53 <note>
54 <para>It might take some time for the archive to be created. When the 54 <para>It might take some time for the archive to be created. When the
55 operation completes, a "CollectLogsComplete" notification is sent from 55 operation completes, a "CollectLogsComplete" notification is sent from
56 the uCPE device to the uCPE Manager. This can be viewed in the GUI 56 the uCPE device to the Enea uCPE Manager. This can be viewed in the
57 under the <literal>Faults</literal> -&gt; <literal>Events</literal> 57 GUI under the <literal>Faults</literal> -&gt;
58 toolbar menu.</para> 58 <literal>Events</literal> toolbar menu.</para>
59 59
60 <figure> 60 <figure>
61 <title>Collecting Debug Logs</title> 61 <title>Collecting Debug Logs</title>
@@ -110,7 +110,7 @@
110 <title>Downloading Logs from the uCPE Device</title> 110 <title>Downloading Logs from the uCPE Device</title>
111 111
112 <para>This option transfers a debug file archive from the uCPE device to 112 <para>This option transfers a debug file archive from the uCPE device to
113 uCPE Manager machine.</para> 113 Enea uCPE Manager.</para>
114 114
115 <orderedlist> 115 <orderedlist>
116 <listitem> 116 <listitem>
@@ -124,7 +124,7 @@
124 124
125 <listitem> 125 <listitem>
126 <para>In the <literal>Device File Listing</literal> table, select 126 <para>In the <literal>Device File Listing</literal> table, select
127 the archive you want to download from the uCPE device to uCPE 127 the archive you want to download from the uCPE device to Enea uCPE
128 Manager.</para> 128 Manager.</para>
129 </listitem> 129 </listitem>
130 130
@@ -133,7 +133,7 @@
133 button.</para> 133 button.</para>
134 134
135 <para>The archive will be downloaded from the uCPE device and stored 135 <para>The archive will be downloaded from the uCPE device and stored
136 on the uCPE Machine.</para> 136 on the Enea uCPE Manager.</para>
137 </listitem> 137 </listitem>
138 </orderedlist> 138 </orderedlist>
139 139
@@ -146,9 +146,9 @@
146 <section id="download_logs_locally"> 146 <section id="download_logs_locally">
147 <title>Downloading collected logs locally</title> 147 <title>Downloading collected logs locally</title>
148 148
149 <para>This option downloads a logs archive from the uCPE Manager to a 149 <para>This option downloads a logs archive from the Enea uCPE Manager to
150 local (user) machine for analysis. The archive must first be available 150 a local (user) machine for analysis. The archive must first be available
151 in the uCPE Manager in order to be downloaded.</para> 151 in the Enea uCPE Manager in order to be downloaded.</para>
152 152
153 <orderedlist> 153 <orderedlist>
154 <listitem> 154 <listitem>
@@ -236,9 +236,10 @@
236 </section> 236 </section>
237 237
238 <section id="delete_archives_ucpem"> 238 <section id="delete_archives_ucpem">
239 <title>Deleting logs archives from the uCPE Manager</title> 239 <title>Deleting logs archives from the Enea uCPE Manager</title>
240 240
241 <para>This option deletes a logs archive from the uCPE Manager.</para> 241 <para>This option deletes a logs archive from the Enea uCPE
242 Manager.</para>
242 243
243 <orderedlist> 244 <orderedlist>
244 <listitem> 245 <listitem>
@@ -258,14 +259,14 @@
258 <listitem> 259 <listitem>
259 <para>Click the <literal>Delete</literal> button.</para> 260 <para>Click the <literal>Delete</literal> button.</para>
260 261
261 <para>The file will be deleted from the uCPE Manager and the table 262 <para>The file will be deleted from the Enea uCPE Manager and the
262 will be updated.</para> 263 table will be updated.</para>
263 </listitem> 264 </listitem>
264 </orderedlist> 265 </orderedlist>
265 266
266 <note> 267 <note>
267 <para>Deleting the logs file from the uCPE Manager does not affect the 268 <para>Deleting the logs file from the Enea uCPE Manager does not
268 file located on the uCPE device.</para> 269 affect the file located on the uCPE device.</para>
269 </note> 270 </note>
270 </section> 271 </section>
271 272
@@ -273,8 +274,8 @@
273 <title>Enabling/Disabling of the Log Collector via Permissions</title> 274 <title>Enabling/Disabling of the Log Collector via Permissions</title>
274 275
275 <para>To disable the ability to access/download the uCPE device's 276 <para>To disable the ability to access/download the uCPE device's
276 debug-log files from the uCPE Manager, the appropriate permissions must 277 debug-log files from the Enea uCPE Manager, the appropriate permissions
277 be changed:</para> 278 must be changed:</para>
278 279
279 <orderedlist> 280 <orderedlist>
280 <listitem> 281 <listitem>
@@ -319,19 +320,19 @@
319 </section> 320 </section>
320 321
321 <section id="download_ucpemg_logs"> 322 <section id="download_ucpemg_logs">
322 <title>Downloading uCPE Manager logs</title> 323 <title>Downloading Enea uCPE Manager logs</title>
323 324
324 <para>Often, sending the uCPE Manager logs together with collected uCPE 325 <para>Often, sending the Enea uCPE Manager logs together with collected
325 device logs to the support team provides important information for 326 uCPE device logs to the support team provides important information for
326 troubleshooting (especially in cases of connectivity issues with the 327 troubleshooting (especially in cases of connectivity issues with the
327 uCPE device and error popups).</para> 328 uCPE device and error popups).</para>
328 329
329 <para>uCPE Manager log files are located in 330 <para>Enea uCPE Manager log files are located in
330 <filename>application/logs/</filename> in the uCPE Manager's 331 <filename>application/logs/</filename> in the Enea uCPE Manager's
331 installation folder 332 installation folder
332 (e.g.<filename>/opt/ems/ucpemanager/application/logs</filename>). They 333 (e.g.<filename>/opt/ems/ucpemanager/application/logs</filename>). They
333 can be copied from that location, or they can be downloaded using the 334 can be copied from that location, or they can be downloaded using the
334 uCPE Manager GUI by performing the following:</para> 335 Enea uCPE Manager GUI by performing the following:</para>
335 336
336 <orderedlist> 337 <orderedlist>
337 <listitem> 338 <listitem>
@@ -372,12 +373,12 @@
372 </section> 373 </section>
373 374
374 <section id="log_collect_no_ucpem"> 375 <section id="log_collect_no_ucpem">
375 <title>Log collecting without using the uCPE Manager</title> 376 <title>Log collecting without using the Enea uCPE Manager</title>
376 377
377 <para>Log collection from uCPE Devices can also be done when there is no 378 <para>Log collection from uCPE Devices can also be done when there is no
378 uCPE Manager connection. A SSH connection to uCPE Device is needed for use 379 Enea uCPE Manager connection. A SSH connection to uCPE Device is needed
379 of the log collector script, which can be found in the uCPE Device file 380 for use of the log collector script, which can be found in the uCPE Device
380 system in <literal>/usr/local/enea/</literal>.</para> 381 file system in <literal>/usr/local/enea/</literal>.</para>
381 382
382 <para>The Log collector script takes relevant information about the system 383 <para>The Log collector script takes relevant information about the system
383 and collects it in an archive:</para> 384 and collects it in an archive:</para>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml
index 4c11b7c..873dc28 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml
@@ -2,23 +2,23 @@
2<chapter id="net_config_operations"> 2<chapter id="net_config_operations">
3 <title>Network Configuration Options</title> 3 <title>Network Configuration Options</title>
4 4
5 <para>Various Advanced Network Configuration options can be done from uCPE 5 <para>Various Advanced Network Configuration options can be done from Enea
6 Manager GUI.</para> 6 uCPE Manager GUI.</para>
7 7
8 <section id="device_callhome_nat"> 8 <section id="device_callhome_nat">
9 <title>Device Call Home Connection for deployment behind NAT</title> 9 <title>Device Call Home Connection for deployment behind NAT</title>
10 10
11 <para>The Device Call Home option enables the initiation of the connection 11 <para>The Device Call Home option enables the initiation of the connection
12 between the uCPE Device and the uCPE Manager, from the uCPE device. The 12 between the uCPE Device and the Enea uCPE Manager, from the uCPE device.
13 Device Call Home option is required when deploying a uCPE device behind 13 The Device Call Home option is required when deploying a uCPE device
14 NAT since the IP address of the uCPE device is hidden for the uCPE 14 behind NAT since the IP address of the uCPE device is hidden for the Enea
15 Manager.</para> 15 uCPE Manager.</para>
16 16
17 <para>Enable Device Call Home by marking the Device Call Home checkbox 17 <para>Enable Device Call Home by marking the Device Call Home checkbox
18 when registering the uCPE device in uCPE Manager. When using this 18 when registering the uCPE device in Enea uCPE Manager. When using this
19 mechanism, the device will initiate a connection to the uCPE Manager for 19 mechanism, the device will initiate a connection to the Enea uCPE Manager
20 NETCONF traffic (over SSH), while the uCPE Manager waits for a device 20 for NETCONF traffic (over SSH), while the Enea uCPE Manager waits for a
21 connection.</para> 21 device connection.</para>
22 </section> 22 </section>
23 23
24 <section id="device_net_config"> 24 <section id="device_net_config">
@@ -57,18 +57,18 @@
57 <itemizedlist> 57 <itemizedlist>
58 <listitem> 58 <listitem>
59 <para><emphasis role="bold">LCore Mask</emphasis>. Allocated cores 59 <para><emphasis role="bold">LCore Mask</emphasis>. Allocated cores
60 for DPDK management functions (CPU core bitmask). Default: 60 for non-datapath OVS-DPDK threads (CPU core bitmask). Default:
61 0x2.</para> 61 0x2.</para>
62 </listitem> 62 </listitem>
63 63
64 <listitem> 64 <listitem>
65 <para><emphasis role="bold">PMD CPU Mask</emphasis>. Allocated cores 65 <para><emphasis role="bold">PMD CPU Mask</emphasis>. Allocated cores
66 for DPDK packet processing (CPU core bitmask). Default: 0x4.</para> 66 for datapath processing (CPU core bitmask). Default: 0x4.</para>
67 </listitem> 67 </listitem>
68 68
69 <listitem> 69 <listitem>
70 <para><emphasis role="bold">Socket Memory</emphasis>. Allocated 70 <para><emphasis role="bold">Socket Memory</emphasis>. Hugepage
71 memory to use. Default: 1494.</para> 71 memory allocated for DPDK. Default: 1494.</para>
72 </listitem> 72 </listitem>
73 </itemizedlist> 73 </itemizedlist>
74 </section> 74 </section>
@@ -88,10 +88,10 @@
88 virtualization infrastructure and VNFs, they must be configured into the 88 virtualization infrastructure and VNFs, they must be configured into the
89 management system.</para> 89 management system.</para>
90 90
91 <para>To add an interface into the uCPE Manager, select the uCPE device, 91 <para>To add an interface into the Enea uCPE Manager, select the uCPE
92 then from the top toolbar select <literal>Configuration -&gt; External 92 device, then from the top toolbar select <literal>Configuration -&gt;
93 Interfaces -&gt; Configuration -&gt; Add</literal>. The available 93 External Interfaces -&gt; Configuration -&gt; Add</literal>. The
94 Interface types are detailed below.</para> 94 available Interface types are detailed below.</para>
95 95
96 <section id="dpdk_interface_type"> 96 <section id="dpdk_interface_type">
97 <title>DPDK Interface Type</title> 97 <title>DPDK Interface Type</title>
@@ -117,10 +117,6 @@
117 </listitem> 117 </listitem>
118 118
119 <listitem> 119 <listitem>
120 <para>Type: dpdk</para>
121 </listitem>
122
123 <listitem>
124 <para>Networking-type: dpdk</para> 120 <para>Networking-type: dpdk</para>
125 </listitem> 121 </listitem>
126 122
@@ -149,10 +145,6 @@
149 </listitem> 145 </listitem>
150 146
151 <listitem> 147 <listitem>
152 <para>Type: sr-iov</para>
153 </listitem>
154
155 <listitem>
156 <para>Networking-type: srIov</para> 148 <para>Networking-type: srIov</para>
157 </listitem> 149 </listitem>
158 150
@@ -172,9 +164,7 @@
172 164
173 <para>Some of the physical network interfaces available on a uCPE 165 <para>Some of the physical network interfaces available on a uCPE
174 device, including Ethernet interfaces, do not have DPDK or SR-IOV 166 device, including Ethernet interfaces, do not have DPDK or SR-IOV
175 support. Instead, the Linux kernel driver has to be used. Wi-Fi and 167 support. Instead, the Linux kernel driver has to be used.</para>
176 4G/LTE modems can also be configured and used for virtualization
177 infrastructure and VNFs.</para>
178 168
179 <para>To add Standard Interfaces under the management system, the user 169 <para>To add Standard Interfaces under the management system, the user
180 must set values for the following fields:</para> 170 must set values for the following fields:</para>
@@ -190,13 +180,54 @@
190 </itemizedlist> 180 </itemizedlist>
191 </section> 181 </section>
192 182
193 <section condition="hidden" id="pci_passthrough_interface_type"> 183 <section id="wan_interface_type">
194 <title>PCI Passthrough Interface Type</title> 184 <title>Wan Interface Type</title>
185
186 <para>WAN interfaces configured during the installation of the uCPE
187 device are automatically added in the Enea uCPE manager as type
188 <literal>wan</literal>. The WAN interface used for management of the
189 uCPE device is marked with the <literal>Management</literal> property
190 set to <literal>True</literal>.</para>
195 191
196 <para>For the PCI Passthrough a user does not have to configure a 192 <para>If a WAN interface is to be assigned for use by a VNF, it must
197 physical interface, instead simply select the PCI address and connect 193 be changed into another interface type depending on the type of
198 it to a virtual port when the VNF instantiation step is 194 connection that will be used. The management WAN interface cannot be
199 reached.</para> 195 changed to a different type. It is automatically used when an In-band
196 management bridge is created.</para>
197
198 <para><emphasis role="bold">How to Edit the Configuration of a Wan
199 Interface</emphasis></para>
200
201 <orderedlist>
202 <listitem>
203 <para>To edit an interface configuration type from the Enea uCPE
204 Manager, select the uCPE device, then from the top toolbar select
205 the <literal>Configuration</literal> menu then <literal>External
206 Interfaces -&gt; Configuration</literal>. The already configured
207 interfaces are displayed here, as can be seen in the figure
208 above.</para>
209 </listitem>
210
211 <listitem>
212 <para>In order to edit an already configured interface, (as in the
213 example popup shown below, a WAN interface) double click on the
214 desired one and a popup will appear. A different popup appears for
215 each type of interface. From the <literal>Host Interface</literal>
216 window, a user can change the networking type and the IP address
217 assignment:</para>
218
219 <figure>
220 <title>Editing an Interface</title>
221
222 <mediaobject>
223 <imageobject>
224 <imagedata align="center" contentwidth="450"
225 fileref="images/edit_inter.png" />
226 </imageobject>
227 </mediaobject>
228 </figure>
229 </listitem>
230 </orderedlist>
200 </section> 231 </section>
201 232
202 <section id="man_configuration"> 233 <section id="man_configuration">
@@ -207,534 +238,465 @@
207 <literal>External Interfaces</literal>, where one can find a list of 238 <literal>External Interfaces</literal>, where one can find a list of
208 available network interfaces and their capabilities.</para> 239 available network interfaces and their capabilities.</para>
209 240
210 <section id="configure_interfaces"> 241 <para>After networking interfaces have been added to the Enea uCPE
211 <title>Configuring Interfaces</title> 242 Manager, the user can change the interface type (DPDK, SR-IOV,
243 Standard, WAN).</para>
212 244
213 <para>After networking interfaces have been added to the uCPE 245 <figure>
214 Manager, the user can change the interface type (DPDK, SR-IOV, 246 <title>Configuration of External Interfaces</title>
215 Standard, WAN).</para>
216 247
217 <note> 248 <mediaobject>
218 <para>WAN interfaces, which are configured during the installation 249 <imageobject>
219 of the device, do not need to be added, they will be automatically 250 <imagedata align="center" contentwidth="600"
220 listed as such in the uCPE Manager when the device 251 fileref="images/edit_inter_config.png" />
221 connects.</para> 252 </imageobject>
222 </note> 253 </mediaobject>
254 </figure>
255 </section>
256 </section>
223 257
224 <figure> 258 <section id="configure_bridges">
225 <title>Configuration of External Interfaces</title> 259 <title>Configuring Bridges</title>
226
227 <mediaobject>
228 <imageobject>
229 <imagedata align="center" contentwidth="600"
230 fileref="images/edit_inter_config.png" />
231 </imageobject>
232 </mediaobject>
233 </figure>
234
235 <para><emphasis role="bold">How to Edit the Configuration of an
236 Interface</emphasis></para>
237
238 <orderedlist>
239 <listitem>
240 <para>To edit an interface configuration type from the uCPE
241 Manager, select the uCPE device, then from the top toolbar
242 select the <literal>Configuration</literal> menu then
243 <literal>External Interfaces -&gt; Configuration</literal>. The
244 already configured interfaces are displayed here, as can be seen
245 in the figure above.</para>
246 </listitem>
247
248 <listitem>
249 <para>In order to edit an already configured interface, (as in
250 the example popup shown below, a WAN interface) double click on
251 the desired one and a popup will appear. A different popup
252 appears for each type of interface. From the <literal>Host
253 Interface</literal> window, a user can change the networking
254 type and the IP address assignment:</para>
255
256 <figure>
257 <title>Editing an Interface</title>
258
259 <mediaobject>
260 <imageobject>
261 <imagedata align="center" contentwidth="450"
262 fileref="images/edit_inter.png" />
263 </imageobject>
264 </mediaobject>
265 </figure>
266 </listitem>
267 </orderedlist>
268 260
269 <note> 261 <para>After networking interfaces have been added to the Enea uCPE
270 <para>The IP address assignment of an interface can be set as 262 Manager, the user can create the necessary OVS bridges.</para>
271 static or dynamic for each type of interface.</para> 263
272 </note> 264 <figure>
273 </section> 265 <title>OVS Bridges</title>
266
267 <mediaobject>
268 <imageobject>
269 <imagedata align="center" contentwidth="600"
270 fileref="images/ovs_bridges_tab.png" />
271 </imageobject>
272 </mediaobject>
273 </figure>
274
275 <para><emphasis role="bold">How to add OVS bridges in the Enea uCPE
276 Manager</emphasis></para>
277
278 <orderedlist>
279 <listitem>
280 <para>Select the uCPE device.</para>
281 </listitem>
274 282
275 <section id="configure_bridges"> 283 <listitem>
276 <title>Configuring Bridges</title> 284 <para>Select <literal>Configuration</literal>.</para>
285 </listitem>
277 286
278 <para>After networking interfaces have been added to the uCPE 287 <listitem>
279 Manager, the user can create the necessary OVS bridges.</para> 288 <para>Click <literal>OpenvSwitch</literal>.</para>
289 </listitem>
280 290
281 <figure> 291 <listitem>
282 <title>OVS Bridges</title> 292 <para>Select the <literal>Bridges</literal> option, then click
293 <literal>Add</literal>.</para>
294 </listitem>
295 </orderedlist>
283 296
284 <mediaobject> 297 <note>
285 <imageobject> 298 <para>Depending on the settings in <literal>Configuration -&gt;
286 <imagedata align="center" contentwidth="600" 299 OpenVSwitch -&gt; DPDK</literal>, OVS bridges with or without DPDK
287 fileref="images/ovs_bridges_tab.png" /> 300 support will be used on the uCPE device.</para>
288 </imageobject> 301 </note>
289 </mediaobject>
290 </figure>
291 302
292 <para><emphasis role="bold">How to add OVS bridges in the uCPE 303 <para>There are three types of bridges which can be created, each one
293 Manager</emphasis></para> 304 fulfiling a different role.</para>
294 305
295 <orderedlist> 306 <section id="inband_mg_bridge">
296 <listitem> 307 <title>uCPE In-band Management bridge</title>
297 <para>Select the uCPE device.</para>
298 </listitem>
299 308
300 <listitem> 309 <para>In-band Management refers to a model where both the data plane
301 <para>Select <literal>Configuration</literal>.</para> 310 and control plane flow over the same network path. In some situations
302 </listitem> 311 (e.g. the uCPE device has only one routable IP address), this is the
312 only option available to both control and configure the uCPE device,
313 while also allowing for data-path traffic to pass over the same
314 physical interface.</para>
303 315
304 <listitem> 316 <para>The solution provided by Enea for in-band management is based
305 <para>Click <literal>OpenvSwitch</literal>.</para> 317 upon an OpenvSwitch bridge managing all traffic passing through the
306 </listitem> 318 WAN physical port. Any standard or DPDK-assigned network interface can
319 be used for the In-Band management bridge.</para>
307 320
308 <listitem> 321 <para>To create the In-Band Management bridge, the user must set
309 <para>Select the <literal>Bridges</literal> option, then click 322 values for the following fields:</para>
310 <literal>Add</literal>.</para>
311 </listitem>
312 </orderedlist>
313 323
314 <note> 324 <itemizedlist>
315 <para>Depending on the settings in <literal>Configuration -&gt; 325 <listitem>
316 OpenVSwitch -&gt; DPDK</literal>, OVS bridges with or without DPDK 326 <para>name: name of the bridge.</para>
317 support will be used on the uCPE device.</para> 327 </listitem>
318 </note>
319 328
320 <para>There are three types of bridges which can be created, each 329 <listitem>
321 one fulfiling a different role.</para> 330 <para>ovs-bridge-type: inbandMgmt</para>
331 </listitem>
332 </itemizedlist>
333 </section>
322 334
323 <section id="inband_mg_bridge"> 335 <section id="inband_mg_br_vnfs">
324 <title>uCPE In-band Management bridge</title> 336 <title>In-band Management bridge for VNFs</title>
325 337
326 <para>In-band Management refers to a model where both the data 338 <para>If VNF management can be done over a dedicated virtual
327 plane and control plane flow over the same network path. In some 339 interface, its possible to extend the networking infrastructure
328 situations (e.g. the uCPE device has only one routable IP 340 configuration to also access the VNF's management interface over the
329 address), this is the only option available to both control and 341 WAN port.</para>
330 configure the uCPE device, while also allowing for data-path
331 traffic to pass over the same physical interface.</para>
332 342
333 <para>The solution provided by Enea for in-band management is 343 <para>For this setup, three types of traffic will pass over the WAN
334 based upon an OpenvSwitch bridge fielding all traffic passing 344 physical interface:</para>
335 through the WAN physical port. Any standard or DPDK-assigned 345
336 network interface can be used for the In-Band management 346 <itemizedlist>
337 bridge.</para> 347 <listitem>
348 <para><emphasis role="bold">Device management</emphasis>. Part of
349 the device configuration done by the Enea uCPE Manager.</para>
350 </listitem>
351
352 <listitem>
353 <para><emphasis role="bold">VNF(s) management</emphasis>. Enabling
354 or disabling features of a VNF. E.g. enabling/disabling the
355 firewall or VPN setup.</para>
356 </listitem>
357
358 <listitem>
359 <para><emphasis role="bold">Data-path</emphasis>. All other
360 traffic that is not used in the control plane and needs to reach a
361 LAN network.</para>
362 </listitem>
363 </itemizedlist>
364
365 <para>To create a VNF In-Band Management bridge, the user must set
366 values for the following fields:</para>
367
368 <itemizedlist>
369 <listitem>
370 <para>name: name of the bridge.</para>
371 </listitem>
372
373 <listitem>
374 <para>ovs-bridge-type: vnfMgmt</para>
375 </listitem>
376
377 <listitem>
378 <para>vnf-mgmt-address: select IPv4 as the type and fill in an
379 internal IP address for the bridge interface that will be
380 connected to the VNF management network, e.g 10.0.0.1.</para>
381 </listitem>
382 </itemizedlist>
383
384 <note>
385 <para>VNF management interfaces must be configured in same subnet as
386 that used by the bridge interface connected to the VNF management
387 network.</para>
388 </note>
389 </section>
390
391 <section id="dataplane_bridge">
392 <title>Data-plane Bridge</title>
393
394 <para>Data-plane bridges are generic bridges used for the VNF
395 data-plane. There are two supported sub-types:</para>
396
397 <itemizedlist>
398 <listitem>
399 <para><emphasis role="bold">communication</emphasis>: allows for
400 VNF communication towards LAN/WAN networks. This bridge type has
401 at least one physical port attached to it.</para>
402 </listitem>
403
404 <listitem>
405 <para><emphasis role="bold">integration</emphasis>: allows for
406 VNF-to-VNF communication (usually for service function chaining).
407 This bridge type does not have any physical port attached.</para>
408 </listitem>
409 </itemizedlist>
338 410
339 <note> 411 <para>To create a Data-plane bridge, the user must set values for the
340 <para>The In-band Management bridge must be recreated each time 412 following fields:</para>
341 the uCPE Manager IP address is changed.</para> 413
342 </note> 414 <itemizedlist>
343 415 <listitem>
344 <para>To create the In-Band Management bridge, the user must set 416 <para>name: name of the bridge.</para>
345 values for the following fields:</para> 417 </listitem>
346 418
347 <itemizedlist> 419 <listitem>
348 <listitem> 420 <para>ovs-bridge-type: select <literal>communication</literal> or
349 <para>name: name of the bridge.</para> 421 <literal>integration</literal>, depending on intended usage. For
350 </listitem> 422 communication bridges, physical interfaces can be added to the
351 423 bridge.</para>
352 <listitem> 424 </listitem>
353 <para>ovs-bridge-type: inbandMgmt</para> 425 </itemizedlist>
354 </listitem>
355 </itemizedlist>
356
357 <note>
358 <para>The first VNF instantiated on the uCPE device must be
359 connected to the In-Band Management bridge and its WAN interface
360 must be configured as the DHCP client.</para>
361 </note>
362 </section>
363
364 <section id="inband_mg_br_vnfs">
365 <title>In-band Management bridge for VNFs</title>
366
367 <para>If VNF management can be done over a dedicated virtual
368 interface, its possible to extend the networking infrastructure
369 configuration to also access the VNF's management interface over
370 the WAN port.</para>
371
372 <para>For this setup, three types of traffic will pass over the
373 WAN physical interface:</para>
374
375 <itemizedlist>
376 <listitem>
377 <para><emphasis role="bold">Device management</emphasis>. Part
378 of the device configuration done by the uCPE Manager.</para>
379 </listitem>
380
381 <listitem>
382 <para><emphasis role="bold">VNF(s) management</emphasis>.
383 Enabling or disabling features of a VNF. E.g.
384 enabling/disabling the firewall or VPN setup.</para>
385 </listitem>
386
387 <listitem>
388 <para><emphasis role="bold">Data-path</emphasis>. All other
389 traffic that is not used in the control plane and needs to
390 reach a LAN network.</para>
391 </listitem>
392 </itemizedlist>
393
394 <para>To create a VNF In-Band Management bridge, the user must set
395 values for the following fields:</para>
396
397 <itemizedlist>
398 <listitem>
399 <para>name: name of the bridge.</para>
400 </listitem>
401
402 <listitem>
403 <para>ovs-bridge-type: vnfMgmt</para>
404 </listitem>
405
406 <listitem>
407 <para>vnf-mgmt-address: select IPv4 as the type and fill in
408 the IP address for management network, e.g 10.0.0.1.</para>
409 </listitem>
410 </itemizedlist>
411
412 <note>
413 <para>VNF management interfaces must be configured in same
414 network as the <literal>vnf-mgmt-address</literal> of the
415 bridge.</para>
416 </note>
417 </section>
418
419 <section id="dataplane_bridge">
420 <title>Data-plane Bridge</title>
421
422 <para>Data-plane bridges are generic bridges used for the VNF
423 data-plane. There are two supported sub-types:</para>
424
425 <itemizedlist>
426 <listitem>
427 <para><emphasis role="bold">communication</emphasis>: allows
428 for VNF communication towards LAN/WAN networks. This bridge
429 type has at least one physical port attached to it.</para>
430 </listitem>
431
432 <listitem>
433 <para><emphasis role="bold">integration</emphasis>: allows for
434 VNF-to-VNF communication (usually for service function
435 chaining). This bridge type does not have any physical port
436 attached.</para>
437 </listitem>
438 </itemizedlist>
439
440 <para>To create a Data-plane bridge, the user must set values for
441 the following fields:</para>
442
443 <itemizedlist>
444 <listitem>
445 <para>name: name of the bridge.</para>
446 </listitem>
447
448 <listitem>
449 <para>ovs-bridge-type: select <literal>communication</literal>
450 or <literal>integration</literal>, depending on intended
451 usage. For communication bridges, physical interfaces can be
452 added to the bridge.</para>
453 </listitem>
454 </itemizedlist>
455 </section>
456 </section>
457 </section> 426 </section>
427 </section>
428 </section>
429
430 <section id="zero_touch_prov">
431 <title>Zero Touch Provisioning - Creating an offline configuration</title>
432
433 <para>Zero-Touch Provisioning (ZTP) refers to the process of when a device
434 starts up for the first time and its initial configuration is pushed down
435 by an external management system, so that it is setup for proper operation
436 without additional manual intervention by an operator. ZTP is an
437 alternative to Manual configuration.</para>
438
439 <para>A variety of operations can occur as part of ZTP such as initial
440 device setup, configuration of managed objects, etc. The goal is to set up
441 a device to the maximum possible extent without forcing an operator to be
442 physically present (initially) to manage the device.</para>
443
444 <para>An offline configuration is usually prepared in advance for the Enea
445 uCPE Manager to setup the virtualization infrastructure on the uCPE
446 device, as soon as a device enrolls into the management system.</para>
447
448 <section id="offline_configuration">
449 <title>Offline Configuration</title>
458 450
459 <section id="zero_touch_prov"> 451 <para>The Offline Configuration subsystem is used to pre-populate a
460 <title>Zero Touch Provisioning - Creating an offline 452 configuration for a device that will be brought under management at a
461 configuration</title> 453 future point in time. When creating an offline configuration store a
462 454 <literal>Device ID</literal> can be specified. This ID uniquely
463 <para>Zero-Touch Provisioning (ZTP) refers to the process of when a 455 identifies the device to be initialized.</para>
464 device starts up for the first time and its initial configuration is 456
465 pushed down by an external management system, so that it is setup for 457 <para>Alternatively, a wildcard can be used in the <literal>Device
466 proper operation without additional manual intervention by an 458 ID</literal> field, which results in a configuration being pushed on all
467 operator. ZTP is an alternative to Manual configuration.</para> 459 uCPE devices upon their initial connection towards the Enea uCPE
468 460 Manager.</para>
469 <para>A variety of operations can occur as part of ZTP such as initial 461
470 device setup, configuration of managed objects, etc. The goal is to 462 <para>If the offline configuration is not configured for a uCPE device,
471 set up a device to the maximum possible extent without forcing an 463 an alarm will be raised: <literal>Day-0 Config:ZTP:Major</literal>,
472 operator to be physically present (initially) to manage the 464 which occurs when the uCPE device connects to the Enea uCPE Manager
473 device.</para> 465 informing that the ZTP setup failed for the specific uCPE device.</para>
474 466
475 <para>An offline configuration is usually prepared in advance for the 467 <para>To create an offline configuration, from the top toolbar menu
476 uCPE Manager to setup the virtualization infrastructure on the uCPE 468 select <literal>Applications</literal> -&gt; <literal>Offline
477 device, as soon as a device enrolls into the management system.</para> 469 Config</literal> -&gt; <literal>Add</literal>. The following fields
478 470 should be filled:</para>
479 <section id="offline_configuration"> 471
480 <title>Offline Configuration</title> 472 <itemizedlist>
481 473 <listitem>
482 <para>The Offline Configuration subsystem is used to pre-populate a 474 <para>Name: name of the device.</para>
483 configuration for a device that will be brought under management at 475 </listitem>
484 a future point in time. When creating an offline configuration store 476
485 a <literal>Device ID</literal> can be specified. This ID uniquely 477 <listitem>
486 identifies the device to be initialized.</para> 478 <para>Device type: Enea universal CPE.</para>
487 479 </listitem>
488 <para>Alternatively, a wildcard can be used in the <literal>Device 480
489 ID</literal> field, which results in a configuration being pushed on 481 <listitem>
490 all uCPE devices upon their initial connection towards the uCPE 482 <para>DeviceVersion: <xi:include
491 Manager.</para> 483 href="../../s_doceneacommon/doc/eltf_params_updated.xml"
492 484 xmlns:xi="http://www.w3.org/2001/XInclude"
493 <para>If the offline configuration is not configured for a uCPE 485 xpointer="element(EneaLinux_REL_VER/1)" /></para>
494 device, an alarm will be raised: <literal>Day-0 486 </listitem>
495 Config:ZTP:Major</literal>, which occurs when the uCPE device 487
496 connects to the uCPE Manager informing that the ZTP setup failed for 488 <listitem>
497 the specific uCPE device.</para> 489 <para>Config Set: uCPE Config</para>
498 490 </listitem>
499 <para>To create an offline configuration, from the top toolbar menu 491
500 select <literal>Applications</literal> -&gt; <literal>Offline 492 <listitem>
501 Config</literal> -&gt; <literal>Add</literal>. The following fields 493 <para>Device ID: device ID or a wildcard(*).</para>
502 should be filled:</para> 494 </listitem>
503 495
504 <itemizedlist> 496 <listitem>
505 <listitem> 497 <para>Device Grouping Tags: a tag to group devices. These tags match
506 <para>Name: name of the device.</para> 498 the customer tags provided during the installation of the
507 </listitem>
508
509 <listitem>
510 <para>Device type: Enea universal CPE.</para>
511 </listitem>
512
513 <listitem>
514 <para>DeviceVersion: <xi:include
515 href="../../s_doceneacommon/doc/eltf_params_updated.xml"
516 xmlns:xi="http://www.w3.org/2001/XInclude"
517 xpointer="element(EneaLinux_REL_VER/1)" /></para>
518 </listitem>
519
520 <listitem>
521 <para>Config Set: uCPE Config</para>
522 </listitem>
523
524 <listitem>
525 <para>Device ID: device ID or a wildcard(*).</para>
526 </listitem>
527
528 <listitem>
529 <para>Device Grouping Tags: a tag to group devices. These tags
530 match the customer tags provided during the installation of the
531 device.</para>
532 </listitem>
533 </itemizedlist>
534
535 <para>The Name is user defined and can be set to any unique text
536 string identifying the configuration. The Device Version will match
537 the Enea NFV Access version of the uCPE device and the Device ID
538 will be set to the previously set identifier of the uCPE
539 device.</para> 499 device.</para>
500 </listitem>
501 </itemizedlist>
502
503 <para>The Name is user defined and can be set to any unique text string
504 identifying the configuration. The Device Version will match the Enea
505 NFV Access version of the uCPE device and the Device ID will be set to
506 the previously set identifier of the uCPE device.</para>
507
508 <para>When a device connects to the Enea uCPE Manager for the first
509 time, it checks the device to see if it has been Zero Touch Provisioned
510 (ZTP). If not, it looks for an offline configuration that matches these
511 values, in the following order:</para>
512
513 <itemizedlist>
514 <listitem>
515 <para>The Device ID.</para>
516 </listitem>
517
518 <listitem>
519 <para>The set of tags.</para>
520 </listitem>
540 521
541 <para>When a device connects to the uCPE Manager for the first time, 522 <listitem>
542 it checks the device to see if it has been Zero Touch Provisioned 523 <para>A "*" for Device ID (wildcard).</para>
543 (ZTP). If not, it looks for an offline configuration that matches 524 </listitem>
544 these values, in the following order:</para> 525 </itemizedlist>
526
527 <para>If a match is found, the offline configuration is sent to the
528 device as part of Zero-Touch-Provisioning.</para>
529
530 <para>After creating the Offline Config Store, access the device through
531 <literal>Applications</literal> -&gt; <literal>offline config</literal>
532 -&gt; <literal>Config App</literal> and provision it with the required
533 initial configuration. This operation mirrors what happens during manual
534 configuration described previously.</para>
535
536 <note>
537 <para>The ZTP will only be triggered the first time a uCPE device
538 connects to the Enea uCPE Manager. Just changing an offline
539 configuration will not push the new changes to the device. If an
540 offline configuration is changed after uCPE device registration, a
541 factory reset can be executed to force a new ZTP to execute by
542 selecting the device, then <literal>Operations</literal> -&gt;
543 <literal>factory reset</literal>.</para>
544 </note>
545 </section>
546 </section>
547
548 <section id="custom_scripts">
549 <title>Custom Scripts for Custom Networking Configurations</title>
550
551 <para>The custom scripts feature allows users to execute user-defined
552 scripts on the uCPE device at various times.This allows for more flexible
553 and advanced configurations such as a LTE modem configuration, advanced
554 network configurations or OVS flow rule programming at any time.</para>
555
556 <section id="upload_scripts">
557 <title>Uploading Scripts</title>
545 558
546 <itemizedlist> 559 <para>The scripts need to be uploaded to the Enea uCPE Manager prior to
547 <listitem> 560 use. When uploading scripts to the Enea uCPE Manager make sure to select
548 <para>The Device ID.</para> 561 the right script type.</para>
549 </listitem>
550 562
551 <listitem> 563 <para>The following script types are supported:</para>
552 <para>The set of tags.</para>
553 </listitem>
554 564
555 <listitem> 565 <itemizedlist>
556 <para>A "*" for Device ID (wildcard).</para> 566 <listitem>
557 </listitem> 567 <para><literal>Once-before-startup</literal>. This script will only
558 </itemizedlist> 568 execute once during the startup.</para>
569 </listitem>
559 570
560 <para>If a match is found, the offline configuration is sent to the 571 <listitem>
561 device as part of Zero-Touch-Provisioning.</para> 572 <para><literal>Always-before-startup</literal>. This script will
573 always execute during the startup.</para>
574 </listitem>
562 575
563 <para>After creating the Offline Config Store, access the device 576 <listitem>
564 through <literal>Applications</literal> -&gt; <literal>offline 577 <para><literal>Once-after-startup</literal>. This script will only
565 config</literal> -&gt; <literal>Config App</literal> and provision 578 execute once after the system has been started.</para>
566 it with the required initial configuration. This operation mirrors 579 </listitem>
567 what happens during manual configuration described 580
568 previously.</para> 581 <listitem>
582 <para><literal>Always-after-startup</literal>. This script will
583 always execute after the system has been started.</para>
584 </listitem>
585 </itemizedlist>
586
587 <para>Follow the instruction below to upload scripts:</para>
588
589 <orderedlist>
590 <listitem>
591 <para>Select <literal>Devices</literal> -&gt; <literal>Custom
592 Scripts</literal> -&gt; <literal>Configure</literal>.</para>
593 </listitem>
594
595 <listitem>
596 <para>Select <literal>Upload to EMS</literal>.</para>
597 </listitem>
598
599 <listitem>
600 <para>In the <literal>Script Type</literal> menu, select the type
601 the uploaded script should have.</para>
602 </listitem>
603
604 <listitem>
605 <para>Press <literal>Choose File</literal> to select the scripts
606 needed, and then press <literal>Send</literal>.</para>
607 </listitem>
608 </orderedlist>
609 </section>
610
611 <section id="remove_scripts">
612 <title>Removing Scripts</title>
613
614 <para>Follow the instruction below to remove scripts:</para>
615
616 <orderedlist>
617 <listitem>
618 <para>Select <literal>Devices</literal> -&gt; <literal>Custom
619 Scripts</literal> -&gt; <literal>Configure</literal>.</para>
620 </listitem>
621
622 <listitem>
623 <para>Select the script you want to delete from the
624 <literal>Uploaded Scripts</literal> tab and then click
625 <literal>Delete</literal>, which will remove the script immediately
626 from the Enea uCPE Manager.</para>
627 </listitem>
628 </orderedlist>
629 </section>
630
631 <section id="configure_scripts">
632 <title>Configuring Script Location</title>
633
634 <para>The location where the scripts are staged in the Enea uCPE Manager
635 can be chanaged as described below:</para>
636
637 <orderedlist>
638 <listitem>
639 <para>Select <literal>Devices</literal> -&gt; <literal>Custom
640 Scripts</literal> -&gt; <literal>Configure</literal>.</para>
641 </listitem>
642
643 <listitem>
644 <para>Select the <literal>Configuration</literal> tab and specify a
645 new loacation to store the scripts.</para>
569 646
570 <note> 647 <note>
571 <para>The ZTP will only be triggered the first time a uCPE device 648 <para>Change the script storage location only if you have many
572 connects to the uCPE Manager. Just changing an offline 649 scripts which you would prefer to store on another partition,
573 configuration will not push the new changes to the device. If an 650 otherwise leave this configuration as is.</para>
574 offline configuration is changed after uCPE device registration, a
575 factory reset can be executed to force a new ZTP to execute by
576 selecting the device, then <literal>Operations</literal> -&gt;
577 <literal>factory reset</literal>.</para>
578 </note> 651 </note>
579 </section> 652 </listitem>
580 </section> 653 </orderedlist>
654 </section>
581 655
582 <section id="custom_scripts"> 656 <section id="run_the_scripts">
583 <title>Custom Scripts for Custom Networking Configurations</title> 657 <title>Running the Scripts</title>
584 658
585 <para>The custom scripts feature allows users to execute user-defined 659 <para><emphasis role="bold">How to run Custom Scripts</emphasis></para>
586 scripts on the uCPE device at various times.This allows for more 660
587 flexible and advanced configurations such as a LTE modem 661 <orderedlist>
588 configuration, advanced network configurations or OVS flow rule 662 <listitem>
589 programming at any time.</para> 663 <para>Select <literal>Devices</literal> -&gt; <literal>Custom
590 664 Scripts</literal> -&gt; <literal>Apply Scripts</literal>.</para>
591 <section id="upload_scripts"> 665 </listitem>
592 <title>Uploading Scripts</title> 666
593 667 <listitem>
594 <para>The scripts need to be uploaded to the uCPE Manager prior to 668 <para>In the <literal>Script Config Screen</literal> pop up, select
595 use. When uploading scripts to the uCPE Manager make sure to select 669 the devices from the device(s) chooser list on which to run the
596 the right script type.</para> 670 scripts. Press the <literal>&gt;</literal> button to move the
597 671 devices to the right side of the chooser, which is the list of
598 <para>The following script types are supported:</para> 672 devices that will execute the selected scripts.</para>
599 673 </listitem>
600 <itemizedlist> 674
601 <listitem> 675 <listitem>
602 <para><literal>Once-before-startup</literal>. This script will 676 <para>Select the scripts from the list under the device(s) chooser
603 only execute once during the startup.</para> 677 by pressing the <literal>+</literal> button.</para>
604 </listitem> 678 </listitem>
605 679
606 <listitem> 680 <listitem>
607 <para><literal>Always-before-startup</literal>. This script will 681 <para>In the pop-up window, select the scripts from the list. If
608 always execute during the startup.</para> 682 there are no scripts to select, then there is no script uploaded
609 </listitem> 683 with that particular type. Upload the script(s) needed and try
610 684 again.</para>
611 <listitem> 685 </listitem>
612 <para><literal>Once-after-startup</literal>. This script will 686
613 only execute once after the system has been started.</para> 687 <listitem>
614 </listitem> 688 <para>Check the checkbox <literal>Reboot devices</literal> if you
615 689 want to reboot and execute the scripts at once and then press
616 <listitem> 690 <literal>ok</literal>.</para>
617 <para><literal>Always-after-startup</literal>. This script will 691
618 always execute after the system has been started.</para> 692 <note>
619 </listitem> 693 <para>The status of execution for the scripts can be seen by
620 </itemizedlist> 694 opening the <literal>Fault</literal> -&gt;
621 695 <literal>Events</literal> screen and filtering by device and/or
622 <para>Follow the instruction below to upload scripts:</para> 696 the event name <filename>Custom</filename>.</para>
623 697 </note>
624 <orderedlist> 698 </listitem>
625 <listitem> 699 </orderedlist>
626 <para>Select <literal>Devices</literal> -&gt; <literal>Custom
627 Scripts</literal> -&gt; <literal>Configure</literal>.</para>
628 </listitem>
629
630 <listitem>
631 <para>Select <literal>Upload to EMS</literal>.</para>
632 </listitem>
633
634 <listitem>
635 <para>In the <literal>Script Type</literal> menu, select the
636 type the uploaded script should have.</para>
637 </listitem>
638
639 <listitem>
640 <para>Press <literal>Choose File</literal> to select the scripts
641 needed, and then press <literal>Send</literal>.</para>
642 </listitem>
643 </orderedlist>
644 </section>
645
646 <section id="remove_scripts">
647 <title>Removing Scripts</title>
648
649 <para>Follow the instruction below to remove scripts:</para>
650
651 <orderedlist>
652 <listitem>
653 <para>Select <literal>Devices</literal> -&gt; <literal>Custom
654 Scripts</literal> -&gt; <literal>Configure</literal>.</para>
655 </listitem>
656
657 <listitem>
658 <para>Select the script you want to delete from the
659 <literal>Uploaded Scripts</literal> tab and then click
660 <literal>Delete</literal>, which will remove the script
661 immediately from the uCPE Manager.</para>
662 </listitem>
663 </orderedlist>
664 </section>
665
666 <section id="configure_scripts">
667 <title>Configuring Script Location</title>
668
669 <para>The location where the scripts are staged in the uCPE Manager
670 can be chanaged as described below:</para>
671
672 <orderedlist>
673 <listitem>
674 <para>Select <literal>Devices</literal> -&gt; <literal>Custom
675 Scripts</literal> -&gt; <literal>Configure</literal>.</para>
676 </listitem>
677
678 <listitem>
679 <para>Select the <literal>Configuration</literal> tab and
680 specify a new loacation to store the scripts.</para>
681
682 <note>
683 <para>Change the script storage location only if you have many
684 scripts which you would prefer to store on another partition,
685 otherwise leave this configuration as is.</para>
686 </note>
687 </listitem>
688 </orderedlist>
689 </section>
690
691 <section id="run_the_scripts">
692 <title>Running the Scripts</title>
693
694 <para><emphasis role="bold">How to run Custom
695 Scripts</emphasis></para>
696
697 <orderedlist>
698 <listitem>
699 <para>Select <literal>Devices</literal> -&gt; <literal>Custom
700 Scripts</literal> -&gt; <literal>Apply Scripts</literal>.</para>
701 </listitem>
702
703 <listitem>
704 <para>In the <literal>Script Config Screen</literal> pop up,
705 select the devices from the device(s) chooser list on which to
706 run the scripts. Press the <literal>&gt;</literal> button to
707 move the devices to the right side of the chooser, which is the
708 list of devices that will execute the selected scripts.</para>
709 </listitem>
710
711 <listitem>
712 <para>Select the scripts from the list under the device(s)
713 chooser by pressing the <literal>+</literal> button.</para>
714 </listitem>
715
716 <listitem>
717 <para>In the pop-up window, select the scripts from the list. If
718 there are no scripts to select, then there is no script uploaded
719 with that particular type. Upload the script(s) needed and try
720 again.</para>
721 </listitem>
722
723 <listitem>
724 <para>Check the checkbox <literal>Reboot devices</literal> if
725 you want to reboot and execute the scripts at once and then
726 press <literal>ok</literal>.</para>
727
728 <note>
729 <para>The status of execution for the scripts can be seen by
730 opening the <literal>Fault</literal> -&gt;
731 <literal>Events</literal> screen and filtering by device
732 and/or the event name <filename>Custom</filename>.</para>
733 </note>
734 </listitem>
735 </orderedlist>
736 </section>
737 </section>
738 </section> 700 </section>
739 </section> 701 </section>
740</chapter> \ No newline at end of file 702</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml b/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml
index 9bf8822..e176cec 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml
@@ -2,17 +2,17 @@
2<chapter id="troubleshooting"> 2<chapter id="troubleshooting">
3 <title>Troubleshooting and Recovery</title> 3 <title>Troubleshooting and Recovery</title>
4 4
5 <para>The following is a small list of possible NFV Access problems, and 5 <para>The following is a small list of possible Enea NFV Access problems,
6 their solutions. <emphasis role="bold">In all scenarios collect the logs if 6 and their solutions. <emphasis role="bold">In all scenarios collect the logs
7 possible for debugging.</emphasis> More information on log collecting can be 7 if possible for debugging.</emphasis> More information on log collecting can
8 found in <olink targetdoc="book_enea_nfv_access_getting_started" 8 be found in <olink targetdoc="book_enea_nfv_access_getting_started"
9 targetptr="log_collector">Using the Log Collector in the <xi:include 9 targetptr="log_collector">Using the Log Collector in the <xi:include
10 href="../../s_docbuild/olinkdb/pardoc-names.xml" 10 href="../../s_docbuild/olinkdb/pardoc-names.xml"
11 xmlns:xi="http://www.w3.org/2001/XInclude" 11 xmlns:xi="http://www.w3.org/2001/XInclude"
12 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> 12 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
13 Manual.</para> 13 Manual.</para>
14 14
15 <para>If you encounter other issues or can't get NFV Access to work 15 <para>If you encounter other issues or can't get Enea NFV Access to work
16 successfully after consulting the information below, please use the <olink 16 successfully after consulting the information below, please use the <olink
17 targetdoc="book_enea_nfv_access_release_info" 17 targetdoc="book_enea_nfv_access_release_info"
18 targetptr="contacting_enea_support">Enea Support team Form, available in the 18 targetptr="contacting_enea_support">Enea Support team Form, available in the
@@ -29,7 +29,7 @@
29 29
30 <thead> 30 <thead>
31 <row> 31 <row>
32 <entry align="center">NFV Access Problem</entry> 32 <entry align="center">Enea NFV Access Problem</entry>
33 33
34 <entry align="center">Solution</entry> 34 <entry align="center">Solution</entry>
35 </row> 35 </row>
@@ -37,13 +37,30 @@
37 37
38 <tbody> 38 <tbody>
39 <row> 39 <row>
40 <entry>A uCPE device fails to connect to the Enea uCPE Manager after
41 installation.</entry>
42
43 <entry>If the uCPE device is not able to connect to the Enea uCPE
44 Manager after an installation, the Web-installer application is
45 started automatically on the uCPE device to change the configuration
46 via a web browser. Please see <olink
47 targetdoc="book_enea_nfv_access_getting_started"
48 targetptr="boot_device_add_map">Booting the uCPE device and adding
49 it to the Map in the <xi:include
50 href="../../s_docbuild/olinkdb/pardoc-names.xml"
51 xmlns:xi="http://www.w3.org/2001/XInclude"
52 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
53 Manual.</entry>
54 </row>
55
56 <row>
40 <entry>The uCPE Device cannot boot after an upgrade.</entry> 57 <entry>The uCPE Device cannot boot after an upgrade.</entry>
41 58
42 <entry><orderedlist> 59 <entry><orderedlist>
43 <listitem> 60 <listitem>
44 <para>Perform a hardware reboot of the uCPE Device and select 61 <para>Perform a hardware reboot of the uCPE Device and select
45 the previous NFV Access image from the GRUB menu. This action 62 the previous Enea NFV Access image from the GRUB menu. This
46 assumes physical access to the uCPE device.</para> 63 action assumes physical access to the uCPE device.</para>
47 </listitem> 64 </listitem>
48 65
49 <listitem> 66 <listitem>
@@ -60,10 +77,10 @@
60 </row> 77 </row>
61 78
62 <row> 79 <row>
63 <entry>After a failed uCPE device upgrade the previous NFV Access 80 <entry>After a failed uCPE device upgrade the previous Enea NFV
64 image (from the GRUB menu) does not boot.</entry> 81 Access image (from the GRUB menu) does not boot.</entry>
65 82
66 <entry>Reinstall NFV Access on the uCPE device and redeploy the 83 <entry>Reinstall Enea NFV Access on the uCPE device and redeploy the
67 initial configuration and virtualized services, by following the 84 initial configuration and virtualized services, by following the
68 steps in <olink targetdoc="book_enea_nfv_access_getting_started" 85 steps in <olink targetdoc="book_enea_nfv_access_getting_started"
69 targetptr="install_ena_device">Installing Enea NFV Access - uCPE 86 targetptr="install_ena_device">Installing Enea NFV Access - uCPE
@@ -75,7 +92,7 @@
75 </row> 92 </row>
76 93
77 <row> 94 <row>
78 <entry>The uCPE Manager upgrade fails and a working snapshot is 95 <entry>The Enea uCPE Manager upgrade fails and a working snapshot is
79 available.</entry> 96 available.</entry>
80 97
81 <entry>If a working snapshot obtained during a previous Upgrade or 98 <entry>If a working snapshot obtained during a previous Upgrade or
@@ -102,8 +119,8 @@
102 </row> 119 </row>
103 120
104 <row> 121 <row>
105 <entry>The uCPE Manager upgrade fails and no working snapshot is 122 <entry>The Enea uCPE Manager upgrade fails and no working snapshot
106 available, but a System Back-up file exists.</entry> 123 is available, but a System Back-up file exists.</entry>
107 124
108 <entry><orderedlist> 125 <entry><orderedlist>
109 <listitem> 126 <listitem>
@@ -114,8 +131,8 @@
114 131
115 <listitem> 132 <listitem>
116 <para>Perform an installation with the restore option of a 133 <para>Perform an installation with the restore option of a
117 previous uCPE Manager configuration as described in <olink 134 previous Enea uCPE Manager configuration as described in
118 targetdoc="book_enea_nfv_access_getting_started" 135 <olink targetdoc="book_enea_nfv_access_getting_started"
119 targetptr="install_ucpemg_from_backup">Installation of the 136 targetptr="install_ucpemg_from_backup">Installation of the
120 uCPE Manager using a System Back-up in the <xi:include 137 uCPE Manager using a System Back-up in the <xi:include
121 href="../../s_docbuild/olinkdb/pardoc-names.xml" 138 href="../../s_docbuild/olinkdb/pardoc-names.xml"
@@ -128,7 +145,7 @@
128 145
129 <row> 146 <row>
130 <entry>The uCPE device is booted, the ssh connection is available 147 <entry>The uCPE device is booted, the ssh connection is available
131 but the device is not connected to the uCPE Manager.</entry> 148 but the device is not connected to the Enea uCPE Manager.</entry>
132 149
133 <entry><orderedlist> 150 <entry><orderedlist>
134 <listitem> 151 <listitem>
@@ -138,7 +155,7 @@
138 155
139 <listitem> 156 <listitem>
140 <para>Use the <literal>Reconnect</literal> button from the 157 <para>Use the <literal>Reconnect</literal> button from the
141 uCPE Manager's GUI.</para> 158 Enea uCPE Manager's GUI.</para>
142 </listitem> 159 </listitem>
143 160
144 <listitem> 161 <listitem>
@@ -190,7 +207,7 @@
190 <listitem> 207 <listitem>
191 <para>Reboot the device using <literal>Operations</literal> 208 <para>Reboot the device using <literal>Operations</literal>
192 -&gt; <literal>Reboot</literal> menu options from within the 209 -&gt; <literal>Reboot</literal> menu options from within the
193 uCPE Manager.</para> 210 Enea uCPE Manager.</para>
194 </listitem> 211 </listitem>
195 212
196 <listitem> 213 <listitem>
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 0876709..3706548 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
@@ -1,18 +1,19 @@
1<?xml version="1.0" encoding="ISO-8859-1"?> 1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="upgrade_ena"> 2<chapter id="upgrade_ena">
3 <title>Upgrading NFV Access</title> 3 <title>Upgrading Enea NFV Access</title>
4 4
5 <para>Enea provides regular releases that will require the upgrading of NFV 5 <para>Enea provides regular releases that will require the upgrading of Enea
6 Access components. The uCPE Manager must be upgraded to the new Enea NFV 6 NFV Access components. The Enea uCPE Manager must be upgraded first,
7 Access version before the uCPE devices are.</para> 7 followed by upgrading Enea NFV Access Run Time on the uCPE devices.</para>
8 8
9 <section id="upgrade_mg"> 9 <section id="upgrade_mg">
10 <title>Upgrading the uCPE Manager</title> 10 <title>Upgrading the Enea uCPE Manager</title>
11 11
12 <note> 12 <note>
13 <para>It is recommended to create a system backup by accessing: 13 <para>It is recommended to create a system backup by accessing:
14 <literal>System</literal> -&gt; <literal>System Backup</literal> from 14 <literal>System</literal> -&gt; <literal>System Backup</literal> from
15 the uCPE Manager GUI, for recovery in case of an upgrade failure.</para> 15 the Enea uCPE Manager GUI, for recovery in case of an upgrade
16 failure.</para>
16 </note> 17 </note>
17 18
18 <orderedlist> 19 <orderedlist>
@@ -31,7 +32,7 @@
31 32
32 <listitem> 33 <listitem>
33 <para>Run the following command with the root account and change 34 <para>Run the following command with the root account and change
34 <literal>/opt/ems</literal> to the correct location of the uCPE 35 <literal>/opt/ems</literal> to the correct location of the Enea uCPE
35 Manager installation:</para> 36 Manager installation:</para>
36 37
37 <programlisting>./upgrade.sh /opt/ems \ 38 <programlisting>./upgrade.sh /opt/ems \
@@ -55,7 +56,7 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
55 56
56 <note> 57 <note>
57 <para>The snapshot file created during the upgrade can be used for 58 <para>The snapshot file created during the upgrade can be used for
58 restoring the uCPE Manager.</para> 59 restoring the Enea uCPE Manager.</para>
59 </note> 60 </note>
60 </listitem> 61 </listitem>
61 62
@@ -70,9 +71,9 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
70 </itemizedlist> 71 </itemizedlist>
71 72
72 <section id="restore_prev_ucpe_install"> 73 <section id="restore_prev_ucpe_install">
73 <title>Restoring a previous uCPE Manager installation</title> 74 <title>Restoring a previous Enea uCPE Manager installation</title>
74 75
75 <para><emphasis role="bold">How to restore a previous uCPE Manager 76 <para><emphasis role="bold">How to restore a previous Enea uCPE Manager
76 installation</emphasis></para> 77 installation</emphasis></para>
77 78
78 <orderedlist> 79 <orderedlist>
@@ -89,8 +90,8 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
89 <listitem> 90 <listitem>
90 <para>Copy the snapshot file 91 <para>Copy the snapshot file
91 (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) 92 (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>)
92 created during a previous uCPE Manager Upgrade or uCPE Manager 93 created during a previous Enea uCPE Manager Upgrade or Enea uCPE
93 Uninstall Operation into the 94 Manager Uninstall Operation into the
94 <literal>&lt;uCPEM-installdir&gt;</literal> directory.</para> 95 <literal>&lt;uCPEM-installdir&gt;</literal> directory.</para>
95 </listitem> 96 </listitem>
96 97
@@ -100,7 +101,7 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
100 101
101 <listitem> 102 <listitem>
102 <para>Run the following command with the root user and change 103 <para>Run the following command with the root user and change
103 <literal>/opt/ems</literal> to the correct location of the uCPE 104 <literal>/opt/ems</literal> to the correct location of the Enea uCPE
104 Manager installation:</para> 105 Manager installation:</para>
105 106
106 <programlisting>./restore.sh /opt/ems ucpemanager-Backup-YYYYddMMHHmm.tar.gz</programlisting> 107 <programlisting>./restore.sh /opt/ems ucpemanager-Backup-YYYYddMMHHmm.tar.gz</programlisting>
@@ -116,8 +117,8 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
116 </listitem> 117 </listitem>
117 118
118 <listitem> 119 <listitem>
119 <para>Reinstall the uCPE Manager application on the specified target 120 <para>Reinstall the Enea uCPE Manager application on the specified
120 location, restoring the data in the database and files in the 121 target location, restoring the data in the database and files in the
121 process.</para> 122 process.</para>
122 </listitem> 123 </listitem>
123 </itemizedlist> 124 </itemizedlist>
@@ -127,20 +128,20 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
127 </section> 128 </section>
128 129
129 <section id="uninstall_ucpem_install"> 130 <section id="uninstall_ucpem_install">
130 <title>Uninstalling an existing uCPE Manager installation</title> 131 <title>Uninstalling an existing Enea uCPE Manager installation</title>
131 132
132 <para><emphasis role="bold">How to uninstall an existing uCPE Manager 133 <para><emphasis role="bold">How to uninstall an existing Enea uCPE
133 installation</emphasis></para> 134 Manager installation</emphasis></para>
134 135
135 <orderedlist> 136 <orderedlist>
136 <listitem> 137 <listitem>
137 <para>Navigate to the folder where the uCPE Manager is installed: 138 <para>Navigate to the folder where the Enea uCPE Manager is
138 <filename>&lt;uCPEM-installdir&gt;</filename>.</para> 139 installed: <filename>&lt;uCPEM-installdir&gt;</filename>.</para>
139 </listitem> 140 </listitem>
140 141
141 <listitem> 142 <listitem>
142 <para>Run the following command with the root user and change 143 <para>Run the following command with the root user and change
143 <literal>/opt/ems</literal> to the correct location of the uCPE 144 <literal>/opt/ems</literal> to the correct location of the Enea uCPE
144 Manager installation:</para> 145 Manager installation:</para>
145 146
146 <programlisting>./uninstall.sh /opt/ems</programlisting> 147 <programlisting>./uninstall.sh /opt/ems</programlisting>
@@ -164,7 +165,7 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
164 165
165 <note> 166 <note>
166 <para>The snapshot file created during the uninstall can be used 167 <para>The snapshot file created during the uninstall can be used
167 for restoring the uCPE Manager.</para> 168 for restoring the Enea uCPE Manager.</para>
168 </note> 169 </note>
169 </listitem> 170 </listitem>
170 171
@@ -183,15 +184,16 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
183 </listitem> 184 </listitem>
184 </itemizedlist> 185 </itemizedlist>
185 186
186 <para>After these steps, the uCPE Manager is completely removed from the 187 <para>After these steps, the Enea uCPE Manager is completely removed
187 system.</para> 188 from the system.</para>
188 </section> 189 </section>
189 </section> 190 </section>
190 191
191 <section id="upgrade_devices"> 192 <section id="upgrade_devices">
192 <title>uCPE device upgrades</title> 193 <title>uCPE device upgrades</title>
193 194
194 <para>A uCPE device can be upgraded using the uCPE Manager GUI.</para> 195 <para>A uCPE device can be upgraded using the Enea uCPE Manager
196 GUI.</para>
195 197
196 <section id="device_up_process"> 198 <section id="device_up_process">
197 <title>The uCPE device upgrade process</title> 199 <title>The uCPE device upgrade process</title>
@@ -251,7 +253,7 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
251 <note> 253 <note>
252 <para>The uCPE Device upgrade is done with image files of type 254 <para>The uCPE Device upgrade is done with image files of type
253 <literal>rootfs.ostree.tar.bz2</literal>, which are available in the 255 <literal>rootfs.ostree.tar.bz2</literal>, which are available in the
254 <filename>Enea_NFV_Ac-cess_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</filename> 256 <filename>Enea_NFV_Access_Run_Time_Platform_&lt;processor&gt;_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</filename>
255 file you downloaded with your release.</para> 257 file you downloaded with your release.</para>
256 </note> 258 </note>
257 259
@@ -345,7 +347,7 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
345 when to run the upgrade.</para> 347 when to run the upgrade.</para>
346 348
347 <note> 349 <note>
348 <para>The hour represents the local uCPE Manager server 350 <para>The hour represents the local Enea uCPE Manager server
349 hour.</para> 351 hour.</para>
350 </note> 352 </note>
351 </listitem> 353 </listitem>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml
index 545bf99..dd90884 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml
@@ -35,8 +35,8 @@
35 <note> 35 <note>
36 <para>There are no standard ways of managing VNF licenses, 36 <para>There are no standard ways of managing VNF licenses,
37 therefore no general guidelines can be provided. One example of 37 therefore no general guidelines can be provided. One example of
38 license handling that can be employed in the uCPE Manager is the 38 license handling that can be employed in the Enea uCPE Manager is
39 adding of a license during the Cloud-Init setup.</para> 39 the adding of a license during the Cloud-Init setup.</para>
40 </note> 40 </note>
41 </listitem> 41 </listitem>
42 42
@@ -109,10 +109,10 @@
109 </section> 109 </section>
110 110
111 <section id="onboard_in_ucpemg"> 111 <section id="onboard_in_ucpemg">
112 <title>Onboarding into the uCPE Manager</title> 112 <title>Onboarding into the Enea uCPE Manager</title>
113 113
114 <para><emphasis role="bold">How to onboard a VNF into the uCPE Manager 114 <para><emphasis role="bold">How to onboard a VNF into the Enea uCPE
115 </emphasis></para> 115 Manager </emphasis></para>
116 116
117 <orderedlist> 117 <orderedlist>
118 <listitem> 118 <listitem>
@@ -133,8 +133,8 @@
133 133
134 <para>This window contains data fields where both necessary and optional 134 <para>This window contains data fields where both necessary and optional
135 information about the VNF can be supplied. After doing so, press the 135 information about the VNF can be supplied. After doing so, press the
136 Onboard button, the uCPE Manager will create the VNF descriptor and add 136 Onboard button, the Enea uCPE Manager will create the VNF descriptor and
137 it to its VNF Catalog.</para> 137 add it to its VNF Catalog.</para>
138 138
139 <figure> 139 <figure>
140 <title>Onboard a VNF</title> 140 <title>Onboard a VNF</title>
@@ -171,7 +171,7 @@
171 <listitem> 171 <listitem>
172 <para><emphasis role="bold">Description</emphasis>. This field 172 <para><emphasis role="bold">Description</emphasis>. This field
173 contains any description provided and is only displayed in the GUI 173 contains any description provided and is only displayed in the GUI
174 tables in the uCPE Manager.</para> 174 tables in the Enea uCPE Manager.</para>
175 </listitem> 175 </listitem>
176 176
177 <listitem> 177 <listitem>
@@ -209,7 +209,7 @@
209 <para>This table will contain the interfaces required by this VNF to be 209 <para>This table will contain the interfaces required by this VNF to be
210 configured, when creating an instance. Consult the VNF vendor to 210 configured, when creating an instance. Consult the VNF vendor to
211 determine which and how many are required. Each interface requires a 211 determine which and how many are required. Each interface requires a
212 name, and optionally a description, used only by the uCPE 212 name, and optionally a description, used only by the Enea uCPE
213 Manager.</para> 213 Manager.</para>
214 214
215 <note> 215 <note>
@@ -219,8 +219,8 @@
219 219
220 <para><emphasis role="bold">Cloud Init Tab</emphasis></para> 220 <para><emphasis role="bold">Cloud Init Tab</emphasis></para>
221 221
222 <para>Click the <literal>Clout Init</literal> tab to provide the 222 <para>Click the <literal>Cloud Init</literal> tab to provide the
223 Clout-Init configuration. There are three fields that need to be 223 Cloud-Init configuration. There are three fields that need to be
224 populated:</para> 224 populated:</para>
225 225
226 <orderedlist> 226 <orderedlist>
@@ -271,9 +271,9 @@
271 <para><emphasis role="bold">Content Files Table</emphasis></para> 271 <para><emphasis role="bold">Content Files Table</emphasis></para>
272 272
273 <para>The <literal>Content Files Table</literal> is ONLY used if 273 <para>The <literal>Content Files Table</literal> is ONLY used if
274 <literal>ConfigDrive</literal> is chosend as the Cloud-Init 274 <literal>ConfigDrive</literal> is chosen as the Cloud-Init
275 Datasource. For each content file added, a <literal>Path</literal> 275 Datasource. For each content file added, a <literal>Path</literal>
276 must be provided. When the uCPE Manager is used to create an 276 must be provided. When the Enea uCPE Manager is used to create an
277 instance for multiple VNFs, the user will be prompted to provide a 277 instance for multiple VNFs, the user will be prompted to provide a
278 data file for each entry in this table. Each type of VNF will 278 data file for each entry in this table. Each type of VNF will
279 require different cloud-init files, e.g.: a license file. The data 279 require different cloud-init files, e.g.: a license file. The data
@@ -291,10 +291,10 @@
291 291
292 <para>In this table, you can enter values for properties that will be 292 <para>In this table, you can enter values for properties that will be
293 used during instantiation of the VNF. The values will augment the 293 used during instantiation of the VNF. The values will augment the
294 default values in the <filename>Domain.XML</filename> file used by 294 default values in the <filename>domain.xml</filename> file used by
295 <literal>libvirt/virsh</literal> (running in NFV Access) when creating 295 <literal>libvirt/virsh</literal> (running in Enea NFV Access) when
296 an instance of the VNF. Consult with the VNF Vendor or ENEA support for 296 creating an instance of the VNF. Consult with the VNF Vendor or ENEA
297 values needed by specific VNFs.</para> 297 support for values needed by specific VNFs.</para>
298 298
299 <para><emphasis role="bold">Property Values</emphasis></para> 299 <para><emphasis role="bold">Property Values</emphasis></para>
300 300
@@ -437,25 +437,20 @@
437 </listitem> 437 </listitem>
438 438
439 <listitem> 439 <listitem>
440 <para>For reverse ssh connections: the <literal>Username</literal> 440 <para>For reverse ssh connections (ssh to a uCPE device behind
441 (default: root) and the <literal>Reverse ssh</literal> checkbox 441 NAT): the <literal>Username</literal> (default: root) and the
442 checked. The port will be automatically choosen by the uCPE 442 <literal>Reverse ssh</literal> checkbox checked. The port will be
443 Manager in the range defined in the <literal>System -&gt; 443 automatically choosen by the Enea uCPE Manager in the range
444 Configuration -&gt; Reverse SSH</literal> configuration panel. By 444 defined in the <literal>System -&gt; Configuration -&gt; Reverse
445 default, the start port will be <literal>7000</literal> and the 445 SSH</literal> configuration panel. By default, the start port will
446 maximum number of ports allocated to all devices is 10. Only one 446 be <literal>7000</literal> and the maximum number of ports
447 port per device is allowed.</para> 447 allocated to all devices is 10. Only one port per device is
448 448 allowed. </para>
449 <para>A SSH Tunnel between the uCPE Manager and the device will be 449
450 created:</para> 450 <para>When the SSH window is closed, the tunnel configuration is
451 451 deleted on the uCPE device and the tunnel is destroyed, so that
452 <programlisting>ssh -f -N -T -R &lt; Port &gt; :localhost:22 &lt;uCPE Mgr user&gt;@&lt;uCPE MgrIP&gt;</programlisting> 452 the port can be reused to establish a new tunnel when
453 453 needed.</para>
454 <para>The device must be connected to the uCPE Manager for the
455 tunnel to be created. On connection, a normal ssh connection will
456 be made:</para>
457
458 <programlisting>ssh -p &lt;Port&gt; &lt;Username&gt;@localhost</programlisting>
459 </listitem> 454 </listitem>
460 </itemizedlist> 455 </itemizedlist>
461 </listitem> 456 </listitem>
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 d470415..a7c1c69 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
@@ -14,10 +14,10 @@
14 href="../../s_doceneacommon/doc/eltf_params_updated.xml" 14 href="../../s_doceneacommon/doc/eltf_params_updated.xml"
15 xmlns:xi="http://www.w3.org/2001/XInclude" 15 xmlns:xi="http://www.w3.org/2001/XInclude"
16 xpointer="element(EneaLinux_REL_VER/1)" /> Release includes a new version of 16 xpointer="element(EneaLinux_REL_VER/1)" /> Release includes a new version of
17 the major components as well as other features and optimizations, 17 the major components as well as other features and optimizations, and
18 and documentation updates. A list of new features and improvements can be found in 18 documentation updates. A list of new features and improvements can be found
19 <xref linkend="relinfo-changes-other">Section 2.1 New 19 in <xref linkend="relinfo-changes-other">Section 2.1 New Features and
20 Features and Improvements</xref>.</para> 20 Improvements</xref>.</para>
21 21
22 <section id="release-content"> 22 <section id="release-content">
23 <title>Enea NFV Access Release Content</title> 23 <title>Enea NFV Access Release Content</title>
@@ -107,8 +107,8 @@
107 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" 107 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
108 xmlns:xi="http://www.w3.org/2001/XInclude" 108 xmlns:xi="http://www.w3.org/2001/XInclude"
109 xpointer="element(book_enea_nfv_access_getting_started/1)" />. 109 xpointer="element(book_enea_nfv_access_getting_started/1)" />.
110 Describes how to install the uCPE Manager, the NFV Access Run-Time 110 Describes how to install the Enea uCPE Manager, the Enea NFV Access
111 platform and Device Management.</para> 111 Run-Time platform and Device Management.</para>
112 </listitem> 112 </listitem>
113 113
114 <listitem> 114 <listitem>
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 9b7ac80..e4c9764 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
@@ -9,8 +9,8 @@
9 9
10 <itemizedlist> 10 <itemizedlist>
11 <listitem> 11 <listitem>
12 <para><remark>LXCR-9904</remark>NFV Access cannot be installed on USB 12 <para><remark>LXCR-9904</remark>Enea NFV Access cannot be installed on
13 storage devices.</para> 13 USB storage devices.</para>
14 </listitem> 14 </listitem>
15 15
16 <listitem> 16 <listitem>
@@ -19,9 +19,9 @@
19 </listitem> 19 </listitem>
20 20
21 <listitem> 21 <listitem>
22 <para><remark>ELCCR-527</remark>Cancelling a file upload in the uCPE 22 <para><remark>ELCCR-527</remark>Cancelling a file upload in the Enea
23 Manager will require the user to close and reopen the upload window for 23 uCPE Manager will require the user to close and reopen the upload window
24 the next upload to work.</para> 24 for the next upload to work.</para>
25 </listitem> 25 </listitem>
26 26
27 <listitem> 27 <listitem>
@@ -58,10 +58,10 @@
58 <listitem> 58 <listitem>
59 <para><remark>LXCR-9992</remark>Depending on hardware capabilities, 59 <para><remark>LXCR-9992</remark>Depending on hardware capabilities,
60 there are certain limitations regarding the <literal>vfio-pci</literal> 60 there are certain limitations regarding the <literal>vfio-pci</literal>
61 and <literal>igb_uio</literal> drivers. While the NFV Access Run Time 61 and <literal>igb_uio</literal> drivers. While the Enea NFV Access Run
62 Platform uses the <literal>vfio-pci</literal> driver by default, for 62 Time Platform uses the <literal>vfio-pci</literal> driver by default,
63 certain hardware configurations, <literal>igb_uio</literal> should be 63 for certain hardware configurations, <literal>igb_uio</literal> should
64 used instead, by providing custom scripting. Please contact Enea for 64 be used instead, by providing custom scripting. Please contact Enea for
65 further details.</para> 65 further details.</para>
66 </listitem> 66 </listitem>
67 67
@@ -77,11 +77,11 @@
77 </listitem> 77 </listitem>
78 78
79 <listitem> 79 <listitem>
80 <para><remark>ELCCR-912</remark>Adding an upgrade image into the uCPE 80 <para><remark>ELCCR-912</remark>Adding an upgrade image into the Enea
81 Manager (<literal>Device &gt; Upgrade &gt; Add</literal>) fails, 81 uCPE Manager (<literal>Device &gt; Upgrade &gt; Add</literal>) fails,
82 producing the following error <literal>ostree: symbol lookup error: 82 producing the following error <literal>ostree: symbol lookup error:
83 /usr/local/lib/libostree-1.so.1: undefined symbol: 83 /usr/local/lib/libostree-1.so.1: undefined symbol:
84 g_utf8_make_valid</literal>. This occurs when the uCPE Manager is 84 g_utf8_make_valid</literal>. This occurs when the Enea uCPE Manager is
85 installed on CentOS 7 prior to C7.1804 (kernel version &lt; 3.10.0-862). 85 installed on CentOS 7 prior to C7.1804 (kernel version &lt; 3.10.0-862).
86 As a workaround, update glib2 to version 2.54.2 or later, using 86 As a workaround, update glib2 to version 2.54.2 or later, using
87 <command>#yum update glib2</command>.</para> 87 <command>#yum update glib2</command>.</para>
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 10c29ca..65b1784 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
@@ -42,21 +42,21 @@
42 </listitem> 42 </listitem>
43 43
44 <listitem> 44 <listitem>
45 <para>Support for installing NFV Access on eMMC disks.</para> 45 <para>Support for installing Enea NFV Access on eMMC disks.</para>
46 </listitem> 46 </listitem>
47 47
48 <listitem> 48 <listitem>
49 <para>Support for installing NFV Access on disks larger than 49 <para>Support for installing Enea NFV Access on disks larger than
50 1TB.</para> 50 1TB.</para>
51 </listitem> 51 </listitem>
52 52
53 <listitem> 53 <listitem>
54 <para>Improved boot time of NFV Access by removing unnecessary or 54 <para>Improved boot time of Enea NFV Access by removing unnecessary or
55 redundant services.</para> 55 redundant services.</para>
56 </listitem> 56 </listitem>
57 57
58 <listitem> 58 <listitem>
59 <para>Fixed the NFV Access bare metal installation on Dell 59 <para>Fixed the Enea NFV Access bare metal installation on Dell
60 VEP1445.</para> 60 VEP1445.</para>
61 61
62 <remark>More information might be needed here.</remark> 62 <remark>More information might be needed here.</remark>
@@ -67,7 +67,7 @@
67 </listitem> 67 </listitem>
68 68
69 <listitem> 69 <listitem>
70 <para><remark>ELCCR-354</remark>Improved uCPE Manager instance 70 <para><remark>ELCCR-354</remark>Improved Enea uCPE Manager instance
71 recovery from a faulty state, through the System Backup 71 recovery from a faulty state, through the System Backup
72 functionality.</para> 72 functionality.</para>
73 </listitem> 73 </listitem>
@@ -110,7 +110,7 @@
110 framework that will replace the existing AF&amp;TH in the next major 110 framework that will replace the existing AF&amp;TH in the next major
111 release. The new automation framework has improved usability and an 111 release. The new automation framework has improved usability and an
112 extended automation feature set. It has to be downloaded separately as 112 extended automation feature set. It has to be downloaded separately as
113 it is not part of the standard NFV Access 2.3 distribution. The 113 it is not part of the standard Enea NFV Access 2.3 distribution. The
114 Automation Framework - Early Access distribution also includes updated 114 Automation Framework - Early Access distribution also includes updated
115 user documentation.</para> 115 user documentation.</para>
116 </listitem> 116 </listitem>
@@ -144,7 +144,7 @@
144 xmlns:xi="http://www.w3.org/2001/XInclude" 144 xmlns:xi="http://www.w3.org/2001/XInclude"
145 xpointer="element(book_enea_nfv_access_ucpem_open_source/1)" />. 145 xpointer="element(book_enea_nfv_access_ucpem_open_source/1)" />.
146 Provides license information pertaining to packages available with the 146 Provides license information pertaining to packages available with the
147 uCPE Manager.</para> 147 Enea uCPE Manager.</para>
148 </listitem> 148 </listitem>
149 149
150 <listitem> 150 <listitem>