1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="getting_started_ucpe_manager">
<title>Getting Started with Enea uCPE Manager</title>
<section id="prereq_ucpe">
<title>Prerequisites</title>
<para>Listed below are the main generic prerequisites required so that the
uCPE Manager can be deployed on the host platform:</para>
<itemizedlist>
<listitem>
<para>A uCPE device with Enea NFV Access Run Time Platform
installed.</para>
</listitem>
<listitem>
<para>A machine running CentOS 7 with network access to the physical
device.</para>
</listitem>
<listitem>
<para>CPU, RAM and storage requirements for the uCPE Manager:</para>
<itemizedlist>
<listitem>
<para>For small-sized deployments (tens of devices):</para>
<itemizedlist spacing="compact">
<listitem>
<para>4 cores</para>
</listitem>
<listitem>
<para>16 GB RAM</para>
</listitem>
<listitem>
<para>300 GB hard-drive</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>For mid-sized deployments (hundreds of devices):</para>
<itemizedlist spacing="compact">
<listitem>
<para>8 cores</para>
</listitem>
<listitem>
<para>32 GB RAM</para>
</listitem>
<listitem>
<para>300 GB hard-drive</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>For large deployments (thousands of devices):</para>
<itemizedlist spacing="compact">
<listitem>
<para>16 cores</para>
</listitem>
<listitem>
<para>64-256 GB RAM</para>
</listitem>
<listitem>
<para>1 - 2 TB hard-drive</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
<section id="install_ucpe_manager">
<title>Install the Enea uCPE Manager</title>
<para>Unpack the uCPE Manager and install it following the instructions
below.</para>
<section id="prep_sys_ucpe_mg">
<title>Preparing your system</title>
<orderedlist>
<listitem>
<para>Install Java:</para>
<orderedlist>
<listitem><para>Install OpenJDK 11:</para>
<programlisting>sudo yum install java-11-openjdk-devel</programlisting>
</listitem>
<listitem><para>Verify the installation:</para>
<programlisting>java -version
openjdk version "11.0.3" 2019-04-16 LTS
OpenJDK Runtime Environment 18.9 (build 11.0.3+7-LTS)
OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing)</programlisting></listitem>
<listitem><para>The following system variables need to point to the OpenJDK 11 installation:</para>
<programlisting>export JAVA_HOME=$(dirname $(dirname $(readlink $(readlink $(which javac)))))
export PATH=$PATH:$JAVA_HOME/bin
export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar
</programlisting>
</listitem>
</orderedlist>
<note><para>If there are multiple java versions installed, switch between them using the
following command:</para>
<programlisting>alternatives --config java</programlisting></note>
</listitem>
<listitem>
<para>Open a terminal with administrative rights, i.e. log into a
<emphasis role="bold">bash</emphasis> shell with
<literal>root</literal> privileges.</para>
</listitem>
<listitem>
<para>Choose the target installation folder, e.g.
<literal>/opt/ems</literal>. Everything will be installed under a
folder called <literal>ucpemanager</literal> within the target
installation folder.</para>
</listitem>
</orderedlist>
<para>The application files will be installed in
<literal>/opt/ems/ucpemanager/application</literal>. The database will
be installed in <literal>/opt/ems/ucpemanager/database</literal>.</para>
<note>
<para>If you have multiple spindles, it is recommended to let the
application run off one and the database off the other. This will
result in optimum performance. It is also recommended that the swap
disk be the same as the one used for the application.</para>
</note>
<para>Assuming another spindle is used (<literal>/drive2</literal>) do
the following:</para>
<itemizedlist>
<listitem>
<para>Create a folder which will host the database (e.g.
<literal>emsDatabase</literal>).</para>
</listitem>
<listitem>
<para>Create a soft-link that will point to this folder:</para>
<programlisting>ln -s /opt/ems/elementcenter/database /drive2/emsDatabase</programlisting>
</listitem>
<listitem>
<para>Follow the installation process as described below.</para>
</listitem>
</itemizedlist>
</section>
<section id="installing_ucpe_mg">
<title>Installing the uCPE Manager</title>
<orderedlist>
<listitem>
<para>Open a terminal with administrative rights, i.e. log into a
<emphasis role="bold">bash</emphasis> shell with
<literal>root</literal> privileges.</para>
</listitem>
<listitem>
<para><command>cd</command> to the folder you are installing
from.</para>
</listitem>
<listitem>
<para>Verify that the folder you are installing from contains the
following files:</para>
<itemizedlist>
<listitem>
<para><filename>README</filename></para>
</listitem>
<listitem>
<para><filename>install.sh</filename></para>
</listitem>
<listitem>
<para><filename>doinstall.sh</filename></para>
</listitem>
<listitem>
<para><literal>configureHA.sh</literal></para>
</listitem>
<listitem>
<para><filename>ucpemanager-x.y-Buildz-Linux.tar.gz</filename></para>
</listitem>
<listitem>
<para><filename>ReleaseNotes</filename></para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Run the following command:</para>
<programlisting>./install.sh /opt/ems ucpemanager-x.y-Buildz-Linux.tar.gz</programlisting>
</listitem>
</orderedlist>
<para>This command will:</para>
<itemizedlist>
<listitem>
<para>Extract the application files from the compressed install
kit.</para>
</listitem>
<listitem>
<para>Install the bundled database (if the user specifies an
internal database).</para>
</listitem>
<listitem>
<para>Install <literal>ucpemanager</literal> as a service with the
name <filename>ucpemanager</filename>.</para>
</listitem>
<listitem>
<para>Start the <literal>ucpemanager</literal> service.</para>
</listitem>
</itemizedlist>
<note>
<para>The service will be automatically started when the computer
boots up.</para>
<para>Check that the CentOS machine where the uCPE Manager is
installed has the firewall disabled.</para>
</note>
<para>Verify that the installation has succeeded by:</para>
<orderedlist>
<listitem>
<para>Pointing your browser to the server machine running the uCPE
Manager.</para>
</listitem>
<listitem>
<para>In the login screen, log in with the username: <emphasis
role="bold">admin</emphasis> and password: <emphasis
role="bold">admin</emphasis>.</para>
</listitem>
</orderedlist>
<para>In order to manage the ucpemanager service, user can run:
<programlisting>service ucpemanager start/stop</programlisting></para>
</section>
<section id="ins_restore_option">
<title>Installing with the restore option</title>
<para>It is possible to use a restore file created by the "System
Backup" utility provided in the uCPE Manager, to install a system and
set it to a known state.</para>
<note>
<para>The file to be used is the zip file created by System Backup,
not the one created by the uninstall or upgrade processes described
below.</para>
</note>
<para>The name format of this file will be:
<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename> (e.g
<literal>SystemBackup_Feb19_2013_2257_42.zip</literal>).</para>
<para>Follow the steps for Installation provided above and provide an
additional argument as shown below:</para>
<programlisting>./install.sh \
/opt/ems ucpemanager-1.0-Build8-Linux.tar.gz \
SystemBackup_MMMDD_YYYY_HHMM_SS.zip</programlisting>
<para>The other steps are exactly the same as specified in the
Installation instructions.</para>
</section>
<section id="upgrading_ucpe_mg">
<title>Upgrading the uCPE Manager</title>
<orderedlist>
<listitem>
<para>Verify that the folder you are upgrading from contains the
following files:</para>
<itemizedlist>
<listitem>
<para><filename>upgrade.sh</filename></para>
</listitem>
<listitem>
<para><filename>doupgrade.sh</filename></para>
</listitem>
<listitem>
<para><filename>configureHA.sh</filename></para>
</listitem>
<listitem>
<para><filename>ucpemanager-x.y-Buildz-Linux.tar.gz</filename></para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Run the following command:</para>
<programlisting>./upgrade.sh /opt/ems ucpemanager-1.0-Build8-Linux.tar.gz</programlisting>
</listitem>
</orderedlist>
<para>Running this command will:</para>
<itemizedlist>
<listitem>
<para>Stop the currently running ucpemanager service.</para>
</listitem>
<listitem>
<para>Create a compressed file of the ucpemanager application
folder, called:
<literal>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</literal>, which
contains a snapshot of the existing installation.</para>
</listitem>
<listitem>
<para>Rename the <literal>application</literal> folder to
<literal>application_original</literal>.</para>
</listitem>
<listitem>
<para>Extract the application files from the specified compressed
install kit. There will now exist a (new) application folder, with
the contents of the new kit.</para>
</listitem>
<listitem>
<para>Start the ucpemanager service.</para>
</listitem>
</itemizedlist>
<para>When the ucpemanager service starts, it will recognize the fact
that an old version of the application needs to be upgraded (based upon
the existence of the <literal>application_original</literal> folder. All
the relevant data from the old installation will be copied to the new
one and the <literal>application_original</literal> folder will be
deleted.</para>
</section>
<section id="uninstalling_ucpe_mg">
<title>Uninstalling an existing uCPE Manager installation</title>
<orderedlist>
<listitem>
<para>Verify that the folder you are uninstalling from contains the
following files:</para>
<itemizedlist>
<listitem>
<para><filename>uninstall.sh</filename></para>
</listitem>
<listitem>
<para><filename>douninstall.sh</filename></para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Run the following command:</para>
<programlisting>./uninstall.sh /opt/ems</programlisting>
</listitem>
</orderedlist>
<para>Running this command will:</para>
<itemizedlist>
<listitem>
<para>Stop the currently running ucpemanager service.</para>
</listitem>
<listitem>
<para>Create a compressed file of the ucpemanager application
folder, called
<literal>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</literal>, which
contains a snapshot of the existing installation.</para>
</listitem>
<listitem>
<para>Uninstall the ucpemanager service, so that it will not startup
on reboot.</para>
</listitem>
<listitem>
<para>Uninstall the database service (if an internal database is
being used).</para>
</listitem>
<listitem>
<para>Completely remove the contents of the
<literal>application</literal> and <literal>database</literal>
folders.</para>
</listitem>
</itemizedlist>
<para>After these steps, the uCPE Manager is completely removed from the
system.</para>
</section>
<section id="restoring_pre_installation">
<title>Restoring a previous uCPE Manager installation</title>
<orderedlist>
<listitem>
<para>Verify that the folder you are restoring from contains the
following files:</para>
<itemizedlist>
<listitem>
<para><filename>restore.sh</filename></para>
</listitem>
<listitem>
<para><filename>dorestore.sh</filename></para>
</listitem>
<listitem>
<para><filename>configureHA.sh</filename></para>
</listitem>
<listitem>
<para><filename>ucpemanager-Backup-YYYYddMMHHmm.tar.gz</filename>
(the original installation snapshot, as obtained from a previous
uninstall).</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Run the following command:</para>
<programlisting>./restore.sh /opt/ems ucpemanager-Backup-YYYYddMMHHmm.tar.gz</programlisting>
</listitem>
</orderedlist>
<para>Running this command will remove any vestiges of the existing
ucpemanager service, if they exist, and reinstall the ucpemanager
application on the specified target, restoring the data in the database
and files in the process.</para>
<para>The ucpemanager service is then started and the older version is
now running on the system.</para>
</section>
</section>
<section id="device_config_provision">
<title>Device Configuration and Provisioning</title>
<para>The following describes the steps required for setting up the
virtualization infrastructure, ensuring that a uCPE device is ready for
virtualized service deployment. The sections herein contain information
about enrolling uCPE devices into the Enea uCPE Manager, selecting
physical interfaces to be used by virtualized networking and creating
different types of bridges to enable VNF communication. The Zero Touch
Provisioning mechanism is also touched upon, as alternative to manual
configuration of the virtualization infrastructure.</para>
<section id="device_config">
<title>Add a uCPE device to the Management System</title>
<para>Enrolling uCPE devices into the Enea uCPE Manager can be
accomplished using one of the two possible methods.</para>
<section id="man_config">
<title>Direct Connection</title>
<para>When using this mechanism, the uCPE Manager will periodically
poll the uCPE device, using a specified IP address as the destination,
attempting to establish a management connection.</para>
<para>Add the uCPE device running the NFV Access Run Time Platform to
the management system by:</para>
<orderedlist>
<listitem>
<para>Selecting in the uCPE Manager: <literal>Devices -> Manage
-> Add</literal>.</para>
</listitem>
<listitem>
<para>Suppling information about the uCPE device, and setting the
parameters that will be used to connect to it.</para>
</listitem>
</orderedlist>
<para>The relevant parameters are:</para>
<itemizedlist>
<listitem>
<para>Type. The type of device to be added, i.e <literal>Enea
universal CPE</literal>.</para>
</listitem>
</itemizedlist>
<itemizedlist>
<listitem>
<para>Name. The name by which the device is referred to in the
uCPE Manager.</para>
</listitem>
</itemizedlist>
<itemizedlist>
<listitem>
<para>IP Address. IP address of the ucPE device.</para>
</listitem>
</itemizedlist>
<itemizedlist>
<listitem>
<para>SSH Port. The NETCONF Port used for communications. Default
is set to 830.</para>
</listitem>
</itemizedlist>
<itemizedlist>
<listitem>
<para>SSH User Name. The user name for SSH connectivity. Default
user is root.</para>
</listitem>
</itemizedlist>
<itemizedlist>
<listitem>
<para>SSH Password. Leave this blank.</para>
</listitem>
</itemizedlist>
<itemizedlist>
<listitem>
<para>Device Calls Home. This checkbox indicates the direction of
device communications. For Direct Connection, leave this flag
unchecked.</para>
</listitem>
</itemizedlist>
<itemizedlist>
<listitem>
<para>Device ID. The unique identifier of the uCPE device. This
links a device to its Day-0 configuration (stored in the offline
configuration system). It is a required field if you want to
perform Zero-Touch Provisioning.</para>
</listitem>
</itemizedlist>
</section>
<section id="using_call_home">
<title>Device Call Home Connection</title>
<para>Follow the same steps as described in the previous section,
making sure that the <literal>Device Calls Home</literal> checkbox is
selected this time.</para>
<para>When using this mechanism, the device will initiate a connection
to the uCPE Manager for NETCONF traffic (over SSH), while the uCPE
Manager waits for a device connection. Make sure the uCPE Manager IP
address has been configured on the device. For more information please
see section <link linkend="install_ena_stick">Installing Enea NFV
Access</link> for more details.</para>
</section>
</section>
<section id="host_int_net_config">
<title>Configure NFV Infrastructure</title>
<para>Once a management connection with the uCPE device has been
established by using any of the supported methods, the virtualization
networking infrastructure can be configured either manually or by using
Zero Touch Provisioning.</para>
<para>The uCPE Manager can list network interfaces found on a device by
selecting the uCPE device first and then selecting
<literal>Configuration</literal> -> <literal>OpenVSwitch
</literal>-> <literal>Host Interface Caps</literal>:</para>
<figure>
<title>Host Interface Caps</title>
<mediaobject>
<imageobject>
<imagedata align="center" contentwidth="600"
fileref="images/host_interface_caps.png" />
</imageobject>
</mediaobject>
</figure>
<para>Available network interfaces can be added to the management
system, for use by the networking virtualization infrastructure.</para>
<section id="man_configuration">
<title>Manual Configuration</title>
<para>For Manual Configuration of uCPE networking, select the uCPE
device first and then <literal>Configuration</literal> ->
<literal>OpenVSwitch</literal>. In <literal>Host Interfaces
Caps</literal>, one can find a list of available network interfaces
and their capabilities.</para>
<section id="configure_interfaces">
<title>Configuring Interfaces</title>
<para>In order to make physical network interfaces available to the
virtualization infrastructure and VNFs, they must be configured into
the management system.</para>
<para>To add an interface into the uCPE Manager, select the uCPE
device, then from the top toolbar select <literal>Configuration
-> OpenVSwitch -> Host Interfaces</literal>. The available
Interface types are detailed below.</para>
<para><emphasis role="bold">DPDK Interface Type</emphasis></para>
<para>Configuring a physical interface in DPDK mode will require a
DPDK-based application (e.g. OVS-DPDK) in order to access and use
the interface. An interface set as the DPDK can be attached to an
OVS-DPDK bridge.</para>
<note>
<para>Make sure the <literal>Enable DPDK</literal> checkbox is
selected in <literal>Device -> Configuration ->
DPDK</literal>, otherwise no interface can be assigned to the
DPDK.</para>
</note>
<para>To add a DPDK interface under the management system, set
appropriate values for the following fields:</para>
<itemizedlist>
<listitem>
<para>Source: name of the physical interface.</para>
</listitem>
<listitem>
<para>Type: dpdk</para>
</listitem>
<listitem>
<para>Networking-type: dpdk</para>
</listitem>
<listitem>
<para>Dpdk-type: the kernel module that allows user space access
to the physical interface. Enea recommends using the
<literal>vfio-pci</literal> driver.</para>
</listitem>
</itemizedlist>
<para>Create an OpenVSwitch bridge (<literal>ovsbr0</literal>) on
the device that uses a DPDK interface type, by selecting the uCPE
device, then from the top toolbar selecting
<literal>Configuration</literal> ->
<literal>OpenVSwitch</literal> -> <literal>Bridges</literal>
-> <literal>Add</literal>.</para>
<para><emphasis role="bold">SR-IOV Interface Type</emphasis></para>
<para>SR-IOV technology allows for the creation of a number of
virtual functions on the host interface, which can be used by VNFs
running on the uCPE device.</para>
<para>For SR-IOV mode configuration, the user must set values for
the following fields:</para>
<itemizedlist>
<listitem>
<para>Source: name of the physical interface.</para>
</listitem>
<listitem>
<para>Type: sr-iov</para>
</listitem>
<listitem>
<para>Networking-type: srIov</para>
</listitem>
<listitem>
<para>sriov-mode: adapter-pool</para>
</listitem>
<listitem>
<para>sriov-num-vfs: the number of virtual functions to
create.</para>
</listitem>
</itemizedlist>
<para><emphasis role="bold">Standard Interface
Type</emphasis></para>
<para>Some of the physical network interfaces available on a uCPE
device, including Ethernet interfaces, do not have DPDK or SR-IOV
support. Instead, the Linux kernel driver has to be used. Wi-Fi and
4G/LTE modems can also be configured and used for virtualization
infrastructure and VNFs.</para>
<para>To add Standard interfaces under the management system, the
user must set values for the following fields:</para>
<itemizedlist>
<listitem>
<para>Source: the name of physical interface.</para>
</listitem>
<listitem>
<para>Networking-type: standard</para>
</listitem>
</itemizedlist>
<para condition="hidden"><emphasis role="bold">PCI Passthrough
Interface Type</emphasis></para>
<para condition="hidden">For the PCI Passthrough a user does not
have to configure a physical interface, instead simply select the
PCI address and connect it to a virtual port when the VNF
instantiation step is reached.</para>
</section>
<section id="configure_bridges">
<title>Configuring Bridges</title>
<para>After networking interfaces have been added to the uCPE
Manager, the user can create the necessary OVS bridges.</para>
<para><emphasis role="bold">How to add OVS bridges in the uCPE
Manager</emphasis></para>
<orderedlist>
<listitem>
<para>Select the uCPE device.</para>
</listitem>
<listitem>
<para>Select Configuration.</para>
</listitem>
<listitem>
<para>Click OpenvSwitch.</para>
</listitem>
<listitem>
<para>Select the Bridges option, then click Add.</para>
</listitem>
</orderedlist>
<note>
<para>Depending on the settings in <literal>Configuration ->
OpenVSwitch -> DPDK</literal>, OVS bridges with or without DPDK
support will be used on the uCPE device.</para>
</note>
<para>There are three types of bridges which can be created, each
one fulfiling a different role:</para>
<para><emphasis role="bold">uCPE In-band Management
bridge</emphasis></para>
<para>In-band Management refers to a model where both the data plane
and control plane flow over the same network path. In some
situations (e.g. the uCPE device has only one routable IP address),
this is the only option available to both control and configure the
uCPE device, while also allowing for data-path traffic to pass over
the same physical interface.</para>
<para>The solution provided by Enea for in-band management is based
upon an OpenvSwitch bridge fielding all traffic passing through the
WAN physical port. As a prerequisite, the WAN physical port has to
be configured to get its IP through DHCP. Any standard or
DPDK-assigned network interface can be used for the In-Band
management bridge.</para>
<note>
<para>The In-Band Management bridge must be recreated each time
the uCPE Manager IP address is changed.</para>
</note>
<para>To create the In-Band Management bridge, the user must set
values for the following fields:</para>
<itemizedlist>
<listitem>
<para>name: name of the bridge.</para>
</listitem>
<listitem>
<para>ovs-bridge-type: inbandMgmt</para>
</listitem>
<listitem>
<para>mgmt-address: select IPv4 as the type and fill in the IP
address of the uCPE Manager.</para>
</listitem>
<listitem>
<para>mgmt-port: the NETCONF management port. Enea recommeneds
leaving this field unchanged.</para>
</listitem>
</itemizedlist>
<note>
<para>The first VNF instantiated on the uCPE device must be
connected to the In-Band Management bridge and its WAN interface
must be configured as the DHCP client.</para>
</note>
<para><emphasis role="bold">In-band Management bridge for
VNFs</emphasis></para>
<para>If VNF management can be done over a dedicated virtual
interface, its possible to extend the networking infrastructure
configuration to also access the VNF's management interface over the
WAN port.</para>
<para>For this setup, three types of traffic will pass over the WAN
physical interface:</para>
<itemizedlist>
<listitem>
<para>Device management. Part of the device configuration done
by the uCPE Manager.</para>
</listitem>
<listitem>
<para>VNF(s) management. Enabling or disabling features of a
VNF. E.g. enabling/disabling the firewall or VPN setup.</para>
</listitem>
<listitem>
<para>Data-path. All other traffic that is not used in the
control plane and needs to reach a LAN network.</para>
</listitem>
</itemizedlist>
<para>To create a VNF In-Band Management bridge, the user must set
values for the following fields:</para>
<itemizedlist>
<listitem>
<para>name: name of the bridge.</para>
</listitem>
<listitem>
<para>ovs-bridge-type: vnfMgmt</para>
</listitem>
<listitem>
<para>vnf-mgmt-address: select IPv4 as the type and fill in the
IP address for management network, e.g 10.0.0.1.</para>
</listitem>
</itemizedlist>
<note>
<para>VNF management interfaces must be configured in same network
as the <literal>vnf-mgmt-address</literal> of the bridge. For more
information, please see 4.4 <link linkend="vnf_management">VNF
Management</link>.</para>
</note>
<para><emphasis role="bold">Data-plane Bridge</emphasis> Data-plane
bridges are generic bridges used for the VNF data-plane. There are
two supported sub-types:</para>
<itemizedlist>
<listitem>
<para>communication: allows for VNF communication towards
LAN/WAN networks. This bridge type has at least one physical
port attached to it.</para>
</listitem>
<listitem>
<para>integration: allows for VNF-to-VNF communication (usually
for service function chaining). This bridge type does not have
any physical port attached.</para>
</listitem>
</itemizedlist>
<para>To create a Data-plane bridge, the user must set values for
the following fields:</para>
<itemizedlist>
<listitem>
<para>name: name of the bridge.</para>
</listitem>
<listitem>
<para>ovs-bridge-type: select <literal>communication</literal>
or <literal>integration</literal>, depending on intended usage.
For communication bridges, physical interfaces can be added to
the bridge.</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id="zero_touch_prov">
<title>Zero Touch Provisioning</title>
<para>Zero-Touch Provisioning (ZTP) refers to the process of when a
device starts up for the first time and its initial configuration is
pushed down by an external management system, so that it is setup for
proper operation without additional manual intervention by an
operator. ZTP is an alternative to Manual configuration.</para>
<para>A variety of operations can occur as part of ZTP such as initial
device setup, configuration of managed objects, etc. The goal is to
set up a device to the maximum possible extent without forcing an
operator to be physically present (initially) to manage the
device.</para>
<para>An offline configuration is usually prepared in advance for the
uCPE Manager to setup the virtualization infrastructure on the uCPE
device, as soon as a device enrolls into the management system.</para>
<section id="offline_configuration">
<title>Offline Configuration</title>
<para>The Offline Configuration subsystem is used to pre-populate a
configuration for a device that will be brought under management at
a future point in time. When creating an offline configuration store
a <literal>Device ID</literal> can be specified. This ID uniquely
identifies the device to be initialized.</para>
<para>Alternatively, a wildcard can be used in the <literal>Device
ID</literal> field, which results in a configuration being pushed on
all uCPE devices upon their initial connection towards the uCPE
Manager.</para>
<para>To create an offline configuration, from the top toolbar menu
select <literal>Applications</literal> -> <literal>Offline
Config</literal> -> <literal>Add</literal>. Specify the value of
the <literal>Device ID</literal> in the required field or wildcard
if appropriate. Choose <literal>Merge</literal> as the "Default
Upload Method" if you do not want any boot configuration set on the
device, to be wiped out. Selecting <literal>Replace</literal> will
set the entire device configuration to match values in the offline
configuration.</para>
<para>When a device connects to the uCPE Manager for the first time, it checks the
device to see if it has been Zero Touch Provisioned (ZTP). If not, it looks for
an offline configuration that matches these values, in the following order:</para>
<itemizedlist>
<listitem>
<para>The Device ID.</para>
</listitem>
<listitem>
<para>The set of tags.</para>
</listitem>
<listitem>
<para>A "*" for Device ID (wildcard).</para>
</listitem>
</itemizedlist>
<para>If a match is found, the offline configuration is sent to the device as part
of Zero-Touch-Provisioning.</para>
<para>After creating the Offline Config Store, access the device
through <literal>Applications</literal> -> <literal>offline
config</literal> -> <literal>Config App</literal> and provision
it with the required initial configuration. This operation mirrors
what happens during manual configuration described in the previous
section.</para>
</section>
</section>
<section id="custom_scripts">
<title>Custom Scripts</title>
<para>The custom scripts feature allows users to execute user-defined
scripts on the uCPE device at various times.This allows for more
flexible and advanced configurations such as a LTE modem
configuration, advanced network configurations or OVS flow rule
programming at any time.</para>
<section id="upload_scripts">
<title>Uploading Scripts</title>
<para>The scripts need to be uploaded to the uCPE Manager prior to
use. When uploading scripts to the uCPE Manager make sure to select
the right script type.</para>
<para>The following script types are supported:</para>
<itemizedlist>
<listitem>
<para><literal>Once-before-startup</literal>. This script will
only execute once during the startup.</para>
</listitem>
<listitem>
<para><literal>Always-before-startup</literal>. This script will
always execute during the startup.</para>
</listitem>
<listitem>
<para><literal>Once-after-startup</literal>. This script will
only execute once after the system has been started.</para>
</listitem>
<listitem>
<para><literal>Always-after-startup</literal>. This script will
always execute after the system has been started.</para>
</listitem>
</itemizedlist>
<para>Follow the instruction below to upload scripts:</para>
<orderedlist>
<listitem>
<para>Select <literal>Devices</literal> -> <literal>Custom
Scripts</literal> -> <literal>Configure</literal>.</para>
</listitem>
<listitem>
<para>Select <literal>Upload to EMS</literal>.</para>
</listitem>
<listitem>
<para>In the <literal>Script Type</literal> menu, select the
type the uploaded script should have.</para>
</listitem>
<listitem>
<para>Press <literal>Choose File</literal> to select the scripts
needed, and then press <literal>Send</literal>.</para>
</listitem>
</orderedlist>
</section>
<section id="remove_scripts">
<title>Removing Scripts</title>
<para>Follow the instruction below to remove scripts:</para>
<orderedlist>
<listitem>
<para>Select <literal>Devices</literal> -> <literal>Custom
Scripts</literal> -> <literal>Configure</literal>.</para>
</listitem>
<listitem>
<para>Select the script you want to delete from the
<literal>Uploaded Scripts</literal> tab and then click
<literal>Delete</literal>, which will remove the script
immediately from the uCPE Manager.</para>
</listitem>
</orderedlist>
</section>
<section id="configure_scripts">
<title>Configuring Script Location</title>
<para>The location where the scripts are staged in the uCPE Manager
can be chanaged as described below:</para>
<orderedlist>
<listitem>
<para>Select <literal>Devices</literal> -> <literal>Custom
Scripts</literal> -> <literal>Configure</literal>.</para>
</listitem>
<listitem>
<para>Select the <literal>Configuration</literal> tab and
specify a new loacation to store the scripts.</para>
<note>
<para>Change the script storage location only if you have many
scripts which you would prefer to store on another partition,
otherwise leave this configuration as is.</para>
</note>
</listitem>
</orderedlist>
</section>
<section id="run_the_scripts">
<title>Running the Scripts</title>
<para><emphasis role="bold">How to run Custom
Scripts</emphasis></para>
<orderedlist>
<listitem>
<para>Select <literal>Devices</literal> -> <literal>Custom
Scripts</literal> -> <literal>Apply Scripts</literal>.</para>
</listitem>
<listitem>
<para>In the <literal>Script Config Screen</literal> pop up,
select the devices from the device(s) chooser list on which to
run the scripts. Press the <literal>></literal> button to
move the devices to the right side of the chooser, which is the
list of devices that will execute the selected scripts.</para>
</listitem>
<listitem>
<para>Select the scripts from the list under the device(s)
chooser by pressing the <literal>+</literal> button.</para>
</listitem>
<listitem>
<para>In the pop-up window, select the scripts from the list. If
there are no scripts to select, then there is no script uploaded
with that particular type. Upload the script(s) needed and try
again.</para>
</listitem>
<listitem>
<para>Check the checkbox <literal>Reboot devices</literal> if
you want to reboot and execute the scripts at once and then
press <literal>ok</literal>.</para>
<note>
<para>The status of execution for the scripts can be seen by
opening the <literal>Fault</literal> ->
<literal>Events</literal> screen and filtering by device
and/or the event name <filename>Custom</filename>.</para>
</note>
</listitem>
</orderedlist>
</section>
</section>
</section>
</section>
<section id="device_upgrade">
<title>Device Upgrade</title>
<section id="device_upgrade_process">
<title>Device Upgrade Process</title>
<para>Device Upgrade/Install performs the following operations to the
device:</para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">Prepare for upgrade</emphasis>. This
stage tells the device that an upgrade is about to happen.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Install file on device</emphasis>. This
stage copies the file to the uCPE device.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Upgrade Device</emphasis>. This stage
causes the device to replace its running image with the newly copied
image.</para>
</listitem>
</itemizedlist>
</section>
<section id="managing_device_upgrade">
<title>Managing the Device Upgrade</title>
<para>Before an install or upgrade can be completed, certain
configuration data must be set. Files also need to be uploaded to the
Device Upgrade image repository to upload to the device.</para>
<para>Launch the Device Upgrade management console by selecting
<literal>Devices</literal> -> <literal>Upgrade</literal> from the top
toolbar. The console when launched will contain the following
tabs:</para>
<itemizedlist>
<listitem>
<para><literal>Image Library</literal>. To add/delete an
image.</para>
</listitem>
<listitem>
<para><literal>Upgrade Operations</literal>. See running upgrades,
cancel any upgrades in progress, start a device upgrade.</para>
</listitem>
<listitem>
<para><literal>Device Status</literal>. Shows the device
status.</para>
</listitem>
<listitem>
<para><literal>Configuration</literal>. Upgrade configuration
parameters.</para>
</listitem>
</itemizedlist>
<para>Press "Close" when the message <literal>File Uploaded
Successfully</literal> appears on the File Upload Screen.</para>
<section id="upload_image">
<title>Image Library</title>
<para><emphasis role="bold">Add an image to the image
repository/library</emphasis></para>
<orderedlist>
<listitem>
<para>Select <literal>Devices</literal> ->
<literal>Upgrade</literal>.</para>
</listitem>
<listitem>
<para>Select <literal>Add</literal> from the <literal>Image
Library</literal> tab to add a new image file.</para>
</listitem>
<listitem>
<para>Click on <literal>Choose File</literal> to provide the path
to the image file. Select the target hardware platform
corresponding to the image being uploaded (xeon-d or
atomc-3000).</para>
</listitem>
<listitem>
<para>Click <literal>Send</literal> to upload the image to the
image repository.</para>
</listitem>
</orderedlist>
<para><emphasis role="bold">Delete an image from the image
repository</emphasis></para>
<orderedlist>
<listitem>
<para>Select <literal>Devices</literal> ->
<literal>Upgrade</literal>.</para>
</listitem>
<listitem>
<para>Select the image you want to delete from the <literal>Image
Library</literal> tab and then click
<literal>Delete</literal>.</para>
</listitem>
</orderedlist>
</section>
<section id="multi_device_install">
<title>Upgrade Operations</title>
<para>The Upgrade Operations tab allows a user to manage device
upgrades in the system. It allows the user to see all the upgrades
that are currently in progress, as well as listing the completed ones.
If an upgrade succeeds or fails, then a row will be added to the
completed upgrades table. If one fails, the failure message will be
visible here.</para>
<note>
<para>The list of completed upgrade tasks resides in memory and will
not persist across reboots of the server.</para>
</note>
<para><emphasis role="bold">How to Install/Upgrade immediately or
schedule for later</emphasis></para>
<orderedlist>
<listitem>
<para>Select <literal>Devices</literal> ->
<literal>Upgrade</literal>.</para>
</listitem>
<listitem>
<para>Select <literal>Upgrade Devices</literal> from the
<literal>Upgrade Operations</literal> tab. This will launch a
<literal>Multi Device Install Image</literal> screen that will
allow the user to install and upgrade more than one device at a
time or upgrade later.</para>
<para>The configurable parameters are:</para>
<itemizedlist>
<listitem>
<para><literal>Scheduling</literal>. Click this checkbox if
the upgrade will be done later. Schedule the day, hour and
minute for when to run the upgrade.</para>
<note>
<para>The time zone is set to Eastern Standard Time
(EST).</para>
</note>
</listitem>
<listitem>
<para><literal>Description</literal>. An optional description
of the operation. It is recommended to add a description so
that different upgrades happening simultaneously can be
distinguished.</para>
</listitem>
<listitem>
<para><literal>Image File</literal>. Click on <literal>Choose
Image File</literal> to select the image file.</para>
</listitem>
<listitem>
<para><literal>Devices</literal>. The list of available
devices is populated when an image file is chosen. The
device(s) chooser is then populated with the list of devices
that can accept that file. Press the <literal>></literal>
button to move the devices to the right side of the chooser,
which is the list of devices that will be upgraded.</para>
</listitem>
<listitem>
<para><literal>Upgrade Operation</literal>. Available options
are:</para>
<itemizedlist>
<listitem>
<para><literal>Install and Activate</literal>. This will
do an image installation as well as an upgrade.</para>
</listitem>
<listitem>
<para><literal>Install Only</literal>. This will do an
image installation only. The image is copied to the
device, and an upgrade will be done later either at a
scheduled time or when the option <literal>Activate
Only</literal> is selected.</para>
</listitem>
<listitem>
<para><literal>Activate Only</literal>. This will activate
an already installed image on the device.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</section>
<section id="check_releases">
<title>Releases installed on a Device</title>
<para>The installed releases on a device can be viewed by selecting
the device first, then from the top toolbar selecting
<literal>Configuration</literal> -> <literal>Upgrade</literal>. The
installed releases on the device, the release status, release state,
commit-id and release version will be listed in a table.</para>
</section>
<section id="check_device_status">
<title>Device Status</title>
<para>The status of the installation and upgrade can be viewed in the
<literal>Device Status</literal> tab. Ongoing or scheduled upgrade
operations can be viewed or cancelled.</para>
<para><emphasis role="bold">To view the status of an installation or
upgrade operations</emphasis></para>
<orderedlist>
<listitem>
<para>Select <literal>Devices</literal> ->
<literal>Upgrade</literal>.</para>
</listitem>
<listitem>
<para>Select <literal>Device Status</literal>. The ongoing
operations are listed at the top and a history of failed or
successful operations are listed at the bottom.</para>
</listitem>
</orderedlist>
<para><emphasis role="bold">To cancel an upgrade
operation</emphasis></para>
<orderedlist>
<listitem>
<para>Select <literal>Devices</literal> -> <literal>Upgrade
</literal> -> <literal> Upgrade Operations</literal>.</para>
</listitem>
<listitem>
<para>Select an operation from the list and press <literal>Cancel
Upgrade</literal> and <literal>Confirm</literal>. The operation
will now be deleted from the list.</para>
</listitem>
</orderedlist>
</section>
<section id="device_upgrade_config">
<title>Configuration</title>
<note>
<para>The default values present in the configuration of each device
are recommended for use. Modifying them is for an Advanced User
only.</para>
</note>
<para><emphasis role="bold">How to Configure the uCPE device Upgrade
</emphasis></para>
<orderedlist>
<listitem>
<para>Select <literal>Devices</literal> ->
<literal>Upgrade</literal>.</para>
</listitem>
<listitem>
<para>Select <literal>Configuration</literal>.</para>
</listitem>
<listitem>
<para>The configurable parameters are:</para>
<itemizedlist>
<listitem>
<para><literal>deviceImageDir</literal>. This is the disk
location of the device image repository. If an absolute path
name such as <literal>/usr/local/deviceimage</literal> is
given, then the absolute path name is used. If no absolute
pathname is given it is considered to be relative to the
installation directory.</para>
</listitem>
<listitem>
<para><literal>maxThreads</literal>. This number dictates how
many upgrades the system can manage at one time, either
individually launched or launched from the multi-device
screens. This value defaults to 20, which means that 20
devices may be updated at one time.</para>
</listitem>
<listitem>
<para><literal>KeepAlive</literal>. This number represents the
number of seconds that a thread will be kept alive before it
is collected. If multiple installations are occurring, this
will keep the thread alive for X seconds before it is
released. If not released, it can be used by the internal
scheduling system as soon as it has completed an
upgrade.</para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</section>
</section>
</section>
<section id="vnf_management">
<title>VNF Management</title>
<para>The Enea uCPE Manager is responsible for onboarding, configuring
(e.g. CloudInit) and ensuring life cycle management of VNFs that are
instantiated and run on the various uCPE devices.</para>
<section id="onboarding_a_vnf">
<title>Onboarding a VNF</title>
<para>The onboarding of a VNF means adding it to the Enea uCPE Manager
VNF Catalog and preparing it for instantiation (deployment on connected
uCPE devices). This is accomplished using the Enea uCPE Manager
Onboarding graphical user interface.</para>
<para>Typically, the Getting Started Guide of a VNF contains all
necessary information needed to onboard a VNF.</para>
<section id="retrieve_art">
<title>Retrieving Artifacts</title>
<para>The user must first retrieve the necessary artifacts from the
VNF vendor:</para>
<orderedlist>
<listitem>
<para>Download the VNF from the commercial vendor.</para>
</listitem>
<listitem>
<para>Procure any VNF-specific files from the VNF vendor, e.g.
license file.</para>
<note>
<para>There are no standard ways of managing VNF licenses,
therefore no general guidelines can be provided. One example of
license handling that can be employed in the uCPE Manager is the
adding of a license during the Cloud-Init setup.</para>
</note>
</listitem>
<listitem>
<para>Optionally, get access to the VNF specific VNF Manager for
day 1 and 2 configuration (in cloud or for local
deployment).</para>
</listitem>
<listitem>
<para>Procure the Getting Started Guide from the VNF vendor,
preferably for KVM deployment for VNF specific configuration
information.</para>
</listitem>
</orderedlist>
</section>
<section id="onboard_prep">
<title>Preparation</title>
<para>Once all needed downloadables, documentation and more have been
attained, preparation for onboarding must be completed:</para>
<orderedlist>
<listitem>
<para>Determine the use-case and performance requirements of the
VNF you wish to deploy:</para>
<itemizedlist spacing="compact">
<listitem>
<para>This decides what resources the VNF is configured for,
along with networking and day zero configurations.</para>
<note>
<para>Generally, the Getting Started Guide for the VNF
provides guidelines for resource allocation, but since
performance is dependent on hardware capacity, the right
resource allocation for deployment is determined through
benchmarking.</para>
</note>
</listitem>
<listitem>
<para>Determine the amount of hardware resources needed for
the VNF (RAM, number of CPUs and storage size).</para>
</listitem>
<listitem>
<para>Determine how many Virtual Network Interfaces the VNF
will use.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Determine the Day-0 configuration method from the VNF
Getting Started guidelines.</para>
<note>
<para>For many VNFs, day zero configuration can be skipped in
early onboarding efforts when automation is not of
importance.</para>
</note>
</listitem>
<listitem>
<para>Determine any requirements needed by the Cloud-Init file
structure and the content needed when this structure is
used.</para>
</listitem>
</orderedlist>
</section>
<section id="onboard_in_ucpemg">
<title>Onboarding into the uCPE Manager</title>
<para><emphasis role="bold">How to onboard a VNF into the uCPE Manager
</emphasis></para>
<orderedlist>
<listitem>
<para>Select from the top toolbar <literal>VNF</literal> ->
<literal>Descriptors</literal></para>
</listitem>
<listitem>
<para>Click the <literal>On-board</literal> button.</para>
</listitem>
<listitem>
<para>When prompted by the UI, make sure the <literal>VM
Image</literal> radio button at the top of the onboarding screen
is selected, it will trigger a popup menu window.</para>
</listitem>
</orderedlist>
<para>This window contains data fields where both necessary and
optional information about the VNF can be supplied. After doing so,
press the Onboard button, the uCPE Manager will create the VNF
descriptor and add it to its VNF Catalog.</para>
<figure>
<title>Onboard a VNF</title>
<mediaobject>
<imageobject>
<imagedata align="center" contentwidth="600"
fileref="images/onboard_a_vnf_image.png" />
</imageobject>
</mediaobject>
</figure>
<para><emphasis role="bold">Main fields</emphasis></para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">VM Image File</emphasis>. This is the
Virtual Machine image file for the VNF. Typically, it is a QCOW
image. Press <literal>Choose File</literal> and select the image
you wish to upload.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Image Format</emphasis>. Select the
format which matches the image file format.</para>
</listitem>
<listitem>
<para><emphasis role="bold">VNF Type Name</emphasis>. This is the
name that will be used to identify this VNF. It will be shown in
the VNFs list.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Description</emphasis>. This field
contains any description provided and is only displayed in the GUI
tables in the uCPE Manager.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Version</emphasis>. This is the
version of the current VNF that you are hosting. It's used to
distinguish this VNF from other versions of the same type.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Memory in MB</emphasis>. This is the
amount of memory (in megabytes) that will be provided to this type
of VNF when it is instantiated. To determine the value for this
field, consult the VNF vendor.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Num of CPUs</emphasis>. The number of
CPUs that will be dedicated to an instance of this VNF when
created. To determine the value for this field, consult the VNF
vendor.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Storage in GB</emphasis>. How much
disk space to provide an instance of this VNF. To determine the
value for this field, consult the VNF vendor.</para>
</listitem>
</itemizedlist>
<para><emphasis role="bold">Interfaces Tab</emphasis></para>
<para>Click on the <literal>Interfaces</literal> tab to show the
Interfaces table.</para>
<para>This table will contain the interfaces required by this VNF to
be configured, when creating an instance. Consult the VNF vendor to
determine which and how many are required. Each interface requires a
name, and optionally a description, used only by the uCPE
Manager.</para>
<para><emphasis role="bold">Cloud Init Tab</emphasis></para>
<para>Click the <literal>Clout Init</literal> tab to provide the
Clout-Init configuration. There are three fields that need to be
populated:</para>
<orderedlist>
<listitem>
<para><emphasis role="bold">Cloud-Init
Datasource</emphasis></para>
<para>To onboard a VNF you must specify the <literal>Cloud-Init
Datasource</literal> that the VNF uses. This information is
procured from the VNF Vendor. Choose one of the following methods
to specify the datasource:</para>
<itemizedlist spacing="compact">
<listitem>
<para><emphasis role="bold">None</emphasis>. If there is no
datasource.</para>
</listitem>
<listitem>
<para><emphasis role="bold">ConfigDrive</emphasis>. This
method allows you to provide any number of content-data files
containing Cloud-Init data.</para>
</listitem>
<listitem>
<para><emphasis role="bold">NoCloud</emphasis>. This is a
simpler method that uses only one cloud init file
(User-Data).</para>
</listitem>
<listitem>
<para><emphasis role="bold">ISO</emphasis>. Pre-cooked
cloud-init image. This image must be created by the user
according to VNF requirements.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para><emphasis role="bold">Cloud-Init Disk Type</emphasis></para>
<para>The <literal>Cloud-Init Disk Type</literal> field must be
set to either <literal>Disk</literal>, or
<literal>CD-ROM</literal>, depending on what the VNF requires. You
can get this information from the VNF Vendor.</para>
</listitem>
<listitem>
<para><emphasis role="bold">Content Files Table</emphasis></para>
<para>The <literal>Content Files Table </literal>is ONLY used if
you choose <literal>ConfigDrive</literal> as the Cloud-Init
Datasource. For each content file added, you must provide a
<literal>Path</literal>. When a user uses the uCPE Manager to
create an instance for multiple VNFs, they will be prompted to
provide a data file for each entry in this table. Each type of VNF
will require different cloud-init files, e.g.: a license
file.</para>
</listitem>
</orderedlist>
<para>Consult with the VNF vendor to determine what is required for
the VNF you are onboarding.</para>
<para><emphasis role="bold">Properties Tab</emphasis></para>
<para>In this table, you can enter values for properties that will be
used during instantiation of the VNF. The values will augment the
default values in the <filename>Domain.XML</filename> file used by
<literal>libvirt/virsh</literal> (running in NFV Access) when creating
an instance of the VNF. Consult with the VNF Vendor or ENEA support
for values needed by specific VNFs.</para>
<para><emphasis role="bold">Property Values</emphasis></para>
<itemizedlist>
<listitem>
<para><literal>numHugePages</literal> defines the number of huge
memory pages the VNF uses (for DPDK).</para>
</listitem>
<listitem>
<para><literal>vnfMgmtIpAddress</literal>: the IP address of the
VNF's management interface, connected to a
<literal>vnfMgmt</literal> bridge (e.g. 10.0.0.2).</para>
</listitem>
<listitem>
<para><literal>internalMgmtPort</literal>: the VNF's TCP/UDP port
used for management (e.g. 443).</para>
</listitem>
<listitem>
<para><literal>externalMgmtPort</literal>: the Management port
used for external access (e.g. 60001).</para>
</listitem>
</itemizedlist>
<note>
<para>The last three properties are useful in conjuction with the
<literal>vnfMgmt</literal> bridge type. They allow the user to map
the internal VNF management port to an external port, useful for VNF
configuration from WAN.</para>
<para>In the previous example, the internal TCP port 443 (HTTPS) was
mapped to the external port 60001, which allows the user to access
the VNF management port from a web browser e.g.
<literal>https://<WAN_IP>:60001</literal>.</para>
</note>
</section>
</section>
<section id="instantiating_a_vnf">
<title>Instantiating a VNF</title>
<para>When a VNF is onboarded and available in the VNF catalog, it can
be instantiated on connected uCPE devices. The configurations provided
when the VNF is onboarded, serve as a template for instantiation. Before
instantiating any VNF, please make sure the available storage space on
the uCPE device is big enough to accommodate the VNF you need to
instantiate.</para>
<para>Follow the instructions below to instantiate a VNF:</para>
<orderedlist>
<listitem>
<para>Select from the top toolbar <literal>VNF</literal> ->
<literal>Instances</literal></para>
</listitem>
<listitem>
<para>Click the <literal>Add</literal> button.</para>
</listitem>
<listitem>
<para>Fill out the following mandatory fields:</para>
<itemizedlist spacing="compact">
<listitem>
<para>Name: a descriptive name.</para>
</listitem>
<listitem>
<para>Device: the uCPE device to instantiate the VNF on.</para>
</listitem>
<listitem>
<para>Networking Configuration:</para>
<itemizedlist spacing="compact">
<listitem>
<para>Connect each configured NIC with a bridge, SR-IOV or
PCI Passthrough.</para>
</listitem>
<listitem>
<para>Set up each NIC with a driver method.</para>
</listitem>
</itemizedlist>
<note>
<para>All configured NICs must be set up before instantiating
a VNF. Failure to do so will end in a failed
instantiation.</para>
</note>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Add VNF-specific configuration data by uploading a Cloud-Init
file (when the Cloud-Init is used).</para>
</listitem>
<listitem>
<para>Add any VNF-specific files (e.g license files).</para>
</listitem>
<listitem>
<para>Hit the <literal>Create</literal> button to deploy the VNF and
run it on the specified uCPE device.</para>
</listitem>
</orderedlist>
<para>Selecting the<literal> VNF -> Events</literal> menu will show
that the VNF was created and a connection was established.</para>
</section>
<section id="enter_console">
<title>Accessing the VNF console</title>
<para>Once the VNF is deployed, the VNF console can be entered using SSH
and virsh commands. The VNF Console is a typical starting point for
determining a successful deployment and configuring a VNF beyond Day
Zero.</para>
<orderedlist>
<listitem>
<para>SSH to the uCPE device from the Enea uCPE Manager
(<literal>Device->SSH</literal>) with default user and password:
<literal>root</literal>.</para>
</listitem>
<listitem>
<para>In SSH:</para>
<orderedlist spacing="compact">
<listitem>
<para>Use the <command>virsh list</command> command to list all
running VNFs and to determine the VNF's instance number.</para>
</listitem>
<listitem>
<para>Use the <command>virsh console <instance
number></command> command to enter the VNF-specific
console.</para>
</listitem>
</orderedlist>
</listitem>
</orderedlist>
</section>
</section>
</chapter>
|