summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/Makefile2
-rw-r--r--doc/book-enea-nfv-access-cmc-example-usecases/doc/128t_vnf_router.xml728
-rw-r--r--doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_1.xml63
-rw-r--r--doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_2.xml326
-rw-r--r--doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_3.xml7
-rw-r--r--doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_4.xml52
-rw-r--r--doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_5.xml213
-rw-r--r--doc/book-enea-nfv-access-cmc-example-usecases/doc/book.xml47
-rw-r--r--doc/book-enea-nfv-access-cmc-example-usecases/doc/enea_vnf_examples.xml289
-rw-r--r--doc/book-enea-nfv-access-cmc-example-usecases/doc/general_env_prerequisites.xml163
-rwxr-xr-xdoc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100.pngbin88944 -> 0 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100_servicechain.pngbin41444 -> 0 bytes
-rw-r--r--doc/book-enea-nfv-access-cmc-example-usecases/doc/introduction.xml152
-rw-r--r--doc/book-enea-nfv-access-cmc-example-usecases/doc/service_chaining_128t_fortigate.xml1087
-rw-r--r--doc/book-enea-nfv-access-cmc-example-usecases/doc/usecases_autoframe.xml46
-rwxr-xr-xdoc/book-enea-nfv-access-cmc-example-usecases/swcomp.mk10
-rw-r--r--doc/book-enea-nfv-access-evalkit/doc/book.xml2
-rwxr-xr-xdoc/book-enea-nfv-access-evalkit/swcomp.mk2
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/grafana.xml2
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml22
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml4
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml51
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml9
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/book.xml2
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml195
25 files changed, 176 insertions, 3298 deletions
diff --git a/doc/Makefile b/doc/Makefile
index eb3290b..38c3569 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -50,7 +50,7 @@ DOCBOOK_TO_BOOKDIR ?= yes
50DOCBOOK_CLEANTMP ?= yes 50DOCBOOK_CLEANTMP ?= yes
51 51
52#Components (books) in this subsystem. Now use all books found here 52#Components (books) in this subsystem. Now use all books found here
53COMPONENTS := book-enea-nfv-access-auto-fw-th-open-source book-enea-nfv-access-auto-fw-th-user-guide book-enea-nfv-access-cmc-example-usecases book-enea-nfv-access-example-usecases book-enea-nfv-access-getting-started book-enea-nfv-access-platform-open-source book-enea-nfv-access-ucpem-open-source book-enea-nfv-access-telemetry-open-source book-enea-nfv-access-release-info book-enea-nfv-access-system-test-specification book-enea-nfv-access-evalkit 53COMPONENTS := book-enea-nfv-access-auto-fw-th-open-source book-enea-nfv-access-auto-fw-th-user-guide book-enea-nfv-access-evalkit book-enea-nfv-access-example-usecases book-enea-nfv-access-getting-started book-enea-nfv-access-platform-open-source book-enea-nfv-access-release-info book-enea-nfv-access-system-test-specification book-enea-nfv-access-telemetry-open-source book-enea-nfv-access-ucpem-open-source
54 54
55 55
56# -------------------------------------------------------------- 56# --------------------------------------------------------------
diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/128t_vnf_router.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/128t_vnf_router.xml
deleted file mode 100644
index be7efb9..0000000
--- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/128t_vnf_router.xml
+++ /dev/null
@@ -1,728 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="vnf_router_cmc_uc">
3 <title>128T VNF Router Example Use-case</title>
4
5 <para>The 128T Networking Platform (128T) natively provides network-based
6 security, control, and insight across data centers, wide-area networks
7 (WAN), and edge locations for enterprises, service providers, and cloud
8 companies alike.</para>
9
10 <section id="preq_128_router">
11 <title>Prerequisites</title>
12
13 <para>The following are needed for this example use case:</para>
14
15 <itemizedlist spacing="compact">
16 <listitem>
17 <para>1 in band management port for device management.</para>
18 </listitem>
19
20 <listitem>
21 <para>1 in band management port for 128T VNF.</para>
22 </listitem>
23
24 <listitem>
25 <para>1 WAN interface for 128T.</para>
26 </listitem>
27
28 <listitem>
29 <para>1 LAN interface for 128T.</para>
30 </listitem>
31 </itemizedlist>
32 </section>
33
34 <section id="vnf_router_cmc">
35 <title>128T VNF Router</title>
36
37 <figure>
38 <title>128T VNF Router Setup Overview</title>
39
40 <mediaobject>
41 <imageobject>
42 <imagedata contentwidth="600" fileref="images/kontron_me1100.png" />
43 </imageobject>
44 </mediaobject>
45 </figure>
46
47 <section id="uc_setup_cmc_router">
48 <title>Use-case Setup</title>
49
50 <para><emphasis role="bold">Configuring Network Interfaces on uCPE
51 devices:</emphasis><orderedlist spacing="compact">
52 <listitem>
53 <para>Log into the uCPE Manager with both username and password
54 values: <literal>admin</literal>.</para>
55 </listitem>
56
57 <listitem>
58 <para>Add the Kontron me1100 uCPE device into the uCPE Manager:
59 <literal>Devices -&gt; Manage -&gt; Add</literal>.</para>
60
61 <para>Fill in the required fields with the following data:</para>
62
63 <table>
64 <title>Device Details</title>
65
66 <tgroup cols="2">
67 <colspec align="left" />
68
69 <colspec colwidth="2*" />
70
71 <colspec colwidth="5*" />
72
73 <thead>
74 <row>
75 <entry align="center">Field</entry>
76
77 <entry align="center">Value</entry>
78 </row>
79 </thead>
80
81 <tbody>
82 <row>
83 <entry>Type</entry>
84
85 <entry>Enea universal CPE</entry>
86 </row>
87
88 <row>
89 <entry>Release</entry>
90
91 <entry>1.0</entry>
92 </row>
93
94 <row>
95 <entry>Name</entry>
96
97 <entry>me1100</entry>
98 </row>
99
100 <row>
101 <entry>IP/DNS Address</entry>
102
103 <entry>&lt;unspecified&gt;<note>
104 <para>Please do not add the IP, it will be updated
105 automatically by new communication protocol.</para>
106 </note></entry>
107 </row>
108
109 <row>
110 <entry>Description</entry>
111
112 <entry>Kontron Target 1</entry>
113 </row>
114
115 <row>
116 <entry>Device ID</entry>
117
118 <entry>The value of the Device ID must be the same as the
119 one used during the NFV Access installation.</entry>
120 </row>
121
122 <row>
123 <entry>SSH Port</entry>
124
125 <entry>830</entry>
126 </row>
127
128 <row>
129 <entry>SSH User Name</entry>
130
131 <entry>root</entry>
132 </row>
133
134 <row>
135 <entry>Password</entry>
136
137 <entry>null</entry>
138 </row>
139
140 <row condition="hidden">
141 <entry>OK</entry>
142
143 <entry>Green status indicates connection with uCPE device
144 was established.</entry>
145 </row>
146 </tbody>
147 </tgroup>
148 </table>
149 </listitem>
150
151 <listitem>
152 <para>Add the device on the map: Right-Click on <literal>Map -&gt;
153 Place Device -&gt; me1100</literal>.</para>
154
155 <note>
156 <para>In order for the device to connect to the uCPE Manager, it
157 must be added to the uCPE Manager and be powered on, having the
158 NFV Access platform started, otherwise it must be rebooted.</para>
159 </note>
160 </listitem>
161
162 <listitem>
163 <para>Configure the virtualization infrastructure for 128T VNF by
164 creating three OVS bridges and a host interface.</para>
165
166 <para>Select the me1100 device then: <literal>Configuration -&gt;
167 OpenVSwitch -&gt; Bridges -&gt; Add</literal>. Fill in the
168 required fields for each bridge with the following data from each
169 table:</para>
170
171 <table>
172 <title>ibm_br Bridge Details</title>
173
174 <tgroup cols="2">
175 <colspec align="left" />
176
177 <colspec colwidth="2*" />
178
179 <colspec colwidth="5*" />
180
181 <thead>
182 <row>
183 <entry align="center">Field</entry>
184
185 <entry align="center">Value</entry>
186 </row>
187 </thead>
188
189 <tbody>
190 <row condition="hidden">
191 <entry>id</entry>
192
193 <entry>&lt;autogenerated - do not change&gt;</entry>
194 </row>
195
196 <row>
197 <entry>Name</entry>
198
199 <entry><literal>ibm_br</literal></entry>
200 </row>
201
202 <row>
203 <entry>ovs-bridge-type</entry>
204
205 <entry>inbandMgmt</entry>
206 </row>
207
208 <row condition="hidden">
209 <entry>mgmt-address</entry>
210
211 <entry>Provide the IP address of the uCPE Manager machine
212 (E.g. 172.24.3.109).</entry>
213 </row>
214
215 <row condition="hidden">
216 <entry>mgmt-port</entry>
217
218 <entry>830</entry>
219 </row>
220
221 <row>
222 <entry>Create</entry>
223
224 <entry><para>The system will automatically select the
225 physical interface that has access to the uCPE
226 Manager.</para></entry>
227 </row>
228 </tbody>
229 </tgroup>
230 </table>
231
232 <table>
233 <title>vnf_mgmt_br Bridge Details</title>
234
235 <tgroup cols="2">
236 <colspec align="left" />
237
238 <colspec colwidth="2*" />
239
240 <colspec colwidth="5*" />
241
242 <thead>
243 <row>
244 <entry align="center">Field</entry>
245
246 <entry align="center">Value</entry>
247 </row>
248 </thead>
249
250 <tbody>
251 <row condition="hidden">
252 <entry>id</entry>
253
254 <entry>&lt;autogenerated - do not change&gt;</entry>
255 </row>
256
257 <row>
258 <entry>Name</entry>
259
260 <entry><literal>vnf_mgmt_br</literal></entry>
261 </row>
262
263 <row>
264 <entry>ovs-bridge-type</entry>
265
266 <entry>vnfMgmt</entry>
267 </row>
268
269 <row>
270 <entry>vnf-mgmt-address</entry>
271
272 <entry>10.0.0.1</entry>
273 </row>
274
275 <row>
276 <entry>Create</entry>
277
278 <entry></entry>
279 </row>
280 </tbody>
281 </tgroup>
282 </table>
283
284 <table>
285 <title>lan_br Bridge Details</title>
286
287 <tgroup cols="2">
288 <colspec align="left" />
289
290 <colspec colwidth="2*" />
291
292 <colspec colwidth="5*" />
293
294 <thead>
295 <row>
296 <entry align="center">Field</entry>
297
298 <entry align="center">Value</entry>
299 </row>
300 </thead>
301
302 <tbody>
303 <row condition="hidden">
304 <entry>id</entry>
305
306 <entry>&lt;autogenerated - do not change&gt;</entry>
307 </row>
308
309 <row>
310 <entry>Name</entry>
311
312 <entry><literal>lan_br</literal></entry>
313 </row>
314
315 <row>
316 <entry>ovs-bridge-type</entry>
317
318 <entry>dataPlane</entry>
319 </row>
320
321 <row>
322 <entry>sub-type</entry>
323
324 <entry>communication</entry>
325 </row>
326
327 <row>
328 <entry>+</entry>
329
330 <entry>Name: enp4s0f1 OK</entry>
331 </row>
332
333 <row>
334 <entry>Create</entry>
335
336 <entry></entry>
337 </row>
338 </tbody>
339 </tgroup>
340 </table>
341
342 <para>Add the Host Interface by selecting the
343 <literal>me1100</literal> device, then <literal>Configuration
344 -&gt; External Interface -&gt; Configuration -&gt; Add</literal>.
345 Fill in the required fields with the following data:</para>
346
347 <table>
348 <title>Host Interface Details</title>
349
350 <tgroup cols="2">
351 <colspec align="left" />
352
353 <colspec colwidth="2*" />
354
355 <colspec colwidth="5*" />
356
357 <thead>
358 <row>
359 <entry align="center">Field</entry>
360
361 <entry align="center">Value</entry>
362 </row>
363 </thead>
364
365 <tbody>
366 <row>
367 <entry>Source</entry>
368
369 <entry><literal>enp4s0f1</literal>. The only interface
370 available for LAN connection.</entry>
371 </row>
372
373 <row>
374 <entry>type</entry>
375
376 <entry>dpdk</entry>
377 </row>
378
379 <row>
380 <entry>networking-type</entry>
381
382 <entry>dpdk</entry>
383 </row>
384
385 <row>
386 <entry>dpdk-type</entry>
387
388 <entry>vfio-pci</entry>
389 </row>
390
391 <row>
392 <entry>Create</entry>
393
394 <entry>&lt;interface enp4s0f1 ready to be used in a LAN
395 bridge.&gt;</entry>
396 </row>
397 </tbody>
398 </tgroup>
399 </table>
400 </listitem>
401 </orderedlist></para>
402
403 <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para>
404
405 <para>Onboard the VM Image through <literal>VNF -&gt; Descriptors -&gt;
406 On-board -&gt; VM Image</literal>, and fill in the required fields with
407 the following values:</para>
408
409 <table>
410 <title>VM Image Details</title>
411
412 <tgroup cols="2">
413 <colspec align="left" />
414
415 <colspec colwidth="2*" />
416
417 <colspec colwidth="5*" />
418
419 <thead>
420 <row>
421 <entry align="center">Field</entry>
422
423 <entry align="center">Value</entry>
424 </row>
425 </thead>
426
427 <tbody>
428 <row>
429 <entry>VM image file</entry>
430
431 <entry><literal>centos_128t_with_ci.qcow2</literal></entry>
432 </row>
433
434 <row>
435 <entry>Image format</entry>
436
437 <entry>QCOW2</entry>
438 </row>
439
440 <row>
441 <entry>VNF Type Name</entry>
442
443 <entry>128T</entry>
444 </row>
445
446 <row>
447 <entry>Description</entry>
448
449 <entry>128T Router</entry>
450 </row>
451
452 <row>
453 <entry>Version</entry>
454
455 <entry>1.0</entry>
456 </row>
457
458 <row>
459 <entry>Memory in MB</entry>
460
461 <entry>8192. More memory can be allocated if required
462 (&lt;28672).</entry>
463 </row>
464
465 <row>
466 <entry>Num. of CPUs</entry>
467
468 <entry>2. More CPUs can be reserved if required
469 (&lt;15).</entry>
470 </row>
471
472 <row>
473 <entry>Interfaces -&gt; +</entry>
474
475 <entry>Name: mgmt</entry>
476 </row>
477
478 <row>
479 <entry>Interfaces -&gt; +</entry>
480
481 <entry>Name: wan</entry>
482 </row>
483
484 <row>
485 <entry>Interfaces -&gt; +</entry>
486
487 <entry>Name: lan</entry>
488 </row>
489
490 <row>
491 <entry>Cloud Init -&gt; Cloud-Init Datasource</entry>
492
493 <entry>ISO</entry>
494 </row>
495
496 <row>
497 <entry>Cloud Init -&gt; Cloud-Init Disk Type</entry>
498
499 <entry>cdrom</entry>
500 </row>
501
502 <row>
503 <entry>Properties -&gt; +</entry>
504
505 <entry>Name: vnfMgmtIpAddress. Value: 10.0.0.2</entry>
506 </row>
507
508 <row>
509 <entry>Properties -&gt; +</entry>
510
511 <entry>Name: internalMgmtPort. Value: 443</entry>
512 </row>
513
514 <row>
515 <entry>Properties -&gt; +</entry>
516
517 <entry>Name: externalMgmtPort. Value: 60001</entry>
518 </row>
519
520 <row>
521 <entry>Onboard</entry>
522
523 <entry>&lt;Wait for message: VNF package onboarded
524 successfully&gt;</entry>
525 </row>
526
527 <row>
528 <entry>Close</entry>
529
530 <entry></entry>
531 </row>
532 </tbody>
533 </tgroup>
534 </table>
535
536 <note>
537 <itemizedlist>
538 <listitem>
539 <para>HTTPS access (443) can be changed with another type of
540 access. Please consult official 128T documentation and make sure
541 the 128T VNF is configured to accept another type of connection
542 before changing the port number.</para>
543 </listitem>
544
545 <listitem>
546 <para><literal>externalMgmtPort</literal> (60001) represents the
547 external port on which the user can access the VNF management
548 interface via HTTPS. Another port can be selected if needed. There
549 are no other changes required or components affected by this
550 change.</para>
551 </listitem>
552
553 <listitem>
554 <para><literal>vnfMgmtIpAddress</literal> (10.0.0.2) represents
555 the IP address of the management interface of the 128T VNF.
556 Changing this value requires an update to the 128T configuration
557 to match the new IP address.</para>
558 </listitem>
559 </itemizedlist>
560 </note>
561
562 <para><emphasis role="bold">Instantiating the VNFs:</emphasis></para>
563
564 <para>Instantiate the 128T VNF by selecting the me1100 device, then
565 <literal>VNF -&gt; Instances -&gt; Add</literal>.</para>
566
567 <para>Fill in the required fields with the following values:</para>
568
569 <table>
570 <title>128T VNF Instantiation</title>
571
572 <tgroup cols="2">
573 <colspec align="left" />
574
575 <colspec colwidth="2*" />
576
577 <colspec colwidth="5*" />
578
579 <thead>
580 <row>
581 <entry align="center">Field</entry>
582
583 <entry align="center">Value</entry>
584 </row>
585 </thead>
586
587 <tbody>
588 <row>
589 <entry>Name</entry>
590
591 <entry>128T_me1100_1</entry>
592 </row>
593
594 <row>
595 <entry>VNF Type</entry>
596
597 <entry>128T</entry>
598 </row>
599
600 <row>
601 <entry>VNFD Version</entry>
602
603 <entry>1.0</entry>
604 </row>
605
606 <row>
607 <entry>Flavour</entry>
608
609 <entry>Canonical</entry>
610 </row>
611
612 <row>
613 <entry>uCPE Device</entry>
614
615 <entry>me1100</entry>
616 </row>
617
618 <row>
619 <entry>Cloud Init File</entry>
620
621 <entry><literal>centos_128t_internet_ci.iso</literal></entry>
622 </row>
623
624 <row>
625 <entry>Domain Update Script</entry>
626
627 <entry></entry>
628 </row>
629
630 <row>
631 <entry>Interfaces</entry>
632
633 <entry></entry>
634 </row>
635
636 <row>
637 <entry>ID</entry>
638
639 <entry>IF Name</entry>
640 </row>
641
642 <row>
643 <entry>mgmt (dpdk)</entry>
644
645 <entry>Bridge: vnf_mgmt_br</entry>
646 </row>
647
648 <row>
649 <entry>wan (dpdk)</entry>
650
651 <entry>Bridge: ibm_br</entry>
652 </row>
653
654 <row>
655 <entry>lan (dpdk)</entry>
656
657 <entry>Bridge: lan_br</entry>
658 </row>
659
660 <row>
661 <entry>Create</entry>
662
663 <entry></entry>
664 </row>
665 </tbody>
666 </tgroup>
667 </table>
668 </section>
669
670 <section id="uc_test_cmc_router">
671 <title>Testing the Use-case</title>
672
673 <para>In order to access the web interface of the 128T VNF, open a
674 browser from a machine connected on the same network with the WAN port
675 of the me1100 uCPE device and browse to:
676 <literal>https://&lt;public_me1100_WAN_IP&gt;:60001</literal>. Log in
677 using the following credentials:</para>
678
679 <itemizedlist>
680 <listitem>
681 <para>Username: admin</para>
682 </listitem>
683
684 <listitem>
685 <para>Password: 128Tadmin</para>
686 </listitem>
687 </itemizedlist>
688
689 <para>In order to validate the data path, connect a test machine to the
690 LAN physical port, assign the static IP and a route:<programlisting>&gt; ifconfig eth3 192.168.64.2 netmask 255.255.255.0
691&gt; ip route add default via 192.168.64.1 dev eth3
692&gt; ping 8.8.8.8</programlisting>For data path validation, it may be required
693 to generate a new cloud-init image to match your network configuration.
694 Please check Appendix A: How to create 128T cloud-init iso image (day-0
695 configuration), for more details.</para>
696 </section>
697
698 <section id="cleanup_cmcone">
699 <title>Use-case Clean-up</title>
700
701 <para>In order to remove the setup created previously all components
702 need to be deleted in reverse order:</para>
703
704 <orderedlist>
705 <listitem>
706 <para>Select the me1100 uCPE device -&gt; VNF -&gt; Instances -&gt;
707 128T -&gt; Delete.</para>
708 </listitem>
709
710 <listitem>
711 <para>Select the me1100 uCPE device -&gt; Configuration -&gt;
712 OpenVSwitch -&gt; Bridges. Select all bridges -&gt; Delete.</para>
713 </listitem>
714
715 <listitem>
716 <para>Select the me1100 uCPE device -&gt; Configuration -&gt;
717 OpenVSwitch -&gt; Host Interfaces. Select all interfaces -&gt;
718 Delete.</para>
719 </listitem>
720
721 <listitem>
722 <para>VNF -&gt; Descriptors, select all bundles -&gt;
723 Offboard.</para>
724 </listitem>
725 </orderedlist>
726 </section>
727 </section>
728</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_1.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_1.xml
deleted file mode 100644
index 023f798..0000000
--- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_1.xml
+++ /dev/null
@@ -1,63 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<appendix id="appendix_one_cmc">
3 <title>How to create a 128T cloud-init iso image (day-0
4 configuration)</title>
5
6 <para><emphasis role="bold">Prerequisites:</emphasis><itemizedlist>
7 <listitem>
8 <para>Development host with Linux shell.</para>
9 </listitem>
10
11 <listitem>
12 <para><literal>genisoimage</literal> tool installed.</para>
13 </listitem>
14 </itemizedlist></para>
15
16 <para>Unpack the <filename>128T/128t-cloud-init-example.tar.gz</filename>
17 archive and check the README file for more details:</para>
18
19 <programlisting>&gt;tar -zxf 128t-cloud-init-example.tar.gz
20&gt;cd 128T/cloud-init-example/
21&gt;ls ./
22README
23user-data
24meta-data
25t128-running.xml</programlisting>
26
27 <para>To generate the cloud-init iso image:</para>
28
29 <programlisting>&gt;genisoimage -output centos_128t_ci.iso -volid cidata -joliet \
30-rock user-data meta-data t128-running.xml </programlisting>
31
32 <para><emphasis role="bold">Notes: </emphasis><itemizedlist>
33 <listitem>
34 <para><literal>user-data</literal> and <literal>meta-data</literal>
35 files must be kept unchanged.</para>
36 </listitem>
37
38 <listitem>
39 <para>To update the 128T configuration change the
40 <literal>t128-runing.xml</literal> file.</para>
41 </listitem>
42
43 <listitem>
44 <para>XML is the same file downloaded from 128T web access:
45 <literal>configuration -&gt; Import and Export Configuration -&gt;
46 Export Configuration -&gt; Download Configuration</literal>. The
47 configuration can be updated from a web interface, downloaded onto the
48 development host and used in generating a new cloud-init iso
49 image.</para>
50 </listitem>
51 </itemizedlist></para>
52
53 <para>By default, <literal>t128-running.xml</literal> is configured to pass
54 all traffic from the LAN to the WAN interface. There is only one change
55 required for the 128T VNF to work on the user's network:</para>
56
57 <programlisting>&lt;rt:next-hop&gt;172.24.15.254&lt;/rt:next-hop&gt;</programlisting>
58
59 <para>Please change &lt;172.24.15.254&gt; with the IP address of your
60 Gateway in the <filename>t128-running.xml</filename> file and generate a new
61 iso image as described above. For more details about configuring the 128T
62 VNF please contact 128 Technologies.</para>
63</appendix> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_2.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_2.xml
deleted file mode 100644
index e3da67f..0000000
--- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_2.xml
+++ /dev/null
@@ -1,326 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<appendix id="appendix_two_cmc">
3 <title>How to create the 128T image for NFV Access</title>
4
5 <para>The following steps were used by Enea to generate the 128T qcow2 image
6 used as the VNF image on NFV Access.</para>
7
8 <note>
9 <para>Follow the <filename>128tISO-Install.pdf</filename> document and
10 keep in mind a Virtual Machine was used instead of a physical host.</para>
11 </note>
12
13 <para><emphasis role="bold">Prerequisites:</emphasis><itemizedlist>
14 <listitem>
15 <para><filename>128T-3.2.7-1.el7.centos.x86_64.iso</filename> provided
16 by 128 Technologies.</para>
17 </listitem>
18
19 <listitem>
20 <para>A Linux development host with internet access.</para>
21 </listitem>
22
23 <listitem>
24 <para>A least one of the TAP interfaces connected to a bridge with
25 Internet access.</para>
26 </listitem>
27 </itemizedlist><emphasis role="bold">How to create the 128T image for NFV
28 Access:</emphasis><orderedlist>
29 <listitem>
30 <programlisting>&gt;qemu-img create -f qcow2 128t.qcow2 128G
31&gt;qemu-system-x86_64 -enable-kvm -m 8G -cpu host -smp cores=3,sockets=1 \
32-M q35 -nographic bios /usr/share/qemu/bios.bin -boot order=d,menu=on \
33cdrom 128T-3.2.7-1.el7.centos.x86_64.iso \
34hdb 128t.qcow2 \
35device e1000,netdev=net1,mac=52:52:01:02:03:01 \
36netdev tap,id=net1,ifname=tap1,script=no,downscript=no</programlisting>
37 </listitem>
38
39 <listitem>
40 <para>Press the &lt;ENTER&gt; key to begin the installation
41 process.</para>
42 </listitem>
43
44 <listitem>
45 <para>Wait for the distribution and the 128T to install:</para>
46
47 <programlisting>------------------------------
48128T Packages Installed
49
50Please Remove Install Media,
51
52then enter &lt;Yes&gt; to reboot and
53continue install process
54
55 &lt;Yes&gt; &lt;No&gt;
56------------------------------</programlisting>
57
58 <para>Press Yes.</para>
59 </listitem>
60
61 <listitem>
62 <para>Wait to reboot and press <literal>CTR+ a+c</literal> to enter
63 the qemu monitor:</para>
64
65 <programlisting>(qemu) quit</programlisting>
66 </listitem>
67
68 <listitem>
69 <para>Start qemu only with the qcow2 image attached, no installer
70 image required:</para>
71
72 <programlisting>&gt;qemu-system-x86_64 -enable-kvm -m 8G -cpu host -smp cores=3,sockets=1 \
73-M q35 -nographic bios /usr/share/qemu/bios.bin \
74-boot order=c,menu=on \
75-hda 128t.qcow2 \
76-device e1000,netdev=net1,mac=52:52:01:02:03:01 \
77-netdev tap,id=net1,ifname=tap1,script=no,downscript=no
78
79------------------------------------------------------------------------------
80Booting from Hard Disk...
81.
82
83 * CentOS Linux (3.10.0-514.2.2.el7.x86_64) 7 (Core)
84 CentOS Linux (0-rescue-4e73a369e89e466a888c9c77655a1d65) 7 (Core)
85
86
87 Use the ^ and v keys to change the selection.
88 Press 'e' to edit the selected item, or 'c' for a command prompt.
89------------------------------------------------------------------------------</programlisting>
90
91 <para>Select the first option.</para>
92 </listitem>
93
94 <listitem>
95 <programlisting>|-------------------128T Installer-------------------|
96| |
97| Configure Linux Networking |
98| |
99| Before 128T SetUp? |
100| |
101| |
102| &lt; Yes &gt; &lt; No &gt; |
103|----------------------------------------------------|</programlisting>
104
105 <para>Select NO.</para>
106 </listitem>
107
108 <listitem>
109 <para><programlisting>|----------------------------------------------------|
110| Please select a role for this node: |
111| |----------------------------------------------| |
112| | (*) Router | |
113| | ( ) Conductor | |
114| |----------------------------------------------| |
115| |
116|----------------------------------------------------|
117| &lt; OK &gt; &lt; Back &gt; |
118|----------------------------------------------------|</programlisting>Select
119 Router and OK.</para>
120 </listitem>
121
122 <listitem>
123 <programlisting>|-------------------Conductor Info-------------------|
124| |
125| |----------------------------------------------| |
126| |1st Conductor Address | |
127| |Conductor Address | |
128| |----------------------------------------------| |
129| |
130|----------------------------------------------------|
131| &lt; OK &gt; &lt; Skip &gt; &lt; Back &gt; &lt; Help &gt; |
132|----------------------------------------------------|</programlisting>
133
134 <para>Select SKIP.</para>
135 </listitem>
136
137 <listitem>
138 <para><programlisting>|----------------------HA Setup----------------------|
139| What kind of Router node is this? |
140| |----------------------------------------------| |
141| |(*) Standalone No HA peer | |
142| |( ) 1st HA Node HA peer is not set up | |
143| |( ) 2nd HA Node HA peer is already set up | |
144| |----------------------------------------------| |
145| |
146| |
147|----------------------------------------------------|
148| &lt; OK &gt; &lt; Back &gt; |
149|----------------------------------------------------|</programlisting>Select
150 Standalone and OK.</para>
151 </listitem>
152
153 <listitem>
154 <programlisting>|---------------------Node Info----------------------|
155| |----------------------------------------------| |
156| | Node Role Router | |
157| | Node Name 128tNode | |
158| | Router Name 128tRouter | |
159| |----------------------------------------------| |
160| |
161|----------------------------------------------------|
162| &lt; OK &gt; &lt; Advanced &gt; &lt; Back &gt; &lt; Help &gt; |
163|----------------------------------------------------|</programlisting>
164
165 <para>Enter a name for the router and node, press OK.</para>
166 </listitem>
167
168 <listitem>
169 <programlisting>|-------------------Password Setup-------------------|
170| Enter the new password for the 128T 'admin' |
171| user: |
172| |----------------------------------------------| |
173| | 128Tadmin | |
174| |----------------------------------------------| |
175| | |
176|----------------------------------------------------|
177| &lt; OK &gt; &lt; Back &gt; |
178|----------------------------------------------------|</programlisting>
179
180 <para>Enter the password for web access: <literal>128Tadmin</literal>
181 and confirm the password.</para>
182 </listitem>
183
184 <listitem>
185 <programlisting>|--------------------------Anonymous Data Collection--------------------------|
186| The 128T Networking Platform comes packaged with a software process |
187|("Roadrunner") that is used to proactively monitor the health and liveliness |
188|of the 128T Router and associated components. This watchdog process collects |
189|anonymous information from the router and sends it to 128 Technology for |
190|storage and analysis. This information helps inform 128 Technology about |
191|software usage, to aid in the support and improvement of the 128 Technology |
192|Networking Platform. |
193| |
194|Disabling this feature will prevent the sending of anonymous usage data to |
195|128 Technology. |
196| |
197| |
198| &lt; Accept &gt; &lt; Back &gt; &lt; Disable &gt; |
199|-----------------------------------------------------------------------------|</programlisting>
200
201 <para>Select Accept.</para>
202 </listitem>
203
204 <listitem>
205 <programlisting>|-----128T Statistics Table Creator-----|
206| Created table for metric 760/827 |
207| Created table for metric 770/827 |
208| Created table for metric 780/827 |
209| Created table for metric 790/827 |
210| Created table for metric 800/827 |
211| Created table for metric 810/827 |
212| Created table for metric 820/827 |
213| Finished pre-creating stats tables |
214| Creating tables for audit events |
215| Finished creating audit event tables |
216| Completed in 27.001386642456055 s |
217| Shutting down local Cassandra node |
218|---------------------------------------|
219| &lt; OK &gt; |
220|---------------------------------------|</programlisting>
221
222 <para>Select OK.</para>
223 </listitem>
224
225 <listitem>
226 <programlisting>|--------128T Installer Status----------|
227| |
228| Install SUCCESS |
229| |
230| Start 128T Router |
231| before proceeding to |
232| login prompt? |
233|---------------------------------------|
234| &lt; Yes &gt; &lt; No &gt; |
235|---------------------------------------|</programlisting>
236
237 <para>Select: Yes</para>
238 </listitem>
239
240 <listitem>
241 <programlisting>localhost login: root
242Password:</programlisting>
243
244 <para>The following user accounts and passwords are created during the
245 ISO installation process:</para>
246
247 <table>
248 <title>Accounts Created</title>
249
250 <tgroup cols="2">
251 <colspec align="left" />
252
253 <thead>
254 <row>
255 <entry align="center">User</entry>
256
257 <entry align="center">Password</entry>
258 </row>
259 </thead>
260
261 <tbody>
262 <row>
263 <entry>root</entry>
264
265 <entry>128tRoutes</entry>
266 </row>
267
268 <row>
269 <entry>t128</entry>
270
271 <entry>128tRoutes</entry>
272 </row>
273 </tbody>
274 </tgroup>
275 </table>
276 </listitem>
277
278 <listitem>
279 <para>GUI login via HTTPS is enabled by default on port 443</para>
280
281 <programlisting>[root@localhost ~]# dhclient enp0s2
282[root@localhost ~]# echo "nameserver 8.8.8.8" &gt;&gt;/etc/resolv.conf
283[root@localhost ~]# yum -y install cloud-init
284[root@localhost ~]# reboot</programlisting>
285 </listitem>
286
287 <listitem>
288 <para>Wait to reboot and press CTR+ a+c to enter in qemu
289 monitor.</para>
290
291 <programlisting>(qemu) quit
292&gt; qemu-img info 128t.qcow2
293image: 128t.qcow2
294file format: qcow2
295virtual size: 128G (137438953472 bytes)
296disk size: 5.4G
297cluster_size: 65536
298Format specific information:
299 compat: 1.1
300 lazy refcounts: false
301 refcount bits: 16
302 corrupt: false</programlisting>
303 </listitem>
304
305 <listitem>
306 <para>Compress the generated <filename>128t.qcow2</filename> image to
307 decrease the size of VNF image:</para>
308
309 <programlisting>qemu-img convert -O qcow2 -c 128t.qcow2 centos_128t_compressed.qcow2
310
311&gt; qemu-img info centos_128t_compressed.qcow2
312image: centos_128t_compressed.qcow2
313file format: qcow2
314virtual size: 128G (137438953472 bytes)
315disk size: 1.2G
316cluster_size: 65536
317Format specific information:
318 compat: 1.1
319 lazy refcounts: false
320 refcount bits: 16
321 corrupt: false
322
323centos_128t_compressed.qcow2 - Resulted image can be used in NFV Access.</programlisting>
324 </listitem>
325 </orderedlist></para>
326</appendix> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_3.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_3.xml
deleted file mode 100644
index 827e8cd..0000000
--- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_3.xml
+++ /dev/null
@@ -1,7 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<appendix id="appendix_three_cmc">
3 <title>How to configure Fortigate VNF (day-0 configuration)</title>
4
5 <para>Please check the README file from Fortigate folder for more
6 details.</para>
7</appendix> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_4.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_4.xml
deleted file mode 100644
index 9641f7c..0000000
--- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_4.xml
+++ /dev/null
@@ -1,52 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<appendix id="appendix_four_cmc">
3 <title>Running Enea Automation Framework tests</title>
4
5 <para>The most relevant information from the Automation Framework and Test
6 Harness structure:</para>
7
8 <programlisting>|---automation_framework
9| |---unittestSuite
10| | |---128tCleanup.json - Use case 1 - clean up - test.
11| | |---128tDeploy.json - Use case 1 - test.
12| | |---128t_FG_SFCCleanup.json - Use case 2 - clean up - test.
13| | |---128t_FG_SFCDeploy.json - Use case 2 - test.
14| | |---config
15| | | |---cmc
16 - Folder containing the configuration files used by tests.
17| | |---unittestLoader.py
18| | |---unittestSuite.py
19|---lab_config
20| |---me1100-1
21| | |---enp4s0f0_0000_04_00_0.json
22| | |---enp4s0f1_0000_04_00_1.json
23| | |---ibm_br.json - In-band management definition.
24| | |---lan_br_enp4s0f1.json - Lan bridge definition.
25| | |---me1100-1.json
26 - Target definition - make sure to update the "address".
27| | |---sfc_br.json - Service chain bridge definition.
28| | |---vnf_mgmt_br.json - VNF management bridge definition.
29|---vnf_config
30| |---128t
31| | |---128tInstance.json - 128T instantiation - used in use case 1.
32| | |---128t.json - 128T onboarding.
33| | |---128tSFCInstance.json - 128T instantiation - used in use case 2.
34| | |---centos_128t_internet_ci.iso - 128T cloud init (day-0) iso image.
35| |---fortigate
36| | |---fg_basic_fw.conf - Fortigate day-0 configuration.
37| | |---fortigateInstance.json - Fortigate instantiantion.
38| | |---fortigate.json - Fortigate onboarding.
39| | |---fortigateLicense.lic
40 - Fortigate license - replace it with a valid License file.
41|---vnf_image
42| |---centos_128t_with_ci.qcow2 - 128T qcow2 image.
43| |---fortios.qcow2 - Fortigate qcow2 image.</programlisting>
44
45 <para>Make sure to update the relevant configuration file for your setup.
46 The essential files to consider are the target configuration
47 (<filename>me1100-1.json</filename>), the license for the Fortigate VNF, and
48 the 128T cloud-init iso image matching your network.</para>
49
50 <para>To run a test:<programlisting>&gt; cd automation_and_systemtest/automation_framework/unittestSuite
51&gt; python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n me1100-1 -s</programlisting></para>
52</appendix> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_5.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_5.xml
deleted file mode 100644
index 7c8c042..0000000
--- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/appendix_5.xml
+++ /dev/null
@@ -1,213 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<appendix id="appendix_five_cmc">
3 <title>Example Tests Results using the Automation Framework</title>
4
5 <programlisting>Test Host:
6Use Case1 - 128T
7&gt; cd automation_and_systemtest/automation_framework/unittestSuite
8&gt; python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n me1100-1 \
9-s 128tDeploy.json -d "128T Deployment"
10
11Running 128T Deployment...
12
13test 001: Add VCPE Agent from me1100-1 device (__main__.UnittestSuite) ...
142019-08-13 12:49:58,091 - INFO: Add uCPE device
152019-08-13 12:49:58,342 - INFO: Done
16ok
17test 002: Wait VCPE Agent device be up (__main__.UnittestSuite) ...
182019-08-13 12:49:58,358 - INFO: Wait uCPE device
192019-08-13 12:50:03,470 - INFO: Done
20ok
21test 003: Bind NIC to DPDK for LAN connection (__main__.UnittestSuite) ...
222019-08-13 12:50:03,486 - INFO: Bind NIC
232019-08-13 12:50:03,901 - INFO: Done
24ok
25test 004: Creating ibm bridge (__main__.UnittestSuite) ...
262019-08-13 12:50:03,920 - INFO: New OVS network bridge
272019-08-13 12:50:17,465 - INFO: Done
28ok
29test 005: Creating VNF Management bridge (__main__.UnittestSuite) ...
302019-08-13 12:50:17,481 - INFO: New OVS network bridge
312019-08-13 12:50:17,626 - INFO: Done
32ok
33test 006: Creating LAN bridge and attaching enp4s0f1 interface to the bridge \
34 (__main__.UnittestSuite) ...
352019-08-13 12:50:17,643 - INFO: New OVS network bridge
362019-08-13 12:50:18,313 - INFO: Done
37ok
38test 007: Onboarding 128T VNF (wizard API) (__main__.UnittestSuite) ...
392019-08-13 12:50:18,332 - INFO: Onboard wizard
402019-08-13 12:52:52,909 - INFO: Done
41ok
42test 008: Instantiate 128T VNF (__main__.UnittestSuite) ...
432019-08-13 12:52:52,924 - INFO: Instantiate VNF
442019-08-13 12:54:06,219 - INFO: Done
45ok
46
47----------------------------------------------------------------------
48Ran 8 tests in 248.144s
49
50OK
51
52
53Clean-up use-case1
54&gt; python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n me1100-1 \
55-s 128tCleanup.json -d "128T Clean-up"
56
57Running 128T Clean-up...
58
59test 001: Destroying 128T VNF (__main__.UnittestSuite) ...
602019-08-13 13:03:02,704 - INFO: Destroy VNF
612019-08-13 13:03:03,619 - INFO: Done
62ok
63test 002: Deleting network bridge LAN (__main__.UnittestSuite) ...
642019-08-13 13:03:03,635 - INFO: Delete OVS network bridge
652019-08-13 13:03:13,857 - INFO: Done
66ok
67test 003: Deleting VNF management bridge (__main__.UnittestSuite) ...
682019-08-13 13:03:13,877 - INFO: Delete OVS network bridge
692019-08-13 13:03:24,027 - INFO: Done
70ok
71test 004: Deleting ibm(In Band Management) bridge (__main__.UnittestSuite) ...
722019-08-13 13:03:24,049 - INFO: Delete OVS network bridge
732019-08-13 13:03:48,815 - INFO: Done
74ok
75test 005: Unbind LAN NIC from DPDK target (__main__.UnittestSuite) ...
762019-08-13 13:03:48,835 - INFO: Unbind NIC
772019-08-13 13:03:50,274 - INFO: Done
78ok
79test 006: Offboarding 128t VNF (__main__.UnittestSuite) ...
802019-08-13 13:03:50,294 - INFO: Offboard VNF
812019-08-13 13:03:50,844 - INFO: Done
82ok
83test 007: Remove VCPE Agent me1100-1 device (__main__.UnittestSuite) ...
842019-08-13 13:03:50,858 - INFO: Remove uCPE device
852019-08-13 13:03:50,998 - INFO: Done
86ok
87
88----------------------------------------------------------------------
89Ran 7 tests in 48.308s
90
91OK
92
93
94Use-case2
95&gt; python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n me1100-1 \
96-s 128t_FG_SFCDeploy.json -d "128T - Fortigate SFC Deployment"
97Running 128T - Fortigate SFC Deployment...
98
99test 001: Add VCPE Agent from me1100-1 device (__main__.UnittestSuite) ...
1002019-08-13 13:09:16,146 - INFO: Add uCPE device
1012019-08-13 13:09:16,272 - INFO: Done
102ok
103test 002: Wait VCPE Agent device be up (__main__.UnittestSuite) ...
1042019-08-13 13:09:16,287 - INFO: Wait uCPE device
1052019-08-13 13:09:23,421 - INFO: Done
106ok
107test 003: Bind NIC to DPDK for LAN connection (__main__.UnittestSuite) ...
1082019-08-13 13:09:23,445 - INFO: Bind NIC
1092019-08-13 13:09:24,226 - INFO: Done
110ok
111test 004: Creating ibm bridge (__main__.UnittestSuite) ...
1122019-08-13 13:09:24,245 - INFO: New OVS network bridge
1132019-08-13 13:09:34,720 - INFO: Done
114ok
115test 005: Creating VNF Management bridge (__main__.UnittestSuite) ...
1162019-08-13 13:09:34,741 - INFO: New OVS network bridge
1172019-08-13 13:09:34,885 - INFO: Done
118ok
119test 006: Creating LAN bridge and attaching enp4s0f1 interface to the bridge \
120(__main__.UnittestSuite) ...
1212019-08-13 13:09:34,903 - INFO: New OVS network bridge
1222019-08-13 13:09:35,566 - INFO: Done
123ok
124test 007: Creating SFC(service function chaining) bridge (__main__.UnittestSuite) ...
1252019-08-13 13:09:35,587 - INFO: New OVS network bridge
1262019-08-13 13:09:35,667 - INFO: Done
127ok
128test 008: Onboarding 128T VNF (wizard API) (__main__.UnittestSuite) ...
1292019-08-13 13:09:35,684 - INFO: Onboard wizard
1302019-08-13 13:12:11,845 - INFO: Done
131ok
132test 009: Onboarding Fortigate VNF (wizard API) (__main__.UnittestSuite) ...
1332019-08-13 13:12:11,861 - INFO: Onboard wizard
1342019-08-13 13:12:16,157 - INFO: Done
135ok
136test 010: Instantiate 128T VNF (__main__.UnittestSuite) ...
1372019-08-13 13:12:16,175 - INFO: Instantiate VNF
1382019-08-13 13:13:31,681 - INFO: Done
139ok
140test 011: Instantiate Fortigate VNF (__main__.UnittestSuite) ...
1412019-08-13 13:13:31,738 - INFO: Instantiate VNF
1422019-08-13 13:13:35,985 - INFO: Done
143ok
144
145----------------------------------------------------------------------
146Ran 11 tests in 259.854s
147
148OK
149
150# Access 128T management interface
151https://172.24.12.154:60001
152user: admin
153password: 128Tadmin
154
155# Access Fortigate management interface
156https://172.24.12.154:60002
157user: admin
158password:
159
160
161
162Use case2 clean-up
163&gt; python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n me1100-1 \
164-s 128t_FG_SFCCleanup.json -d "128T - Fortigate SFC CleanUp"
165
166Running 128T - Fortigate SFC CleanUp...
167
168test 001: Destroying Fortigate VNF (__main__.UnittestSuite) ...
1692019-08-13 13:51:30,204 - INFO: Destroy VNF
1702019-08-13 13:51:31,781 - INFO: Done
171ok
172test 002: Destroying 128T VNF (__main__.UnittestSuite) ...
1732019-08-13 13:51:31,822 - INFO: Destroy VNF
1742019-08-13 13:51:32,729 - INFO: Done
175ok
176test 003: Deleting network bridge SFC (__main__.UnittestSuite) ...
1772019-08-13 13:51:32,756 - INFO: Delete OVS network bridge
1782019-08-13 13:51:42,863 - INFO: Done
179ok
180test 004: Deleting network bridge LAN (__main__.UnittestSuite) ...
1812019-08-13 13:51:42,878 - INFO: Delete OVS network bridge
1822019-08-13 13:51:53,087 - INFO: Done
183ok
184test 005: Deleting VNF management bridge (__main__.UnittestSuite) ...
1852019-08-13 13:51:53,103 - INFO: Delete OVS network bridge
1862019-08-13 13:52:03,251 - INFO: Done
187ok
188test 006: Deleting ibm(In Band Management) bridge (__main__.UnittestSuite) ...
1892019-08-13 13:52:03,269 - INFO: Delete OVS network bridge
1902019-08-13 13:52:29,868 - INFO: Done
191ok
192test 007: Unbind LAN NIC from DPDK target (__main__.UnittestSuite) ...
1932019-08-13 13:52:29,885 - INFO: Unbind NIC
1942019-08-13 13:52:31,415 - INFO: Done
195ok
196test 008: Offboarding 128t VNF (__main__.UnittestSuite) ...
1972019-08-13 13:52:31,435 - INFO: Offboard VNF
1982019-08-13 13:52:32,009 - INFO: Done
199ok
200test 009: Offboarding Fortigate VNF (__main__.UnittestSuite) ...
2012019-08-13 13:52:32,023 - INFO: Offboard VNF
2022019-08-13 13:52:32,157 - INFO: Done
203ok
204test 010: Remove VCPE Agent me1100-1 device (__main__.UnittestSuite) ...
2052019-08-13 13:52:32,170 - INFO: Remove uCPE device
2062019-08-13 13:52:32,294 - INFO: Done
207ok
208
209----------------------------------------------------------------------
210Ran 10 tests in 62.104s
211
212OK</programlisting>
213</appendix> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/book.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/book.xml
deleted file mode 100644
index 459aec8..0000000
--- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/book.xml
+++ /dev/null
@@ -1,47 +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_cmc_example_usecases">
7 <title><trademark class="registered">Enea</trademark> NFV Access CMC Networks Example Use-cases</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="general_env_prerequisites.xml"
22 xmlns:xi="http://www.w3.org/2001/XInclude" />
23
24 <xi:include href="128t_vnf_router.xml"
25 xmlns:xi="http://www.w3.org/2001/XInclude" />
26
27 <xi:include href="service_chaining_128t_fortigate.xml"
28 xmlns:xi="http://www.w3.org/2001/XInclude" />
29
30 <xi:include href="usecases_autoframe.xml"
31 xmlns:xi="http://www.w3.org/2001/XInclude" />
32
33 <xi:include href="appendix_1.xml"
34 xmlns:xi="http://www.w3.org/2001/XInclude" />
35
36 <xi:include href="appendix_2.xml"
37 xmlns:xi="http://www.w3.org/2001/XInclude" />
38
39 <xi:include href="appendix_3.xml"
40 xmlns:xi="http://www.w3.org/2001/XInclude" />
41
42 <xi:include href="appendix_4.xml"
43 xmlns:xi="http://www.w3.org/2001/XInclude" />
44
45 <xi:include href="appendix_5.xml"
46 xmlns:xi="http://www.w3.org/2001/XInclude" />
47</book>
diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/enea_vnf_examples.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/enea_vnf_examples.xml
deleted file mode 100644
index 8f11107..0000000
--- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/enea_vnf_examples.xml
+++ /dev/null
@@ -1,289 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="enea_vnf_examples">
3 <title>Enea VNF Example Use-cases</title>
4
5 <para>Enea NFV Access is a complete NFV Infrastructure (NFVI) platform
6 designed for deployment on white box uCPEs at the customer premise, and
7 optimized for common Virtual Customer Premises Equipment (vCPE) and SD-WAN
8 use cases.</para>
9
10 <section id="prere_enea_vnf">
11 <title>Prerequisites</title>
12
13 <para>The following file(s) are needed for this example use-case:
14 <literal>enea-nfv-access-vnf-qemux86-64.qcow2</literal>. This image is
15 provided with your release.</para>
16 </section>
17
18 <section id="enea_vnf">
19 <title>TestPMD VNF</title>
20
21 <para>In this use-case, <literal>uCPE device 1</literal> will run pktgen
22 (the DPDK application) and <literal>uCPE device 2</literal> will onboard
23 and instantiate two VNFs. One VNF will run <literal>testpmd_fwd</literal>,
24 forwarding traffic, and the other will run <literal>testpmd_term</literal>
25 which will terminate traffic.</para>
26
27 <figure>
28 <title>Enea TestPMD VNF Overview</title>
29
30 <mediaobject>
31 <imageobject>
32 <imagedata align="center"
33 fileref="images/enea_vnf_demo_overview.png" scale="80" />
34 </imageobject>
35 </mediaobject>
36 </figure>
37
38 <section id="enea_vnf_setup">
39 <title>Use-case Setup</title>
40
41 <para><emphasis role="bold">Configuring Network Interfaces on uCPE
42 devices:</emphasis></para>
43
44 <orderedlist>
45 <listitem>
46 <para>Bind the host interfaces to the DPDK by selecting
47 <literal>uCPE device 1</literal> first, then accessing
48 <literal>Configuration</literal> -&gt;
49 <literal>OpenVSwitch</literal> -&gt; <literal>Host
50 Interfaces</literal> -&gt; <literal>Add</literal>.</para>
51 </listitem>
52
53 <listitem>
54 <para>Select the network interface that will be used to connect to
55 the second uCPE device and configure it for the DPDK.</para>
56 </listitem>
57
58 <listitem>
59 <para>Select the <literal>Create</literal> button to send the
60 configuration to <literal>uCPE device 1</literal>.</para>
61 </listitem>
62
63 <listitem>
64 <para>Repeat these same steps on <literal>uCPE device
65 2</literal>.</para>
66 </listitem>
67
68 <listitem>
69 <para>Click the <literal>Add</literal> button from the Bridges
70 tab.</para>
71 </listitem>
72
73 <listitem>
74 <para>Create an Open vSwitch bridge (<literal>ovsbr0</literal>) on
75 <literal>uCPE device 1</literal> that uses one DPDK interface, by
76 selecting <literal>uCPE device 1</literal>, then:
77 <literal>Configuration</literal> -&gt;<literal>OpenVSwitch</literal>
78 -&gt;<literal>Bridges</literal>.</para>
79 </listitem>
80 </orderedlist>
81
82 <para><emphasis role="bold">Onboarding the VNF:</emphasis></para>
83
84 <orderedlist>
85 <listitem>
86 <para>Select <literal>VNF</literal>
87 -&gt;<literal>Descriptor</literal> -&gt;
88 <literal>On-board</literal>.</para>
89 </listitem>
90
91 <listitem>
92 <para>Select the <literal>VM Image</literal> radio button.</para>
93 </listitem>
94
95 <listitem>
96 <para>Provide the path to the qcow image by selecting
97 <literal>Browse </literal> from the <literal>VM image file</literal>
98 option.</para>
99 </listitem>
100
101 <listitem>
102 <para>Fill the required fields below and press
103 <literal>Onboard</literal>:</para>
104
105 <itemizedlist spacing="compact">
106 <listitem>
107 <para><emphasis role="bold">Memory in MB</emphasis>: 1024</para>
108 </listitem>
109
110 <listitem>
111 <para><emphasis role="bold">Nr. of CPUs</emphasis>: 1</para>
112 </listitem>
113
114 <listitem>
115 <para><emphasis role="bold">Storage in GB</emphasis>: 10</para>
116 </listitem>
117 </itemizedlist>
118 </listitem>
119 </orderedlist>
120
121 <para><emphasis role="bold">Instantiating two VNFs on uCPE device
122 2:</emphasis></para>
123
124 <orderedlist>
125 <listitem>
126 <para>Select uCPE device 2, then access <literal>VNF</literal> -&gt;
127 <literal>Instances</literal> -&gt; <literal>Add</literal>.</para>
128 </listitem>
129
130 <listitem>
131 <para>Fill-in the required fields and click
132 <literal>Create</literal>.</para>
133 </listitem>
134
135 <listitem>
136 <para>Configure VNF 1 to forward traffic.</para>
137 </listitem>
138
139 <listitem>
140 <para>Configure VNF 2 to terminate traffic.</para>
141 </listitem>
142
143 <listitem>
144 <para>Add Open vSwitch flows to control this traffic:</para>
145
146 <figure>
147 <title>Configuring the FWD flow</title>
148
149 <mediaobject>
150 <imageobject>
151 <imagedata align="center" fileref="images/flow_fwd.png"
152 scale="90" />
153 </imageobject>
154 </mediaobject>
155 </figure>
156
157 <figure>
158 <title>Configuring the TERM flow</title>
159
160 <mediaobject>
161 <imageobject>
162 <imagedata align="center" fileref="images/flow_term.png"
163 scale="90" />
164 </imageobject>
165 </mediaobject>
166 </figure>
167 </listitem>
168
169 <listitem>
170 <para>Start pktgen on uCPE device 1. Connect to the device by
171 selecting it first, then access <literal>SSH</literal> -&gt;
172 <literal>user</literal> (root) and perform the following:</para>
173
174 <programlisting>cd /usr/share/apps/pktgen/
175./pktgen -c 0x7 -n 4 --proc-type auto --socket-mem 256 -w 0000:05:00.3 -- \
176-P -m "[1:2].0"
177Pktgen:/&gt; start 0</programlisting>
178
179 <note>
180 <para>The PCI address &lt;0000:05:00.3&gt; used in this example
181 varies depending on the uCPE device. To determine the exact PCI
182 address used, look in the uCPE device specific Network
183 configuration.</para>
184 </note>
185 </listitem>
186 </orderedlist>
187 </section>
188
189 <section id="test_ena_vnf">
190 <title>Testing the Use-case</title>
191
192 <para>Connect to the forwarder VNF in order to check the traffic
193 statistics, by selecting the uCPE device first, then accessing
194 <literal>SSH</literal> -&gt; <literal>user</literal> (root):</para>
195
196 <programlisting>Virsh list
197Virsh console 1
198# Qemux86-64 login: root
199tail -f /var/log/testpmd-out</programlisting>
200
201 <figure>
202 <title>Traffic Statistics</title>
203
204 <mediaobject>
205 <imageobject>
206 <imagedata align="center"
207 fileref="images/connection_information.png" scale="70" />
208 </imageobject>
209 </mediaobject>
210 </figure>
211 </section>
212
213 <section condition="hidden" id="vnf_pci">
214 <title>TestPMD VNF using PCI passthrough</title>
215
216 <para>In this use case, uCPE device 1 will run the Pktgen and uCPE
217 device 2 will run the TestPMD VNF. Both will be using PCI
218 passthrough:</para>
219
220 <figure>
221 <title>TestPMD VNF using PCI passthrough Overview</title>
222
223 <mediaobject>
224 <imageobject>
225 <imagedata align="center" fileref="images/testPMD_VNF_PCI.png"
226 scale="65" />
227 </imageobject>
228 </mediaobject>
229 </figure>
230
231 <orderedlist>
232 <listitem>
233 <para>Make sure that neither uCPE device 1 nor uCPE device 2 have
234 any configured host interfaces by selcting uCPE device :
235 <literal>Configuration</literal> -&gt;
236 <literal>OpenVSwitch</literal> -&gt; <literal>Host
237 Interfaces</literal>.</para>
238 </listitem>
239
240 <listitem>
241 <para>On uCPE device 1 start the Pktgen VNF. Select
242 <literal>PciPassthrough</literal> as the Interface type.</para>
243
244 <para>From the drop-down list, select the PCI interface
245 corresponding to the NIC which is connected to uCPE device 2:</para>
246
247 <figure>
248 <title>Selecting the Pktgen VNF Interface</title>
249
250 <mediaobject>
251 <imageobject>
252 <imagedata align="center"
253 fileref="images/pciPass_interface.png" scale="70" />
254 </imageobject>
255 </mediaobject>
256 </figure>
257 </listitem>
258
259 <listitem>
260 <para>On uCPE device 2, start the TestPmdForwarder VNF. Select
261 "PciPassthrough" as the Interface type. From the drop-down list,
262 select the PCI interface corresponding to the NIC which is connected
263 to uCPE device 1:</para>
264
265 <figure>
266 <title>Selecting the TestPmdForwarder VNF Interface</title>
267
268 <mediaobject>
269 <imageobject>
270 <imagedata align="center"
271 fileref="images/testpmd_fwdvnf_int.png" scale="70" />
272 </imageobject>
273 </mediaobject>
274 </figure>
275 </listitem>
276
277 <listitem>
278 <para>To check that traffic is being forwarded from uCPE device 2,
279 SSH to the uCPE device and connect to the VNFs console:</para>
280
281 <programlisting>Right click on uCPE device 2 and select SSH.
282Run: virsh list
283Run: virsh console [VM NAME]
284Run: tail -f /opt/testpmd-out</programlisting>
285 </listitem>
286 </orderedlist>
287 </section>
288 </section>
289</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/general_env_prerequisites.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/general_env_prerequisites.xml
deleted file mode 100644
index c0df438..0000000
--- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/general_env_prerequisites.xml
+++ /dev/null
@@ -1,163 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="general_env_setup">
3 <title>General Environment Setup</title>
4
5 <section id="gen_prereq">
6 <title>Prerequisites</title>
7
8 <table>
9 <title>General Prerequisites</title>
10
11 <tgroup cols="2">
12 <colspec align="center" />
13
14 <colspec colwidth="2*" />
15
16 <colspec colwidth="5*" />
17
18 <thead>
19 <row>
20 <entry align="center">Prerequisites</entry>
21
22 <entry align="center">Observations</entry>
23 </row>
24 </thead>
25
26 <tbody>
27 <row>
28 <entry align="left">Kontron me1100 target<itemizedlist>
29 <listitem>
30 <para>Processor Xeon-D</para>
31 </listitem>
32
33 <listitem>
34 <para>2 x 10G SFP/SFP+</para>
35 </listitem>
36
37 <listitem>
38 <para>SSD storage</para>
39 </listitem>
40
41 <listitem>
42 <para>32 GB RAM</para>
43 </listitem>
44 </itemizedlist></entry>
45
46 <entry align="left"><itemizedlist>
47 <listitem>
48 <para>This is an example hardware configuration available in
49 the Enea internal lab.</para>
50 </listitem>
51
52 <listitem>
53 <para>One of the SFP ports is connected to a network with
54 DHCP server access (receiving a dynamic IP based on
55 MAC).</para>
56 </listitem>
57
58 <listitem>
59 <para>The target has network access to the uCPE
60 Manager.</para>
61 </listitem>
62
63 <listitem>
64 <para>Enea NFV Access must be installed on the target. For
65 details on how to install Enea NFV Access, please see <olink
66 targetdoc="book_enea_nfv_access_getting_started"
67 targetptr="access_installer">How to install Enea NFV Access
68 in <xi:include
69 href="../../s_docbuild/olinkdb/pardoc-names.xml"
70 xmlns:xi="http://www.w3.org/2001/XInclude"
71 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>.</para>
72 </listitem>
73 </itemizedlist></entry>
74 </row>
75
76 <row>
77 <entry align="left">Management machine - Linux based
78 (CentOS)</entry>
79
80 <entry align="left"><itemizedlist>
81 <listitem>
82 <para>The uCPE Manager must be installed on this host or
83 virtual machine. For installation details see, <olink
84 targetdoc="book_enea_nfv_access_getting_started"
85 targetptr="install_ucpe_manager">How to Install the uCPE
86 Manager in <xi:include
87 href="../../s_docbuild/olinkdb/pardoc-names.xml"
88 xmlns:xi="http://www.w3.org/2001/XInclude"
89 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>.</para>
90 </listitem>
91
92 <listitem>
93 <para>The uCPE Manager must have access to the me1100
94 target.</para>
95 </listitem>
96
97 <listitem>
98 <para>A web browser must be installed to access the
99 management interface of the VNFs. The management interface
100 of any VNF can be accessed from any machine connected on the
101 same network with the me1100 target.</para>
102 </listitem>
103 </itemizedlist></entry>
104 </row>
105
106 <row>
107 <entry align="left">Development machine - Linux based</entry>
108
109 <entry align="left"><itemizedlist>
110 <listitem>
111 <para>The Automation Framework and Test Harness must be
112 installed. Please see the Enea NFV Access Automation
113 Framework and Test Harness User Guide for more info.</para>
114 </listitem>
115
116 <listitem>
117 <para>This is a host or virtual machine with network access
118 to the uCPE Manager and the me1100 target.</para>
119 </listitem>
120
121 <listitem>
122 <para>It can be used for the 128T VNF installation. Please
123 see Appendix B for more details.</para>
124 </listitem>
125 </itemizedlist></entry>
126 </row>
127 </tbody>
128 </tgroup>
129 </table>
130 </section>
131
132 <section id="rel_structure_cmc">
133 <title>Release structure</title>
134
135 <programlisting>|---ENEA_NFV_Access
136| |---doc
137| | |---book-enea-nfv-access-auto-fw-th-user-guide.pdf
138| | |---book-enea-nfv-access-cmc-example-usecases
139| | |---book-enea-nfv-access-example-usecases.pdf
140| | |---book-enea-nfv-access-getting-started.pdf
141| | |---book-enea-nfv-access-open-source.pdf
142| | |---book-enea-nfv-access-release-info.pdf
143| | |---book-enea-nfv-access-vnf-onboarding-guide.pdf
144| | |---book-enea-ucpe-manager-open-source.pdf
145| | |---book-enea-nfv-access-auto-fw-th-user-guide.pdf
146| | |---book-enea-nfv-access-system-test-specification.pdf
147| |---enea-nfv-access-edgelink-netconf-xeon-d-20190812201510.hddimg \
148 - NFV Access USB installer image
149|---automation_and_systemtest.tar.gz - Automation framework and tests
150|---book-enea-nfv-access-cmc-example-usecases.pdf
151|---128T
152| |---128t-cloud-init-example.tar.gz
153| |---centos_128t_internet_ci.iso
154| |---centos_128t_with_ci.qcow2
155|---Fortigate
156| |---fg_basic_fw_example.conf
157| |---README
158|---uCPE_Manager
159| |---ucpeManager_1.0_b10-CentOS.tar.gz
160| |---ucpeManager_1.0_b10-CentOS-VM.ova
161| |---ucpeManager_1.0_b10-Windows.zip</programlisting>
162 </section>
163</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100.png b/doc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100.png
deleted file mode 100755
index 9ed0203..0000000
--- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100.png
+++ /dev/null
Binary files differ
diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100_servicechain.png b/doc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100_servicechain.png
deleted file mode 100755
index e568824..0000000
--- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/images/kontron_me1100_servicechain.png
+++ /dev/null
Binary files differ
diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/introduction.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/introduction.xml
deleted file mode 100644
index 5365b16..0000000
--- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/introduction.xml
+++ /dev/null
@@ -1,152 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="intro_cmc">
3 <title>Introduction</title>
4
5 <para>Enea NFV Access for universal Customer Premise Equipment (uCPE) is a
6 virtualization and management platform, which allows end-users to introduce,
7 instantiate, and run third-party VNFs onto their operating systems. The
8 solution is comprised of two major components working in close
9 cooperation:</para>
10
11 <itemizedlist>
12 <listitem>
13 <para>The Enea NFV Access Runtime Platform, which acts as the host for
14 Virtualized Network Functions (VNFs) and provides management over
15 NETCONF.</para>
16 </listitem>
17
18 <listitem>
19 <para>The Enea uCPE Manager, a solution that runs on an external server,
20 providing VNF Management functionality and managing large numbers of
21 uCPEs.</para>
22 </listitem>
23 </itemizedlist>
24
25 <para>Enea NFV Access for CMC Networks is tailored around the two use cases
26 agreed upon during initial discussions. The current version of Enea NFV
27 Access provides a working and deployable configuration example for the 128T
28 router and the Fortinet Firewall service chained together on a Kontron
29 ME-1100 Xeon-D based platform.</para>
30
31 <para>This document describes all steps required to replicate the use cases
32 in the customer environment. The information provided will guide the user in
33 reproducing the setup using either the uCPE Manager GUI or the Automation
34 Framework and Test Harness.</para>
35
36 <note>
37 <itemizedlist>
38 <listitem>
39 <para>All VNF configurations should be seen as example configurations
40 made while working in the Enea internal lab. The customer will update
41 these configurations according to his local network setup.
42 Particularities are described in the Appendix chapters.</para>
43 </listitem>
44
45 <listitem>
46 <para>It is assumed that the user is familiar with Enea NFV Access and
47 has studied the official documentation, namely the "Enea NFV Access
48 Getting Started" manual before proceeding with this document.</para>
49 </listitem>
50 </itemizedlist>
51 </note>
52
53 <section condition="hidden" id="rev_hist">
54 <title>Revision History</title>
55
56 <table>
57 <title>Revisions</title>
58
59 <tgroup cols="4">
60 <colspec align="center" />
61
62 <thead>
63 <row>
64 <entry align="center">Revision</entry>
65
66 <entry align="center">Author</entry>
67
68 <entry align="center">Date</entry>
69
70 <entry align="center">Purpose of Revision</entry>
71 </row>
72 </thead>
73
74 <tbody>
75 <row>
76 <entry></entry>
77
78 <entry></entry>
79
80 <entry></entry>
81
82 <entry></entry>
83 </row>
84
85 <row>
86 <entry></entry>
87
88 <entry></entry>
89
90 <entry></entry>
91
92 <entry></entry>
93 </row>
94 </tbody>
95 </tgroup>
96 </table>
97 </section>
98
99 <section condition="hidden" id="ref_cmc">
100 <title>References</title>
101
102 <remark>[1]What does this refer to and what should be listed
103 here.</remark>
104 </section>
105
106 <section id="def_acro_cmc">
107 <title>Definitions and Acronyms</title>
108
109 <table>
110 <title>Definitions and Acronyms</title>
111
112 <tgroup cols="2">
113 <colspec align="left" />
114
115 <colspec colwidth="2*" />
116
117 <colspec colwidth="5*" />
118
119 <thead>
120 <row>
121 <entry align="center">Component</entry>
122
123 <entry align="center">Definition</entry>
124 </row>
125 </thead>
126
127 <tbody>
128 <row>
129 <entry>uCPE Manager</entry>
130
131 <entry>The Enea uCPE Manager is an EMS/NMS platform that provides
132 the VNF Management capabilities for NFV Access devices. The uCPE
133 Manager can be deployed on a Linux (CentOS) based physical or
134 virtual server. Coresident with the uCPE Manager is additional
135 functionality, which includes the Automation Framework.</entry>
136 </row>
137
138 <row>
139 <entry>Automation Framework</entry>
140
141 <entry>The Automation Framework consists of a set of tools and a
142 collection of Python based scripts that can be used to automate
143 the process of onboarding a VNF with all of the required
144 configuration for day zero deployment at scale. This tooling calls
145 the auto-generated REST API that is exposed on the uCPE Manager as
146 a north bound interface.</entry>
147 </row>
148 </tbody>
149 </tgroup>
150 </table>
151 </section>
152</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/service_chaining_128t_fortigate.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/service_chaining_128t_fortigate.xml
deleted file mode 100644
index 458da7f..0000000
--- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/service_chaining_128t_fortigate.xml
+++ /dev/null
@@ -1,1087 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="service_chaining_128t_fortigate">
3 <title>Service Chaining 128T - Fortigate Example Use-case</title>
4
5 <para>The term service chaining or service function chaining (SFC) is used
6 to describe the definition and instantiation of an ordered list of instances
7 of such service functions and the subsequent "steering" of traffic flows
8 through those service functions. The set of enabled service function chains
9 reflects operator service offerings and is designed in conjunction with
10 application delivery and service and network policy.</para>
11
12 <para>The Network Service Header (NSH - RFC 8300) is a service-chaining
13 protocol that is added to network traffic, in the packet header, to describe
14 a sequence of service nodes (PNFs or VNFs) that the packet must be routed to
15 prior to reaching its destination address, thus creating a service
16 chain.</para>
17
18 <section id="prereq_serv_chain_cmc">
19 <title>Prerequisites</title>
20
21 <para>The 128T router and the Fortinet firewall in a service chain require
22 the following prequisites for this example use case:</para>
23
24 <itemizedlist spacing="compact">
25 <listitem>
26 <para>1 in band management port for device management.</para>
27 </listitem>
28
29 <listitem>
30 <para>1 in band management port for the 128T router.</para>
31 </listitem>
32
33 <listitem>
34 <para>1 in band management port for Fortinet.</para>
35 </listitem>
36
37 <listitem>
38 <para>1 WAN interface for Fortinet.</para>
39 </listitem>
40
41 <listitem>
42 <para>1 LAN facing interface for Fortinet.</para>
43 </listitem>
44
45 <listitem>
46 <para>1 WAN facing interface for the 128T router.</para>
47 </listitem>
48
49 <listitem>
50 <para>1 service chain (SFC Bridged interface) to sit between the
51 Firewall and vRouter.</para>
52 </listitem>
53 </itemizedlist>
54 </section>
55
56 <section id="ser_chain_uc">
57 <title>Service Chaining 128T - Fortigate</title>
58
59 <figure>
60 <title>Service Chaining 128T - Fortigate Setup Overview</title>
61
62 <mediaobject>
63 <imageobject>
64 <imagedata contentwidth="600"
65 fileref="images/kontron_me1100_servicechain.png" />
66 </imageobject>
67 </mediaobject>
68 </figure>
69
70 <section>
71 <title>Use-case Setup</title>
72
73 <para><emphasis role="bold">Configuring Network Interfaces on uCPE
74 devices:</emphasis><orderedlist>
75 <listitem>
76 <para>Log into the uCPE Manager with both username and password
77 values: <literal>admin</literal>.</para>
78 </listitem>
79
80 <listitem>
81 <para>Add the Kontron me1100 uCPE device into the uCPE Manager:
82 <literal>Devices -&gt; Manage -&gt; Add</literal>.</para>
83
84 <para>Fill in the required fields with the following data:</para>
85
86 <table>
87 <title>Device Details</title>
88
89 <tgroup cols="2">
90 <colspec align="left" />
91
92 <colspec colwidth="2*" />
93
94 <colspec colwidth="5*" />
95
96 <thead>
97 <row>
98 <entry align="center">Field</entry>
99
100 <entry align="center">Value</entry>
101 </row>
102 </thead>
103
104 <tbody>
105 <row>
106 <entry>Type</entry>
107
108 <entry>Enea universal CPE</entry>
109 </row>
110
111 <row>
112 <entry>Release</entry>
113
114 <entry>1.0</entry>
115 </row>
116
117 <row>
118 <entry>Name</entry>
119
120 <entry>me1100</entry>
121 </row>
122
123 <row>
124 <entry>IP/DNS Address</entry>
125
126 <entry>&lt;unspecified&gt;<note>
127 <para>Please do not provide an IP address.</para>
128 </note></entry>
129 </row>
130
131 <row>
132 <entry>Description</entry>
133
134 <entry>Kontron Target 1</entry>
135 </row>
136
137 <row>
138 <entry>Device ID</entry>
139
140 <entry>The value of the Device ID must be the same as the
141 one used during the NFV Access installation.</entry>
142 </row>
143
144 <row>
145 <entry>SSH Port</entry>
146
147 <entry>830</entry>
148 </row>
149
150 <row>
151 <entry>SSH User Name</entry>
152
153 <entry>root</entry>
154 </row>
155
156 <row>
157 <entry>Password</entry>
158
159 <entry>null</entry>
160 </row>
161
162 <row>
163 <entry>OK</entry>
164
165 <entry>Green status indicates connection with uCPE device
166 was established.</entry>
167 </row>
168 </tbody>
169 </tgroup>
170 </table>
171 </listitem>
172
173 <listitem>
174 <para>In order to add the device on the map: Right-Click on
175 <literal>Map -&gt; Place Device -&gt; me1100</literal>.</para>
176
177 <note>
178 <para>In order for the device to connect to the uCPE Manager,
179 it must be added to the uCPE Manager and be powered on,
180 having the NFV Access platform started, otherwise it must
181 be rebooted.</para>
182 </note>
183 </listitem>
184
185 <listitem>
186 <para>Configure the infrastructure for the 128T and Fortigate VNFs
187 in the service chain by creating four OVS bridges and a host
188 interface.</para>
189
190 <para>Add the Host Interface by selecting the
191 <literal>me1100</literal> device, then <literal>Configuration
192 -&gt; External Interfaces -&gt; Configuration -&gt; Add</literal>.
193 Fill in the required fields with the following data:</para>
194
195 <table>
196 <title>Host Interface Details</title>
197
198 <tgroup cols="2">
199 <colspec align="left" />
200
201 <colspec colwidth="2*" />
202
203 <colspec colwidth="5*" />
204
205 <thead>
206 <row>
207 <entry align="center">Field</entry>
208
209 <entry align="center">Value</entry>
210 </row>
211 </thead>
212
213 <tbody>
214 <row>
215 <entry>Source</entry>
216
217 <entry><literal>enp4s0f1</literal>. The only interface
218 available for LAN connection.</entry>
219 </row>
220
221 <row>
222 <entry>type</entry>
223
224 <entry>dpdk</entry>
225 </row>
226
227 <row>
228 <entry>networking-type</entry>
229
230 <entry>dpdk</entry>
231 </row>
232
233 <row>
234 <entry>dpdk-type</entry>
235
236 <entry>vfio-pci</entry>
237 </row>
238
239 <row>
240 <entry>Create</entry>
241
242 <entry>&lt;interface enp4s0f1 ready to be used in a LAN
243 bridge.&gt;</entry>
244 </row>
245 </tbody>
246 </tgroup>
247 </table>
248
249 <para>Add the OVS bridges by selecting the me1100 device then:
250 <literal>Configuration -&gt; OpenVSwitch -&gt; Bridges -&gt;
251 Add</literal>.</para>
252
253 <para>Fill in the required fields for each bridge with the
254 following data from each table:</para>
255
256 <table>
257 <title>ibm_br Bridge Details</title>
258
259 <tgroup cols="2">
260 <colspec align="left" />
261
262 <colspec colwidth="2*" />
263
264 <colspec colwidth="5*" />
265
266 <thead>
267 <row>
268 <entry align="center">Field</entry>
269
270 <entry align="center">Value</entry>
271 </row>
272 </thead>
273
274 <tbody>
275 <row condition="hidden">
276 <entry>id</entry>
277
278 <entry>&lt;autogenerated - do not change&gt;</entry>
279 </row>
280
281 <row>
282 <entry>Name</entry>
283
284 <entry><literal>ibm_br</literal></entry>
285 </row>
286
287 <row>
288 <entry>ovs-bridge-type</entry>
289
290 <entry>InbandMgmt</entry>
291 </row>
292
293 <row condition="hidden">
294 <entry>mgmt-address</entry>
295
296 <entry>Provide the IP address of the uCPE Manager machine
297 (E.g. 172.24.3.109).</entry>
298 </row>
299
300 <row condition="hidden">
301 <entry>mgmt-port</entry>
302
303 <entry>830</entry>
304 </row>
305
306 <row>
307 <entry>Create</entry>
308
309 <entry></entry>
310 </row>
311 </tbody>
312 </tgroup>
313 </table>
314
315 <table>
316 <title>vnf_mgmt_br Bridge Details</title>
317
318 <tgroup cols="2">
319 <colspec align="left" />
320
321 <colspec colwidth="2*" />
322
323 <colspec colwidth="5*" />
324
325 <thead>
326 <row>
327 <entry align="center">Field</entry>
328
329 <entry align="center">Value</entry>
330 </row>
331 </thead>
332
333 <tbody>
334 <row condition="hidden">
335 <entry>id</entry>
336
337 <entry>&lt;autogenerated - do not change&gt;</entry>
338 </row>
339
340 <row>
341 <entry>Name</entry>
342
343 <entry><literal>vnf_mgmt_br</literal></entry>
344 </row>
345
346 <row>
347 <entry>ovs-bridge-type</entry>
348
349 <entry>vnfMgmt</entry>
350 </row>
351
352 <row>
353 <entry>vnf-mgmt-address</entry>
354
355 <entry>10.0.0.1</entry>
356 </row>
357
358 <row>
359 <entry>Create</entry>
360
361 <entry></entry>
362 </row>
363 </tbody>
364 </tgroup>
365 </table>
366
367 <table>
368 <title>lan_br Bridge Details</title>
369
370 <tgroup cols="2">
371 <colspec align="left" />
372
373 <colspec colwidth="2*" />
374
375 <colspec colwidth="5*" />
376
377 <thead>
378 <row>
379 <entry align="center">Field</entry>
380
381 <entry align="center">Value</entry>
382 </row>
383 </thead>
384
385 <tbody>
386 <row condition="hidden">
387 <entry>id</entry>
388
389 <entry>&lt;autogenerated - do not change&gt;</entry>
390 </row>
391
392 <row>
393 <entry>Name</entry>
394
395 <entry><literal>lan_br</literal></entry>
396 </row>
397
398 <row>
399 <entry>ovs-bridge-type</entry>
400
401 <entry>dataPlane</entry>
402 </row>
403
404 <row>
405 <entry>sub-type</entry>
406
407 <entry>communication</entry>
408 </row>
409
410 <row>
411 <entry>+</entry>
412
413 <entry>Name: enp4s0f1 OK</entry>
414 </row>
415
416 <row>
417 <entry>Create</entry>
418
419 <entry></entry>
420 </row>
421 </tbody>
422 </tgroup>
423 </table>
424
425 <table>
426 <title>sfc_br Bridge Details</title>
427
428 <tgroup cols="2">
429 <colspec align="left" />
430
431 <colspec colwidth="2*" />
432
433 <colspec colwidth="5*" />
434
435 <thead>
436 <row>
437 <entry align="center">Field</entry>
438
439 <entry align="center">Value</entry>
440 </row>
441 </thead>
442
443 <tbody>
444 <row condition="hidden">
445 <entry>id</entry>
446
447 <entry>&lt;autogenerated - do not change&gt;</entry>
448 </row>
449
450 <row>
451 <entry>Name</entry>
452
453 <entry><literal>sfc_br</literal></entry>
454 </row>
455
456 <row>
457 <entry>ovs-bridge-type</entry>
458
459 <entry>dataPlane</entry>
460 </row>
461
462 <row>
463 <entry>sub-type</entry>
464
465 <entry>integration</entry>
466 </row>
467
468 <row>
469 <entry>Create</entry>
470
471 <entry></entry>
472 </row>
473 </tbody>
474 </tgroup>
475 </table>
476 </listitem>
477 </orderedlist></para>
478
479 <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para>
480
481 <para>Onboard the 128T VNF VM Image through <literal>VNF -&gt;
482 Descriptors -&gt; On-board -&gt; VM Image</literal>, and fill in the
483 required fields with the following values:</para>
484
485 <table>
486 <title>128T VM Image Details</title>
487
488 <tgroup cols="2">
489 <colspec align="left" />
490
491 <colspec colwidth="2*" />
492
493 <colspec colwidth="5*" />
494
495 <thead>
496 <row>
497 <entry align="center">Field</entry>
498
499 <entry align="center">Value</entry>
500 </row>
501 </thead>
502
503 <tbody>
504 <row>
505 <entry>VM image file</entry>
506
507 <entry><literal>centos_128t_with_ci.qcow2</literal></entry>
508 </row>
509
510 <row>
511 <entry>Image format</entry>
512
513 <entry>QCOW2</entry>
514 </row>
515
516 <row>
517 <entry>VNF Type Name</entry>
518
519 <entry>128T</entry>
520 </row>
521
522 <row>
523 <entry>Description</entry>
524
525 <entry>128T Router</entry>
526 </row>
527
528 <row>
529 <entry>Version</entry>
530
531 <entry>1.0</entry>
532 </row>
533
534 <row>
535 <entry>Memory in MB</entry>
536
537 <entry>8192. More memory can be allocated if required
538 (&lt;28672).</entry>
539 </row>
540
541 <row>
542 <entry>Num. of CPUs</entry>
543
544 <entry>2. More CPUs can be reserved if required
545 (&lt;15).</entry>
546 </row>
547
548 <row>
549 <entry>Interfaces -&gt; +</entry>
550
551 <entry>Name: mgmt</entry>
552 </row>
553
554 <row>
555 <entry>Interfaces -&gt; +</entry>
556
557 <entry>Name: wan</entry>
558 </row>
559
560 <row>
561 <entry>Interfaces -&gt; +</entry>
562
563 <entry>Name: lan</entry>
564 </row>
565
566 <row>
567 <entry>Cloud Init -&gt; Cloud-Init Datasource</entry>
568
569 <entry>ISO</entry>
570 </row>
571
572 <row>
573 <entry>Cloud Init -&gt; Cloud-Init Disk Type</entry>
574
575 <entry>cdrom</entry>
576 </row>
577
578 <row>
579 <entry>Properties -&gt; +</entry>
580
581 <entry>Name: vnfMgmtIpAddress. Value: 10.0.0.2</entry>
582 </row>
583
584 <row>
585 <entry>Properties -&gt; +</entry>
586
587 <entry>Name: internalMgmtPort. Value: 443</entry>
588 </row>
589
590 <row>
591 <entry>Properties -&gt; +</entry>
592
593 <entry>Name: externalMgmtPort. Value: 60001</entry>
594 </row>
595
596 <row>
597 <entry>Onboard</entry>
598
599 <entry>&lt;Wait for message: VNF package onboarded
600 successfully&gt;</entry>
601 </row>
602
603 <row>
604 <entry>Close</entry>
605
606 <entry></entry>
607 </row>
608 </tbody>
609 </tgroup>
610 </table>
611
612 <note>
613 <itemizedlist>
614 <listitem>
615 <para>HTTPS access (443) can be changed to another type of access.
616 Please consult official 128T documentation and make sure the 128T
617 VNF is configured to accept another type of connection before
618 changing the port number.</para>
619 </listitem>
620
621 <listitem>
622 <para><literal>externalMgmtPort(60001)</literal> represents the
623 external port on which the user can access the VNF management
624 interface from the web browser via HTTPS. The user can select
625 another port if needed. There are no other changes required or
626 components affected by this change.</para>
627 </listitem>
628
629 <listitem>
630 <para><literal>vnfMgmtIpAddress</literal> (10.0.0.2) represents
631 the IP address of the management interface of the 128T VNF.
632 Changing this value requires an update to the 128T configuration
633 to match the new IP address.</para>
634 </listitem>
635 </itemizedlist>
636 </note>
637
638 <para>Onboard the Fortigate VNF VM Image through <literal>VNF -&gt;
639 Descriptors -&gt; On-board -&gt; VM Image</literal>, and fill in the
640 required fields with the following values:</para>
641
642 <table>
643 <title>Fortigate VM Image Details</title>
644
645 <tgroup cols="2">
646 <colspec align="left" />
647
648 <colspec colwidth="2*" />
649
650 <colspec colwidth="5*" />
651
652 <thead>
653 <row>
654 <entry align="center">Field</entry>
655
656 <entry align="center">Value</entry>
657 </row>
658 </thead>
659
660 <tbody>
661 <row>
662 <entry>VM image file</entry>
663
664 <entry><literal>fortios.qcow2</literal>. Please make sure to
665 contact Fortigate for an official Fortigate KVM image.</entry>
666 </row>
667
668 <row>
669 <entry>Image format</entry>
670
671 <entry>QCOW2</entry>
672 </row>
673
674 <row>
675 <entry>VNF Type Name</entry>
676
677 <entry>Fortigate</entry>
678 </row>
679
680 <row>
681 <entry>Description</entry>
682
683 <entry>Fortigate VNF</entry>
684 </row>
685
686 <row>
687 <entry>Version</entry>
688
689 <entry>1.0</entry>
690 </row>
691
692 <row>
693 <entry>Memory in MB</entry>
694
695 <entry>1024. More memory can be allocated if required
696 (&lt;28672).</entry>
697 </row>
698
699 <row>
700 <entry>Num. of CPUs</entry>
701
702 <entry>1. More CPUs can be reserved if required
703 (&lt;15).</entry>
704 </row>
705
706 <row>
707 <entry>Interfaces -&gt; +</entry>
708
709 <entry>Name: mgmt</entry>
710 </row>
711
712 <row>
713 <entry>Interfaces -&gt; +</entry>
714
715 <entry>Name: wan</entry>
716 </row>
717
718 <row>
719 <entry>Interfaces -&gt; +</entry>
720
721 <entry>Name: lan</entry>
722 </row>
723
724 <row>
725 <entry>Cloud Init -&gt; Cloud-Init Datasource</entry>
726
727 <entry>ConfigDrive</entry>
728 </row>
729
730 <row>
731 <entry>Cloud Init -&gt; Cloud-Init Disk Type</entry>
732
733 <entry>cdrom</entry>
734 </row>
735
736 <row>
737 <entry>Cloud Init -&gt; +</entry>
738
739 <entry>Path: license</entry>
740 </row>
741
742 <row>
743 <entry>Properties -&gt; +</entry>
744
745 <entry>Name: vnfMgmtIpAddress. Value: 10.0.0.3</entry>
746 </row>
747
748 <row>
749 <entry>Properties -&gt; +</entry>
750
751 <entry>Name: internalMgmtPort. Value: 443</entry>
752 </row>
753
754 <row>
755 <entry>Properties -&gt; +</entry>
756
757 <entry>Name: externalMgmtPort. Value: 60002</entry>
758 </row>
759
760 <row>
761 <entry>Onboard</entry>
762
763 <entry>&lt;Wait for message: VNF package onboarded
764 successfully&gt;</entry>
765 </row>
766
767 <row>
768 <entry>Close</entry>
769
770 <entry></entry>
771 </row>
772 </tbody>
773 </tgroup>
774 </table>
775
776 <note>
777 <itemizedlist>
778 <listitem>
779 <para>HTTPS access (443) can be changed to another type of access.
780 Please consult official Fortigate documentation and make sure the
781 Fortigate VNF is configured to accept another type of connection
782 before changing the port number.</para>
783 </listitem>
784
785 <listitem>
786 <para><literal>externalMgmtPort</literal> (60002) represents the
787 external port on which the user can access the VNF management
788 interface from the web browser via HTTPS. The user can select
789 another port if needed. There are no other changes required or
790 components affected by this change.</para>
791 </listitem>
792
793 <listitem>
794 <para><literal>vnfMgmtIpAddress</literal> (10.0.0.3) represents
795 the IP address of the management interface of the Fortigate VNF.
796 Changing this value requires an update to the Fortigate
797 configuration to match with new IP address.</para>
798 </listitem>
799 </itemizedlist>
800 </note>
801
802 <para><emphasis role="bold">Instantiating the VNFs:</emphasis></para>
803
804 <para>Instantiate the 128T VNF by selecting the me1100 device, then
805 <literal>VNF -&gt; Instances -&gt; Add</literal>.</para>
806
807 <para>Fill in the required fields with the following values:</para>
808
809 <table>
810 <title>128T VNF Instantiation</title>
811
812 <tgroup cols="2">
813 <colspec align="left" />
814
815 <colspec colwidth="2*" />
816
817 <colspec colwidth="5*" />
818
819 <thead>
820 <row>
821 <entry align="center">Field</entry>
822
823 <entry align="center">Value</entry>
824 </row>
825 </thead>
826
827 <tbody>
828 <row>
829 <entry>Name</entry>
830
831 <entry>128T_me1100_1</entry>
832 </row>
833
834 <row>
835 <entry>VNF Type</entry>
836
837 <entry>128T</entry>
838 </row>
839
840 <row>
841 <entry>VNFD Version</entry>
842
843 <entry>1.0</entry>
844 </row>
845
846 <row>
847 <entry>Flavour</entry>
848
849 <entry>Canonical</entry>
850 </row>
851
852 <row>
853 <entry>uCPE Device</entry>
854
855 <entry>me1100</entry>
856 </row>
857
858 <row>
859 <entry>Cloud Init File</entry>
860
861 <entry><literal>centos_128t_internet_ci.iso</literal>. Example
862 image provided. Please see Appendix A for details on how to
863 change the configuration and create a new cloud-init iso
864 image.</entry>
865 </row>
866
867 <row>
868 <entry>Domain Update Script</entry>
869
870 <entry></entry>
871 </row>
872
873 <row>
874 <entry>Interfaces</entry>
875
876 <entry></entry>
877 </row>
878
879 <row>
880 <entry>ID</entry>
881
882 <entry>IF Name</entry>
883 </row>
884
885 <row>
886 <entry>mgmt (dpdk)</entry>
887
888 <entry>Bridge: vnf_mgmt_br</entry>
889 </row>
890
891 <row>
892 <entry>wan (dpdk)</entry>
893
894 <entry>Bridge: ibm_br</entry>
895 </row>
896
897 <row>
898 <entry>lan (dpdk)</entry>
899
900 <entry>Bridge: sfc_br</entry>
901 </row>
902
903 <row>
904 <entry>Create</entry>
905
906 <entry></entry>
907 </row>
908 </tbody>
909 </tgroup>
910 </table>
911
912 <para>Instantiate the Fortigate VNF by selecting the me1100 device, then
913 <literal>VNF -&gt; Instances -&gt; Add</literal>.</para>
914
915 <para>Fill in the required fields with the following values:</para>
916
917 <table>
918 <title>Fortigate VNF Instantiation</title>
919
920 <tgroup cols="2">
921 <colspec align="left" />
922
923 <colspec colwidth="2*" />
924
925 <colspec colwidth="5*" />
926
927 <thead>
928 <row>
929 <entry align="center">Field</entry>
930
931 <entry align="center">Value</entry>
932 </row>
933 </thead>
934
935 <tbody>
936 <row>
937 <entry>Name</entry>
938
939 <entry>fg_me1100_1</entry>
940 </row>
941
942 <row>
943 <entry>VNF Type</entry>
944
945 <entry>Fortigate</entry>
946 </row>
947
948 <row>
949 <entry>VNFD Version</entry>
950
951 <entry>1.0</entry>
952 </row>
953
954 <row>
955 <entry>Flavour</entry>
956
957 <entry>Canonical</entry>
958 </row>
959
960 <row>
961 <entry>uCPE Device</entry>
962
963 <entry>me1100</entry>
964 </row>
965
966 <row>
967 <entry>Cloud Init File</entry>
968
969 <entry><literal>fg_cmc_basic_fw.conf</literal></entry>
970 </row>
971
972 <row>
973 <entry>License File</entry>
974
975 <entry><literal>FGVM08TM00001.lic</literal>. Please make sure to
976 use a valid license file (.lic) received from Fortinet.</entry>
977 </row>
978
979 <row>
980 <entry>Domain Update Script</entry>
981
982 <entry></entry>
983 </row>
984
985 <row>
986 <entry>Interfaces</entry>
987
988 <entry></entry>
989 </row>
990
991 <row>
992 <entry>ID</entry>
993
994 <entry>IF Name</entry>
995 </row>
996
997 <row>
998 <entry>mgmt (dpdk)</entry>
999
1000 <entry>Bridge: vnf_mgmt_br</entry>
1001 </row>
1002
1003 <row>
1004 <entry>wan (dpdk)</entry>
1005
1006 <entry>Bridge: sfc_br</entry>
1007 </row>
1008
1009 <row>
1010 <entry>lan (dpdk)</entry>
1011
1012 <entry>Bridge: lan_br</entry>
1013 </row>
1014
1015 <row>
1016 <entry>Create</entry>
1017
1018 <entry></entry>
1019 </row>
1020 </tbody>
1021 </tgroup>
1022 </table>
1023 </section>
1024
1025 <section>
1026 <title>Testing the Use-case</title>
1027
1028 <para>In order to access the web interfaces of the 128T VNF, open a
1029 browser on a machine connected on the same network with the WAN port of
1030 the target and connect to:
1031 <literal>https://&lt;publicIP&gt;:60001</literal> using the username:
1032 admin and the password: 128Tadmin.</para>
1033
1034 <para>In order to access the web interfaces of the Fortigate VNF, open a
1035 browser on a machine connected on the same network with the WAN port of
1036 the target and connect to:
1037 <literal>https://&lt;publicIP&gt;:60002</literal> using the username:
1038 admin, and leaving the password blank.</para>
1039
1040 <note>
1041 <para>Make sure the WAN interface of the me1100 device has access to
1042 the internet. The Fortigate VNF requires internet access to validate
1043 the license.</para>
1044 </note>
1045
1046 <para>In order to validate the data path connect a test machine to the
1047 LAN physical port and check for a dynamic IP (the Fortigate LAN
1048 interface is configured with a DHCP server):<programlisting>&gt; dhclient eth1
1049&gt; ping 8.8.8.8</programlisting>For data path validation, a new cloud-init
1050 image may need to be generated for the 128T VNF to match your network
1051 configuration. Please check Appendix A "How to create 128T cloud-init
1052 iso image (day-0 configuration)" for details.</para>
1053 </section>
1054
1055 <section>
1056 <title>Use-case Clean-up</title>
1057
1058 <para>In order to remove the setup created in previously, all components
1059 need to be deleted in reverse order:</para>
1060
1061 <orderedlist>
1062 <listitem>
1063 <para>Select the <literal>me1100</literal> uCPE device -&gt; VNF
1064 -&gt; Instances. Select the 128T and Fortigate VNFs -&gt;
1065 Delete.</para>
1066 </listitem>
1067
1068 <listitem>
1069 <para>Select the <literal>me1100</literal> uCPE device -&gt;
1070 Configuration -&gt; OpenVSwitch -&gt; Bridges. Select all bridges
1071 -&gt; Delete.</para>
1072 </listitem>
1073
1074 <listitem>
1075 <para>Select the <literal>me1100</literal> uCPE device -&gt;
1076 Configuration -&gt; External Interfaces -&gt; Configuration. Select
1077 all interfaces -&gt; Delete.</para>
1078 </listitem>
1079
1080 <listitem>
1081 <para>VNF -&gt; Descriptors. Select all bundles -&gt;
1082 Offboard.</para>
1083 </listitem>
1084 </orderedlist>
1085 </section>
1086 </section>
1087</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/doc/usecases_autoframe.xml b/doc/book-enea-nfv-access-cmc-example-usecases/doc/usecases_autoframe.xml
deleted file mode 100644
index 9fb65a0..0000000
--- a/doc/book-enea-nfv-access-cmc-example-usecases/doc/usecases_autoframe.xml
+++ /dev/null
@@ -1,46 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="autoframe_uc_cmc">
3 <title>Running Example Use-cases from the Automation Framework</title>
4
5 <section id="uc_one_auto_cmc">
6 <title>128T VNF Router Example Use-case</title>
7
8 <para><emphasis role="bold">Deploying the 128T VNF
9 Router</emphasis></para>
10
11 <programlisting>&gt; cd automation_and_systemtest/automation_framework/unittestSuite
12&gt; python unittestSuite.py -u admin -p admin -H &lt;uCPE_Manager_IP&gt; -n me1100-1 \
13-s AddDevice_uCPEM.json -d "Add Device uCPE Manager"
14&gt; python unittestSuite.py -u admin -p admin -H &lt;uCPE_Manager_IP&gt; -n me1100-1 \
15-s 128tDeploy.json -d "128T Deployment"<remark>ADCA wants to replace these last two lines.
16With what?</remark></programlisting>
17
18 <para><emphasis role="bold">Use-case Clean-up</emphasis></para>
19
20 <programlisting>&gt; python unittestSuite.py -u admin -p admin -H &lt;uCPE_Manager_IP&gt; -n me1100-1 \
21-s 128tCleanup.json -d "128T Clean-up"</programlisting>
22 </section>
23
24 <section id="uc_two_auto_cmc">
25 <title>Service Chaining 128T - Fortigate Example Use-case</title>
26
27 <para><emphasis role="bold">Deploying the 128T router and Fortigate
28 VNF</emphasis></para>
29
30 <programlisting>&gt; cd automation_and_systemtest/automation_framework/unittestSuite
31&gt; python unittestSuite.py -u admin -p admin -H &lt;uCPE_Manager_IP&gt; -n me1100-1 \
32-s AddDevice_uCPEM.json -d "Add Device uCPE Manager"
33&gt; python unittestSuite.py -u admin -p admin -H &lt;uCPE_Manager_IP&gt; -n me1100-1 \
34-s 128t_FG_SFCDeploy.json -d "128T - Fortigate SFC Deployment" </programlisting>
35
36 <para><emphasis role="bold">Use-case Clean-up</emphasis></para>
37
38 <programlisting>&gt; python unittestSuite.py -u admin -p admin -H &lt;uCPE_Manager_IP&gt; -n me1100-1 \
39-s 128t_FG_SFCCleanup.json -d "128T - Fortigate SFC CleanUp"</programlisting>
40
41 <note>
42 <para>Please replace &lt;uCPE_Manager_IP&gt; with the IP address of the
43 uCPE Manager machine.</para>
44 </note>
45 </section>
46</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-cmc-example-usecases/swcomp.mk b/doc/book-enea-nfv-access-cmc-example-usecases/swcomp.mk
deleted file mode 100755
index ca26c5c..0000000
--- a/doc/book-enea-nfv-access-cmc-example-usecases/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-cmc-example-usecases
9BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) for CMC Networks Example Use-cases"
10BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS)
diff --git a/doc/book-enea-nfv-access-evalkit/doc/book.xml b/doc/book-enea-nfv-access-evalkit/doc/book.xml
index 04c3dea..90399a7 100644
--- a/doc/book-enea-nfv-access-evalkit/doc/book.xml
+++ b/doc/book-enea-nfv-access-evalkit/doc/book.xml
@@ -4,7 +4,7 @@
4<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED"> 4<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED">
5]> 5]>
6<book id="book_enea_nfv_access_evalkit"> 6<book id="book_enea_nfv_access_evalkit">
7 <title><trademark class="registered">Enea</trademark> NFV Access EvalKit Manual</title> 7 <title><trademark class="registered">Enea</trademark> NFV Access Evaluation Kit</title>
8 8
9 <subtitle>Release Version 9 <subtitle>Release Version
10 <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" 10 <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)"
diff --git a/doc/book-enea-nfv-access-evalkit/swcomp.mk b/doc/book-enea-nfv-access-evalkit/swcomp.mk
index 4568a23..fe11914 100755
--- a/doc/book-enea-nfv-access-evalkit/swcomp.mk
+++ b/doc/book-enea-nfv-access-evalkit/swcomp.mk
@@ -6,5 +6,5 @@ BOOK_VER ?= $(REL_VER)-dev
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) 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 7
8BOOKPACKAGES := book-enea-nfv-access-evalkit 8BOOKPACKAGES := book-enea-nfv-access-evalkit
9BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) for CMC Networks Example Use-cases" 9BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) Evaluation Kit"
10BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) 10BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS)
diff --git a/doc/book-enea-nfv-access-getting-started/doc/grafana.xml b/doc/book-enea-nfv-access-getting-started/doc/grafana.xml
index 9fc9a27..05276ed 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/grafana.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/grafana.xml
@@ -263,4 +263,4 @@
263 <emphasis role="bold">Telemetry</emphasis> tab. The default dashboard 263 <emphasis role="bold">Telemetry</emphasis> tab. The default dashboard
264 available when launching Grafana can be customized as well.</para> 264 available when launching Grafana can be customized as well.</para>
265 </section> 265 </section>
266</chapter> \ No newline at end of file 266</chapter>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml
index f8da56d..d9784a0 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/installation_guide.xml
@@ -260,9 +260,9 @@ sudo firewall-cmd --reload</programlisting>
260 <listitem> 260 <listitem>
261 <para>Verify the installation:</para> 261 <para>Verify the installation:</para>
262 262
263 <programlisting>java -version 263 <programlisting>java -version
264openjdk version "11.0.3" 2019-04-16 LTS 264openjdk version "11.0.3" 2019-04-16 LTS
265OpenJDK Run Time Environment 18.9 (build 11.0.3+7-LTS) 265OpenJDK Run Time Environment 18.9 (build 11.0.3+7-LTS)
266OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing)</programlisting> 266OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing)</programlisting>
267 267
268 <note> 268 <note>
@@ -283,7 +283,7 @@ OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing)</program
283 installation:</para> 283 installation:</para>
284 284
285 <programlisting>export JAVA_HOME=$(dirname $(dirname $(readlink $(readlink $(which java))))) 285 <programlisting>export JAVA_HOME=$(dirname $(dirname $(readlink $(readlink $(which java)))))
286export PATH=$PATH:$JAVA_HOME/bin 286export PATH=$PATH:$JAVA_HOME/bin
287export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</programlisting> 287export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</programlisting>
288 288
289 <note> 289 <note>
@@ -478,7 +478,7 @@ userdel postgres</programlisting>
478 </listitem> 478 </listitem>
479 479
480 <listitem> 480 <listitem>
481 <para>Enter <literal>&lt;uCPEM-installdir&gt;</literal>.</para> 481 <para>Enter <literal>&lt;uCPEM-installdir&gt;/dist</literal>.</para>
482 </listitem> 482 </listitem>
483 483
484 <listitem> 484 <listitem>
@@ -856,7 +856,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
856 856
857 <itemizedlist> 857 <itemizedlist>
858 <listitem> 858 <listitem>
859 <para>The static Enea Edge Management IP Address. This can be 859 <para>The static Enea Edge Management IP Address or FQDN. This can be
860 either:</para> 860 either:</para>
861 861
862 <itemizedlist spacing="compact"> 862 <itemizedlist spacing="compact">
@@ -871,6 +871,11 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
871 please see <link linkend="firewall_config">Firewall 871 please see <link linkend="firewall_config">Firewall
872 Configuration</link>.</para> 872 Configuration</link>.</para>
873 </listitem> 873 </listitem>
874
875 <listitem>
876 <para>The Fully Qualified Domain Name (FQDN) of the Enea
877 uCPE Manager host machine.</para>
878 </listitem>
874 </itemizedlist> 879 </itemizedlist>
875 </listitem> 880 </listitem>
876 881
@@ -925,7 +930,8 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
925 <note> 930 <note>
926 <para>If errors are detected during installation, full logs will be 931 <para>If errors are detected during installation, full logs will be
927 available on the last page of the Web-installer. Please contact Enea 932 available on the last page of the Web-installer. Please contact Enea
928 for log analysis.</para> 933 for log analysis. The system is not expected to be usable if errors are
934 reported during installation.</para>
929 935
930 <para>If the USB stick was booted in UEFI mode, a UEFI boot entry is 936 <para>If the USB stick was booted in UEFI mode, a UEFI boot entry is
931 automatically created and the system will start booting from the hard 937 automatically created and the system will start booting from the hard
@@ -1184,4 +1190,4 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
1184 </note> 1190 </note>
1185 </section> 1191 </section>
1186 </section> 1192 </section>
1187</chapter> \ No newline at end of file 1193</chapter>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml
index 65dfb2b..dae5b36 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/net_config_options.xml
@@ -279,7 +279,7 @@
279 <itemizedlist> 279 <itemizedlist>
280 <listitem> 280 <listitem>
281 <para>Country Code: the country code, a 2 letter 281 <para>Country Code: the country code, a 2 letter
282 identifier.</para> 282 ISO3166-alpha2 identifier.</para>
283 </listitem> 283 </listitem>
284 284
285 <listitem> 285 <listitem>
@@ -883,4 +883,4 @@
883 Interfaces</emphasis>.</para> 883 Interfaces</emphasis>.</para>
884 </note> 884 </note>
885 </section> 885 </section>
886</chapter> \ No newline at end of file 886</chapter>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml
index e833c2d..641775d 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/upgrade_ena.xml
@@ -27,7 +27,7 @@
27 </listitem> 27 </listitem>
28 28
29 <listitem> 29 <listitem>
30 <para>Enter <literal>&lt;uCPEM-installdir&gt;</literal>.</para> 30 <para>Enter <literal>&lt;uCPEM-installdir&gt;/dist</literal>.</para>
31 </listitem> 31 </listitem>
32 32
33 <listitem> 33 <listitem>
@@ -52,7 +52,8 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
52 <para>Create a compressed file of the <literal>ucpemanager</literal> 52 <para>Create a compressed file of the <literal>ucpemanager</literal>
53 application folder 53 application folder
54 (<filename>ucpemanager-Back-up-YYYYddMMHHmm.tar.gz</filename>), which 54 (<filename>ucpemanager-Back-up-YYYYddMMHHmm.tar.gz</filename>), which
55 contains a snapshot of the existing installation.</para> 55 contains a snapshot of the existing installation in the
56 <literal>&lt;uCPEM-installdir&gt;/dist</literal> directory.</para>
56 57
57 <note> 58 <note>
58 <para>The snapshot file created during the upgrade can be used for 59 <para>The snapshot file created during the upgrade can be used for
@@ -70,12 +71,21 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
70 </listitem> 71 </listitem>
71 </itemizedlist> 72 </itemizedlist>
72 73
73 <para>For an example on how to upgrade an Enea Edge Management 74 <para><olink targetdoc="book_enea_nfv_access_getting_started"
74 installation in a High Availability setup, consult <olink 75 targetptr="fresh_ucpemg_install">Fresh Installation of the Enea Edge Management
76 in the <ns:include
77 href="../../s_docbuild/olinkdb/pardoc-names.xml"
78 xmlns:ns="http://www.w3.org/2001/XInclude"
79 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
80 Manual contains information about the input required to be entered during
81 the execution of the upgrade script.</para>
82
83 <para>For an example on how to upgrade an Enea Edge Management installation
84 in a High Availability setup, consult <olink
75 targetdoc="book_enea_nfv_access_getting_started" 85 targetdoc="book_enea_nfv_access_getting_started"
76 targetptr="ha_upgrade">Upgrading a High Availability Deployment in the 86 targetptr="ha_upgrade">Upgrading a High Availability Deployment in the
77 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml" 87 <ns:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
78 xmlns:xi="http://www.w3.org/2001/XInclude" 88 xmlns:ns="http://www.w3.org/2001/XInclude"
79 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink> 89 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
80 Manual.</para> 90 Manual.</para>
81 91
@@ -105,7 +115,7 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
105 </listitem> 115 </listitem>
106 116
107 <listitem> 117 <listitem>
108 <para>Enter <literal>&lt;uCPEM-installdir&gt;</literal>.</para> 118 <para>Enter <literal>&lt;uCPEM-installdir&gt;/dist</literal>.</para>
109 </listitem> 119 </listitem>
110 120
111 <listitem> 121 <listitem>
@@ -227,6 +237,15 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
227 upgrades the uCPE device to a newer version.</para> 237 upgrades the uCPE device to a newer version.</para>
228 </listitem> 238 </listitem>
229 </orderedlist> 239 </orderedlist>
240
241 <note>
242 <para>Upgrading from Enea NFV Access 2.3.0 is not possible when using
243 the Enea uCPE Manager in HTTPS mode. Either switch to HTTP by accessing
244 <emphasis role="bold">System</emphasis>, <emphasis
245 role="bold">Configuration</emphasis>, <emphasis role="bold">Web
246 Access</emphasis> and checking the <emphasis role="bold">Enable
247 HTTP</emphasis> box, or installing it manually.</para>
248 </note>
230 </section> 249 </section>
231 250
232 <section id="mg_upgrade"> 251 <section id="mg_upgrade">
@@ -260,10 +279,6 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
260 </listitem> 279 </listitem>
261 </itemizedlist> 280 </itemizedlist>
262 281
263 <para>Press <emphasis role="bold">Close</emphasis> when the message
264 <literal>File Uploaded Successfully</literal> appears on the <emphasis
265 role="bold">File Upload</emphasis> screen.</para>
266
267 <note> 282 <note>
268 <para>The uCPE Device upgrade is done with image files of the type 283 <para>The uCPE Device upgrade is done with image files of the type
269 <literal>rootfs.ostree.tar.bz2</literal>, which are available in the 284 <literal>rootfs.ostree.tar.bz2</literal>, which are available in the
@@ -386,9 +401,10 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
386 can accept an image file is populated when the image file is 401 can accept an image file is populated when the image file is
387 chosen.</para> 402 chosen.</para>
388 403
389 <para>Press the <emphasis role="bold">&gt;</emphasis> button to 404 <para>Mark the uCPE devices that you wish to upgrade and press the
390 move the uCPE devices to the right side of the selector. Those 405 <emphasis role="bold">&gt;</emphasis> button to move the uCPE
391 chosen form the list of uCPE devices that will be upgraded.</para> 406 devices to the right side of the selector. Those chosen form the
407 list of uCPE devices that will be upgraded.</para>
392 </listitem> 408 </listitem>
393 409
394 <listitem> 410 <listitem>
@@ -415,6 +431,11 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
415 </listitem> 431 </listitem>
416 </itemizedlist> 432 </itemizedlist>
417 </listitem> 433 </listitem>
434
435 <listitem>
436 <para>To start the upgrade, click <emphasis
437 role="bold">ok</emphasis>.</para>
438 </listitem>
418 </itemizedlist> 439 </itemizedlist>
419 440
420 <note> 441 <note>
@@ -564,4 +585,4 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
564 </section> 585 </section>
565 </section> 586 </section>
566 </section> 587 </section>
567</chapter> \ No newline at end of file 588</chapter>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml
index fbf7091..bd2fb0b 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml
@@ -125,13 +125,6 @@
125 <para>Click the <emphasis role="bold">On-board</emphasis> 125 <para>Click the <emphasis role="bold">On-board</emphasis>
126 button.</para> 126 button.</para>
127 </listitem> 127 </listitem>
128
129 <listitem>
130 <para>When prompted by the UI, make sure the <emphasis
131 role="bold">VM Image</emphasis> radio button at the top of the
132 onboarding screen is selected, it will trigger a popup menu
133 window.</para>
134 </listitem>
135 </orderedlist> 128 </orderedlist>
136 129
137 <para>This window contains data fields where both necessary and optional 130 <para>This window contains data fields where both necessary and optional
@@ -481,4 +474,4 @@
481 </listitem> 474 </listitem>
482 </orderedlist> 475 </orderedlist>
483 </section> 476 </section>
484</chapter> \ No newline at end of file 477</chapter>
diff --git a/doc/book-enea-nfv-access-release-info/doc/book.xml b/doc/book-enea-nfv-access-release-info/doc/book.xml
index cffe9b5..413eb6f 100644
--- a/doc/book-enea-nfv-access-release-info/doc/book.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/book.xml
@@ -9,7 +9,7 @@
9 9
10 <subtitle>Release Version 10 <subtitle>Release Version
11 <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" 11 <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)"
12 xmlns:xi="http://www.w3.org/2001/XInclude" /> Beta</subtitle> 12 xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle>
13 13
14 <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> 14 <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb -->
15 15
diff --git a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml
index d71deff..1f5fb0c 100644
--- a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml
@@ -49,6 +49,13 @@
49 </listitem> 49 </listitem>
50 50
51 <listitem> 51 <listitem>
52 <para><remark>USERDOCAP-648</remark>The <literal>storage size</literal>
53 parameter on the VNF onboarding page is ignored. The default storage
54 size specified when creating the VM image is used when instantiating the
55 VM and when presenting VM information.</para>
56 </listitem>
57
58 <listitem>
52 <para><remark>LXCR-9853</remark>The WAN interface of a uCPE device needs 59 <para><remark>LXCR-9853</remark>The WAN interface of a uCPE device needs
53 to be connected to a network with at least a router/gateway installed 60 to be connected to a network with at least a router/gateway installed
54 for next-hop communication.</para> 61 for next-hop communication.</para>
@@ -83,89 +90,123 @@
83 </listitem> 90 </listitem>
84 91
85 <listitem> 92 <listitem>
86 <para><remark>ELCCR-912</remark>When the Enea Edge Management is installed 93 <para><remark>ELCCR-912</remark>When the Enea Edge Management is installed
87 on CentOS 7, prior to C7.1804 (kernel version 3.10.0-862), adding an 94 on CentOS 7, prior to C7.1804 (kernel version 3.10.0-862), adding an
88 upgrade image fails. As a workaround, please update <literal>glib2</literal> 95 upgrade image fails. As a workaround, please update
89 to version 2.54.2 or later, using <literal>#yum update glib2</literal>.</para> 96 <literal>glib2</literal> to version 2.54.2 or later, using <literal>#yum
97 update glib2</literal>.</para>
98 </listitem>
99
100 <listitem>
101 <para><remark>ELCCR-854</remark>Changing the management interface IP
102 address will result in a temporary loss of connection with the uCPE
103 device. If the device is behind a NAT, while using the Call Home
104 connection, reestablishing the connection automatically could take up to
105 20 minutes. Restarting the vCPE Overlay will immediately reestablish the
106 connection, but that implies the existence of an alternate way to
107 trigger the vCPE restart operation on the device.</para>
108 </listitem>
109
110 <listitem>
111 <para><remark>USERDOCAP-641</remark>Enea Edge does not have
112 support for IPv6 addresses on both uCPE devices and the Enea Edge
113 Management installation.</para>
114 </listitem>
115
116 <listitem>
117 <para><remark>ELCCR-1428</remark>Wireless AP creation through the REST
118 API does not validate that the wireless interface and LAN bridge are
119 configured. Using these parameters may result in undefined
120 behavior.</para>
121 </listitem>
122
123 <listitem>
124 <para><remark>USERDOCAP-651</remark>Wireless AP configuration is
125 optimized for wireless modules that use the <literal>ath10k</literal>
126 driver. Using other wireless modules may result in undefined
127 behavior.</para>
128 </listitem>
129
130 <listitem>
131 <para><remark>ELCCR-1351</remark>The updated
132 <filename>.Keystore</filename> and <filename>server.xml</filename> files
133 from the
134 <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/</literal>
135 folder are overwritten during a product upgrade. As a workaround for
136 this issue, after an upgrade, copy the updated
137 <filename>.Keystore</filename> and <filename>server.xml</filename> files
138 into the
139 <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/</literal>
140 folder and restart the ucpemanager service.</para>
141 </listitem>
142
143 <listitem>
144 <para><remark>ELCCR-1371</remark>The current self-signed certificate for
145 the Enea Edge Management is generated at build time, with a hard-coded
146 common-name causing the uCPE device upgrade to fail in HTTPS mode. As a
147 workaround, another certificate (containing an IP based common-name)
148 must be generated.</para>
149
150 <para>Perform the following the steps to generate the
151 certificate:</para>
152
153 <orderedlist>
154 <listitem>
155 <para>Stop the Edge Management service.</para>
90 </listitem> 156 </listitem>
91 157
158 <listitem>
159 <para>Create the certificate using the
160 <filename>createCertificate.sh</filename> script from distribution
161 folder. This will create a new <filename>.Keystore</filename> file
162 and copy it into the
163 <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config/certificates</literal>
164 folder.</para>
165 </listitem>
166
167 <listitem>
168 <para>Start the Enea Edge Management, the new certificate should now
169 take effect.</para>
170 </listitem>
171 </orderedlist>
172 </listitem>
173
174 <listitem>
175 <para><remark>ELCCR-1378</remark>Modifying the type of the external
176 interfaces can lead to errors. Instead of modifying, it is recommended
177 to delete the old interfaces and recreate them with the desired
178 type.</para>
179 </listitem>
180
92 <listitem> 181 <listitem>
93 <para><remark>ELCCR-854</remark>Changing the management interface IP address 182 <para><remark>ELCCR-907</remark>At times the VIP address is not acquired
94 will result in a temporary loss of connection with the uCPE device. If the 183 by any of the backup nodes if a power failure happens on primary node in
95 device is behind a NAT, while using the Call Home connection, 184 a High Availability setup. To recover, follow the official documentation
96 reestablishing the connection automatically could take up to 20 minutes. 185 available at <ulink
97 Restarting the vCPE Overlay will immediately reestablish the connection, 186 url="https://mariadb.com/kb/en/galera-cluster-recovery/">Galera Cluster
98 but that implies the existence of an alternate way to trigger the vCPE 187 Recovery</ulink>.</para>
99 restart operation on the device.</para>
100 </listitem>
101
102 <listitem>
103 <para><remark>USERDOCAP-641</remark>Enea Edge does not have support
104 for IPv6 addresses on both uCPE devices and the Enea Edge Management
105 installation.</para>
106 </listitem>
107
108 <listitem>
109 <para><remark>ELCCR-1428</remark>Wireless AP creation through the REST
110 API does not validate that the wireless interface and LAN bridge are
111 configured. Using these parameters may result in undefined behavior.</para>
112 </listitem>
113
114 <listitem>
115 <para><remark>ELCCR-1351</remark>The updated <filename>.Keystore</filename>
116 and <filename>server.xml</filename> files from the
117 <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/</literal>
118 folder are overwritten during a product upgrade. As a workaround for
119 this issue, after an upgrade, copy the updated <filename>.Keystore</filename>
120 and <filename>server.xml</filename> files into the
121 <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/</literal>
122 folder and restart the ucpemanager service.</para>
123 </listitem>
124
125 <listitem>
126 <para><remark>ELCCR-1371</remark>The current self-signed certificate for
127 the Enea Edge Management is generated at build time, with a hard-coded common-name
128 causing the uCPE device upgrade to fail in HTTPS mode. As a workaround,
129 another certificate (containing an IP based common-name) must be generated.</para>
130
131 <para>Perform the following the steps to generate the certificate:</para>
132
133 <orderedlist>
134 <listitem><para>Stop the Enea Edge Management service.</para></listitem>
135
136 <listitem><para>Create the certificate using the
137 <filename>createCertificate.sh</filename> script from distribution
138 folder. This will create a new <filename>.Keystore</filename> file
139 and copy it into the
140 <literal>/opt/ems/ucpemanager/application/3rdParty/apache-tomcat/conf/config/certificates</literal>
141 folder.</para></listitem>
142
143 <listitem><para>Start the Enea Edge Management, the new certificate
144 should now take effect.</para></listitem>
145 </orderedlist>
146 </listitem>
147
148 <listitem>
149 <para><remark>ELCCR-1378</remark>Modifying the type of the external interfaces can lead
150 to errors. Instead of modifying, it is recommended to delete the old
151 interfaces and recreate them with the desired type.</para>
152 </listitem>
153
154 <listitem>
155 <para><remark>ELCCR-907</remark>At times the VIP address is not acquired
156 by any of the backup nodes if a power failure happens on primary node
157 in a High Availability setup. To recover, follow the official documentation
158 available at <ulink
159 url="https://mariadb.com/kb/en/galera-cluster-recovery/">Galera Cluster Recovery</ulink>.</para>
160 </listitem> 188 </listitem>
161 189
162 <listitem condition="hidden"> 190 <listitem condition="hidden">
163 <para><emphasis role="bold">PDF navigation</emphasis>: When using links 191 <para><remark>LXCR-3283</remark><emphasis role="bold">PDF
164 to open other PDFs, or jump to another place in the same PDF, jumping 192 navigation</emphasis>: When using links to open other PDFs, or jump to
165 back sometimes fails. This has been observed when opening a PDF in Adobe 193 another place in the same PDF, jumping back sometimes fails. This has
166 Reader, inside a browser with PDF add-on, as well as when the browser is 194 been observed when opening a PDF in Adobe Reader, inside a browser with
167 configured to open PDF files in an external PDF reader. As a workaround, 195 PDF add-on, as well as when the browser is configured to open PDF files
168 open the HTML version of the document.<remark>LXCR-3283</remark></para> 196 in an external PDF reader. As a workaround, open the HTML version of the
197 document.</para>
198 </listitem>
199
200 <listitem>
201 <para><remark>ELCCR-1468</remark>When using the Enea Edge Management in
202 HTTPS mode, upgrading a device from NFV Access 2.3.0 is not possible.
203 Either switch to HTTP mode (for more details see <olink
204 targetdoc="book_enea_nfv_access_getting_started"
205 targetptr="device_up_process">The uCPE device Upgrade Process in the
206 <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
207 xmlns:xi="http://www.w3.org/2001/XInclude"
208 xpointer="element(book_enea_nfv_access_getting_started/1)" /></olink>
209 Manual) or install it manually.</para>
169 </listitem> 210 </listitem>
170 </itemizedlist> 211 </itemizedlist>
171 212
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-05-13 16:23:20 +0000