summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-getting-started
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-nfv-access-getting-started')
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml415
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/book.xml41
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/archive_list.pngbin87667 -> 0 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/collect_debug_logs.pngbin47994 -> 0 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/debug_settings.pngbin32833 -> 0 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/dev_file_mg.pngbin138952 -> 0 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/download_files.pngbin79979 -> 0 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/edit_inter.pngbin9000 -> 0 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.pngbin37721 -> 0 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/fault_events.pngbin46986 -> 0 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/onboard_a_vnf_image.pngbin19864 -> 0 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/ovs_bridges_tab.pngbin55326 -> 0 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.pngbin127794 -> 0 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/prep_execution.pngbin121264 -> 0 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/doc/images/vnf_space.pngbin44338 -> 0 bytes
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml1010
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/introduction.xml264
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/log_collector.xml402
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml711
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml225
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml545
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml476
-rwxr-xr-xdoc/book-enea-nfv-access-getting-started/swcomp.mk10
23 files changed, 0 insertions, 4099 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
deleted file mode 100644
index 6be1205..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/advanced_configurations.xml
+++ /dev/null
@@ -1,415 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<chapter id="advanced_conf">
5 <title>Advanced Configurations</title>
6
7 <para>This chapter describes possible configurations for advanced features
8 such as the Hugepage Reservation Service customization, UEFI Secure Boot and
9 Bare Metal Provisioning.</para>
10
11 <section id="bare_meta_prov">
12 <title>Bare Metal Provisioning</title>
13
14 <para>Bare Metal Provisioning can be used for automated deployment of the
15 Enea NFV Access Runtime Platform on a large number of uCPE devices. The
16 uCPE devices may have no previous operating system installed, or are
17 reinstalled without preserving any existing data. Enea NFV Access Bare
18 Metal Provisioning is based on standardized Pre-Boot Execution environment
19 (PXE) booting.</para>
20
21 <para>The Bare Metal Provisioning process begins by PXE booting an Enea
22 NFV Access installer <literal>initramfs</literal> image. The installer
23 downloads a configuration file, as well as the Enea NFV Access Runtime
24 Platform image and then proceeds to install the system by dividing the
25 disk into 2 partitions: a GPT partition containing the GRUB boot loader
26 and a second partition containing the Enea NFV Access Runtime Platform
27 root filesystem. When the installation is complete, the uCPE device is
28 automatically rebooted into Enea NFV Access Runtime Platform.</para>
29
30 <note>
31 <para>The <literal>.hddimg</literal>, <literal>initramfs</literal>, and
32 <literal>bzImage</literal> files are available in the
33 <filename>Enea_NFV_Access_Run_Time_Platform_
34 &lt;processor&gt;_&lt;version&gt;-&lt;build_number&gt;.tar.gz</filename>
35 file you downloaded with your release.</para>
36 </note>
37
38 <section id="bare_meta_prov_prereq">
39 <title>Prerequisites</title>
40
41 <itemizedlist>
42 <listitem>
43 <para>The uCPE devices to be installed are connected in a working
44 PXE network boot environment. The PXE server can be set up using any
45 Linux distribution that includes TFTP and DHCP software packages.
46 Refer to the documentation for your distribution for setup
47 instructions.</para>
48 </listitem>
49
50 <listitem>
51 <para>An HTTP server must be available and accessible from the uCPE
52 devices in the provisioning network. Note that the installer will
53 use the same interface that the uCPE device is PXE-booted from, to
54 obtain an IP address using DHCP and access the HTTP server.</para>
55 </listitem>
56
57 <listitem>
58 <para>The uCPE devices are preconfigured in BIOS to boot from the
59 hard drive where the Enea NFV Access Runtime Platform will be
60 installed.</para>
61 </listitem>
62
63 <listitem>
64 <para>CSM support and Dual Boot must be enabled in BIOS (i.e. PXE
65 booting in legacy mode), while the final Enea NFV Access image will
66 boot in UEFI mode. Doing a mass deployment using legacy PXE booting
67 usually means that Secure Boot is disabled, Secure Boot 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>
76 </listitem>
77 </itemizedlist>
78 </section>
79
80 <section id="bare_meta_prov_server">
81 <title>Server Configuration</title>
82
83 <para>The following images provided with your Enea NFV Access release
84 need to be made available on the PXE and HTTP servers:</para>
85
86 <orderedlist>
87 <listitem>
88 <para>Copy the Enea NFV Access installer
89 <literal>initramfs</literal> image and kernel
90 <literal>bzImage</literal> for your uCPE device architecture to the
91 TFTP directory on the PXE server (e.g
92 <literal>/var/lib/tftpboot</literal>).</para>
93 </listitem>
94
95 <listitem>
96 <para>Compress the Enea NFV Access Runtime Platform
97 <literal>.hddimg</literal> image for the uCPE device architecture
98 using <literal>gzip</literal> and copy the resulting
99 <literal>hddimg.gz</literal> file to the HTTP server.</para>
100 </listitem>
101 </orderedlist>
102
103 <section id="bare_meta_prov_install_config">
104 <title>Installation Configuration File</title>
105
106 <para>An installation configuration file needs to be prepared on the
107 HTTP server. The format of the configuration file is a list of
108 "<literal>name = value</literal>" pairs and the available parameters
109 are described below.</para>
110
111 <para>Mandatory parameter(s):</para>
112
113 <itemizedlist>
114 <listitem>
115 <para><literal>image_url</literal>. The HTTP server URL used for
116 downloading the Enea NFV Access Runtime Platform image.</para>
117 </listitem>
118 </itemizedlist>
119
120 <para>Optional parameters:</para>
121
122 <itemizedlist>
123 <listitem>
124 <para><literal>install_drive</literal>. The name of the drive
125 where the Enea NFV Access Runtime Platform will be installed (e.g
126 <literal>/dev/sda</literal>). If not set, the installer will use
127 the largest detected (non-USB) drive on the uCPE device.</para>
128 </listitem>
129
130 <listitem>
131 <para><literal>prompt_user</literal>. If the parameter is set to
132 "yes", the installer will ask for confirmation before formatting
133 and partitioning the drive. The default behaviour is to proceed
134 automatically without any user interaction.</para>
135 </listitem>
136 </itemizedlist>
137
138 <para>Installation Configuration File Example:</para>
139
140 <programlisting>image_url = http://192.168.1.100/enea-nfv-access-xeon-d.hddimg.gz
141install_drive = /dev/sda</programlisting>
142
143 <note>
144 <para>The installation configuration file needs to use the Linux
145 end-of-line format (\n), not the Windows format (\r\n).</para>
146 </note>
147 </section>
148
149 <section id="bare_meta_prov_pxe">
150 <title>PXE Configuration</title>
151
152 <para>A PXE entry for the Enea NFV Access installation needs to be
153 added as the default boot selection in the pxelinux configuration file
154 (e.g <literal>/var/lib/tftpboot/pxelinux.cfg/default</literal>). The
155 PXE entry should have the following settings:</para>
156
157 <programlisting>default nfv_access
158label nfv_access
159menu label ^NFV_ACCESS_INSTALLER
160kernel &lt;Path to kernel&gt;
161append root=/dev/ram0 initrd=&lt;Path to initramfs&gt; LABEL=pxe-installer \
162 INSTALL_CFG=http://&lt;Server IP&gt;/&lt;Path to install config file&gt; \
163 console=ttyS0,115200 earlyprintk=ttyS0,115200
164ipappend 2</programlisting>
165 </section>
166 </section>
167
168 <section id="bare_meta_prov_inst">
169 <title>Starting the Installation</title>
170
171 <para>To initiate the installation, set the boot device (for next boot
172 only) to PXE and reboot the uCPE devices. How to do this depends on the
173 remote management capabilities of the uCPE devices and may require
174 vendor-specific tools.</para>
175
176 <para>Example initiation using <literal>ipmitool</literal>:</para>
177
178 <programlisting>ipmitool -U &lt;user&gt; -P &lt;password&gt; -H &lt;uCPE device IPMI IP address&gt; chassis bootdev pxe
179ipmitool -U &lt;user&gt; -P &lt;password&gt; -H &lt;uCPE device IPMI IP address&gt; power reset </programlisting>
180
181 <para>The uCPE devices should be configured in BIOS to boot from the
182 installation drive first in order to automatically start the Enea NFV
183 Access Runtime Platform when the installation is finished.</para>
184 </section>
185 </section>
186
187 <section id="uefi_secure_boot">
188 <title>UEFI Secure Boot</title>
189
190 <para>Secure Boot was designed to enhance security in the pre-boot
191 environment. It prevents malicious software and applications from being
192 loaded during the system start-up process.</para>
193
194 <para>The basic principle of UEFI Secure Boot is that it requires all
195 artifacts involved in the boot process (bootloaders, kernel, initramfs) to
196 be signed using a set of private keys. On a Secure Boot enabled uCPE
197 device these artifacts are checked against a set of public certificates
198 which correspond to these keys. If there are any mismatches the boot
199 process will fail at the stage(s) they are detected.</para>
200
201 <para>For more information about Secure Boot please refer to <ulink
202 url="https://www.uefi.org/sites/default/files/resources/UEFI_Secure_Boot_in_Modern_Computer_Security_Solutions_2013.pdf">Secure
203 Boot in Modern Computer Security Solutions</ulink>.</para>
204
205 <section id="secure_boot_keys">
206 <title>Enabling UEFI Secure Boot</title>
207
208 <para>All Enea NFV Access image artifacts delivered with the release are
209 signed using the Enea UEFI Secure boot private keys. These artifacts can
210 be used on a uCPE device that doesn't have Secure Boot enabled. To use
211 the Secure Boot feature, however, the user must make the Enea UEFI
212 Secure Boot public certificates available on the uCPE device before
213 enabling the feature in BIOS. This process is called
214 "Provisioning".</para>
215
216 <section id="manual_key_provisioning">
217 <title>Provisioning the Enea UEFI Secure Boot Certificates</title>
218
219 <para>The UEFI firmware is normally shipped with factory preloaded
220 certificates. If these do not already include Certificates from Enea,
221 they will need to be appended or replaced with the Enea
222 Certificates.</para>
223
224 <para><emphasis role="bold">UEFI Secure Boot certificates provided
225 with your release:</emphasis></para>
226
227 <itemizedlist>
228 <listitem>
229 <para><literal>Platform Key (PK)</literal>: this key protects the
230 next key from uncontrolled modification. Once this key is
231 enrolled, Secure Boot enters into <literal>User Mode</literal>.
232 The drivers and loaders signed with the <literal>Platform
233 Key</literal> can then be loaded by the firmware.</para>
234 </listitem>
235
236 <listitem>
237 <para><literal>Key Exchange key (KEK)</literal>: this key allows
238 other certificates which have a connection to the private portion
239 of the <literal>Platform Key</literal> to be used.</para>
240 </listitem>
241
242 <listitem>
243 <para><literal>Authorized Signature (DB)</literal>: contains the
244 <literal>trusted keys</literal> used for authenticating any
245 drivers or applications executed in the UEFI environment.</para>
246 </listitem>
247 </itemizedlist>
248
249 <para>The Enea UEFI Secure Boot certificates are installed together
250 with the Enea NFV Access Runtime Platform onto the hard drive. They
251 can be found on the EFI partition (usually the first partition of the
252 drive) under <literal>/uefi_sb_keys</literal>.</para>
253
254 <para>These certificates need to be manually enrolled in BIOS. The
255 exact details on how to proceed may vary depending the version of the
256 UEFI firmware.</para>
257
258 <para>The UEFI firmware is normally shipped with factory preloaded
259 certificates. If these do not already include Certificates from Enea,
260 they will need to be appended or replaced with the Enea
261 Certificates.</para>
262 </section>
263
264 <section id="enable_secure_boot">
265 <title>Enabling Secure Boot in BIOS</title>
266
267 <para>Once the certificates are enrolled, Secure Boot needs to be
268 enabled in BIOS and the device rebooted.</para>
269 </section>
270 </section>
271 </section>
272
273 <section id="hugepage_reservation">
274 <title>Hugepage Reservation Service</title>
275
276 <para>Enea NFV Access implements an automatic hugepage allocation service
277 that is triggered at each startup. The service is skipped if hugepages
278 have been allocated in the kernel boot command line.</para>
279
280 <para>There are two strategies outlined for hugepage allocation:</para>
281
282 <itemizedlist>
283 <listitem>
284 <para>If a system has an amount of memory up to 8GB, the allocation
285 algorithm will reserve up to 30% (no more than 2GB), for the OS and
286 the rest as 2MB hugepages.</para>
287 </listitem>
288
289 <listitem>
290 <para>If a system has an amount of memory that's higher than 8GB, the
291 allocation algorithm will reserve all but 2GB of memory as 1GB
292 hugepages, leaving the rest (2GB) to be used by the OS.</para>
293 </listitem>
294 </itemizedlist>
295
296 <note>
297 <para>This is a best effort reservation after kernel boot, so the
298 results may vary accordingly.</para>
299 </note>
300
301 <section id="hugepage_customizing_auto">
302 <title>Customizing Automatic Hugepage Reservation</title>
303
304 <para>Configuration of Hugepage reservation is done in
305 <literal>/etc/enea-nfv-access/hugepages.cfg</literal>.</para>
306
307 <para><emphasis role="bold">Parameters used by the automatic algorithm:
308 </emphasis></para>
309
310 <itemizedlist spacing="compact">
311 <listitem>
312 <para><literal>hugepage_setup</literal>: Enables the automatic
313 configuraiton algorithm. It has only one value,
314 <literal>auto</literal>. For manual configuration comment or remove
315 this parameter. Use the other parameter descriptions as a
316 template/example.</para>
317 </listitem>
318
319 <listitem>
320 <para><literal>threshold_to_use_1g</literal>: Decides the threshold
321 which instructs the algorithm to use 1GB hugepages. If a system's
322 memory is higher than <literal>threshold_to_use_1g</literal>, then
323 the algorithm will use 1GB hugepages, otherwise it will use 2MB
324 hugepages.</para>
325 </listitem>
326
327 <listitem>
328 <para><literal>percent_os_alloc</literal>: Decides how much memory
329 to try to reserve for userspace applications. The algorithm will try
330 to reserve at least the value of <literal>percent_os_alloc</literal>
331 of the total system memory for userspace applications.</para>
332 </listitem>
333
334 <listitem>
335 <para><literal>maximum_os_alloc_mb</literal>: Maximum amount of
336 memory to allocate for userspace applications. If
337 <literal>percent_os_alloc</literal> of the total system memory
338 exceeds <literal>maximum_os_alloc_mb</literal> then the maximum
339 allocated memory for userspace applications is
340 <literal>maximum_os_alloc_mb</literal>.</para>
341 </listitem>
342 </itemizedlist>
343
344 <para><emphasis role="bold">Example of automatic Hugepage
345 Configuration:</emphasis></para>
346
347 <programlisting>hugepage_setup = auto
348threshold_to_use_1g = 8192
349percent_os_alloc = 30
350maximum_os_alloc_mb = 2048</programlisting>
351
352 <para>The following possible allocations can result (based on total
353 system memory available):</para>
354
355 <itemizedlist>
356 <listitem>
357 <para>2GB of memory: approximately 30% will be allocated for the OS
358 and the rest will be allocated as 2MB hugepages.</para>
359 </listitem>
360
361 <listitem>
362 <para>4GB of memory: approximately 30% will be allocated for the OS
363 and the rest will be allocated as 2MB hugepages.</para>
364 </listitem>
365
366 <listitem>
367 <para>16GB of memory: approximately 2GB will be allocated for the OS
368 and the rest as 1GB hugepages.</para>
369 </listitem>
370 </itemizedlist>
371
372 <note>
373 <para>The memory allocated for the kernel and hugepages might vary
374 slightly depending on how much memory is available.</para>
375 </note>
376 </section>
377
378 <section id="hugepage_customizing_man">
379 <title>Customizing Manual Hugepage Reservation</title>
380
381 <para>The automatic algorithm can be disabled and hugepages in turn,
382 configured manually. To do this, comment the line which defines
383 <literal>hugepage_setup</literal> as <literal>auto</literal> and
384 configure memory for each CPU socket in the following manner:</para>
385
386 <programlisting>&lt;NUMA node&gt;.&lt;hugepage size&gt; = &lt;number of pages&gt;</programlisting>
387
388 <para>Where <literal>&lt;NUMA node&gt;</literal> refers to a node which
389 is part of the system's NUMA topology, <literal>&lt;hugepage
390 size&gt;</literal> decides what type of hugepages should be set and
391 <literal>&lt;number of hugepages&gt;</literal> is how many hugepages of
392 <literal>&lt;hugepage size&gt;</literal> should be allocated.</para>
393
394 <para>To list the available system nodes, run:</para>
395
396 <programlisting>ls -d /sys/devices/system/node/node* </programlisting>
397
398 <para>To list available hugepage sizes, per node, run:</para>
399
400 <programlisting>ls -d /sys/devices/system/node/node*/hugepages/hugepages-*</programlisting>
401
402 <para>Example of Manual Hugepage Configuration, configuring the system
403 to allocate three 1GB hugepages and 512 of 2MB hugepages on node:</para>
404
405 <programlisting>node0.2048kB = 512
406node0.1048576kB = 3 </programlisting>
407
408 <note>
409 <para>Make sure there are no hugepages reserved in the kernel boot
410 command line, these will override any manual configuration done in the
411 service.</para>
412 </note>
413 </section>
414 </section>
415</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-getting-started/doc/book.xml b/doc/book-enea-nfv-access-getting-started/doc/book.xml
deleted file mode 100644
index d148f3b..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/book.xml
+++ /dev/null
@@ -1,41 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED">
5]>
6<book id="book_enea_nfv_access_getting_started">
7 <title><trademark class="registered">Enea</trademark> NFV Access Getting Started</title>
8
9 <subtitle>Release Version
10 <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)"
11 xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle>
12
13 <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb -->
14
15 <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml"
16 xmlns:xi="http://www.w3.org/2001/XInclude" />
17
18 <xi:include href="introduction.xml"
19 xmlns:xi="http://www.w3.org/2001/XInclude" />
20
21 <xi:include href="installation_guide.xml"
22 xmlns:xi="http://www.w3.org/2001/XInclude" />
23
24 <xi:include href="upgrade_ena.xml"
25 xmlns:xi="http://www.w3.org/2001/XInclude" />
26
27 <xi:include href="advanced_configurations.xml"
28 xmlns:xi="http://www.w3.org/2001/XInclude" />
29
30 <xi:include href="net_config_options.xml"
31 xmlns:xi="http://www.w3.org/2001/XInclude" />
32
33 <xi:include href="vnf_mg.xml"
34 xmlns:xi="http://www.w3.org/2001/XInclude" />
35
36 <xi:include href="log_collector.xml"
37 xmlns:xi="http://www.w3.org/2001/XInclude" />
38
39 <xi:include href="troubleshooting.xml"
40 xmlns:xi="http://www.w3.org/2001/XInclude" />
41</book>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/archive_list.png b/doc/book-enea-nfv-access-getting-started/doc/images/archive_list.png
deleted file mode 100755
index 302f32d..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/images/archive_list.png
+++ /dev/null
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/collect_debug_logs.png b/doc/book-enea-nfv-access-getting-started/doc/images/collect_debug_logs.png
deleted file mode 100755
index 6582737..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/images/collect_debug_logs.png
+++ /dev/null
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/debug_settings.png b/doc/book-enea-nfv-access-getting-started/doc/images/debug_settings.png
deleted file mode 100755
index 2c97b2c..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/images/debug_settings.png
+++ /dev/null
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/dev_file_mg.png b/doc/book-enea-nfv-access-getting-started/doc/images/dev_file_mg.png
deleted file mode 100755
index a4a4f5c..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/images/dev_file_mg.png
+++ /dev/null
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/download_files.png b/doc/book-enea-nfv-access-getting-started/doc/images/download_files.png
deleted file mode 100755
index cb686e4..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/images/download_files.png
+++ /dev/null
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter.png b/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter.png
deleted file mode 100755
index fddde37..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter.png
+++ /dev/null
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.png b/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.png
deleted file mode 100755
index f9ab8aa..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/images/edit_inter_config.png
+++ /dev/null
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/fault_events.png b/doc/book-enea-nfv-access-getting-started/doc/images/fault_events.png
deleted file mode 100755
index aeec955..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/images/fault_events.png
+++ /dev/null
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/onboard_a_vnf_image.png b/doc/book-enea-nfv-access-getting-started/doc/images/onboard_a_vnf_image.png
deleted file mode 100755
index da52202..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/images/onboard_a_vnf_image.png
+++ /dev/null
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/ovs_bridges_tab.png b/doc/book-enea-nfv-access-getting-started/doc/images/ovs_bridges_tab.png
deleted file mode 100755
index 0b3ec54..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/images/ovs_bridges_tab.png
+++ /dev/null
Binary files differ
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
deleted file mode 100755
index 2db2487..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/images/prep_deploy.png
+++ /dev/null
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
deleted file mode 100755
index 404760b..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/images/prep_execution.png
+++ /dev/null
Binary files differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/vnf_space.png b/doc/book-enea-nfv-access-getting-started/doc/images/vnf_space.png
deleted file mode 100755
index 1a5ddab..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/images/vnf_space.png
+++ /dev/null
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
deleted file mode 100644
index b82d48b..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml
+++ /dev/null
@@ -1,1010 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="installation_guide">
3 <title>Setting up and Installing the Enea NFV Access Base
4 Configuration</title>
5
6 <para>The setup and installation steps detailed below will deploy a base
7 configuration which will be used as a reference for more complex deployment
8 scenarios.</para>
9
10 <section id="hw_reqs">
11 <title>Hardware Requirements</title>
12
13 <para>The following hardware is needed for deploying the base
14 configuration:</para>
15
16 <itemizedlist>
17 <listitem>
18 <para>One server running the CentOS 7 distribution</para>
19
20 <para>Minimal Requirement: 4 Cores, 16 GB RAM and 300 GB single disk
21 storage. Make sure the CentOS 7 server is updated to the latest
22 revision before installing Enea NFV Access.</para>
23
24 <para>The purpose of the CentOS 7 server is to host the Enea uCPE
25 Manager. Network access between the CentOS 7 server and the uCPE
26 devices is required. The Enea uCPE Manager and the uCPE devices will
27 be connected on separate subnets to avoid inconsistencies.</para>
28 </listitem>
29
30 <listitem>
31 <para>One or more uCPE devices.</para>
32
33 <para>Whitebox devices where the Enea NFV Access Runtime Platform
34 will be installed, containing a minimum of 2 cores and 4 GB RAM and at
35 least two ethernet ports that will be configured as WAN and LAN during
36 deployment.</para>
37
38 <para>When hosting an entire solution including one or several network
39 services, the hardware must also have the resources to host one or
40 more VNFs. During a typical evaluation, a dual VNF service on the Enea
41 NFV Access Runtime Platform needs a CPU with 4-8 cores and at least 8
42 GB RAM. The supported Intel CPUs of Enea NFV Access are documented in
43 the <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
44 xmlns:xi="http://www.w3.org/2001/XInclude"
45 xpointer="element(book_enea_nfv_access_release_info/1)" />
46 manual.</para>
47
48 <para>Enea NFV Access needs EFI support in BIOS to boot. When
49 configuring the uCPE device BIOS a serial connection is
50 required.</para>
51 </listitem>
52
53 <listitem>
54 <para>A laptop.</para>
55
56 <para>The laptop is used for 2 scenarios:</para>
57
58 <itemizedlist>
59 <listitem>
60 <para>Installing the Enea NFV Access Runtime Platform on uCPE
61 Devices.</para>
62 </listitem>
63
64 <listitem>
65 <para>Connecting to the GUI of the Enea uCPE Manager for
66 management and configuration. Network access between the CentOS 7
67 server and the laptop is required. Please see the <xi:include
68 href="../../s_docbuild/olinkdb/pardoc-common.xml"
69 xmlns:xi="http://www.w3.org/2001/XInclude"
70 xpointer="element(book_enea_nfv_access_release_info/1)" /> manual
71 available with your release, for recommended browsers.</para>
72 </listitem>
73 </itemizedlist>
74 </listitem>
75
76 <listitem>
77 <para>A 16 GB USB stick used for the uCPE Device Installation.</para>
78 </listitem>
79 </itemizedlist>
80 </section>
81
82 <section id="sw_config">
83 <title>Software Configuration</title>
84
85 <para>The CentOS 7 server requires a specific configuration for the setup
86 to work.</para>
87
88 <section id="firewall_config">
89 <title>Firewall Configuration</title>
90
91 <para>Any firewall running on the CentOS 7 server may block the
92 management protocols required to communicate between the uCPE device and
93 the Enea uCPE Manager as well as between the Enea uCPE Manager and its
94 northbound clients. Quick handling of a blocking firewall would be to
95 disable it, typical for a lab environment, through:</para>
96
97 <programlisting>sudo systemctl stop firewalld
98sudo systemctl disable firewalld
99sudo systemctl mask now firewalld</programlisting>
100
101 <para>For an advanced firewall configuration, the following ports need
102 to be opened:</para>
103
104 <table>
105 <title>Ports to be Activated</title>
106
107 <tgroup cols="3">
108 <colspec align="left" />
109
110 <tbody>
111 <row>
112 <entry>80</entry>
113
114 <entry>TCP</entry>
115
116 <entry>Required for GUI Access.</entry>
117 </row>
118
119 <row>
120 <entry>443</entry>
121
122 <entry>TCP</entry>
123
124 <entry>Required for GUI Access and Device Connectivity.</entry>
125 </row>
126
127 <row>
128 <entry>54327</entry>
129
130 <entry>UDP</entry>
131
132 <entry>Required for the Enea uCPE Manager High Availability
133 Configuration.</entry>
134 </row>
135
136 <row>
137 <entry>5701:5708</entry>
138
139 <entry>TCP</entry>
140
141 <entry>Required for the Enea uCPE Manager High Availability
142 Configuration.</entry>
143 </row>
144
145 <row>
146 <entry>4334</entry>
147
148 <entry>TCP</entry>
149
150 <entry>Required for Call Home.</entry>
151 </row>
152
153 <row>
154 <entry>2021:2040</entry>
155
156 <entry>TCP</entry>
157
158 <entry>Required for Call Home.</entry>
159 </row>
160
161 <row>
162 <entry>7000:7010</entry>
163
164 <entry>TCP</entry>
165
166 <entry>Required for Reverse SSH.</entry>
167 </row>
168 </tbody>
169 </tgroup>
170 </table>
171
172 <para>Use the following command sequence to enable the required ports
173 for deployment of the Enea uCPE Manager:</para>
174
175 <programlisting>sudo firewall-cmd --permanent --add-port=80/tcp
176sudo firewall-cmd --permanent --add-port=443/tcp
177sudo firewall-cmd --permanent --add-port=54327/udp
178sudo firewall-cmd --permanent --add-port=5701-5708/tcp
179sudo firewall-cmd --permanent --add-port=4334/tcp
180sudo firewall-cmd --permanent --add-port=2021-2040/tcp
181sudo firewall-cmd --permanent --add-port=7000-7010/tcp
182sudo firewall-cmd --reload</programlisting>
183 </section>
184
185 <section id="openjdk_postgresql_config">
186 <title>Configuring OpenJDK and PostgreSQL</title>
187
188 <para>The Enea uCPE Manager requires a specific Java version (OpenJDK
189 11) and a PostgreSQL version to operate correctly.</para>
190
191 <para><emphasis role="bold">Installing OpenJDK</emphasis></para>
192
193 <orderedlist>
194 <listitem>
195 <para>Install OpenJDK 11 using the root account:</para>
196
197 <programlisting>yum install java-11-openjdk-devel</programlisting>
198 </listitem>
199
200 <listitem>
201 <para>Verify the installation:</para>
202
203 <programlisting>java -version
204openjdk version "11.0.3" 2019-04-16 LTS
205OpenJDK Run Time Environment 18.9 (build 11.0.3+7-LTS)
206OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing) </programlisting>
207
208 <note>
209 <para>If there are multiple java versions installed, switch
210 between them using the following command:</para>
211
212 <programlisting>alternatives --config java</programlisting>
213
214 <para>Optionally, the user can switch between the
215 <literal>javac</literal> versions using:</para>
216
217 <programlisting>alternatives --config javac</programlisting>
218 </note>
219 </listitem>
220
221 <listitem>
222 <para>The following system variables need to point to the OpenJDK 11
223 installation:</para>
224
225 <programlisting>export JAVA_HOME=$(dirname $(dirname $(readlink $(readlink $(which java)))))
226export PATH=$PATH:$JAVA_HOME/bin
227export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</programlisting>
228
229 <note>
230 <para>In order to make these system variables persistent, the
231 commands given above should be added to a script in the
232 <literal>/etc/profile.d/</literal> folder. <emphasis
233 role="bold">Sudo</emphasis> access is needed for this
234 operation.</para>
235 </note>
236 </listitem>
237 </orderedlist>
238
239 <para>The Enea uCPE Manager requires a specific PostgreeSQL version.
240 This is embedded in the Enea uCPE Manager installation. In order to
241 avoid conflicts, any existing PostgreeSQL installation needs to be
242 uninstalled.</para>
243
244 <para><emphasis role="bold">Uninstalling PostgreSQL</emphasis></para>
245
246 <orderedlist>
247 <listitem>
248 <para>Open a terminal with administrative rights, i.e. log into a
249 bash shell with root privileges.</para>
250 </listitem>
251
252 <listitem>
253 <para>Execute the following command to check if you have a currently
254 running the PostgreSQL database server:</para>
255
256 <programlisting>ps -ef | grep post</programlisting>
257 </listitem>
258
259 <listitem>
260 <para>Remove the currently installed PostgreSQL server (including
261 the existing postgres user):</para>
262
263 <programlisting>yum remove postgres\*
264rm -rf /var/lib/pgsql
265rm -f /etc/postgres-reg.ini
266userdel postgres</programlisting>
267
268 <note>
269 <para>This step is not necessary if the Enea uCPE Manager will be
270 using an external database (like MariaDB).</para>
271 </note>
272 </listitem>
273 </orderedlist>
274
275 <para>If you have multiple spindles, it is recommended to let the
276 application run off one and the database off the other. This will result
277 in optimum performance. It is also recommended that the swap disk be the
278 same as the one used for the application.</para>
279
280 <para>Assuming another spindle is used (<literal>/drive2</literal>) do
281 the following:</para>
282
283 <orderedlist>
284 <listitem>
285 <para>Create a folder which will host the database (e.g.
286 <literal>emsDatabase</literal>).</para>
287 </listitem>
288
289 <listitem>
290 <para>Create a soft-link that will point to this folder:</para>
291
292 <programlisting>ln -s /opt/ems/elementcenter/database /drive2/emsDatabase</programlisting>
293 </listitem>
294
295 <listitem>
296 <para>Follow the installation steps for the Enea uCPE Manager
297 available in <olink targetdoc="book_enea_nfv_access_getting_started"
298 targetptr="install_ucpe_mg">Installing the uCPE Manager in the
299 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
300 xmlns:xi="http://www.w3.org/2001/XInclude"
301 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
302 Manual.</para>
303 </listitem>
304 </orderedlist>
305 </section>
306 </section>
307
308 <section id="ucpe_config">
309 <title>uCPE Device Configuration</title>
310
311 <section id="wan_lan_ports">
312 <title>Determining the WAN and LAN ports</title>
313
314 <para>A typical whitebox comes with multiple physical network ports,
315 ready to be used. The user must determine the purpose and allocation of
316 each port. The allocation is later aligned with the software
317 configuration within the Enea NFV Access installer.</para>
318
319 <para>A common way is to allocate the left ports to WANs and the right
320 ports to LANs. At least one port must be allocated to WAN and one to
321 LAN.</para>
322 </section>
323
324 <section id="ucpe_identifier">
325 <title>Determining the Device ID</title>
326
327 <para>Each uCPE device needs a unique identifier. This identifier is
328 used to match the registration in the Enea uCPE Manager and the offline
329 configuration of the uCPE device during ZTP (Zero Touch
330 Provisioning)</para>
331
332 <para>Select a text string to represent the uCPE device, e.g.
333 <literal>uCPE-1</literal> or
334 <literal>fwa-t1012vc_boston_1234</literal>.</para>
335 </section>
336
337 <section id="bios_config">
338 <title>Configuring the BIOS</title>
339
340 <para>The factory configuration of the BIOS may not match the
341 requirements of Enea NFV Access. The BIOS configuration needs to be
342 reviewed and potentially reconfigured to prepare for a successful
343 installation.</para>
344
345 <para>Access the BIOS using a serial cable between the uCPE device and
346 the laptop, to review and configure the BIOS correctly. The whitebox
347 vendor is expected to provide the right serial cable for the box. A
348 terminal emulator (such as putty) is needed on the laptop.</para>
349
350 <para>Enable the following BIOS features/configurations:</para>
351
352 <itemizedlist>
353 <listitem>
354 <para>EFI</para>
355 </listitem>
356
357 <listitem>
358 <para>Intel Virtualization Technology (VT-x)</para>
359 </listitem>
360
361 <listitem>
362 <para>Intel Virtualization Technology for Directed I/O (VT-d)</para>
363 </listitem>
364
365 <listitem>
366 <para>SR-IOV</para>
367 </listitem>
368 </itemizedlist>
369
370 <para>The boot order may also need to be modified to support
371 installation and execution of the Enea NFV Access Runtime Platform on
372 the uCPE device.</para>
373
374 <para>The following boot order is recommended for a base
375 configuration:</para>
376
377 <orderedlist>
378 <listitem>
379 <para>Boot from USB</para>
380 </listitem>
381
382 <listitem>
383 <para>Boot from Disk</para>
384 </listitem>
385 </orderedlist>
386
387 <para>With the above boot order there is no need for a configuration of
388 the BIOS during installation and deployment.</para>
389 </section>
390 </section>
391
392 <section id="prep_deploy">
393 <title>Preparing the Deployment</title>
394
395 <section id="install_ucpe_mg">
396 <title>Installing the Enea uCPE Manager</title>
397
398 <para>The Enea uCPE Manager can be installed using as a fresh/first-time
399 configuration or using a backup file of a previous installation, created
400 within the Enea uCPE Manager GUI.</para>
401
402 <section id="fresh_ucpemg_install">
403 <title>Fresh Installation of the Enea uCPE Manager</title>
404
405 <para>On the CentOS 7 server open a terminal, log into a bash shell
406 with the root account and perform the following:</para>
407
408 <orderedlist>
409 <listitem>
410 <para>Extract
411 <literal>Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</literal></para>
412
413 <para>The directory in which the archive has been unpacked will be
414 denoted as: <literal>&lt;uCPEM-installdir&gt;</literal>.</para>
415 </listitem>
416
417 <listitem>
418 <para>Enter <literal>&lt;uCPEM-installdir&gt;</literal>.</para>
419 </listitem>
420
421 <listitem>
422 <para>Choose the target installation folder, e.g.
423 <literal>/opt/ems</literal>. Everything will be installed under a
424 folder called <literal>/ucpemanager</literal> within the target
425 installation folder.</para>
426
427 <para>The application files will be installed in
428 <literal>/opt/ems/ucpemanager/application</literal>. The database
429 will be installed in
430 <literal>/opt/ems/ucpemanager/database</literal>.</para>
431 </listitem>
432
433 <listitem>
434 <para>Run the following interactive command:</para>
435
436 <programlisting>./install.sh /opt/ems \
437Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programlisting>
438
439 <para>The default configuration values are specified in brackets.
440 If no other value is preferred and typed in, pressing
441 <literal>ENTER</literal> will keep the default values. When there
442 is an option within parentheses (i.e.Y/N), a value must be
443 specified.</para>
444
445 <note>
446 <para>The same configuration values set now will need to be
447 provided when upgrading or uninstalling the Enea uCPE
448 Manager.</para>
449 </note>
450
451 <itemizedlist>
452 <listitem>
453 <para>Database Configurations:</para>
454
455 <itemizedlist spacing="compact">
456 <listitem>
457 <para>Are you using the embedded PostgreSQL database?
458 [Y/N]: <literal>Y</literal>.</para>
459 </listitem>
460
461 <listitem>
462 <para>Specify the database process password
463 <literal>[postgres]:</literal></para>
464 </listitem>
465
466 <listitem>
467 <para>Specify the database ID (or name)
468 <literal>[ucpemanager]:</literal></para>
469 </listitem>
470
471 <listitem>
472 <para>Specify the database server port
473 <literal>[5432]:</literal></para>
474 </listitem>
475
476 <listitem>
477 <para>Specify a database user name
478 <literal>[postgres]:</literal></para>
479 </listitem>
480
481 <listitem>
482 <para>Specify a database password
483 <literal>[postgres]:</literal></para>
484 </listitem>
485
486 <listitem>
487 <para>Specify the database startup thread pool size
488 <literal>[1]:</literal></para>
489 </listitem>
490 </itemizedlist>
491 </listitem>
492
493 <listitem>
494 <para>Service Configurations:</para>
495
496 <itemizedlist spacing="compact">
497 <listitem>
498 <para>Specify a service username
499 [<literal>ucpemanager</literal>]:</para>
500 </listitem>
501
502 <listitem>
503 <para>Specify a service password
504 <literal>[ucpemanager</literal>]:</para>
505 </listitem>
506 </itemizedlist>
507 </listitem>
508
509 <listitem>
510 <para>High Availability Configurations:</para>
511
512 <itemizedlist spacing="compact">
513 <listitem>
514 <para>Specify the IP address of the local interface: The
515 CentOS 7 Server loopback address:
516 <literal>127.0.0.1</literal>.</para>
517 </listitem>
518
519 <listitem>
520 <para>Is this server part of a cluster? [Y/N]:
521 <literal>N</literal>.</para>
522 </listitem>
523 </itemizedlist>
524 </listitem>
525
526 <listitem>
527 <para>Heap Configuration:</para>
528
529 <itemizedlist spacing="compact">
530 <listitem>
531 <para>Please enter the new Maximum Heap Size
532 [<literal>4g]</literal>:</para>
533 </listitem>
534 </itemizedlist>
535 </listitem>
536 </itemizedlist>
537
538 <para>This command will:</para>
539
540 <itemizedlist spacing="compact">
541 <listitem>
542 <para>Extract the application files from the compressed
543 installation kit.</para>
544 </listitem>
545
546 <listitem>
547 <para>Install the bundled database.</para>
548 </listitem>
549
550 <listitem>
551 <para>Install the Enea uCPE Manager as a service with the name
552 <literal>ucpemanager</literal>.</para>
553 </listitem>
554
555 <listitem>
556 <para>Start the <literal>ucpemanager</literal> service</para>
557 </listitem>
558 </itemizedlist>
559 </listitem>
560
561 <listitem>
562 <para>Using the IPv4 address of the CentOS 7 Server in a web
563 browser, running on the laptop, log into the Enea uCPE Manager GUI
564 using the default username and password:
565 <literal>admin/admin</literal>.</para>
566 </listitem>
567 </orderedlist>
568
569 <note>
570 <para>The IPv4 address of the CentOS 7 Server, connected to the same
571 network as the uCPE Devices, will be used as a configuration
572 parameter both when setting up the uCPE devices.</para>
573 </note>
574 </section>
575
576 <section id="install_ucpemg_from_backup">
577 <title>Installation of the Enea uCPE Manager using a System
578 Back-up</title>
579
580 <para>The Enea uCPE Manager can be restored if a back-up file has been
581 previously created.</para>
582
583 <para>A backup file can be created by accessing:
584 <literal>System</literal> -&gt; <literal>System Backup</literal> from
585 the Enea uCPE Manager GUI. The resulting zip archive will be located
586 in the <filename>/opt/ems/ucpemanager/application/backup</filename>
587 folder and will be named
588 <literal>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</literal> (e.g
589 System-Backup_Feb19_2013_2257_42.zip). Save the archive to another
590 location outside the Enea uCPE Manager installation folder for future
591 use.</para>
592
593 <note>
594 <para>The System Back-up file obtained from the Enea uCPE Manager
595 GUI (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is
596 different from the Enea uCPE Manager snapshot obtained during a Enea
597 uCPE Manager Upgrade or Uninstall operation
598 (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>) needed
599 for recovery of the Enea uCPE Manager. For more details please see
600 <olink targetdoc="book_enea_nfv_access_getting_started"
601 targetptr="restore_prev_ucpe_install">Restoring a previous uCPE
602 Manager installation in the <xi:include
603 href="../../s_docbuild/olinkdb/pardoc-names.xml"
604 xmlns:xi="http://www.w3.org/2001/XInclude"
605 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
606 Manual.</para>
607 </note>
608
609 <para>To install the Enea uCPE Manager with the restore option provide
610 an additional argument as shown below during installation:</para>
611
612 <programlisting>./install.sh \
613/opt/ems Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz \
614SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting>
615 </section>
616 </section>
617
618 <section id="prep_usb_ena">
619 <title>Preparing the USB stick for installation of the Enea NFV Access
620 Runtime Platform</title>
621
622 <para>To install the Enea NFV Access Runtime Platform, create a
623 bootable USB stick with the image you intend to install.</para>
624
625 <para>In the example below, step by step instructions are provided for
626 the CentOS 7 distribution. It's possible with the appropriate tools to
627 also use Windows OS or MacOS.</para>
628
629 <note>
630 <para>The .hddimg image is available in the
631 <filename>Enea_NFV_Access_Run_Time_Platform_
632 &lt;processor&gt;_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</filename>
633 file you downloaded with your release.</para>
634 </note>
635
636 <para><emphasis role="bold">Create a bootable USB stick
637 image</emphasis></para>
638
639 <orderedlist>
640 <listitem>
641 <para>Copy the <filename>.hddimg</filename> image file provided by
642 Enea, into the CentOS 7 server.</para>
643 </listitem>
644
645 <listitem>
646 <para>Connect the USB stick to the CentOS 7 Server and identify the
647 USB device name given by the system with
648 <literal>lsblk</literal>:</para>
649
650 <programlisting>NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
651sda 8:0 1 28.7G 0 disk
652sdb 8:0 0 111.8G 0 disk
653|-sdb1 8:1 0 111.8G 0 part</programlisting>
654 </listitem>
655
656 <listitem>
657 <para>Copy the <filename>.hddimg</filename> image onto the USB
658 stick, e.g:</para>
659
660 <programlisting>sudo dd if=./enea-nfv-access-&lt;machine&gt;.hddimg \
661of=/dev/sdb bs=4M conv=fsync</programlisting>
662
663 <para>Where
664 <filename>enea-nfv-access-&lt;machine&gt;.hddimg</filename> is the
665 <filename>.hddimg</filename> file and <literal>sdb</literal> is the
666 assigned USB device name.</para>
667 </listitem>
668 </orderedlist>
669 </section>
670
671 <section id="prep_phys_deploy">
672 <title>Preparing Physical Deployment for Installation</title>
673
674 <figure>
675 <title>Preparing for Hardware Installation</title>
676
677 <mediaobject>
678 <imageobject>
679 <imagedata contentwidth="600" fileref="images/prep_deploy.png" />
680 </imageobject>
681 </mediaobject>
682 </figure>
683
684 <para>While the uCPE device is powered off, in order to install and
685 configure the Enea NFV Access Runtime using the prepared USB stick,
686 connect the laptop to a uCPE device LAN port. For this purpose, a Layer
687 2 switch or direct cable connection can be used.</para>
688 </section>
689
690 <section id="install_ena_device">
691 <title>Installing Enea NFV Access - uCPE Device Installation</title>
692
693 <para>To initiate the installation of the Enea NFV Access Runtime
694 Platform do the following:</para>
695
696 <orderedlist>
697 <listitem>
698 <para>Plug the USB stick into the uCPE device.</para>
699 </listitem>
700
701 <listitem>
702 <para>Power up the uCPE device and boot the USB stick.</para>
703 </listitem>
704
705 <listitem>
706 <para>The Web-installer application will start automatically and can
707 be accessed in a web browser on the laptop at
708 <literal>http://172.16.1.1</literal> (port 80).</para>
709 </listitem>
710
711 <listitem>
712 <para>On the first page of the Web-installer, the user must fill
713 in:</para>
714
715 <itemizedlist>
716 <listitem>
717 <para>The static Enea uCPE Manager IP Address.</para>
718 </listitem>
719
720 <listitem>
721 <para>The unique identifier of the uCPE device (called
722 "DeviceId" in this guide).</para>
723 </listitem>
724
725 <listitem>
726 <para>Customer Tags. They are used for Zero Touch Provisining
727 (ZTP) and can be left empty for a base configuration. What can
728 be entered here (if needed), are the tag(s) specified when
729 creating an offline configuration in the Enea uCPE Manager. A
730 later addition of customer tags can only be done by reinstalling
731 the uCPE devices.</para>
732 </listitem>
733 </itemizedlist>
734 </listitem>
735
736 <listitem>
737 <para>Connect the WAN cable to the uCPE device (see Figure 2). This
738 will be used as the uCPE management network interface, as described
739 below.</para>
740 </listitem>
741
742 <listitem>
743 <para>On the second page of the Web-installer, the user must do the
744 following:</para>
745
746 <itemizedlist>
747 <listitem>
748 <para>Configure the management network interface. This interface
749 is used by the Enea uCPE Manager to communicate with the uCPE
750 device.</para>
751 </listitem>
752
753 <listitem>
754 <para>Plug-in additional WAN interfaces (if applicable) and
755 provide their Layer 3 configuration.</para>
756 </listitem>
757 </itemizedlist>
758 </listitem>
759 </orderedlist>
760
761 <para>When the user has completed the configuration steps in the
762 Web-installer, Enea NFV Access is installed on the hard drive. At this
763 stage, user should remove the USB stick and LAN cable and shutdown the
764 uCPE device. It will be started after necessary configurations are done
765 on the Enea uCPE Manager, as described below.</para>
766
767 <note>
768 <para>If the USB stick was booted in UEFI mode, an UEFI boot entry is
769 automatically created and the system will start booting from the hard
770 drive without further user configuration.</para>
771 </note>
772 </section>
773
774 <section id="prep_phys_exec">
775 <title>Preparing Physical Deployment for Execution</title>
776
777 <figure>
778 <title>Preparing for Deployment Execution</title>
779
780 <mediaobject>
781 <imageobject>
782 <imagedata contentwidth="600" fileref="images/prep_execution.png" />
783 </imageobject>
784 </mediaobject>
785 </figure>
786
787 <para>The following network configuration is needed for managing the
788 uCPE device and service deployment:</para>
789
790 <itemizedlist>
791 <listitem>
792 <para>Network connection between the server running the Enea uCPE
793 Manager and the laptop.</para>
794 </listitem>
795
796 <listitem>
797 <para>Network connection between the server running the Enea uCPE
798 Manager and the uCPE device.</para>
799 </listitem>
800 </itemizedlist>
801 </section>
802 </section>
803
804 <section id="mg_ucpe_devices">
805 <title>Management of uCPE Devices</title>
806
807 <para>When the installation is complete the uCPE device can be managed in
808 the Enea uCPE Manager.</para>
809
810 <section id="add_offline_config">
811 <title>Add a default Offline Configuration</title>
812
813 <para>Zero Touch Provisioning is always turned on when a uCPE device
814 connects to the Enea uCPE Manager. To enable it in the Enea uCPE
815 Manager, an offline configuration needs to be registered for Day-0
816 configuration.</para>
817
818 <note>
819 <para>Day-0 configuration is a software lifecycle term referring to
820 early configurations to put the uCPE device in an active state. Day-1
821 Configurations are applied after Day-0 and set the uCPE device and its
822 service in an active state. Day-2 Configurations are live
823 configurations on the uCPE and its service, applied after the uCPE
824 device and its service have been activated.</para>
825 </note>
826
827 <para>The offline configuration consists of data and parameters that are
828 meant to be automatically set when a uCPE device connects to the Enea
829 uCPE Manager for the first time. The configuration is typically focused
830 on setting up the network management of the uCPE device, e.g.
831 configuring network interfaces, WAN and LAN networking and service
832 chains.</para>
833
834 <para>For this base configuration, the offline configuration will be
835 left blank. The blank offline configuration can be filled with
836 user-specific values and data once the service is created, which is done
837 after installation is complete.</para>
838
839 <note>
840 <para>If the offline configuration is not configured, an alarm will be
841 raised: <literal>Day-0 Config:ZTP:Major</literal> when the uCPE device
842 tries to connect to Enea uCPE Manager, informing the user that the ZTP
843 setup failed for the uCPE device.</para>
844 </note>
845
846 <para><emphasis role="bold">To create an offline
847 configuration</emphasis> <orderedlist>
848 <listitem>
849 <para>In a browser access the Enea uCPE Manager, then
850 <literal>Applications</literal>-&gt;<literal>Offline
851 Config</literal>.</para>
852 </listitem>
853
854 <listitem>
855 <para>Create a new offline configuration in the GUI by clicking
856 <literal>Add</literal> and filling in the mandatory fields:
857 <literal>name</literal>, <literal>deviceVersion</literal> and
858 <literal>deviceId</literal>.</para>
859
860 <para>The name is user defined and can be set to any unique text
861 string identifying the configuration. The
862 <literal>deviceVersion</literal> must match the Enea NFV Access
863 version of the uCPE device and the <literal>deviceId</literal>
864 must be the previously set identifier of the uCPE device
865 (DeviceId).</para>
866 </listitem>
867 </orderedlist></para>
868 </section>
869
870 <section id="add_ucpe_mg">
871 <title>Add a uCPE device to the Management System</title>
872
873 <para>In order to enroll a uCPE device in the management system and
874 establish a management connection, the user will add uCPE device
875 information in the Enea uCPE Manager. This is accomplished by selecting
876 <literal>Devices</literal> -&gt; <literal>Manage</literal> -&gt;
877 <literal>Add</literal>.</para>
878
879 <para>The relevant parameters are:</para>
880
881 <itemizedlist>
882 <listitem>
883 <para><emphasis role="bold">Type.</emphasis> The type of device to
884 be added, i.e Enea universal CPE.</para>
885 </listitem>
886
887 <listitem>
888 <para><emphasis role="bold">Name.</emphasis> The name by which the
889 uCPE device is referred to in the Enea uCPE Manager.
890 (Mandatory).</para>
891 </listitem>
892
893 <listitem>
894 <para><emphasis role="bold">SSH Port.</emphasis> The NETCONF Port
895 used for communications. Default is set to 830.</para>
896 </listitem>
897
898 <listitem>
899 <para><emphasis role="bold">SSH User Name.</emphasis> The user name
900 for SSH connectivity. Default user is root.</para>
901 </listitem>
902
903 <listitem>
904 <para><emphasis role="bold">SSH Password.</emphasis> Leave this
905 blank.</para>
906 </listitem>
907
908 <listitem>
909 <para><emphasis role="bold">Device Calls Home.</emphasis> This
910 checkbox indicates the direction of uCPE device communications. For
911 a base configuration, leave this flag unchecked.</para>
912 </listitem>
913
914 <listitem>
915 <para><emphasis role="bold">Device ID.</emphasis> The unique
916 identifier of the uCPE device. (Mandatory).</para>
917 </listitem>
918 </itemizedlist>
919 </section>
920
921 <section id="boot_device_add_map">
922 <title>Booting the uCPE device and adding it to the Map</title>
923
924 <para>When connectivity is established with the Enea uCPE Manager and a
925 uCPE device is already registered with a matching <literal>Device
926 ID</literal>, the installation is complete, and the connection is
927 established.</para>
928
929 <para>When a uCPE device is registered it can be manually added to the
930 map for overview. Right-click on the map and select <literal>Place
931 Device</literal> to put the uCPE device on the map.</para>
932
933 <para>In case of management connection failure (e.g. due to a
934 misconfiguration), the uCPE device status will be seen as RED
935 (disconnected) in the Enea uCPE Manager. The uCPE device configuration
936 can be corrected by removing the WAN cable(s), reconnecting the laptop
937 to the LAN interface of the uCPE device and rebooting it. At this point,
938 the Web-installer can be accessed from the laptop as described in <olink
939 targetdoc="book_enea_nfv_access_getting_started"
940 targetptr="install_ena_device">Installing Enea NFV Access - uCPE Device
941 installation in the <xi:include
942 href="../../s_docbuild/olinkdb/pardoc-names.xml"
943 xmlns:xi="http://www.w3.org/2001/XInclude"
944 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
945 Manual.</para>
946 </section>
947 </section>
948
949 <section id="ucpe_monitor">
950 <title>uCPE Device Monitorization and Control</title>
951
952 <para>Once the uCPE device is connected to the Enea uCPE Manager, it is
953 ready for central management. Two important functions available in the
954 Enea uCPE Manager GUI are alarm checking and resource allocation.</para>
955
956 <section id="check_alarms">
957 <title>Checking Alarms</title>
958
959 <para>The Enea uCPE Manager dashboard presents alarms in a specific
960 window on the front page.</para>
961
962 <para>An alarm can be easily triggered by disconnecting and reconnecting
963 the WAN ethernet cable from the uCPE device. The management system will
964 detect the broken link and raise an alarm: <literal>Device
965 Disconnected::Critical</literal>.</para>
966
967 <para>A separate Alarm Management window can be accessed from the Enea
968 uCPE Manager menu for in-depth access and programming of Alarms and
969 Events.</para>
970 </section>
971
972 <section id="ck_resource_alloc">
973 <title>Checking uCPE device Resource Allocation</title>
974
975 <para>When the uCPE device is connected to the Enea uCPE Manager it is
976 of interest to check the amount of hardware resources in use.</para>
977
978 <para>To check CPU, RAM and disk utilization simply select the uCPE
979 device and click the <literal>Virtual Machines</literal> tab in the map
980 view. The same view will show active VNFs running on the uCPE device
981 once instantiated.</para>
982 </section>
983
984 <section id="access_device_cli">
985 <title>Accessing the uCPE device CLI</title>
986
987 <para>As a final check to make sure the uCPE device was installed and
988 configured correctly, access the uCPE device Linux CLI by selecting the
989 uCPE device on the map and using the SSH button from the panel. A new
990 window will appear for CLI access. The default user and password are
991 <literal>root</literal> and blank, respectively.</para>
992
993 <para>The Enea NFV Access CLI is a pure Linux CLI providing access to
994 standard Linux CLI commands. The CLI is a central feature for running
995 custom scripting.</para>
996
997 <note>
998 <para>In case the uCPE was installed behind a NAT device, reverse SSH
999 connection will be used. For more details, please see <olink
1000 targetdoc="book_enea_nfv_access_getting_started"
1001 targetptr="device_callhome_nat">Device Call Home Connection for
1002 deployment behind NAT in the <xi:include
1003 href="../../s_docbuild/olinkdb/pardoc-names.xml"
1004 xmlns:xi="http://www.w3.org/2001/XInclude"
1005 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
1006 Manual.</para>
1007 </note>
1008 </section>
1009 </section>
1010</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml b/doc/book-enea-nfv-access-getting-started/doc/introduction.xml
deleted file mode 100644
index 5f8a5ad..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/introduction.xml
+++ /dev/null
@@ -1,264 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<chapter id="intro_ucpe">
5 <title>Overview</title>
6
7 <para>This document describes the Enea NFV Access and provides installation
8 steps for deploying a base configuration in order to create:</para>
9
10 <itemizedlist>
11 <listitem>
12 <para>A functional uCPE Management installation ready to manage uCPE
13 devices.</para>
14 </listitem>
15
16 <listitem>
17 <para>One or several managed uCPE devices, ready to host network
18 services, using one wired WAN and one wired LAN connection.</para>
19 </listitem>
20 </itemizedlist>
21
22 <para>Extended deployment and configuration options are also detailed in the
23 following chapters.</para>
24
25 <section id="ena_solution">
26 <title>Enea NFV Access</title>
27
28 <para>Enea NFV Access for universal Customer Premise Equipment (uCPE) is a
29 virtualization and management platform, which allows end-users to onboard,
30 instantiate, and run third-party VNFs onto their systems. It is comprised
31 of two major components working in close cooperation:</para>
32
33 <itemizedlist>
34 <listitem>
35 <para>The Enea NFV Access Runtime Platform, which acts as the host
36 for Virtualized Network Functions (VNFs) and provides management over
37 NETCONF.</para>
38 </listitem>
39
40 <listitem>
41 <para>The Enea uCPE Manager, a solution that runs on an external
42 server, used for VNF Management and managing large numbers of uCPE
43 devices.</para>
44 </listitem>
45 </itemizedlist>
46
47 <para>In addition, Enea NFV Access also includes a software framework for
48 Automation and Testing (AFTH). More information can be found in
49 <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
50 xmlns:xi="http://www.w3.org/2001/XInclude"
51 xpointer="element(book_enea_nfv_access_auto_fw_th_user_guide/1)" />.</para>
52
53 <para>Details concerning release content, including documentation
54 structure, are provided in the <xi:include
55 href="../../s_docbuild/olinkdb/pardoc-common.xml"
56 xmlns:xi="http://www.w3.org/2001/XInclude"
57 xpointer="element(book_enea_nfv_access_release_info/1)" /> manual included
58 with your release.</para>
59
60 <section id="nfv_access">
61 <title>Enea NFV Access Runtime Platform</title>
62
63 <para>Enea NFV Access Runtime Platform is a lightweight,
64 multi-architecture virtualization platform built on de-facto standards
65 in an SDN/NFV ecosystem. It is designed for a high networking
66 performance with minimal hardware footprint, by only providing relevant
67 functionalties and technologies.</para>
68
69 <para>Virtualization methods include Virtual Machines (KVM / QEMU) and
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>
76
77 <figure>
78 <title>VNF Space</title>
79
80 <mediaobject>
81 <imageobject>
82 <imagedata align="center" contentwidth="600"
83 fileref="images/vnf_space.png" />
84 </imageobject>
85 </mediaobject>
86 </figure>
87 </section>
88
89 <section id="ucpe_manager">
90 <title>Enea uCPE Manager</title>
91
92 <para>The Enea uCPE Manager is centralized control system providing
93 uCPEs domain management capabilities through a GUI and REST API. It can
94 be deployed on a host or a virtual machine running 64-bit CentOS 7 on an
95 x86 platform. The Enea uCPE Manager uses a southbound NETCONF protocol
96 to connect and manage uCPE devices.</para>
97
98 <para>The Enea uCPE Manager provides the following key features:</para>
99
100 <itemizedlist>
101 <listitem>
102 <para>Enea NFV Access Runtime Platform Software Management</para>
103 </listitem>
104
105 <listitem>
106 <para>VNF Onboarding</para>
107 </listitem>
108
109 <listitem>
110 <para>VNF Management</para>
111 </listitem>
112
113 <listitem>
114 <para>FCAPS</para>
115 </listitem>
116
117 <listitem>
118 <para>Zero Touch Provisioning</para>
119 </listitem>
120
121 <listitem>
122 <para>Alarms / Events management and monitoring</para>
123 </listitem>
124 </itemizedlist>
125 </section>
126 </section>
127
128 <section id="def_and_acr">
129 <title>Definitions and Acronyms</title>
130
131 <section id="definitions">
132 <title>Definitions</title>
133
134 <table>
135 <title>Definitions</title>
136
137 <tgroup cols="2">
138 <colspec align="left" colname="1" colwidth="1*" />
139
140 <colspec align="left" colname="2" colwidth="3*" />
141
142 <tbody>
143 <row>
144 <entry>Enea NFV Access</entry>
145
146 <entry>The Enea NFV Access Runtime Platform and the Enea uCPE
147 Manager.</entry>
148 </row>
149
150 <row>
151 <entry>Enea NFV Access Runtime Platform</entry>
152
153 <entry>A lightweight, multi-architecture virtualization
154 platform, supporting Virtual Machines.</entry>
155 </row>
156
157 <row>
158 <entry>Enea uCPE Manager</entry>
159
160 <entry>Enea Universal Customer Premises Equipment
161 Manager.</entry>
162 </row>
163
164 <row>
165 <entry>uCPE device</entry>
166
167 <entry>A whitebox running the Enea NFV Access Runtime
168 Platform.</entry>
169 </row>
170 </tbody>
171 </tgroup>
172 </table>
173 </section>
174
175 <section id="acronyms">
176 <title>Acronyms</title>
177
178 <table>
179 <title>Acronyms</title>
180
181 <tgroup cols="2">
182 <colspec align="left" colname="1" colwidth="1*" />
183
184 <colspec align="left" colname="2" colwidth="3*" />
185
186 <tbody>
187 <row>
188 <entry>API</entry>
189
190 <entry>Application Programming Interface.</entry>
191 </row>
192
193 <row>
194 <entry>DPDK</entry>
195
196 <entry>Data Plane Development Kit.</entry>
197 </row>
198
199 <row>
200 <entry>EFI</entry>
201
202 <entry>Extensible Firmware Interface.</entry>
203 </row>
204
205 <row>
206 <entry>FCAPS</entry>
207
208 <entry>Fault-management, Configuration, Accounting, Performance
209 and Security.</entry>
210 </row>
211
212 <row>
213 <entry>NETCONF</entry>
214
215 <entry>Network Configuration Protocol.</entry>
216 </row>
217
218 <row>
219 <entry>NFV</entry>
220
221 <entry>Network Functions Virtualization.</entry>
222 </row>
223
224 <row>
225 <entry>OVS</entry>
226
227 <entry>Open vSwitch.</entry>
228 </row>
229
230 <row>
231 <entry>UEFI</entry>
232
233 <entry>Unified Extensible Firmware Interface.</entry>
234 </row>
235
236 <row>
237 <entry>SR-IOV</entry>
238
239 <entry>Single Root Input/Output Virtualization.</entry>
240 </row>
241
242 <row>
243 <entry>PCI</entry>
244
245 <entry>Peripheral Component Interconnect.</entry>
246 </row>
247
248 <row>
249 <entry>REST</entry>
250
251 <entry>Representational State Transfer.</entry>
252 </row>
253
254 <row>
255 <entry>VNF</entry>
256
257 <entry>Virtual Network Function.</entry>
258 </row>
259 </tbody>
260 </tgroup>
261 </table>
262 </section>
263 </section>
264</chapter> \ No newline at end of file
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
deleted file mode 100644
index 8b8be31..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/log_collector.xml
+++ /dev/null
@@ -1,402 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="log_collector">
3 <title>Using the Log Collector</title>
4
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 Enea uCPE
7 Manager. The following describe how the log collection mechanism
8 works.</para>
9
10 <section id="log_collect_ucpem">
11 <title>Log collecting using the Enea uCPE Manager</title>
12
13 <para>The Enea uCPE Manager allows for collecting a set of logs and state
14 information from a uCPE device.</para>
15
16 <section id="log_collect">
17 <title>Collecting the Logs</title>
18
19 <para>Collect the necessary log files and system details, then create an
20 archive (a tar file) on the uCPE device in the
21 <filename>/var/odm/log/archives</filename> folder:</para>
22
23 <orderedlist>
24 <listitem>
25 <para>Access <literal>Operations</literal> -&gt; <literal>Collect
26 Debug Logs</literal>.</para>
27 </listitem>
28
29 <listitem>
30 <para>Provide a file name in the new window.</para>
31 </listitem>
32
33 <listitem>
34 <para>Press the <literal>Execute</literal> button.</para>
35
36 <para>A success message is shown in the same window as shown below.
37 At this moment, the process of collecting logs on the uCPE device
38 starts.</para>
39 </listitem>
40
41 <figure>
42 <title>Collecting Debug Logs</title>
43
44 <mediaobject>
45 <imageobject>
46 <imagedata align="center" contentwidth="500"
47 fileref="images/collect_debug_logs.png" />
48 </imageobject>
49 </mediaobject>
50 </figure>
51 </orderedlist>
52
53 <note>
54 <para>It might take some time for the archive to be created. When the
55 operation completes, a "CollectLogsComplete" notification is sent from
56 the uCPE device to the Enea uCPE Manager. This can be viewed in the
57 GUI under the <literal>Faults</literal> -&gt;
58 <literal>Events</literal> toolbar menu.</para>
59
60 <figure>
61 <title>Collecting Debug Logs</title>
62
63 <mediaobject>
64 <imageobject>
65 <imagedata align="center" contentwidth="500"
66 fileref="images/fault_events.png" />
67 </imageobject>
68 </mediaobject>
69 </figure>
70 </note>
71 </section>
72
73 <section id="view_logs">
74 <title>View collected Logs</title>
75
76 <para>A list with the archives containing already collected logs will be
77 shown in the <literal>Device File Listing</literal> table:</para>
78
79 <orderedlist>
80 <listitem>
81 <para>Access <literal>Files</literal> -&gt;
82 <literal>Download</literal>.</para>
83 </listitem>
84
85 <listitem>
86 <para>Press the <literal>List</literal> button.</para>
87
88 <figure>
89 <title>Device File Listing Table</title>
90
91 <mediaobject>
92 <imageobject>
93 <imagedata align="center" contentwidth="500"
94 fileref="images/archive_list.png" />
95 </imageobject>
96 </mediaobject>
97 </figure>
98 </listitem>
99 </orderedlist>
100
101 <note>
102 <para>If the filename you specified does not appear, it might still be
103 in the process of creation. Click on the <literal>Refresh</literal>
104 icon at the bottom of the table until you can see the desired file
105 listing.</para>
106 </note>
107 </section>
108
109 <section id="download_fr_dev">
110 <title>Downloading Logs from the uCPE Device</title>
111
112 <para>This option transfers a debug file archive from the uCPE device to
113 Enea uCPE Manager.</para>
114
115 <orderedlist>
116 <listitem>
117 <para>Access <literal>Files</literal> -&gt;
118 <literal>Download</literal>.</para>
119 </listitem>
120
121 <listitem>
122 <para>Press the <literal>List</literal> button.</para>
123 </listitem>
124
125 <listitem>
126 <para>In the <literal>Device File Listing</literal> table, select
127 the archive you want to download from the uCPE device to Enea uCPE
128 Manager.</para>
129 </listitem>
130
131 <listitem>
132 <para>Press the <literal>Download from Device</literal>
133 button.</para>
134
135 <para>The archive will be downloaded from the uCPE device and stored
136 on the Enea uCPE Manager.</para>
137 </listitem>
138 </orderedlist>
139
140 <note>
141 <para>The archive will not be deleted from the uCPE device after
142 download.</para>
143 </note>
144 </section>
145
146 <section id="download_logs_locally">
147 <title>Downloading collected Logs locally</title>
148
149 <para>This option downloads a logs archive from the Enea uCPE Manager to
150 a local (user) machine for analysis. The archive must first be available
151 in the Enea uCPE Manager in order to be downloaded.</para>
152
153 <orderedlist>
154 <listitem>
155 <para>Access <literal>Devices</literal> -&gt;
156 <literal>Files</literal>.</para>
157 </listitem>
158
159 <listitem>
160 <para>Select the <literal>Downloaded Files</literal> tab.</para>
161 </listitem>
162
163 <listitem>
164 <para>Select an archive from <literal>Downloaded Files</literal>
165 table.</para>
166 </listitem>
167
168 <listitem>
169 <para>Click the <literal>Download</literal> button.</para>
170
171 <para>The file will be downloaded in browser's download
172 folder.</para>
173
174 <figure>
175 <title>Downloaded Files Table</title>
176
177 <mediaobject>
178 <imageobject>
179 <imagedata align="center" contentwidth="500"
180 fileref="images/download_files.png" />
181 </imageobject>
182 </mediaobject>
183 </figure>
184 </listitem>
185 </orderedlist>
186 </section>
187
188 <section id="delete_log_archive_dev">
189 <title>Deleting a Logs Archive from a uCPE device</title>
190
191 <para>Use this option when you want to delete unnecessary collected logs
192 on the uCPE device.</para>
193
194 <orderedlist>
195 <listitem>
196 <para>Access <literal>Files</literal> -&gt;
197 <literal>Download</literal>.</para>
198 </listitem>
199
200 <listitem>
201 <para>Press the <literal>List</literal> button.</para>
202 </listitem>
203
204 <listitem>
205 <para>In the <literal>Device File Listing</literal> table, select
206 the archive you want to delete from the uCPE device.</para>
207 </listitem>
208
209 <listitem>
210 <para>Press the <literal>Delete</literal> button.</para>
211
212 <para>The archive will be deleted from the uCPE device and the table
213 will be updated.</para>
214 </listitem>
215 </orderedlist>
216
217 <para>The same can be achieved using these alternative options:</para>
218
219 <orderedlist>
220 <listitem>
221 <para>Access <literal>Operations</literal> -&gt; <literal>Delete
222 Debug Log Archive</literal>.</para>
223 </listitem>
224
225 <listitem>
226 <para>Provide a file name in the new window.</para>
227 </listitem>
228
229 <listitem>
230 <para>Press the <literal>Execute</literal> button.</para>
231
232 <para>A success message is displayed if the file is deleted from the
233 uCPE device correctly.</para>
234 </listitem>
235 </orderedlist>
236 </section>
237
238 <section id="delete_archives_ucpem">
239 <title>Deleting a Logs Archive from the Enea uCPE Manager</title>
240
241 <para>This option deletes a logs archive from the Enea uCPE
242 Manager.</para>
243
244 <orderedlist>
245 <listitem>
246 <para>Access <literal>Devices</literal> -&gt;
247 <literal>Files</literal>.</para>
248 </listitem>
249
250 <listitem>
251 <para>Select the <literal>Downloaded Files</literal> tab.</para>
252 </listitem>
253
254 <listitem>
255 <para>Select an archive from the <literal>Downloaded Files</literal>
256 table.</para>
257 </listitem>
258
259 <listitem>
260 <para>Click the <literal>Delete</literal> button.</para>
261
262 <para>The file will be deleted from the Enea uCPE Manager and the
263 table will be updated.</para>
264 </listitem>
265 </orderedlist>
266
267 <note>
268 <para>Deleting the logs file from the Enea uCPE Manager does not
269 affect the file located on the uCPE device.</para>
270 </note>
271 </section>
272
273 <section condition="hidden" id="enable_disable_via_perms">
274 <title>Enabling/Disabling of the Log Collector via Permissions</title>
275
276 <para>To disable the ability to access/download the uCPE device's
277 debug-log files from the Enea uCPE Manager, the appropriate permissions
278 must be changed:</para>
279
280 <orderedlist>
281 <listitem>
282 <para>Access <literal>Security</literal> -&gt;
283 <literal>Configuration</literal>.</para>
284 </listitem>
285
286 <listitem>
287 <para>Click the <literal>Security Groups</literal> tab.</para>
288 </listitem>
289
290 <listitem>
291 <para>Click the desired group.</para>
292 </listitem>
293
294 <listitem>
295 <para>Click the <literal>Permissions</literal> tab on the right
296 side.</para>
297 </listitem>
298
299 <listitem>
300 <para>Click the <literal>Devices</literal> tab like in the image
301 below.</para>
302 </listitem>
303
304 <listitem>
305 <para>Change the <literal>Device File Management</literal> option to
306 <literal>none</literal> to disable the feature.</para>
307 </listitem>
308 </orderedlist>
309
310 <figure>
311 <title>Device File Management</title>
312
313 <mediaobject>
314 <imageobject>
315 <imagedata align="center" contentwidth="500"
316 fileref="images/dev_file_mg.png" />
317 </imageobject>
318 </mediaobject>
319 </figure>
320 </section>
321
322 <section id="download_ucpemg_logs">
323 <title>Downloading Enea uCPE Manager Logs</title>
324
325 <para>Often, sending the Enea uCPE Manager logs together with collected
326 uCPE device logs to the support team provides important information for
327 troubleshooting (especially in cases of connectivity issues with the
328 uCPE device and error popups).</para>
329
330 <para>Enea uCPE Manager log files are located in
331 <filename>application/logs/</filename> in the Enea uCPE Manager's
332 installation folder
333 (e.g.<filename>/opt/ems/ucpemanager/application/logs</filename>). They
334 can be copied from that location, or they can be downloaded using the
335 Enea uCPE Manager GUI by performing the following:</para>
336
337 <orderedlist>
338 <listitem>
339 <para>Access <literal>Test</literal> -&gt; <literal>Debug
340 Settings</literal> and select the <literal>Log Files</literal>
341 tab.</para>
342 </listitem>
343
344 <listitem>
345 <para>Select the desired log file
346 (<filename>ucpemanager.log</filename> or
347 <filename>watchdog.log</filename>) and press the
348 <literal>Download</literal> button.</para>
349 </listitem>
350
351 <listitem>
352 <para>A new (blank) popup window opens and the file is downloaded
353 locally. This popup can be closed after the download.</para>
354 </listitem>
355
356 <listitem>
357 <para>Repeat steps 2. And 3. Until all the desired log files have
358 been downloaded</para>
359 </listitem>
360 </orderedlist>
361
362 <figure>
363 <title>Debug Settings</title>
364
365 <mediaobject>
366 <imageobject>
367 <imagedata align="center" contentwidth="500"
368 fileref="images/debug_settings.png" />
369 </imageobject>
370 </mediaobject>
371 </figure>
372 </section>
373 </section>
374
375 <section id="log_collect_no_ucpem">
376 <title>Log collecting without using the Enea uCPE Manager</title>
377
378 <para>Log collection from uCPE Devices can also be done when there is no
379 Enea uCPE Manager connection. A SSH connection to uCPE Device is needed
380 for use of the log collector script, which can be found in the uCPE Device
381 file system in <literal>/usr/local/enea/</literal>.</para>
382
383 <para>The Log collector script takes relevant information about the system
384 and collects it in an archive:</para>
385
386 <programlisting>./log-collector.sh -p &lt;LOG_PATHh&gt; -n &lt;ARCHIVE_NAME&gt;</programlisting>
387
388 <para>Where <literal>-p</literal> is the path where the log archive will
389 be saved, <literal>-n</literal> is the archive name.</para>
390
391 <note>
392 <para>If <literal>-p</literal> is not provided, the default path will be
393 used: <literal>/var/logcollector</literal>. If <literal>-n</literal> is
394 not provided, the default name will be used:
395 <filename>log_archive_&lt;timestamp&gt;.tar.gz</filename>.</para>
396 </note>
397
398 <para>To access the help menu of the script:</para>
399
400 <programlisting>./log-collector.sh -h</programlisting>
401 </section>
402</chapter> \ No newline at end of file
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
deleted file mode 100644
index 1d51537..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml
+++ /dev/null
@@ -1,711 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="net_config_operations">
3 <title>Network Configuration Options</title>
4
5 <para>Various Advanced Network Configuration options can be done from Enea
6 uCPE Manager GUI.</para>
7
8 <section id="device_callhome_nat">
9 <title>Device Call Home Connection for Deployment behind NAT</title>
10
11 <para>The Device Call Home option enables the initiation of the connection
12 between the uCPE Device and the Enea uCPE Manager, from the uCPE device.
13 The Device Call Home option is required when deploying a uCPE device
14 behind NAT since the IP address of the uCPE device is hidden for the Enea
15 uCPE Manager.</para>
16
17 <para>Enable Device Call Home by marking the Device Call Home checkbox
18 when registering the uCPE device in Enea uCPE Manager. When using this
19 mechanism, the device will initiate a connection to the Enea uCPE Manager
20 for NETCONF traffic (over SSH), while the Enea uCPE Manager waits for a
21 device connection.</para>
22 </section>
23
24 <section id="device_net_config">
25 <title>uCPE Device Network Configuration</title>
26
27 <para>The following describes the steps required for setting up the
28 virtualization infrastructure, ensuring that a uCPE device has networking
29 setup for virtualized service deployment. Networking is enabled by
30 selecting physical interfaces to be used by virtualized networking and
31 creating different types of bridges to enable VNF communication.</para>
32
33 <para>The Zero Touch Provisioning mechanism is also touched upon, as
34 alternative to manual configuration of the virtualization
35 infrastructure.</para>
36
37 <section id="config_dpdk">
38 <title>Configure DPDK</title>
39
40 <para>DPDK is an important functionality for accelerating networking
41 performance. The DPDK is enabled by default and should be utilized in
42 most configurations.</para>
43
44 <para>In use cases where CPU capacity is very limited, disabling DPDK
45 can free up CPU capacity and overall performance can improve. Navigate
46 to <literal>Configuration</literal> -&gt; <literal>DPDK</literal> and
47 deselect <literal>Enable DPDK</literal> to disable the DPDK.</para>
48
49 <note>
50 <para>Disabling the DPDK cannot be done after other network
51 configurations have been made.</para>
52 </note>
53
54 <para>In <literal>Configuration</literal> -&gt; <literal>DPDK</literal>
55 it is also possible to configure DPDK resources such as:</para>
56
57 <itemizedlist>
58 <listitem>
59 <para><emphasis role="bold">LCore Mask</emphasis>. Allocated cores
60 for non-datapath OVS-DPDK threads (CPU core bitmask). Default:
61 0x2.</para>
62 </listitem>
63
64 <listitem>
65 <para><emphasis role="bold">PMD CPU Mask</emphasis>. Allocated cores
66 for datapath processing (CPU core bitmask). Default: 0x4.</para>
67 </listitem>
68
69 <listitem>
70 <para><emphasis role="bold">Socket Memory</emphasis>. Hugepage
71 memory allocated for DPDK. Default: 1494.</para>
72 </listitem>
73 </itemizedlist>
74 </section>
75
76 <section id="config_ext_interfaces">
77 <title>Configure External Interfaces</title>
78
79 <para>Once a management connection with the uCPE device has been
80 established by using any of the supported methods, the virtualization
81 networking infrastructure can be configured either manually or by using
82 Zero Touch Provisioning.</para>
83
84 <para>Available network interfaces can be added to the management
85 system, for use by the networking virtualization infrastructure.</para>
86
87 <para>In order to make physical network interfaces available to the
88 virtualization infrastructure and VNFs, they must be configured into the
89 management system.</para>
90
91 <para>To add an interface into the Enea uCPE Manager, select the uCPE
92 device, then from the top toolbar select <literal>Configuration -&gt;
93 External Interfaces -&gt; Configuration -&gt; Add</literal>. The
94 available Interface types are detailed below.</para>
95
96 <section id="dpdk_interface_type">
97 <title>DPDK Interface Type</title>
98
99 <para>Configuring a physical interface in DPDK mode will require a
100 DPDK-based application (e.g. OVS-DPDK) in order to access and use the
101 interface. An interface set as DPDK can be attached to an OVS-DPDK
102 bridge.</para>
103
104 <note>
105 <para>Make sure the <literal>Enable DPDK</literal> checkbox is
106 selected in <literal>Device -&gt; Configuration -&gt;
107 DPDK</literal>, otherwise no interface can be assigned as
108 DPDK.</para>
109 </note>
110
111 <para>To add a DPDK interface under the management system, set
112 appropriate values for the following fields:</para>
113
114 <itemizedlist>
115 <listitem>
116 <para>Source: name of the physical interface.</para>
117 </listitem>
118
119 <listitem>
120 <para>Networking-type: dpdk</para>
121 </listitem>
122
123 <listitem>
124 <para>Dpdk-type: the kernel module that allows user space access
125 to the physical interface. Either the <literal>vfio-pci</literal>
126 (most commonly used type) or the <literal>igb_uio</literal> driver
127 can be used.</para>
128 </listitem>
129 </itemizedlist>
130 </section>
131
132 <section id="sriov_interface_type">
133 <title>SR-IOV Interface Type</title>
134
135 <para>SR-IOV technology allows for the creation of a number of virtual
136 functions on the host interface, which can be used by VNFs running on
137 the uCPE device.</para>
138
139 <para>For SR-IOV mode configuration, the user must set values for the
140 following fields:</para>
141
142 <itemizedlist>
143 <listitem>
144 <para>Source: name of the physical interface.</para>
145 </listitem>
146
147 <listitem>
148 <para>Networking-type: srIov</para>
149 </listitem>
150
151 <listitem>
152 <para>sriov-mode: adapter-pool</para>
153 </listitem>
154
155 <listitem>
156 <para>sriov-num-vfs: the number of virtual functions to
157 create.</para>
158 </listitem>
159 </itemizedlist>
160 </section>
161
162 <section id="standard_interface_type">
163 <title>Standard Interface Type</title>
164
165 <para>Some of the physical network interfaces available on a uCPE
166 device, including Ethernet interfaces, do not have DPDK or SR-IOV
167 support. Instead, the Linux kernel driver has to be used.</para>
168
169 <para>To add Standard Interfaces under the management system, the user
170 must set values for the following fields:</para>
171
172 <itemizedlist>
173 <listitem>
174 <para>Source: the name of physical interface.</para>
175 </listitem>
176
177 <listitem>
178 <para>Networking-type: standard.</para>
179 </listitem>
180 </itemizedlist>
181 </section>
182
183 <section id="wan_interface_type">
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>
191
192 <para>If a WAN interface is to be assigned for use by a VNF, it must
193 be changed into another interface type depending on the type of
194 connection that will be used. The management WAN interface cannot be
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>
231
232 <note>
233 <para>When changing the <literal>address-assignment</literal> from
234 static to DHCP, if any of the <literal>ip-address</literal>,
235 <literal>netmask</literal> or <literal>gateway</literal> fields have
236 invalid values a validation error will be triggered. These fields
237 must be empty or have the valid values for their respective address
238 assignment.</para>
239 </note>
240 </section>
241
242 <section id="man_configuration">
243 <title>Manual Configuration</title>
244
245 <para>For Manual Configuration of uCPE networking, select the uCPE
246 device first and then <literal>Configuration</literal> -&gt;
247 <literal>External Interfaces</literal>, where one can find a list of
248 available network interfaces and their capabilities.</para>
249
250 <para>After networking interfaces have been added to the Enea uCPE
251 Manager, the user can change the interface type (DPDK, SR-IOV,
252 Standard, WAN).</para>
253
254 <figure>
255 <title>Configuration of External Interfaces</title>
256
257 <mediaobject>
258 <imageobject>
259 <imagedata align="center" contentwidth="600"
260 fileref="images/edit_inter_config.png" />
261 </imageobject>
262 </mediaobject>
263 </figure>
264 </section>
265 </section>
266
267 <section id="configure_bridges">
268 <title>Configuring Bridges</title>
269
270 <para>After networking interfaces have been added to the Enea uCPE
271 Manager, the user can create the necessary OVS bridges.</para>
272
273 <figure>
274 <title>OVS Bridges</title>
275
276 <mediaobject>
277 <imageobject>
278 <imagedata align="center" contentwidth="600"
279 fileref="images/ovs_bridges_tab.png" />
280 </imageobject>
281 </mediaobject>
282 </figure>
283
284 <para><emphasis role="bold">How to add OVS bridges in the Enea uCPE
285 Manager</emphasis></para>
286
287 <orderedlist>
288 <listitem>
289 <para>Select the uCPE device.</para>
290 </listitem>
291
292 <listitem>
293 <para>Select <literal>Configuration</literal>.</para>
294 </listitem>
295
296 <listitem>
297 <para>Click <literal>OpenvSwitch</literal>.</para>
298 </listitem>
299
300 <listitem>
301 <para>Select the <literal>Bridges</literal> option, then click
302 <literal>Add</literal>.</para>
303 </listitem>
304 </orderedlist>
305
306 <note>
307 <para>Depending on the settings in <literal>Configuration -&gt;
308 OpenVSwitch -&gt; DPDK</literal>, OVS bridges with or without DPDK
309 support will be used on the uCPE device.</para>
310 </note>
311
312 <para>There are three types of bridges which can be created, each one
313 fulfiling a different role.</para>
314
315 <section id="inband_mg_bridge">
316 <title>uCPE In-band Management bridge</title>
317
318 <para>In-band Management refers to a model where both the data plane
319 and control plane flow over the same network path. In some situations
320 (e.g. the uCPE device has only one routable IP address), this is the
321 only option available to both control and configure the uCPE device,
322 while also allowing for data-path traffic to pass over the same
323 physical interface.</para>
324
325 <para>The solution provided by Enea for in-band management is based
326 upon an OpenvSwitch bridge managing all traffic passing through the
327 WAN physical port. Any standard or DPDK-assigned network interface can
328 be used for the In-Band management bridge.</para>
329
330 <para>To create the In-Band Management bridge, the user must set
331 values for the following fields:</para>
332
333 <itemizedlist>
334 <listitem>
335 <para>name: name of the bridge.</para>
336 </listitem>
337
338 <listitem>
339 <para>ovs-bridge-type: inbandMgmt</para>
340 </listitem>
341 </itemizedlist>
342 </section>
343
344 <section id="inband_mg_br_vnfs">
345 <title>In-band Management bridge for VNFs</title>
346
347 <para>If VNF management can be done over a dedicated virtual
348 interface, its possible to extend the networking infrastructure
349 configuration to also access the VNF's management interface over the
350 WAN port.</para>
351
352 <para>For this setup, three types of traffic will pass over the WAN
353 physical interface:</para>
354
355 <itemizedlist>
356 <listitem>
357 <para><emphasis role="bold">Device management</emphasis>. Part of
358 the device configuration done by the Enea uCPE Manager.</para>
359 </listitem>
360
361 <listitem>
362 <para><emphasis role="bold">VNF(s) management</emphasis>. Enabling
363 or disabling features of a VNF. E.g. enabling/disabling the
364 firewall or VPN setup.</para>
365 </listitem>
366
367 <listitem>
368 <para><emphasis role="bold">Data-path</emphasis>. All other
369 traffic that is not used in the control plane and needs to reach a
370 LAN network.</para>
371 </listitem>
372 </itemizedlist>
373
374 <para>To create a VNF In-Band Management bridge, the user must set
375 values for the following fields:</para>
376
377 <itemizedlist>
378 <listitem>
379 <para>name: name of the bridge.</para>
380 </listitem>
381
382 <listitem>
383 <para>ovs-bridge-type: vnfMgmt</para>
384 </listitem>
385
386 <listitem>
387 <para>vnf-mgmt-address: select IPv4 as the type and fill in an
388 internal IP address for the bridge interface that will be
389 connected to the VNF management network, e.g 10.0.0.1.</para>
390 </listitem>
391 </itemizedlist>
392
393 <note>
394 <para>VNF management interfaces must be configured in same subnet as
395 that used by the bridge interface connected to the VNF management
396 network.</para>
397 </note>
398 </section>
399
400 <section id="dataplane_bridge">
401 <title>Data-plane bridge</title>
402
403 <para>Data-plane bridges are generic bridges used for the VNF
404 data-plane. There are two supported sub-types:</para>
405
406 <itemizedlist>
407 <listitem>
408 <para><emphasis role="bold">communication</emphasis>: allows for
409 VNF communication towards LAN/WAN networks. This bridge type has
410 at least one physical port attached to it.</para>
411 </listitem>
412
413 <listitem>
414 <para><emphasis role="bold">integration</emphasis>: allows for
415 VNF-to-VNF communication (usually for service function chaining).
416 This bridge type does not have any physical port attached.</para>
417 </listitem>
418 </itemizedlist>
419
420 <para>To create a Data-plane bridge, the user must set values for the
421 following fields:</para>
422
423 <itemizedlist>
424 <listitem>
425 <para>name: name of the bridge.</para>
426 </listitem>
427
428 <listitem>
429 <para>ovs-bridge-type: select <literal>communication</literal> or
430 <literal>integration</literal>, depending on intended usage. For
431 communication bridges, physical interfaces can be added to the
432 bridge.</para>
433 </listitem>
434 </itemizedlist>
435 </section>
436 </section>
437 </section>
438
439 <section id="zero_touch_prov">
440 <title>Zero Touch Provisioning - Creating an Offline Configuration</title>
441
442 <para>Zero-Touch Provisioning (ZTP) refers to the process of when a device
443 starts up for the first time and its initial configuration is pushed down
444 by an external management system, so that it is setup for proper operation
445 without additional manual intervention by an operator. ZTP is an
446 alternative to Manual configuration.</para>
447
448 <para>A variety of operations can occur as part of ZTP such as initial
449 device setup, configuration of managed objects, etc. The goal is to set up
450 a device to the maximum possible extent without forcing an operator to be
451 physically present (initially) to manage the device.</para>
452
453 <para>An offline configuration is usually prepared in advance for the Enea
454 uCPE Manager to setup the virtualization infrastructure on the uCPE
455 device, as soon as a device enrolls into the management system.</para>
456
457 <section id="offline_configuration">
458 <title>Offline Configuration</title>
459
460 <para>The Offline Configuration subsystem is used to pre-populate a
461 configuration for a device that will be brought under management at a
462 future point in time. When creating an offline configuration store a
463 <literal>Device ID</literal> can be specified. This ID uniquely
464 identifies the device to be initialized.</para>
465
466 <para>Alternatively, a wildcard can be used in the <literal>Device
467 ID</literal> field, which results in a configuration being pushed on all
468 uCPE devices upon their initial connection towards the Enea uCPE
469 Manager.</para>
470
471 <para>If the offline configuration is not configured for a uCPE device,
472 an alarm will be raised: <literal>Day-0 Config:ZTP:Major</literal>,
473 which occurs when the uCPE device connects to the Enea uCPE Manager
474 informing that the ZTP setup failed for the specific uCPE device.</para>
475
476 <para>To create an offline configuration, from the top toolbar menu
477 select <literal>Applications</literal> -&gt; <literal>Offline
478 Config</literal> -&gt; <literal>Add</literal>. The following fields
479 should be filled:</para>
480
481 <itemizedlist>
482 <listitem>
483 <para>Name: name of the device.</para>
484 </listitem>
485
486 <listitem>
487 <para>Device type: Enea universal CPE.</para>
488 </listitem>
489
490 <listitem>
491 <para>DeviceVersion: <xi:include
492 href="../../s_doceneacommon/doc/eltf_params_updated.xml"
493 xmlns:xi="http://www.w3.org/2001/XInclude"
494 xpointer="element(EneaLinux_REL_VER/1)" /></para>
495 </listitem>
496
497 <listitem>
498 <para>Config Set: uCPE Config</para>
499 </listitem>
500
501 <listitem>
502 <para>Device ID: device ID or a wildcard(*).</para>
503 </listitem>
504
505 <listitem>
506 <para>Device Grouping Tags: a tag to group devices. These tags match
507 the customer tags provided during the installation of the
508 device.</para>
509 </listitem>
510 </itemizedlist>
511
512 <para>The Name is user defined and can be set to any unique text string
513 identifying the configuration. The Device Version will match the Enea
514 NFV Access version of the uCPE device and the Device ID will be set to
515 the previously set identifier of the uCPE device.</para>
516
517 <para>When a device connects to the Enea uCPE Manager for the first
518 time, it checks the device to see if it has been Zero Touch Provisioned
519 (ZTP). If not, it looks for an offline configuration that matches these
520 values, in the following order:</para>
521
522 <itemizedlist>
523 <listitem>
524 <para>The Device ID.</para>
525 </listitem>
526
527 <listitem>
528 <para>The set of tags.</para>
529 </listitem>
530
531 <listitem>
532 <para>A "*" for Device ID (wildcard).</para>
533 </listitem>
534 </itemizedlist>
535
536 <para>If a match is found, the offline configuration is sent to the
537 device as part of Zero-Touch-Provisioning.</para>
538
539 <para>After creating the Offline Config Store, access the device through
540 <literal>Applications</literal> -&gt; <literal>offline config</literal>
541 -&gt; <literal>Config App</literal> and provision it with the required
542 initial configuration. This operation mirrors what happens during manual
543 configuration described previously.</para>
544
545 <note>
546 <para>The ZTP will only be triggered the first time a uCPE device
547 connects to the Enea uCPE Manager. Just changing an offline
548 configuration will not push the new changes to the device. If an
549 offline configuration is changed after uCPE device registration, a
550 factory reset can be executed to force a new ZTP to execute by
551 selecting the device, then <literal>Operations</literal> -&gt;
552 <literal>factory reset</literal>.</para>
553 </note>
554 </section>
555 </section>
556
557 <section id="custom_scripts">
558 <title>Custom Scripts for Custom Networking Configurations</title>
559
560 <para>The custom scripts feature allows users to execute user-defined
561 scripts on the uCPE device at various times.This allows for more flexible
562 and advanced configurations such as a LTE modem configuration, advanced
563 network configurations or OVS flow rule programming at any time.</para>
564
565 <section id="upload_scripts">
566 <title>Uploading Scripts</title>
567
568 <para>The scripts need to be uploaded to the Enea uCPE Manager prior to
569 use. When uploading scripts to the Enea uCPE Manager make sure to select
570 the right script type.</para>
571
572 <para>The following script types are supported:</para>
573
574 <itemizedlist>
575 <listitem>
576 <para><literal>Once-before-startup</literal>. This script will only
577 execute once during the startup.</para>
578 </listitem>
579
580 <listitem>
581 <para><literal>Always-before-startup</literal>. This script will
582 always execute during the startup.</para>
583 </listitem>
584
585 <listitem>
586 <para><literal>Once-after-startup</literal>. This script will only
587 execute once after the system has been started.</para>
588 </listitem>
589
590 <listitem>
591 <para><literal>Always-after-startup</literal>. This script will
592 always execute after the system has been started.</para>
593 </listitem>
594 </itemizedlist>
595
596 <para>Follow the instruction below to upload scripts:</para>
597
598 <orderedlist>
599 <listitem>
600 <para>Select <literal>Devices</literal> -&gt; <literal>Custom
601 Scripts</literal> -&gt; <literal>Configure</literal>.</para>
602 </listitem>
603
604 <listitem>
605 <para>Select <literal>Upload to EMS</literal>.</para>
606 </listitem>
607
608 <listitem>
609 <para>In the <literal>Script Type</literal> menu, select the type
610 the uploaded script should have.</para>
611 </listitem>
612
613 <listitem>
614 <para>Press <literal>Choose File</literal> to select the scripts
615 needed, and then press <literal>Send</literal>.</para>
616 </listitem>
617 </orderedlist>
618 </section>
619
620 <section id="remove_scripts">
621 <title>Removing Scripts</title>
622
623 <para>Follow the instruction below to remove scripts:</para>
624
625 <orderedlist>
626 <listitem>
627 <para>Select <literal>Devices</literal> -&gt; <literal>Custom
628 Scripts</literal> -&gt; <literal>Configure</literal>.</para>
629 </listitem>
630
631 <listitem>
632 <para>Select the script you want to delete from the
633 <literal>Uploaded Scripts</literal> tab and then click
634 <literal>Delete</literal>, which will remove the script immediately
635 from the Enea uCPE Manager.</para>
636 </listitem>
637 </orderedlist>
638 </section>
639
640 <section id="configure_scripts">
641 <title>Configuring Script Location</title>
642
643 <para>The location where the scripts are staged in the Enea uCPE Manager
644 can be chanaged as described below:</para>
645
646 <orderedlist>
647 <listitem>
648 <para>Select <literal>Devices</literal> -&gt; <literal>Custom
649 Scripts</literal> -&gt; <literal>Configure</literal>.</para>
650 </listitem>
651
652 <listitem>
653 <para>Select the <literal>Configuration</literal> tab and specify a
654 new loacation to store the scripts.</para>
655
656 <note>
657 <para>Change the script storage location only if you have many
658 scripts which you would prefer to store on another partition,
659 otherwise leave this configuration as is.</para>
660 </note>
661 </listitem>
662 </orderedlist>
663 </section>
664
665 <section id="run_the_scripts">
666 <title>Running the Scripts</title>
667
668 <para><emphasis role="bold">How to run Custom Scripts</emphasis></para>
669
670 <orderedlist>
671 <listitem>
672 <para>Select <literal>Devices</literal> -&gt; <literal>Custom
673 Scripts</literal> -&gt; <literal>Apply Scripts</literal>.</para>
674 </listitem>
675
676 <listitem>
677 <para>In the <literal>Script Config Screen</literal> pop up, select
678 the devices from the device(s) chooser list on which to run the
679 scripts. Press the <literal>&gt;</literal> button to move the
680 devices to the right side of the chooser, which is the list of
681 devices that will execute the selected scripts.</para>
682 </listitem>
683
684 <listitem>
685 <para>Select the scripts from the list under the device(s) chooser
686 by pressing the <literal>+</literal> button.</para>
687 </listitem>
688
689 <listitem>
690 <para>In the pop-up window, select the scripts from the list. If
691 there are no scripts to select, then there is no script uploaded
692 with that particular type. Upload the script(s) needed and try
693 again.</para>
694 </listitem>
695
696 <listitem>
697 <para>Check the checkbox <literal>Reboot devices</literal> if you
698 want to reboot and execute the scripts at once and then press
699 <literal>ok</literal>.</para>
700
701 <note>
702 <para>The status of execution for the scripts can be seen by
703 opening the <literal>Fault</literal> -&gt;
704 <literal>Events</literal> screen and filtering by device and/or
705 the event name <filename>CustomScriptExecuted</filename>.</para>
706 </note>
707 </listitem>
708 </orderedlist>
709 </section>
710 </section>
711</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
deleted file mode 100644
index e176cec..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/troubleshooting.xml
+++ /dev/null
@@ -1,225 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="troubleshooting">
3 <title>Troubleshooting and Recovery</title>
4
5 <para>The following is a small list of possible Enea NFV Access problems,
6 and their solutions. <emphasis role="bold">In all scenarios collect the logs
7 if possible for debugging.</emphasis> More information on log collecting can
8 be found in <olink targetdoc="book_enea_nfv_access_getting_started"
9 targetptr="log_collector">Using the Log Collector in the <xi:include
10 href="../../s_docbuild/olinkdb/pardoc-names.xml"
11 xmlns:xi="http://www.w3.org/2001/XInclude"
12 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
13 Manual.</para>
14
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
17 targetdoc="book_enea_nfv_access_release_info"
18 targetptr="contacting_enea_support">Enea Support team Form, available in the
19 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
20 xmlns:xi="http://www.w3.org/2001/XInclude"
21 xpointer="element(book_enea_nfv_access_release_info/1)" /></olink> Manual
22 downloaded with your release.</para>
23
24 <table>
25 <title>Troubleshooting and Recovery</title>
26
27 <tgroup cols="2">
28 <colspec align="left" />
29
30 <thead>
31 <row>
32 <entry align="center">Enea NFV Access Problem</entry>
33
34 <entry align="center">Solution</entry>
35 </row>
36 </thead>
37
38 <tbody>
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>
57 <entry>The uCPE Device cannot boot after an upgrade.</entry>
58
59 <entry><orderedlist>
60 <listitem>
61 <para>Perform a hardware reboot of the uCPE Device and select
62 the previous Enea NFV Access image from the GRUB menu. This
63 action assumes physical access to the uCPE device.</para>
64 </listitem>
65
66 <listitem>
67 <para>Reinitiate the Upgrade procedure according to the steps
68 in section <olink
69 targetdoc="book_enea_nfv_access_getting_started"
70 targetptr="upgrade_devices">uCPE device upgrades in the
71 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
72 xmlns:xi="http://www.w3.org/2001/XInclude"
73 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
74 Manual.</para>
75 </listitem>
76 </orderedlist></entry>
77 </row>
78
79 <row>
80 <entry>After a failed uCPE device upgrade the previous Enea NFV
81 Access image (from the GRUB menu) does not boot.</entry>
82
83 <entry>Reinstall Enea NFV Access on the uCPE device and redeploy the
84 initial configuration and virtualized services, by following the
85 steps in <olink targetdoc="book_enea_nfv_access_getting_started"
86 targetptr="install_ena_device">Installing Enea NFV Access - uCPE
87 Device installation in the <xi:include
88 href="../../s_docbuild/olinkdb/pardoc-names.xml"
89 xmlns:xi="http://www.w3.org/2001/XInclude"
90 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
91 Manual.</entry>
92 </row>
93
94 <row>
95 <entry>The Enea uCPE Manager upgrade fails and a working snapshot is
96 available.</entry>
97
98 <entry>If a working snapshot obtained during a previous Upgrade or
99 Uninstall is available
100 (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>):
101 <orderedlist>
102 <listitem>
103 <para>Cleanup the current upgrade attempt with:</para>
104
105 <programlisting>./cleanup.sh /opt/ems</programlisting>
106 </listitem>
107
108 <listitem>
109 <para>Restore the previous installation as described in <olink
110 targetdoc="book_enea_nfv_access_getting_started"
111 targetptr="restore_prev_ucpe_install">Restoring a previous
112 uCPE Manager installation in the <xi:include
113 href="../../s_docbuild/olinkdb/pardoc-names.xml"
114 xmlns:xi="http://www.w3.org/2001/XInclude"
115 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
116 Manual.</para>
117 </listitem>
118 </orderedlist></entry>
119 </row>
120
121 <row>
122 <entry>The Enea uCPE Manager upgrade fails and no working snapshot
123 is available, but a System Back-up file exists.</entry>
124
125 <entry><orderedlist>
126 <listitem>
127 <para>Cleanup the current upgrade attempt with:</para>
128
129 <programlisting>./cleanup.sh /opt/ems</programlisting>
130 </listitem>
131
132 <listitem>
133 <para>Perform an installation with the restore option of a
134 previous Enea uCPE Manager configuration as described in
135 <olink targetdoc="book_enea_nfv_access_getting_started"
136 targetptr="install_ucpemg_from_backup">Installation of the
137 uCPE Manager using a System Back-up in the <xi:include
138 href="../../s_docbuild/olinkdb/pardoc-names.xml"
139 xmlns:xi="http://www.w3.org/2001/XInclude"
140 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
141 Manual.</para>
142 </listitem>
143 </orderedlist></entry>
144 </row>
145
146 <row>
147 <entry>The uCPE device is booted, the ssh connection is available
148 but the device is not connected to the Enea uCPE Manager.</entry>
149
150 <entry><orderedlist>
151 <listitem>
152 <para>Perform a hardware reboot on the uCPE device to
153 reinitiate the connection mechanism.</para>
154 </listitem>
155
156 <listitem>
157 <para>Use the <literal>Reconnect</literal> button from the
158 Enea uCPE Manager's GUI.</para>
159 </listitem>
160
161 <listitem>
162 <para>Connect to uCPE Device console and run the factory reset
163 script:</para>
164
165 <programlisting>/usr/local/odm/bin/factory_reset.sh</programlisting>
166 </listitem>
167
168 <listitem>
169 <para>If the above actions do not work, reinstall and
170 reconfigure the device using the steps provided in <olink
171 targetdoc="book_enea_nfv_access_getting_started"
172 targetptr="install_ena_device">Installing Enea NFV Access -
173 uCPE Device installation in the <xi:include
174 href="../../s_docbuild/olinkdb/pardoc-names.xml"
175 xmlns:xi="http://www.w3.org/2001/XInclude"
176 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
177 Manual.</para>
178 </listitem>
179 </orderedlist></entry>
180 </row>
181
182 <row>
183 <entry>The SSH connection to the device cannot be
184 established.</entry>
185
186 <entry>Perform a hardware reboot on the uCPE device. If the problem
187 is not fixed, reinstall and reconfigure the device using the steps
188 provided in <olink targetdoc="book_enea_nfv_access_getting_started"
189 targetptr="install_ena_device">Installing Enea NFV Access - uCPE
190 Device installation in the <xi:include
191 href="../../s_docbuild/olinkdb/pardoc-names.xml"
192 xmlns:xi="http://www.w3.org/2001/XInclude"
193 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
194 Manual.</entry>
195 </row>
196
197 <row>
198 <entry>The VNF Service is not working as expected after
199 reconfiguration (e.g. a VNF chain is malfunctioning).</entry>
200
201 <entry><orderedlist>
202 <listitem>
203 <para>Undo all flows and/or configuration changes in order to
204 move the system to a previously working configuration.</para>
205 </listitem>
206
207 <listitem>
208 <para>Reboot the device using <literal>Operations</literal>
209 -&gt; <literal>Reboot</literal> menu options from within the
210 Enea uCPE Manager.</para>
211 </listitem>
212
213 <listitem>
214 <para>If the above actions do not work, redeploy all services.
215 This is done by cleaning up the existing configuration using:
216 <literal>Operations</literal> -&gt; <literal>Factory
217 Reset</literal> for a specific device and redeploying the VNF
218 services.</para>
219 </listitem>
220 </orderedlist></entry>
221 </row>
222 </tbody>
223 </tgroup>
224 </table>
225</chapter> \ No newline at end of file
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
deleted file mode 100644
index 01fd8ec..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml
+++ /dev/null
@@ -1,545 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="upgrade_ena">
3 <title>Upgrading Enea NFV Access</title>
4
5 <para>Enea provides regular releases that will require the upgrading of Enea
6 NFV Access components. The Enea uCPE Manager must be upgraded first,
7 followed by upgrading Enea NFV Access Runtime on the uCPE devices.</para>
8
9 <section id="upgrade_mg">
10 <title>Upgrading the Enea uCPE Manager</title>
11
12 <note>
13 <para>It is recommended to create a system backup by accessing:
14 <literal>System</literal> -&gt; <literal>System Backup</literal> from
15 the Enea uCPE Manager GUI, for recovery in case of an upgrade
16 failure.</para>
17 </note>
18
19 <orderedlist>
20 <listitem>
21 <para>Extract the
22 <filename>Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</filename>
23 folder.</para>
24
25 <para>The directory in which the archive has been unpacked will be
26 denoted as <literal>&lt;uCPEM-installdir&gt;</literal>.</para>
27 </listitem>
28
29 <listitem>
30 <para>Enter <literal>&lt;uCPEM-installdir&gt;</literal>.</para>
31 </listitem>
32
33 <listitem>
34 <para>Run the following command with the root account and change
35 <literal>/opt/ems</literal> to the correct location of the Enea uCPE
36 Manager installation:</para>
37
38 <programlisting>./upgrade.sh /opt/ems \
39Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programlisting>
40 </listitem>
41 </orderedlist>
42
43 <para>Running this command will:</para>
44
45 <itemizedlist>
46 <listitem>
47 <para>Stop the currently running <literal>ucpemanager</literal>
48 service.</para>
49 </listitem>
50
51 <listitem>
52 <para>Create a compressed file of the <literal>ucpemanager</literal>
53 application folder
54 (<filename>ucpemanager-Back-up-YYYYddMMHHmm.tar.gz</filename>), which
55 contains a snapshot of the existing installation.</para>
56
57 <note>
58 <para>The snapshot file created during the upgrade can be used for
59 restoring the Enea uCPE Manager.</para>
60 </note>
61 </listitem>
62
63 <listitem>
64 <para>Extract the application files from the specified compressed
65 install kit.</para>
66 </listitem>
67
68 <listitem>
69 <para>Start the <literal>ucpemanager</literal> service.</para>
70 </listitem>
71 </itemizedlist>
72
73 <section id="restore_prev_ucpe_install">
74 <title>Restoring a previous Enea uCPE Manager Installation</title>
75
76 <para><emphasis role="bold">How to restore a previous Enea uCPE Manager
77 installation</emphasis></para>
78
79 <orderedlist>
80 <listitem>
81 <para>Extract
82 <filename>Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</filename></para>
83 </listitem>
84
85 <listitem>
86 <para>The directory in which the archive has been unpacked will be
87 denoted as <literal>&lt;uCPEM-installdir&gt;</literal>.</para>
88 </listitem>
89
90 <listitem>
91 <para>Copy the snapshot file
92 (<filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>)
93 created during a previous Enea uCPE Manager Upgrade or Enea uCPE
94 Manager Uninstall Operation into the
95 <literal>&lt;uCPEM-installdir&gt;</literal> directory.</para>
96 </listitem>
97
98 <listitem>
99 <para>Enter <literal>&lt;uCPEM-installdir&gt;</literal>.</para>
100 </listitem>
101
102 <listitem>
103 <para>Run the following command with the root user and change
104 <literal>/opt/ems</literal> to the correct location of the Enea uCPE
105 Manager installation:</para>
106
107 <programlisting>./restore.sh /opt/ems ucpemanager-Backup-YYYYddMMHHmm.tar.gz</programlisting>
108 </listitem>
109 </orderedlist>
110
111 <para>Running this command will:</para>
112
113 <itemizedlist>
114 <listitem>
115 <para>Remove any vestiges of the existing
116 <literal>ucpemanager</literal> service, if they exist.</para>
117 </listitem>
118
119 <listitem>
120 <para>Reinstall the Enea uCPE Manager application on the specified
121 target location, restoring the data in the database and files in the
122 process.</para>
123 </listitem>
124 </itemizedlist>
125
126 <para>The <literal>ucpemanager</literal> service will then start with
127 the older version now running on the system.</para>
128 </section>
129
130 <section id="uninstall_ucpem_install">
131 <title>Uninstalling an existing Enea uCPE Manager Installation</title>
132
133 <para><emphasis role="bold">How to uninstall an existing Enea uCPE
134 Manager installation</emphasis></para>
135
136 <orderedlist>
137 <listitem>
138 <para>Navigate to the folder where the Enea uCPE Manager is
139 installed: <filename>&lt;uCPEM-installdir&gt;</filename>.</para>
140 </listitem>
141
142 <listitem>
143 <para>Run the following command with the root user and change
144 <literal>/opt/ems</literal> to the correct location of the Enea uCPE
145 Manager installation:</para>
146
147 <programlisting>./uninstall.sh /opt/ems</programlisting>
148 </listitem>
149 </orderedlist>
150
151 <para>Running this command will:</para>
152
153 <itemizedlist>
154 <listitem>
155 <para>Stop the currently running <literal>ucpemanager</literal>
156 service.</para>
157 </listitem>
158
159 <listitem>
160 <para>Create a compressed file of the <literal>ucpemanager</literal>
161 application folder:
162 <filename>ucpemanager-Back-up-YYYYddMMHHmm.tar.gz</filename>, which
163 contains a snapshot of the existing installation and functions as a
164 restore point.</para>
165
166 <note>
167 <para>The snapshot file created during the uninstall can be used
168 for restoring the Enea uCPE Manager.</para>
169 </note>
170 </listitem>
171
172 <listitem>
173 <para>Uninstall the <literal>ucpemanager</literal> service, so that
174 it will not startup on reboot.</para>
175 </listitem>
176
177 <listitem>
178 <para>Uninstall the database service.</para>
179 </listitem>
180
181 <listitem>
182 <para>Completely remove the contents of the application and database
183 folders.</para>
184 </listitem>
185 </itemizedlist>
186
187 <para>After these steps, the Enea uCPE Manager is completely removed
188 from the system.</para>
189 </section>
190 </section>
191
192 <section id="upgrade_devices">
193 <title>uCPE device Upgrades</title>
194
195 <para>A uCPE device can be upgraded using the Enea uCPE Manager
196 GUI.</para>
197
198 <section id="device_up_process">
199 <title>The uCPE device Upgrade Process</title>
200
201 <para>The Device Upgrade/Install option performs the following
202 operations to the uCPE device:</para>
203
204 <orderedlist>
205 <listitem>
206 <para><emphasis role="bold">Prepare for upgrade.</emphasis> This
207 stage prepares the files needed for an upgrade.</para>
208 </listitem>
209
210 <listitem>
211 <para><emphasis role="bold">Install file on device.</emphasis> This
212 stage copies the file to the uCPE device.</para>
213 </listitem>
214
215 <listitem>
216 <para><emphasis role="bold">Upgrade Device.</emphasis> This stage
217 upgrades the uCPE device to a newer version.</para>
218 </listitem>
219 </orderedlist>
220 </section>
221
222 <section id="mg_upgrade">
223 <title>Managing the device Upgrade</title>
224
225 <para>Before an installation or upgrade can be completed, certain
226 configuration data must be set. Files also need to be uploaded to the
227 Device Upgrade image repository to be uploaded to the device.</para>
228
229 <para>Launch the Device Upgrade management console by selecting
230 <literal>Devices</literal> -&gt; <literal>Upgrade</literal> from the top
231 tool-bar. The console will contain the following tabs:</para>
232
233 <itemizedlist>
234 <listitem>
235 <para><literal>Image Library</literal>. To add/delete an
236 image.</para>
237 </listitem>
238
239 <listitem>
240 <para><literal>Upgrade Operations</literal>. See running upgrades,
241 cancel any upgrades in progress, start a uCPE device upgrade.</para>
242 </listitem>
243
244 <listitem>
245 <para><literal>Configuration</literal>. Upgrade configuration
246 parameters.</para>
247 </listitem>
248 </itemizedlist>
249
250 <para>Press Close when the message <literal>File Uploaded
251 Successfully</literal> appears on the File Upload Screen.</para>
252
253 <note>
254 <para>The uCPE Device upgrade is done with image files of type
255 <literal>rootfs.ostree.tar.bz2</literal>, which are available in the
256 <filename>Enea_NFV_Access_Run_Time_Platform_&lt;processor&gt;_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</filename>
257 file you downloaded with your release.</para>
258 </note>
259
260 <section id="image_lib">
261 <title>Image Library</title>
262
263 <para><emphasis role="bold">Adding an image to the image
264 repository/library</emphasis><orderedlist>
265 <listitem>
266 <para>Select <literal>Devices</literal> -&gt;
267 <literal>Upgrade</literal>.</para>
268 </listitem>
269
270 <listitem>
271 <para>Select <literal>Add</literal> from the <literal>Image
272 Library</literal> tab to add a new image file.</para>
273 </listitem>
274
275 <listitem>
276 <para>Click on <literal>Choose File</literal> to provide the
277 path to the image file (must be of type
278 <literal>rootfs.os-tree.tar.bz2</literal>).</para>
279 </listitem>
280
281 <listitem>
282 <para>Select the target hardware platform corresponding to the
283 image being uploaded (<literal>xeon-d</literal> or
284 <literal>atom-c3000</literal>).</para>
285 </listitem>
286
287 <listitem>
288 <para>Click <literal>Send</literal> to upload the image to the
289 image repository.</para>
290 </listitem>
291 </orderedlist></para>
292
293 <para><emphasis role="bold">Deleting an image from the image
294 repository</emphasis></para>
295
296 <orderedlist>
297 <listitem>
298 <para>Select <literal>Devices</literal> -&gt;
299 <literal>Upgrade</literal>.</para>
300 </listitem>
301
302 <listitem>
303 <para>Select the image you want to delete from the <literal>Image
304 Library</literal> tab and then click
305 <literal>Delete</literal>.</para>
306 </listitem>
307 </orderedlist>
308 </section>
309
310 <section id="upgrade_options">
311 <title>Upgrade Operations</title>
312
313 <para>The <literal>Upgrade Operations</literal> tab allows a user to
314 manage uCPE device upgrades in the system. It allows the user to see
315 all the upgrades that are currently in progress, as well as listing
316 the completed ones. If an upgrade succeeds or fails, then a row will
317 be added to the completed upgrades table. If one fails, the failure
318 message will be visible in the table.</para>
319
320 <note>
321 <para>The list of completed upgrade tasks resides in the cache
322 memory and will not persist across reboots of the server.</para>
323 </note>
324
325 <para><emphasis role="bold">How to Install/Upgrade a device
326 immediately or schedule the process for later</emphasis><orderedlist>
327 <listitem>
328 <para>Select <literal>Devices</literal> -&gt;
329 <literal>Upgrade</literal>.</para>
330 </listitem>
331
332 <listitem>
333 <para>Select <literal>Upgrade Devices</literal> from the
334 <literal>Upgrade Operations</literal> tab. This will launch a
335 <literal>Multi Device Install Image</literal> screen that will
336 allow the user to install and upgrade more than one uCPE device
337 at a time or upgrade later.</para>
338 </listitem>
339 </orderedlist></para>
340
341 <para>The configurable parameters are:</para>
342
343 <itemizedlist>
344 <listitem>
345 <para><literal>Scheduling</literal>. Click this checkbox if the
346 upgrade will be done later. Schedule the day, hour and minute for
347 when to run the upgrade.</para>
348
349 <note>
350 <para>The hour represents the local Enea uCPE Manager server
351 hour.</para>
352 </note>
353 </listitem>
354
355 <listitem>
356 <para><literal>Description</literal>. An optional description of
357 the operation. It is recommended to add a description so that
358 different upgrades happening simultaneously can be
359 distinguished.</para>
360 </listitem>
361
362 <listitem>
363 <para><literal>Image File</literal>. Click on <literal>Choose
364 Image File</literal> to select the image file.</para>
365 </listitem>
366
367 <listitem>
368 <para><literal>Devices</literal>. The list of uCPE Devices that
369 can accept an image file is populated when the image file is
370 chosen.</para>
371
372 <para>Press the <literal>&gt;</literal> button to move the uCPE
373 devices to the right side of the selector. Those chosen form the
374 list of uCPE devices that will be upgraded.</para>
375 </listitem>
376
377 <listitem>
378 <para>Upgrade Operation. The available options are:</para>
379
380 <itemizedlist>
381 <listitem>
382 <para><literal>Install and Activate</literal>. This will do an
383 image installation as well as an upgrade.</para>
384 </listitem>
385
386 <listitem>
387 <para><literal>Install Only</literal>. This will do an image
388 installation only. The image is copied to the uCPE device, and
389 an upgrade will be done later either at a scheduled time or
390 when the option <literal>Activate Only</literal> is
391 selected.</para>
392 </listitem>
393
394 <listitem>
395 <para><literal>Activate Only</literal>. This will activate an
396 already installed image on the uCPE device.</para>
397 </listitem>
398 </itemizedlist>
399 </listitem>
400 </itemizedlist>
401
402 <note>
403 <para>When the uCPE device activates the upgrade, it will be
404 rebooted automatically.</para>
405 </note>
406 </section>
407
408 <section id="releases_installed">
409 <title>Releases installed on a uCPE device</title>
410
411 <para>The installed releases on a uCPE device can be viewed by
412 selecting the uCPE device first, then from the top toolbar selecting
413 <literal>Configuration</literal> -&gt;
414 <literal>Upgrade</literal>.</para>
415
416 <para>The installed releases on the uCPE device, the release status,
417 release state, <literal>commit-id</literal> and release version will
418 be listed in a table.</para>
419 </section>
420
421 <section id="upgrade_status">
422 <title>uCPE device Upgrade Status</title>
423
424 <para>The status of the installation and upgrade can be viewed in the
425 <literal>Upgrade Operations</literal> tab. Ongoing or scheduled
426 upgrade operations can be viewed or cancelled.</para>
427
428 <para><emphasis role="bold">To view the status of an installation or
429 upgrade operations</emphasis></para>
430
431 <orderedlist>
432 <listitem>
433 <para>Select <literal>Devices</literal> -&gt;
434 <literal>Upgrade</literal>.</para>
435 </listitem>
436
437 <listitem>
438 <para>Select <literal>Upgrade Operations</literal>. The ongoing
439 operations are listed at the top and a history of failed or
440 successful operations are listed at the bottom.</para>
441 </listitem>
442
443 <listitem>
444 <para>Select an <literal>Active</literal> or <literal>Completed
445 Upgrade Operation</literal> and click the <literal>Device
446 Status</literal> button to see detailed information regarding the
447 upgrade operation, including the uCPE devices involved and
448 information per uCPE device.</para>
449 </listitem>
450 </orderedlist>
451
452 <para><emphasis role="bold">To cancel an upgrade
453 operation</emphasis></para>
454
455 <orderedlist>
456 <listitem>
457 <para>Select <literal>Devices</literal> -&gt;
458 <literal>Upgrade</literal> -&gt; <literal>Upgrade
459 Operations</literal>.</para>
460 </listitem>
461
462 <listitem>
463 <para>Select an operation from the list and press <literal>Cancel
464 Upgrade</literal> and <literal>Confirm</literal>. The operation
465 will then be deleted from the list.</para>
466 </listitem>
467 </orderedlist>
468 </section>
469
470 <section id="config">
471 <title>Configuration</title>
472
473 <note>
474 <para>The default values present in the configuration of each uCPE
475 device are recommended for use. Modifying them is for an Advanced
476 User only.</para>
477 </note>
478
479 <para><emphasis role="bold">How to Configure the uCPE device
480 Upgrade</emphasis><orderedlist>
481 <listitem>
482 <para>Select <literal>Devices</literal> -&gt;
483 <literal>Upgrade</literal>.</para>
484 </listitem>
485
486 <listitem>
487 <para>Select <literal>Configuration</literal>.</para>
488 </listitem>
489
490 <listitem>
491 <para>The configurable parameters are:</para>
492
493 <itemizedlist>
494 <listitem>
495 <para><literal>deviceImageDir</literal>. This is the disk
496 location of the device image repository.</para>
497
498 <note>
499 <para>If no absolute path name is given it is assumed to
500 be relative to the installation directory.</para>
501 </note>
502 </listitem>
503
504 <listitem>
505 <para><literal>maxThreads</literal>. This number dictates
506 how many upgrades the system can manage at one time, either
507 individually launched or launched from the multi-device
508 screens. This value defaults to 20, which means that 20 uCPE
509 devices may be updated at one time.</para>
510 </listitem>
511
512 <listitem>
513 <para><literal>KeepAlive</literal>. This number represents
514 the number of seconds that a thread will be kept alive
515 before it is collected. If multiple installations are
516 occurring, this will keep the thread alive for X seconds
517 before it is released. If not released, it can be used by
518 the internal scheduling system as soon as it has completed
519 an upgrade.</para>
520 </listitem>
521 </itemizedlist>
522 </listitem>
523 </orderedlist></para>
524 </section>
525
526 <section id="related_functionality">
527 <title>Related Functionality for a uCPE device Upgrade</title>
528
529 <para>Each uCPE device can receive image files and use them to
530 upgrade. This can be done by selecting the uCPE device in the
531 <literal>System</literal> view and clicking the
532 <literal>Upgrade</literal> button. In the new window, an upgrade image
533 can be chosen from the <literal>Image Files</literal> tab by selecting
534 the image file from the list and clicking the <literal>Install on
535 Device</literal> button.</para>
536
537 <para>Once an image is installed on the uCPE device, the image will be
538 available on the uCPE device and be visible in the
539 <literal>Releases</literal> tab. It can then be selected from the list
540 and the upgrade started by clicking the <literal>Upgrade</literal>
541 button.</para>
542 </section>
543 </section>
544 </section>
545</chapter> \ No newline at end of file
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
deleted file mode 100644
index 2dfe248..0000000
--- a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml
+++ /dev/null
@@ -1,476 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="vnf_mg">
3 <title>VNF Management</title>
4
5 <para>The Enea uCPE Manager is responsible for onboarding, configuring (e.g.
6 CloudInit) and ensuring life cycle management of VNFs that are instantiated
7 and run on the various uCPE devices.</para>
8
9 <section id="onboarding_a_vnf">
10 <title>Onboarding a VNF</title>
11
12 <para>The onboarding of a VNF means adding it to the Enea uCPE Manager VNF
13 Catalogue and preparing it for instantiation (deployment on connected uCPE
14 devices). This is accomplished using the Enea uCPE Manager Onboarding
15 graphical user interface.</para>
16
17 <para>Typically, the Getting Started Guide of a VNF, provided by the VNF
18 vendor, contains all necessary information needed to onboard a VNF.</para>
19
20 <section id="retrieve_art">
21 <title>Retrieving Artifacts</title>
22
23 <para>The user must first retrieve the necessary artifacts from the VNF
24 vendor:</para>
25
26 <orderedlist>
27 <listitem>
28 <para>Download the VNF from the commercial vendor.</para>
29 </listitem>
30
31 <listitem>
32 <para>Procure any VNF-specific files from the VNF vendor, e.g.
33 license file.</para>
34
35 <note>
36 <para>There are no standard ways of managing VNF licenses,
37 therefore no general guidelines can be provided. One example of
38 license handling that can be employed in the Enea uCPE Manager is
39 the adding of a license during the Cloud-Init setup.</para>
40 </note>
41 </listitem>
42
43 <listitem>
44 <para>Optionally, get access to the VNF specific VNF Manager for day
45 1 and 2 configuration (in cloud or for local deployment).</para>
46 </listitem>
47
48 <listitem>
49 <para>Procure the Getting Started Guide from the VNF vendor,
50 preferably for KVM deployment for VNF specific configuration
51 information.</para>
52 </listitem>
53 </orderedlist>
54 </section>
55
56 <section id="onboard_prep">
57 <title>Preparation</title>
58
59 <para>Once all needed downloadables, documentation and more have been
60 attained, preparation for onboarding must be completed:</para>
61
62 <orderedlist>
63 <listitem>
64 <para>Determine the use-case and performance requirements of the VNF
65 you wish to deploy:</para>
66
67 <itemizedlist spacing="compact">
68 <listitem>
69 <para>This decides what resources the VNF is configured for,
70 along with networking and day zero configurations.</para>
71
72 <note>
73 <para>Generally, the Getting Started Guide for the VNF
74 provides guidelines for resource allocation, but since
75 performance is dependent on hardware capacity, the right
76 resource allocation for deployment is determined through
77 benchmarking.</para>
78 </note>
79 </listitem>
80
81 <listitem>
82 <para>Determine the amount of hardware resources needed for the
83 VNF (RAM, number of CPUs and storage size).</para>
84 </listitem>
85
86 <listitem>
87 <para>Determine how many Virtual Network Interfaces the VNF will
88 use.</para>
89 </listitem>
90 </itemizedlist>
91 </listitem>
92
93 <listitem>
94 <para>Determine the Day-0 configuration method from the VNF Getting
95 Started guidelines.</para>
96
97 <note>
98 <para>For many VNFs, day zero configuration can be skipped in
99 early onboarding efforts when automation is not of
100 importance.</para>
101 </note>
102 </listitem>
103
104 <listitem>
105 <para>Determine any requirements needed by the Cloud-Init file
106 structure and the content needed when this structure is used.</para>
107 </listitem>
108 </orderedlist>
109 </section>
110
111 <section id="onboard_in_ucpemg">
112 <title>Onboarding into the Enea uCPE Manager</title>
113
114 <para><emphasis role="bold">How to onboard a VNF into the Enea uCPE
115 Manager </emphasis></para>
116
117 <orderedlist>
118 <listitem>
119 <para>Select from the top toolbar <literal>VNF</literal> -&gt;
120 <literal>Descriptors</literal></para>
121 </listitem>
122
123 <listitem>
124 <para>Click the <literal>On-board</literal> button.</para>
125 </listitem>
126
127 <listitem>
128 <para>When prompted by the UI, make sure the <literal>VM
129 Image</literal> radio button at the top of the onboarding screen is
130 selected, it will trigger a popup menu window.</para>
131 </listitem>
132 </orderedlist>
133
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
136 Onboard button, the Enea uCPE Manager will create the VNF descriptor and
137 add it to its VNF Catalog.</para>
138
139 <figure>
140 <title>Onboard a VNF</title>
141
142 <mediaobject>
143 <imageobject>
144 <imagedata align="center" contentwidth="600"
145 fileref="images/onboard_a_vnf_image.png" />
146 </imageobject>
147 </mediaobject>
148 </figure>
149
150 <para><emphasis role="bold">Main fields</emphasis></para>
151
152 <itemizedlist>
153 <listitem>
154 <para><emphasis role="bold">VM Image File</emphasis>. This is the
155 Virtual Machine image file for the VNF. Typically, it is a QCOW
156 image. Press <literal>Choose File</literal> and select the image you
157 wish to upload.</para>
158 </listitem>
159
160 <listitem>
161 <para><emphasis role="bold">Image Format</emphasis>. Select the
162 format which matches the image file format.</para>
163 </listitem>
164
165 <listitem>
166 <para><emphasis role="bold">VNF Type Name</emphasis>. This is the
167 name that will be used to identify this VNF. It will be shown in the
168 VNFs list.</para>
169 </listitem>
170
171 <listitem>
172 <para><emphasis role="bold">Description</emphasis>. This field
173 contains any description provided and is only displayed in the GUI
174 tables in the Enea uCPE Manager.</para>
175 </listitem>
176
177 <listitem>
178 <para><emphasis role="bold">Version</emphasis>. This is the version
179 of the current VNF that you are hosting. It's used to distinguish
180 this VNF from other versions of the same type.</para>
181 </listitem>
182
183 <listitem>
184 <para><emphasis role="bold">Memory in MB</emphasis>. This is the
185 amount of memory (in megabytes) that will be provided to this type
186 of VNF when it is instantiated. To determine the value for this
187 field, consult the VNF vendor.</para>
188 </listitem>
189
190 <listitem>
191 <para><emphasis role="bold">Num of CPUs</emphasis>. The number of
192 CPUs that will be dedicated to an instance of this VNF when created.
193 To determine the value for this field, consult the VNF
194 vendor.</para>
195 </listitem>
196
197 <listitem>
198 <para><emphasis role="bold">Storage in GB</emphasis>. How much disk
199 space to provide an instance of this VNF. To determine the value for
200 this field, consult the VNF vendor.</para>
201 </listitem>
202 </itemizedlist>
203
204 <para><emphasis role="bold">Interfaces Tab</emphasis></para>
205
206 <para>Click on the <literal>Interfaces</literal> tab to show the
207 Interfaces table.</para>
208
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
211 determine which and how many are required. Each interface requires a
212 name, and optionally a description, used only by the Enea uCPE
213 Manager.</para>
214
215 <note>
216 <para>CAUTION: The user MUST conserve the same order for the virtual
217 interfaces during both onboarding and instantiation phases.</para>
218 </note>
219
220 <para><emphasis role="bold">Cloud Init Tab</emphasis></para>
221
222 <para>Click the <literal>Cloud Init</literal> tab to provide the
223 Cloud-Init configuration. There are three fields that need to be
224 populated:</para>
225
226 <orderedlist>
227 <listitem>
228 <para><emphasis role="bold">Cloud-Init Datasource</emphasis></para>
229
230 <para>To onboard a VNF you must specify the <literal>Cloud-Init
231 Datasource</literal> that the VNF uses. This information is procured
232 from the VNF Vendor. Choose one of the following methods to specify
233 the datasource:</para>
234
235 <itemizedlist spacing="compact">
236 <listitem>
237 <para><emphasis role="bold">None</emphasis>. If there is no
238 datasource.</para>
239 </listitem>
240
241 <listitem>
242 <para><emphasis role="bold">ConfigDrive</emphasis>. This method
243 allows you to provide any number of content-data files
244 containing Cloud-Init data.</para>
245 </listitem>
246
247 <listitem>
248 <para><emphasis role="bold">NoCloud</emphasis>. This is a
249 simpler method that uses only one cloud init file
250 (User-Data).</para>
251 </listitem>
252
253 <listitem>
254 <para><emphasis role="bold">ISO</emphasis>. Pre-cooked
255 cloud-init image. This image must be created by the user
256 according to VNF requirements.</para>
257 </listitem>
258 </itemizedlist>
259 </listitem>
260
261 <listitem>
262 <para><emphasis role="bold">Cloud-Init Disk Type</emphasis></para>
263
264 <para>The <literal>Cloud-Init Disk Type</literal> field must be set
265 to either <literal>Disk</literal>, or <literal>CD-ROM</literal>,
266 depending on what the VNF requires. You can get this information
267 from the VNF Vendor.</para>
268 </listitem>
269
270 <listitem>
271 <para><emphasis role="bold">Content Files Table</emphasis></para>
272
273 <para>The <literal>Content Files Table</literal> is ONLY used if
274 <literal>ConfigDrive</literal> is chosen as the Cloud-Init
275 Datasource. For each content file added, a <literal>Path</literal>
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
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
280 files will be added to the cloud-init image that the user provides
281 at the instantiation of the VNF. If the cloud-init image is not
282 provided, no Cloud-Init Data Source will be created for that VNF and
283 there will be no warning.</para>
284 </listitem>
285 </orderedlist>
286
287 <para>Consult with the VNF vendor to determine what is required for the
288 VNF you are onboarding.</para>
289
290 <para><emphasis role="bold">Properties Tab</emphasis></para>
291
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
294 default values in the <filename>domain.xml</filename> file used by
295 <literal>libvirt/virsh</literal> (running in Enea NFV Access) when
296 creating an instance of the VNF. Consult with the VNF Vendor or ENEA
297 support for values needed by specific VNFs.</para>
298
299 <para><emphasis role="bold">Property Values</emphasis></para>
300
301 <itemizedlist>
302 <listitem>
303 <para><literal>numHugePages</literal> defines the number of huge
304 memory pages the VNF uses (for DPDK).</para>
305 </listitem>
306
307 <listitem>
308 <para><literal>vnfMgmtIpAddress</literal>: the IP address of the
309 VNF's management interface, connected to a
310 <literal>vnfMgmt</literal> bridge (e.g. 10.0.0.2).</para>
311 </listitem>
312
313 <listitem>
314 <para><literal>internalMgmtPort</literal>: the VNF's TCP/UDP port
315 used for management (e.g. 443).</para>
316 </listitem>
317
318 <listitem>
319 <para><literal>externalMgmtPort</literal>: the Management port used
320 for external access (e.g. 60001).</para>
321 </listitem>
322 </itemizedlist>
323
324 <note>
325 <para>The last three properties are useful in conjuction with the
326 <literal>vnfMgmt</literal> bridge type. They allow the user to map the
327 internal VNF management port to an external port, useful for VNF
328 configuration from WAN.</para>
329
330 <para>In the previous example, the internal TCP port 443 (HTTPS) was
331 mapped to the external port 60001, which allows the user to access the
332 VNF management port from a web browser e.g.
333 <literal>https://&lt;WAN_IP&gt;:60001</literal>.</para>
334 </note>
335 </section>
336 </section>
337
338 <section id="instantiating_a_vnf">
339 <title>Instantiating a VNF</title>
340
341 <para>When a VNF is onboarded and available in the VNF catalog, it can be
342 instantiated on connected uCPE devices. The configurations provided when
343 the VNF is onboarded, serve as a template for instantiation. Before
344 instantiating any VNF, please make sure the available storage space on the
345 uCPE device is big enough to accommodate the VNF you need to
346 instantiate.</para>
347
348 <para>Follow the instructions below to instantiate a VNF:</para>
349
350 <orderedlist>
351 <listitem>
352 <para>Select from the top toolbar <literal>VNF</literal> -&gt;
353 <literal>Instances</literal></para>
354 </listitem>
355
356 <listitem>
357 <para>Click the <literal>Add</literal> button.</para>
358 </listitem>
359
360 <listitem>
361 <para>Fill out the following mandatory fields:</para>
362
363 <itemizedlist spacing="compact">
364 <listitem>
365 <para>Name: a descriptive name.</para>
366 </listitem>
367
368 <listitem>
369 <para>VNF Type: a list of onboarded VNFs.</para>
370 </listitem>
371
372 <listitem>
373 <para>uCPE Device: the uCPE device to instantiate the VNF
374 on.</para>
375 </listitem>
376
377 <listitem>
378 <para>Networking Configuration:</para>
379
380 <itemizedlist spacing="compact">
381 <listitem>
382 <para>Connect each configured NIC with a bridge, SR-IOV or PCI
383 Passthrough.</para>
384 </listitem>
385
386 <listitem>
387 <para>Set up each NIC with a driver method.</para>
388 </listitem>
389 </itemizedlist>
390
391 <note>
392 <para>All configured NICs must be set up before instantiating a
393 VNF. Failure to do so will end in a failed instantiation.</para>
394 </note>
395 </listitem>
396 </itemizedlist>
397 </listitem>
398
399 <listitem>
400 <para>Add VNF-specific configuration data by uploading a Cloud-Init
401 file (when the Cloud-Init is used).</para>
402 </listitem>
403
404 <listitem>
405 <para>Add any VNF-specific files (e.g license files).</para>
406 </listitem>
407
408 <listitem>
409 <para>Hit the <literal>Create</literal> button to deploy the VNF and
410 run it on the specified uCPE device.</para>
411 </listitem>
412 </orderedlist>
413
414 <para>Selecting the<literal> VNF -&gt; Events</literal> menu will show
415 that the VNF was created and a connection was established.</para>
416 </section>
417
418 <section id="enter_console">
419 <title>Accessing the VNF console</title>
420
421 <para>Once the VNF is deployed, the VNF console can be entered using SSH
422 and virsh commands. The VNF Console is a typical starting point for
423 determining a successful deployment and configuring a VNF beyond Day
424 Zero.</para>
425
426 <orderedlist>
427 <listitem>
428 <para>SSH to the uCPE device from the Enea uCPE Manager
429 (<literal>Device-&gt;SSH</literal>) using:</para>
430
431 <itemizedlist>
432 <listitem>
433 <para>For normal connections: the <literal>Username</literal>
434 (default: root), the <literal>Password</literal> (default: no
435 password), the <literal>Port</literal> (default: 22) and the
436 <literal>Reverse ssh</literal> checkbox: unchecked.</para>
437 </listitem>
438
439 <listitem>
440 <para>For reverse ssh connections (ssh to a uCPE device behind
441 NAT): the <literal>Username</literal> (default: root) and the
442 <literal>Reverse ssh</literal> checkbox checked. The port will be
443 automatically choosen by the Enea uCPE Manager in the range
444 defined in the <literal>System -&gt; Configuration -&gt; Reverse
445 SSH</literal> configuration panel. By default, the start port will
446 be <literal>7000</literal> and the maximum number of ports
447 allocated to all devices is 10. Only one port per device is
448 allowed.</para>
449
450 <para>When the SSH window is closed, the tunnel configuration is
451 deleted on the uCPE device and the tunnel is destroyed, so that
452 the port can be reused to establish a new tunnel when
453 needed.</para>
454 </listitem>
455 </itemizedlist>
456 </listitem>
457
458 <listitem>
459 <para>In SSH:</para>
460
461 <orderedlist spacing="compact">
462 <listitem>
463 <para>Use the <command>virsh list</command> command to list all
464 running VNFs and to determine the VNF's instance number.</para>
465 </listitem>
466
467 <listitem>
468 <para>Use the <command>virsh console &lt;instance
469 number&gt;</command> command to enter the VNF-specific
470 console.</para>
471 </listitem>
472 </orderedlist>
473 </listitem>
474 </orderedlist>
475 </section>
476</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-getting-started/swcomp.mk b/doc/book-enea-nfv-access-getting-started/swcomp.mk
deleted file mode 100755
index ca6439f..0000000
--- a/doc/book-enea-nfv-access-getting-started/swcomp.mk
+++ /dev/null
@@ -1,10 +0,0 @@
1# Component build specification
2
3# Version of THIS book
4BOOK_VER ?= $(REL_VER)-dev
5
6DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print)
7
8BOOKPACKAGES := book-enea-nfv-access-getting-started
9BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) Getting Started"
10BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS)
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-07-08 18:15:34 +0000