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
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
**VNF Modeling Requirements**
=====================================
TOSCA YAML
--------------------------
Introduction
^^^^^^^^^^^^^^
This reference document is the VNF TOSCA Template Requirements for
ONAP, which provides recommendations and standards for building VNF
TOSCA templates compatible with ONAP initial implementations of
Network Cloud. It has the following features:
1. VNF TOSCA template designer supports GUI and CLI.
2. VNF TOSCA template is aligned to the newest TOSCA protocol, “Working
Draft 04-Revision 06”.
3. VNF TOSCA template supports EPA features, such as NUMA, Hyper
Threading, SRIOV， etc.
Intended Audience
^^^^^^^^^^^^^^^^^^
This document is intended for persons developing VNF TOSCA templates
that will be orchestrated by ONAP.
Scope
^^^^^^^^^^^^^^^^
ONAP implementations of Network Cloud supports TOSCA Templates, also
referred to as TOSCA in this document.
ONAP requires the TOSCA Templates to follow a specific format. This
document provides the mandatory, recommended, and optional requirements
associated with this format.
Overview
^^^^^^^^^^^^^^^^
The document includes three charters to help the VNF providers to use the
VNF model design tools and understand the VNF package structure and VNF
TOSCA templates.
In the ONAP, VNF Package and VNFD template can be designed by manually
or via model designer tools. VNF model designer tools can provide the
GUI and CLI tools for the VNF provider to develop the VNF Package and VNFD
template.
The VNF package structure is align to the NFV TOSCA protocol, and
supports CSAR
The VNFD and VNF package are all align to the NFV TOSCA protocol, which
supports multiple TOSCA template yaml files, and also supports
self-defined node or other extensions.
NFV TOSCA Template
^^^^^^^^^^^^^^^^^^^^
TOSCA templates supported by ONAP must follow the requirements
enumerated in this section.
TOSCA Introduction
^^^^^^^^^^^^^^^^^^^
TOSCA defines a Meta model for defining IT services. This Meta model
defines both the structure of a service as well as how to manage it. A
Topology Template (also referred to as the topology model of a service)
defines the structure of a service. Plans define the process models that
are used to create and terminate a service as well as to manage a
service during its whole lifetime.
A Topology Template consists of a set of Node Templates and Relationship
Templates that together define the topology model of a service as a (not
necessarily connected) directed graph. A node in this graph is
represented by a *Node Template*. A Node Template specifies the
occurrence of a Node Type as a component of a service. A *Node Type*
defines the properties of such a component (via *Node Type Properties*)
and the operations (via *Interfaces*) available to manipulate the
component. Node Types are defined separately for reuse purposes and a
Node Template references a Node Type and adds usage constraints, such as
how many times the component can occur.
|image1|
Figure 1: Structural Elements of Service Template and their Relations
TOSCA Modeling Principles & Data Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This section describing TOSCA modeling principles and data model for
NFV, which shall be based on [TOSCA-1.0] and [TOSCA-Simple-Profile-YAML
V1.0], or new type based on ETSI NFV requirements, etc.
VNF Descriptor Template
^^^^^^^^^^^^^^^^^^^^^^^^^
The VNF Descriptor (VNFD) describes the topology of the VNF by means of
ETSI NFV IFA011 [IFA011] terms such as VDUs, Connection Points, Virtual
Links, External Connection Points, Scaling Aspects, Instantiation Levels
and Deployment Flavours.
The VNFD (VNF Descriptor) is read by both the NFVO and the VNFM. It
represents the contract & interface of a VNF and ensures the
interoperability across the NFV functional blocks.
The main parts of the VNFD are the following:
- VNF topology: it is modeled in a cloud agnostic way using virtualized
containers and their connectivity. Virtual Deployment Units (VDU)
describe the capabilities of the virtualized containers, such as
virtual CPU, RAM, disks; their connectivity is modeled with VDU
Connection Point Descriptors (VduCpd), Virtual Link Descriptors (Vld)
and VNF External Connection Point Descriptors (VnfExternalCpd);
- VNF deployment aspects: they are described in one or more deployment
flavours, including instantiation levels, supported LCM operations,
VNF LCM operation configuration parameters, placement constraints
(affinity / antiaffinity), minimum and maximum VDU instance numbers,
and scaling aspect for horizontal scaling.
The following table defines the TOSCA Type “derived from” values that
SHALL be used when using the TOSCA Simple Profile for NFV version 1.0
specification [TOSCA-Simple-Profile-NFV-v1.0] for NFV VNFD.
+---------------------+------------------------------------+-----------------+
| **ETSI NFV Element**| **TOSCA VNFD** | **Derived from**|
| | | |
| **[IFA011]** | **[TOSCA-Simple-Profile-NFV-v1.0]**| |
+=====================+====================================+=================+
| VNF | tosca.nodes.nfv.VNF | tosca.nodes.Root|
+---------------------+------------------------------------+-----------------+
| VDU | tosca.nodes.nfv.VDU | tosca.nodes.Root|
+---------------------+------------------------------------+-----------------+
| Cpd (Connection | tosca.nodes.nfv.Cpd | tosca.nodes.Root|
| Point) | tosca.nodes.nfv.Cpd | tosca.nodes.Root|
+---------------------+------------------------------------+-----------------+
| VduCpd (internal | tosca.nodes.nfv.VduCpd | tosca.nodes.\ |
| connection point) | | nfv.Cpd |
+---------------------+------------------------------------+-----------------+
| VnfVirtualLinkDesc | tosca.nodes.nfv.VnfVirtualLinkDesc | tosca.nodes.Root|
| (Virtual Link) | | |
+---------------------+------------------------------------+-----------------+
| VnfExtCpd (External | tosca.nodes.nfv.VnfExtCpd | tosca.nodes.Root|
| Connection Point) | | |
+---------------------+------------------------------------+-----------------+
| Virtual Storage | | |
+---------------------+------------------------------------+-----------------+
| Virtual Compute | | |
+---------------------+------------------------------------+-----------------+
| Software Image | | |
+---------------------+------------------------------------+-----------------+
| Deployment Flavour | | |
+---------------------+------------------------------------+-----------------+
| Scaling Aspect | | |
+---------------------+------------------------------------+-----------------+
| Element Group | | |
+---------------------+------------------------------------+-----------------+
| Instantiation | | |
| Level | | |
+---------------------+------------------------------------+-----------------+
+--------------------------------------------------------------------+
| +--------------------------------------------------------------+ |
| | tosca\_definitions\_version: tosca\_simple\_yaml\_1\_0 | |
| | | |
| | description: VNFD TOSCA file demo | |
| | | |
| | imports: | |
| | | |
| | - TOSCA\_definition\_nfv\_1\_0.yaml | |
| | | |
| | - TOSCA\_definition\_nfv\_ext\_1\_0.yaml | |
| | | |
| | | **node\_types: | |
| | tosca.nodes.nfv.VNF.vOpenNAT: | |
| | derived\_from:** tosca.nodes.nfv.VNF | |
| | | **requirements: | |
| | **- **sriov\_plane: | |
| | capability:** tosca.capabilities.nfv.VirtualLinkable | |
| | | **node:** tosca.nodes.nfv.VnfVirtualLinkDesc | |
| | | **relationship:** tosca.relationships.nfv.VirtualLinksTo | |
| +--------------------------------------------------------------+ |
+====================================================================+
+--------------------------------------------------------------------+
EPA Requirements
^^^^^^^^^^^^^^^^^^
1. SR-IOV Passthrought
Definitions of SRIOV\_Port are necessary if VDU supports SR-IOV. Here is
an example.
+------------------------------------------------+
| node\_templates: |
| |
| vdu\_vNat: |
| |
| SRIOV\_Port: |
| |
| attributes: |
| |
| tosca\_name: SRIOV\_Port |
| |
| properties: |
| |
| virtual\_network\_interface\_requirements: |
| |
| - name: sriov |
| |
| support\_mandatory: false |
| |
| description: sriov |
| |
| requirement: |
| |
| SRIOV: true |
| |
| role: root |
| |
| description: sriov port |
| |
| layer\_protocol: ipv4 |
| |
| requirements: |
| |
| - virtual\_binding: |
| |
| capability: virtual\_binding |
| |
| node: vdu\_vNat |
| |
| relationship: |
| |
| type: tosca.relationships.nfv.VirtualBindsTo |
| |
| - virtual\_link: |
| |
| node: tosca.nodes.Root |
| |
| type: tosca.nodes.nfv.VduCpd |
| |
| substitution\_mappings: |
| |
| requirements: |
| |
| sriov\_plane: |
| |
| - SRIOV\_Port |
| |
| - virtual\_link |
| |
| node\_type: tosca.nodes.nfv.VNF.vOpenNAT |
+------------------------------------------------+
2. Hugepages
Definitions of mem\_page\_size as one property shall be added to
Properties and set the value to large if one VDU node supports
huagepages. Here is an example.
+----------------------------------+
| node\_templates: |
| |
| vdu\_vNat: |
| |
| Hugepages: |
| |
| attributes: |
| |
| tosca\_name: Huge\_pages\_demo |
| |
| properties: |
| |
| mem\_page\_size:large |
+==================================+
+----------------------------------+
3. NUMA (CPU/Mem)
Likewise, we shall add definitions of numa to
requested\_additional\_capabilities if we wand VUD nodes to support
NUMA. Here is an example.
+-------------------------------------------------+
| topology\_template: |
| |
| node\_templates: |
| |
| vdu\_vNat: |
| |
| capabilities: |
| |
| virtual\_compute: |
| |
| properties: |
| |
| virtual\_memory: |
| |
| numa\_enabled: true |
| |
| virtual\_mem\_size: 2 GB |
| |
| requested\_additional\_capabilities: |
| |
| numa: |
| |
| support\_mandatory: true |
| |
| requested\_additional\_capability\_name: numa |
| |
| target\_performance\_parameters: |
| |
| hw:numa\_nodes: "2" |
| |
| hw:numa\_cpus.0: "0,1" |
| |
| hw:numa\_mem.0: "1024" |
| |
| hw:numa\_cpus.1: "2,3,4,5" |
| |
| hw:numa\_mem.1: "1024" |
+-------------------------------------------------+
4. Hyper-Theading
Definitions of Hyper-Theading are necessary as one of
requested\_additional\_capabilities of one VUD node if that node
supports Hyper-Theading. Here is an example.
+-------------------------------------------------------------+
| topology\_template: |
| |
| node\_templates: |
| |
| vdu\_vNat: |
| |
| capabilities: |
| |
| virtual\_compute: |
| |
| properties: |
| |
| virtual\_memory: |
| |
| numa\_enabled: true |
| |
| virtual\_mem\_size: 2 GB |
| |
| requested\_additional\_capabilities: |
| |
| hyper\_threading: |
| |
| support\_mandatory: true |
| |
| requested\_additional\_capability\_name: hyper\_threading |
| |
| target\_performance\_parameters: |
| |
| hw:cpu\_sockets : "2" |
| |
| hw:cpu\_threads : "2" |
| |
| hw:cpu\_cores : "2" |
| |
| hw:cpu\_threads\_policy: "isolate" |
+-------------------------------------------------------------+
5. OVS+DPDK
Definitions of ovs\_dpdk are necessary as one of
requested\_additional\_capabilities of one VUD node if that node
supports dpdk. Here is an example.
+------------------------------------------------------+
| topology\_template: |
| |
| node\_templates: |
| |
| vdu\_vNat: |
| |
| capabilities: |
| |
| virtual\_compute: |
| |
| properties: |
| |
| virtual\_memory: |
| |
| numa\_enabled: true |
| |
| virtual\_mem\_size: 2 GB |
| |
| requested\_additional\_capabilities: |
| |
| ovs\_dpdk: |
| |
| support\_mandatory: true |
| |
| requested\_additional\_capability\_name: ovs\_dpdk |
| |
| target\_performance\_parameters: |
| |
| sw:ovs\_dpdk: "true" |
+------------------------------------------------------+
NFV TOSCA Type Definition
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
tosca.capabilites.nfv.VirtualCompute
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------+-----------------------------------------+
| **Shorthand Name** | VirtualCompute |
+===========================+=========================================+
| **Type Qualified Name** | tosca: VirtualCompute |
+---------------------------+-----------------------------------------+
| **Type URI** | tosca.capabilities.nfv.VirtualCompute |
+---------------------------+-----------------------------------------+
| **derived from** | tosca.nodes.Root |
+---------------------------+-----------------------------------------+
Properties
+++++++++++
+---------------+---------+---------------+------------+----------------------+
| Name | Required| Type | Constraints| Description |
+===============+=========+===============+============+======================+
| request\ | No | tosca.\ | | Describes additional |
| _additional\ | | datatypes.\ | | capability for a |
| _capabilities | | nfv.Requested\| | particular VDU. |
| | | Additional\ | | |
| | | Capability | | |
+---------------+---------+---------------+------------+----------------------+
| virtual\ | yes | tosca.\ | | Describes virtual |
| _memory | | datatypes.\ | | memory of the |
| | | nfv.Virtual\ | | virtualized compute. |
| | | Memory | | |
+---------------+---------+---------------+------------+----------------------+
| virtual\ | yes | tosca.\ | | Describes virtual |
| _cpu | | datatypes.\ | | CPU(s) of the |
| | | nfv.Virtual\ | | virtualized compute. |
| | | Cpu | | |
+---------------+---------+---------------+------------+----------------------+
| name | yes | | | |
+---------------+---------+---------------+------------+----------------------+
Definition
+++++++++++
+-----------------------------------------------------------+
| tosca.capabilities.nfv.VirtualCompute: |
| |
| derived\_from: tosca.capabilities.Root |
| |
| properties: |
| |
| requested\_additional\_capabilities: |
| |
| type: map |
| |
| entry\_schema: |
| |
| type: tosca.datatypes.nfv.RequestedAdditionalCapability |
| |
| required: false |
| |
| virtual\_memory: |
| |
| type: tosca.datatypes.nfv.VirtualMemory |
| |
| required: true |
| |
| virtual\_cpu: |
| |
| type: tosca.datatypes.nfv.VirtualCpu |
| |
| required: true |
+-----------------------------------------------------------+
tosca.nodes.nfv.VDU.Compute
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The NFV Virtualization Deployment Unit (VDU) compute node type
represents a VDU entity which it describes the deployment and
operational behavior of a VNF component (VNFC), as defined by **[ETSI
NFV IFA011].**
+-----------------------+-------------------------------+
| Shorthand Name | VDU.Compute |
+=======================+===============================+
| Type Qualified Name | tosca:VDU.Compute |
+-----------------------+-------------------------------+
| Type URI | tosca.nodes.nfv.VDU.Compute |
+-----------------------+-------------------------------+
| derived\_from | tosca.nodes.Compute |
+-----------------------+-------------------------------+
Attributes
++++++++++++
None
Capabilities
++++++++++++++
+------------+--------------------+------------+------------------------------+
| Name | Type | Constraints| Description |
+============+====================+============+==============================+
| virtual\ | tosca.\ | | Describes virtual compute |
| _compute | capabilities.nfv.\ | | resources capabilities. |
| | VirtualCompute | | |
+------------+--------------------+------------+------------------------------+
| monitoring\| tosca.\ | None | Monitoring parameter, which |
| _parameter | capabilities.nfv.\ | | can be tracked for a VNFC |
| | Metric | | based on this VDU |
| | | | |
| | | | Examples include: |
| | | | memory-consumption, |
| | | | CPU-utilisation, |
| | | | bandwidth-consumption, VNFC |
| | | | downtime, etc. |
+------------+--------------------+------------+------------------------------+
| Virtual\ | tosca.\ | | Defines ability of |
| _binding | capabilities.nfv.\ | | VirtualBindable |
| | VirtualBindable | | |
| | | | |
| | editor note: need | | |
| | to create a | | |
| | capability type | | |
+------------+--------------------+------------+------------------------------+
Definition
++++++++++++
+-----------------------------------------------------------------------------+
| tosca.nodes.nfv.VDU.Compute: |
| |
| derived\_from: tosca.nodes.Compute |
| |
| properties: |
| |
| name: |
| |
| type: string |
| |
| required: true |
| |
| description: |
| |
| type: string |
| |
| required: true |
| |
| boot\_order: |
| |
| type: list # explicit index (boot index) not necessary, contrary to IFA011 |
| |
| entry\_schema: |
| |
| type: string |
| |
| required: false |
| |
| nfvi\_constraints: |
| |
| type: list |
| |
| entry\_schema: |
| |
| type: string |
| |
| required: false |
| |
| configurable\_properties: |
| |
| type: map |
| |
| entry\_schema: |
| |
| type: tosca.datatypes.nfv.VnfcConfigurableProperties |
| |
| required: true |
| |
| attributes: |
| |
| private\_address: |
| |
| status: deprecated |
| |
| public\_address: |
| |
| status: deprecated |
| |
| networks: |
| |
| status: deprecated |
| |
| ports: |
| |
| status: deprecated |
| |
| capabilities: |
| |
| virtual\_compute: |
| |
| type: tosca.capabilities.nfv.VirtualCompute |
| |
| virtual\_binding: |
| |
| type: tosca.capabilities.nfv.VirtualBindable |
| |
| #monitoring\_parameter: |
| |
| # modeled as ad hoc (named) capabilities in VDU node template |
| |
| # for example: |
| |
| #capabilities: |
| |
| # cpu\_load: tosca.capabilities.nfv.Metric |
| |
| # memory\_usage: tosca.capabilities.nfv.Metric |
| |
| host: #Editor note: FFS. How this capabilities should be used in NFV Profile|
| |
| type: `*tosca.capabilities.Container* <#DEFN_TYPE_CAPABILITIES_CONTAINER>`__|
| |
| valid\_source\_types: |
| [`*tosca.nodes.SoftwareComponent* <#DEFN_TYPE_NODES_SOFTWARE_COMPONENT>`__] |
| |
| occurrences: [0,UNBOUNDED] |
| |
| endpoint: |
| |
| occurrences: [0,0] |
| |
| os: |
| |
| occurrences: [0,0] |
| |
| scalable: |
| #Editor note: FFS. How this capabilities should be used in NFV Profile |
| |
| type: `*tosca.capabilities.Scalable* <#DEFN_TYPE_CAPABILITIES_SCALABLE>`__ |
| |
| binding: |
| |
| occurrences: [0,UNBOUND] |
| |
| requirements: |
| |
| - virtual\_storage: |
| |
| capability: tosca.capabilities.nfv.VirtualStorage |
| |
| relationship: tosca.relationships.nfv.VDU.AttachedTo |
| |
| node: tosca.nodes.nfv.VDU.VirtualStorage |
| |
| occurences: [ 0, UNBOUNDED ] |
| |
| - local\_storage: #For NFV Profile, this requirement is deprecated. |
| |
| occurrences: [0,0] |
| |
| artifacts: |
| |
| - sw\_image: |
| |
| file: |
| |
| type: tosca.artifacts.nfv.SwImage |
+-----------------------------------------------------------------------------+
Artifact
++++++++++
+--------+---------+----------------+------------+------------------------+
| Name | Required| Type | Constraints| Description |
+========+=========+================+============+========================+
| SwImage| Yes | tosca.\ | | Describes the software |
| | | artifacts.nfv.\| | image which is directly|
| | | SwImage | | realizing this virtual |
| | | | | storage |
+--------+---------+----------------+------------+------------------------+
|image2|
tosca.nodes.nfv.Cpd
~~~~~~~~~~~~~~~~~~~~~
The TOSCA Cpd node represents network connectivity to a compute resource
or a VL as defined by [ETSI GS NFV-IFA 011]. This is an abstract type
used as parent for the various Cpd types.
+-----------------------+-----------------------+
| Shorthand Name | Cpd |
+=======================+=======================+
| Type Qualified Name | tosca:Cpd |
+-----------------------+-----------------------+
| Type URI | tosca.nodes.nfv.Cpd |
+-----------------------+-----------------------+
Attributes
+++++++++++
+--------+------------+--------+---------------+---------------+
| Name | Required | Type | Constraints | Description |
+========+============+========+===============+===============+
+--------+------------+--------+---------------+---------------+
Requirements
+++++++++++++
None
Capabilities
+++++++++++++
None
Definition
+++++++++++
+----------------------------------------------------------------------+
| tosca.nodes.nfv.Cpd: |
| |
| derived\_from: tosca.nodes.Root |
| |
| properties: |
| |
| layer\_protocol: |
| |
| type:string |
| |
| constraints: |
| |
| - valid\_values: [ethernet, mpls, odu2, ipv4, ipv6, pseudo\_wire ] |
| |
| required:true |
| |
| role: #Name in ETSI NFV IFA011 v0.7.3 cpRole |
| |
| type:string |
| |
| constraints: |
| |
| - valid\_values: [ root, leaf ] |
| |
| required:flase |
| |
| description: |
| |
| type: string |
| |
| required: false |
| |
| address\_data: |
| |
| type: list |
| |
| entry\_schema: |
| |
| type: tosca.datatype.nfv.AddressData |
| |
| required:false |
+----------------------------------------------------------------------+
Additional Requirement
+++++++++++++++++++++++
None.
tosca.nodes.nfv.VduCpd
~~~~~~~~~~~~~~~~~~~~~~~
The TOSCA node VduCpd represents a type of TOSCA Cpd node and describes
network connectivity between a VNFC instance (based on this VDU) and an
internal VL as defined by [ETSI GS NFV-IFA 011].
+-----------------------+--------------------------+
| Shorthand Name | VduCpd |
+=======================+==========================+
| Type Qualified Name | tosca: VduCpd |
+-----------------------+--------------------------+
| Type URI | tosca.nodes.nfv.VduCpd |
+-----------------------+--------------------------+
Properties
+++++++++++
+-----------------+---------+---------------+------------+--------------------+
| Name | Required| Type | Constraints| Description |
+=================+=========+===============+============+====================+
| bitrate\ | no | integer | | Bitrate requirement|
| _requirement | | | | on this connection |
| | | | | point. |
+-----------------+---------+---------------+------------+--------------------+
| virtual\ | | Virtual\ | | Specifies |
| _network\ | no | Network\ | | requirements on a |
| _interface_\ | | Interface\ | | virtual network |
| requirements | | Requirements\ | | realising the CPs |
| | | | | instantiated from |
| | | | | this CPD |
+-----------------+---------+---------------+------------+--------------------+
Attributes
+++++++++++
None
Requirements
+++++++++++++
+----------+---------+--------------------+------------+----------------------+
| Name | Required| Type | Constraints| Description |
+==========+=========+====================+============+======================+
| virtual\ | yes | tosca.\ | | Describe the |
| _binding | | capabilities.nfv.\ | | requirement for |
| | | VirtualBindable\ | | binding with VDU |
+----------+---------+--------------------+------------+----------------------+
| virtual\ | no | tosca.\ | | Describes the |
| _link | | capabilities.nfv.\ | | requirements for |
| | | VirtualLinkable | | linking to virtual |
| | | | | link |
+----------+---------+--------------------+------------+----------------------+
Definition
+++++++++++
+----------------------------------------------------------------+
| tosca.nodes.nfv.VduCpd: |
| |
| derived\_from: tosca.nodes.nfv.Cpd |
| |
| properties: |
| |
| bitrate\_requirement: |
| |
| type: integer |
| |
| required:false |
| |
| virtual\_network\_interface\_requirements |
| |
| type: list |
| |
| entry\_schema: |
| |
| type: VirtualNetworkInterfaceRequirements |
| |
| required:false |
| |
| requirements: |
| |
| - virtual\_link: |
| |
| capability: tosca.capabilities.nfv.VirtualLinkable |
| |
| relationship: tosca.relationships.nfv.VirtualLinksTo |
| |
| node: tosca.nodes.nfv.VnfVirtualLinkDesc - virtual\_binding: |
| |
| capability: tosca.capabilities.nfv.VirtualBindable |
| |
| relationship: tosca.relationships.nfv.VirtualBindsTo |
| |
| node: tosca.nodes.nfv.VDU |
+----------------------------------------------------------------+
tosca.nodes.nfv.VDU.VirtualStorage
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The NFV VirtualStorage node type represents a virtual storage entity
which it describes the deployment and operational behavior of a virtual
storage resources, as defined by **[ETSI NFV IFA011].**
**[editor note]** open issue: should NFV profile use the current storage
model as described in YAML 1.1. Pending on Shitao proposal (see
NFVIFA(17)000110 discussion paper)
**[editor note]** new relationship type as suggested in Matt
presentation. Slide 8. With specific rules of “valid\_target\_type”
+---------------------------+--------------------------------------+
| **Shorthand Name** | VirtualStorage |
+===========================+======================================+
| **Type Qualified Name** | tosca: VirtualStorage |
+---------------------------+--------------------------------------+
| **Type URI** | tosca.nodes.nfv.VDU.VirtualStorage |
+---------------------------+--------------------------------------+
| **derived\_from** | tosca.nodes.Root |
+---------------------------+--------------------------------------+
tosca.artifacts.nfv.SwImage
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------+------------------------------------+
| **Shorthand Name** | SwImage |
+===========================+====================================+
| **Type Qualified Name** | tosca:SwImage |
+---------------------------+------------------------------------+
| **Type URI** | tosca.artifacts.nfv.SwImage |
+---------------------------+------------------------------------+
| **derived\_from** | tosca.artifacts.Deployment.Image |
+---------------------------+------------------------------------+
Properties
++++++++++++
+-----------------+---------+----------+------------+-------------------------+
| Name | Required| Type | Constraints| Description |
+=================+=========+==========+============+=========================+
| name | yes | string | | Name of this software |
| | | | | image |
+-----------------+---------+----------+------------+-------------------------+
| version | yes | string | | Version of this software|
| | | | | image |
+-----------------+---------+----------+------------+-------------------------+
| checksum | yes | string | | Checksum of the software|
| | | | | image file |
+-----------------+---------+----------+------------+-------------------------+
| container\ | yes | string | | The container format |
| _format | | | | describes the container |
| | | | | file format in which |
| | | | | software image is |
| | | | | provided. |
+-----------------+---------+----------+------------+-------------------------+
| disk\_format | yes | string | | The disk format of a |
| | | | | software image is the |
| | | | | format of the underlying|
| | | | | disk image |
+-----------------+---------+----------+------------+-------------------------+
| min\_disk | yes | scalar-\ | | The minimal disk size |
| | | unit.size| | requirement for this |
| | | | | software image. |
+-----------------+---------+----------+------------+-------------------------+
| min\_ram | no | scalar-\ | | The minimal RAM |
| | | unit.size| | requirement for this |
| | | | | software image. |
+-----------------+---------+----------+------------+-------------------------+
| Size | yes | scalar-\ | | The size of this |
| | | unit.size| | software image |
+-----------------+---------+----------+------------+-------------------------+
| sw\_image | yes | string | | A reference to the |
| | | | | actual software image |
| | | | | within VNF Package, or |
| | | | | url. |
+-----------------+---------+----------+------------+-------------------------+
| operating\ | no | string | | Identifies the operating|
| _system | | | | system used in the |
| | | | | software image. |
+-----------------+---------+----------+------------+-------------------------+
| supported\ | no | list | | Identifies the |
| _virtualization\| | | | virtualization |
| _enviroment | | | | environments (e.g. |
| | | | | hypervisor) compatible |
| | | | | with this software image|
+-----------------+---------+----------+------------+-------------------------+
Definition
+++++++++++
+-----------------------------------------------------+
| tosca.artifacts.nfv.SwImage: |
| |
| derived\_from: tosca.artifacts.Deployment.Image |
| |
| properties or metadata: |
| |
| #id: |
| |
| # node name |
| |
| name: |
| |
| type: string |
| |
| required: true |
| |
| version: |
| |
| type: string |
| |
| required: true |
| |
| checksum: |
| |
| type: string |
| |
| required: true |
| |
| container\_format: |
| |
| type: string |
| |
| required: true |
| |
| disk\_format: |
| |
| type: string |
| |
| required: true |
| |
| min\_disk: |
| |
| type: scalar-unit.size # Number |
| |
| required: true |
| |
| min\_ram: |
| |
| type: scalar-unit.size # Number |
| |
| required: false |
| |
| size: |
| |
| type: scalar-unit.size # Number |
| |
| required: true |
| |
| sw\_image: |
| |
| type: string |
| |
| required: true |
| |
| operating\_system: |
| |
| type: string |
| |
| required: false |
| |
| supported\_virtualisation\_environments: |
| |
| type: list |
| |
| entry\_schema: |
| |
| type: string |
| |
| required: false |
+-----------------------------------------------------+
vNAT Example
^^^^^^^^^^^^^
openovnf\_\_vOpenNAT.yaml
~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-------------------------------------------------------------+
| imports: |
| |
| - openonfv\_\_tosca.capabilities.Scalable.yaml |
| |
| - openonfv\_\_tosca.capabilities.nfv.Metric.yaml |
| |
| - openonfv\_\_tosca.capabilities.network.Bindable.yaml |
| |
| - openonfv\_\_tosca.capabilities.Attachment.yaml |
| |
| - openonfv\_\_tosca.capabilities.nfv.VirtualBindable.yaml |
| |
| - openonfv\_\_tosca.requirements.nfv.VirtualStorage.yaml |
| |
| - openonfv\_\_tosca.nodes.nfv.VDU.VirtualStorage.yaml |
| |
| - openonfv\_\_tosca.relationships.nfv.VirtualBindsTo.yaml |
| |
| - openonfv\_\_tosca.nodes.nfv.VDU.Compute.yaml |
| |
| - openonfv\_\_tosca.artifacts.nfv.SwImage.yaml |
| |
| - openonfv\_\_tosca.capabilities.nfv.VirtualCompute.yaml |
| |
| - openonfv\_\_tosca.capabilities.Container.yaml |
| |
| - openonfv\_\_tosca.capabilities.nfv.VirtualStorage.yaml |
| |
| - openonfv\_\_tosca.requirements.nfv.VirtualBinding.yaml |
| |
| - openovnf\_\_tosca.nodes.nfv.VNF.vOpenNAT.yaml |
| |
| - openonfv\_\_tosca.capabilities.Endpoint.Admin.yaml |
| |
| - openonfv\_\_tosca.capabilities.OperatingSystem.yaml |
| |
| - openonfv\_\_tosca.nodes.nfv.VduCpd.yaml |
| |
| - openonfv\_\_tosca.relationships.nfv.VDU.AttachedTo.yaml |
| |
| metadata: |
| |
| vnfProductName: openNAT |
| |
| vnfdVersion: 1.0.0 |
| |
| vnfProvider: intel |
| |
| vnfmInfo: GVNFM |
| |
| csarVersion: 1.0.0 |
| |
| vnfdId: openNAT-1.0 |
| |
| csarProvider: intel |
| |
| vnfProductInfoDescription: openNAT |
| |
| version: 1.0.0 |
| |
| csarType: NFAR |
| |
| vendor: intel |
| |
| localizationLanguage: '[english, chinese]' |
| |
| id: openNAT-1.0 |
| |
| defaultLocalizationLanguage: english |
| |
| vnfProductInfoName: openNAT |
| |
| vnfSoftwareVersion: 1.0.0 |
| |
| topology\_template: |
| |
| node\_templates: |
| |
| vdu\_vNat: |
| |
| artifacts: |
| |
| vNatVNFImage: |
| |
| file: /swimages/xenial-snat.qcow2 |
| |
| type: tosca.artifacts.nfv.SwImage |
| |
| properties: |
| |
| name: vNatVNFImage |
| |
| version: "1.0" |
| |
| checksum: "5000" |
| |
| container\_format: bare |
| |
| disk\_format: qcow2 |
| |
| min\_disk: 10 GB |
| |
| min\_ram: 1 GB |
| |
| size: 10 GB |
| |
| sw\_image: /swimages/xenial-snat.qcow2 |
| |
| operating\_system: unbantu |
| |
| attributes: |
| |
| tosca\_name: vdu\_vNat |
| |
| capabilities: |
| |
| virtual\_compute: |
| |
| properties: |
| |
| virtual\_memory: |
| |
| numa\_enabled: true |
| |
| virtual\_mem\_size: 2 GB |
| |
| requested\_additional\_capabilities: |
| |
| numa: |
| |
| support\_mandatory: true |
| |
| requested\_additional\_capability\_name: numa |
| |
| target\_performance\_parameters: |
| |
| hw:numa\_nodes: "2" |
| |
| hw:numa\_cpus.0: "0,1" |
| |
| hw:numa\_mem.0: "1024" |
| |
| hw:numa\_cpus.1: "2,3,4,5" |
| |
| hw:numa\_mem.1: "1024" |
| |
| hyper\_threading: |
| |
| support\_mandatory: true |
| |
| requested\_additional\_capability\_name: hyper\_threading |
| |
| target\_performance\_parameters: |
| |
| hw:cpu\_sockets : "2" |
| |
| hw:cpu\_threads : "2" |
| |
| hw:cpu\_cores : "2" |
| |
| hw:cpu\_threads\_policy: "isolate" |
| |
| ovs\_dpdk: |
| |
| support\_mandatory: true |
| |
| requested\_additional\_capability\_name: ovs\_dpdk |
| |
| target\_performance\_parameters: |
| |
| sw:ovs\_dpdk: "true" |
| |
| virtual\_cpu: |
| |
| cpu\_architecture: X86 |
| |
| num\_virtual\_cpu: 2 |
| |
| properties: |
| |
| configurable\_properties: |
| |
| test: |
| |
| additional\_vnfc\_configurable\_properties: |
| |
| aaa: 1 |
| |
| name: vNat |
| |
| descrption: the virtual machine of vNat |
| |
| boot\_order: |
| |
| - vNAT\_Storage |
| |
| requirements: |
| |
| - virtual\_storage: |
| |
| capability: virtual\_storage |
| |
| node: vNAT\_Storage |
| |
| relationship: |
| |
| properties: |
| |
| location: /mnt/volume\_0 |
| |
| type: tosca.relationships.nfv.VDU.AttachedTo |
| |
| - local\_storage: |
| |
| node: tosca.nodes.Root |
| |
| type: tosca.nodes.nfv.VDU.Compute |
| |
| SRIOV\_Port: |
| |
| attributes: |
| |
| tosca\_name: SRIOV\_Port |
| |
| properties: |
| |
| virtual\_network\_interface\_requirements: |
| |
| - name: sriov |
| |
| support\_mandatory: false |
| |
| description: sriov |
| |
| requirement: |
| |
| SRIOV: true |
| |
| role: root |
| |
| description: sriov port |
| |
| layer\_protocol: ipv4 |
| |
| requirements: |
| |
| - virtual\_binding: |
| |
| capability: virtual\_binding |
| |
| node: vdu\_vNat |
| |
| relationship: |
| |
| type: tosca.relationships.nfv.VirtualBindsTo |
| |
| - virtual\_link: |
| |
| node: tosca.nodes.Root |
| |
| type: tosca.nodes.nfv.VduCpd |
| |
| vNAT\_Storage: |
| |
| attributes: |
| |
| tosca\_name: vNAT\_Storage |
| |
| properties: |
| |
| id: vNAT\_Storage |
| |
| size\_of\_storage: 10 GB |
| |
| rdma\_enabled: false |
| |
| type\_of\_storage: volume |
| |
| type: tosca.nodes.nfv.VDU.VirtualStorage |
| |
| substitution\_mappings: |
| |
| requirements: |
| |
| sriov\_plane: |
| |
| - SRIOV\_Port |
| |
| - virtual\_link |
| |
| node\_type: tosca.nodes.nfv.VNF.vOpenNAT |
| |
| tosca\_definitions\_version: tosca\_simple\_yaml\_1\_0 |
+-------------------------------------------------------------+
openonfv\_\_tosca.nodes.nfv.VDU.VirtualStorage.yaml
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------------------------------------+
| imports: |
| |
| - openonfv\_\_tosca.capabilities.nfv.VirtualStorage.yaml |
| |
| node\_types: |
| |
| tosca.nodes.nfv.VDU.VirtualStorage: |
| |
| capabilities: |
| |
| virtual\_storage: |
| |
| type: tosca.capabilities.nfv.VirtualStorage |
| |
| derived\_from: tosca.nodes.Root |
| |
| properties: |
| |
| id: |
| |
| type: string |
| |
| size\_of\_storage: |
| |
| type: string |
| |
| rdma\_enabled: |
| |
| required: false |
| |
| type: boolean |
| |
| type\_of\_storage: |
| |
| type: string |
| |
| tosca\_definitions\_version: tosca\_simple\_yaml\_1\_0 |
+------------------------------------------------------------+
openonfv\_\_tosca.nodes.nfv.VduCpd.yaml
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-----------------------------------------------------------------+
| data\_types: |
| |
| tosca.datatypes.nfv.L3AddressData: |
| |
| properties: |
| |
| number\_of\_ip\_address: |
| |
| required: false |
| |
| type: integer |
| |
| ip\_address\_assignment: |
| |
| type: boolean |
| |
| ip\_address\_type: |
| |
| constraints: |
| |
| - valid\_values: |
| |
| - ipv4 |
| |
| - ipv6 |
| |
| required: false |
| |
| type: string |
| |
| floating\_ip\_activated: |
| |
| type: string |
| |
| tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements: |
| |
| properties: |
| |
| name: |
| |
| required: false |
| |
| type: string |
| |
| support\_mandatory: |
| |
| type: boolean |
| |
| description: |
| |
| required: false |
| |
| type: string |
| |
| requirement: |
| |
| entry\_schema: |
| |
| type: string |
| |
| type: map |
| |
| tosca.datatype.nfv.AddressData: |
| |
| properties: |
| |
| address\_type: |
| |
| constraints: |
| |
| - valid\_values: |
| |
| - mac\_address |
| |
| - ip\_address |
| |
| type: string |
| |
| l2\_address\_data: |
| |
| required: false |
| |
| type: tosca.datatypes.nfv.L2AddressData |
| |
| l3\_address\_data: |
| |
| required: false |
| |
| type: tosca.datatypes.nfv.L3AddressData |
| |
| tosca.datatypes.nfv.L2AddressData: {} |
| |
| imports: |
| |
| - openonfv\_\_tosca.requirements.nfv.VirtualBinding.yaml |
| |
| - openonfv\_\_tosca.requirements.nfv.VirtualBinding.yaml |
| |
| node\_types: |
| |
| tosca.nodes.nfv.VduCpd: |
| |
| derived\_from: tosca.nodes.Root |
| |
| properties: |
| |
| virtual\_network\_interface\_requirements: |
| |
| entry\_schema: |
| |
| type: tosca.datatypes.nfv.VirtualNetworkInterfaceRequirements |
| |
| required: false |
| |
| type: list |
| |
| role: |
| |
| constraints: |
| |
| - valid\_values: |
| |
| - root |
| |
| - leaf |
| |
| required: false |
| |
| type: string |
| |
| bitrate\_requirement: |
| |
| required: false |
| |
| type: integer |
| |
| description: |
| |
| required: false |
| |
| type: string |
| |
| layer\_protocol: |
| |
| constraints: |
| |
| - valid\_values: |
| |
| - ethernet |
| |
| - mpls |
| |
| - odu2 |
| |
| - ipv4 |
| |
| - ipv6 |
| |
| - pseudo\_wire |
| |
| type: string |
| |
| address\_data: |
| |
| entry\_schema: |
| |
| type: tosca.datatype.nfv.AddressData |
| |
| required: false |
| |
| type: list |
| |
| requirements: |
| |
| - virtual\_binding: |
| |
| capability: tosca.capabilities.nfv.VirtualBindable |
| |
| occurrences: |
| |
| - 0 |
| |
| - UNBOUNDED |
| |
| - virtual\_link: |
| |
| capability: tosca.capabilities.nfv.VirtualBindable |
| |
| occurrences: |
| |
| - 0 |
| |
| - UNBOUNDED |
| |
| tosca\_definitions\_version: tosca\_simple\_yaml\_1\_0 |
+-----------------------------------------------------------------+
.. |image1| image:: Image1.png
:width: 5.76806in
:height: 4.67161in
.. |image2| image:: Image2.png
:width: 5.40486in
:height: 2.46042in
Heat
-------------
General Guidelines
^^^^^^^^^^^^^^^^^^^
YAML Format
^^^^^^^^^^^^^
Heat Orchestration Templates must use valid YAML. YAML (YAML Ain't
Markup Language) is a human friendly data serialization standard for all
programming languages. See http://www.yaml.org/.
Heat Orchestration Template Format
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Heat Orchestration templates must be defined in YAML.
YAML rules include:
- Tabs are NOT allowed, use spaces ONLY.
- R-43125 The VNF Heat **MUST** indent properties and lists with 1 or
more spaces.
- All Resource IDs and resource property parameters are case-sensitive.
(e.g., "ThIs", is not the same as "thiS")
Heat Orchestration Template Structure
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Heat Orchestration template structure follows the following format, as
defined by OpenStack at
https://docs.openstack.org/developer/heat/template_guide/hot_spec.html.
.. code-block:: yaml
heat_template_version: <date>
description:
# a description of the template
parameter_groups:
# a declaration of input parameter groups and order
parameters:
# declaration of input parameters
resources:
# declaration of template resources
outputs:
# declaration of output parameters
conditions:
# declaration of conditions
R-67888 The VNF Heat **MUST** contain the following
sections:
- heat\_template\_version:
- description:
- parameters:
- resources:
Heat Orchestration templates for ONAP may contain the following
sections:
- parameter\_groups:
- outputs:
heat\_template\_version
++++++++++++++++++++++++
This section is ONAP mandatory. The heat\_template\_version must be set
to a date that is supported by the OpenStack environment.
description
++++++++++++
R-39402 The VNF Heat **MUST** contain the description section.
parameter\_groups
+++++++++++++++++++
This ONAP optional section allows for specifying how the input
parameters should be grouped and the order to provide the parameters in.
parameters
+++++++++++
R-35414 The VNF Heat **MUST** contain the parameter section.
This section allows for
specifying input parameters that must be provided when instantiating
the template. Each parameter is specified in a separated nested block
with the name of the parameters defined in the first line and additional
attributes (e.g., type, label) defined as nested elements.
R-90279 The VNF Heat **MUST** use in a resource all parameters declared in
a template except for the parameters for the OS::Nova::Server property
availability\_zone. See `Property: availability\_zone`_. for more details on
availability\_zone.
.. code-block:: yaml
parameters:
<param name>:
type: <string | number | json | comma_delimited_list | boolean>
label: <human-readable name of the parameter>
description: <description of the parameter>
default: <default value for parameter>
hidden: <true | false>
constraints:
<parameter constraints>
immutable: <true | false>
- param name:
- The name of the parameter.
- ONAP requires that the param name must contain only alphanumeric
characters and “\_” underscores. Special characters must not be
used.
- type:
- The type of the parameter. Supported types are string, number,
comma\_delimited\_list, json and boolean.
- R-28657 The VNF Heat **MUST** provide the attribute 'type' on
parameters per the OpenStack Heat Orchestration Template standard.
- label:
- A human readable name for the parameter.
- This attribute is optional.
- description:
- A human readable description for the parameter.
- R-44001 The VNF Heat **MUST** provide the attribute 'description'
on parameters. (Note that this attribute is OpenStack optional.)
- default:
- A default value for the parameter.
- R-90526 The VNF Heat **MUST NOT** use the attribute 'default'.
If a parameter has a default value, it must be provided in
the environment file. (Note that this attribute is OpenStack
optional.)
- hidden:
- Defines whether the parameters should be hidden when a user
requests information about a stack created from the template. This
attribute can be used to hide passwords specified as parameters.
- This attribute is optional and defaults to false.
- constraints:
- A list of constraints to apply. The constraints block of a
parameter definition defines additional validation constraints
that apply to the value of the parameter. The parameter values
provided in the Heat Orchestration Template are validated against
the constraints at instantiation time. The constraints are defined
as a list with the following syntax
constraints:
- <constraint type>: <constraint definition>
description: <constraint description>
- constraint type: Type of constraint to apply.
- constraint definition: The actual constraint, depending on the
constraint type.
- description: A description of the constraint. The text is presented
to the user when the value the user defines violates the constraint.
If omitted, a default validation message is presented to the user.
This attribute is optional.
- R-88863 The VNF Heat **MUST** have a constraint of range or
allowed\_values for a parameter type 'number'.
- range: The range constraint applies to parameters of type number.
It defines a lower and upper limit for the numeric value of the
parameter. The syntax of the range constraint is
range: { min: <lower limit>, max: <upper limit> }
It is possible to define a range constraint with only a lower limit
or an upper limit.
- allowed\_values: The allowed\_values constraint applies to parameters
of type string or number. It specifies a set of possible values for a
parameter. At deployment time, the user-provided value for the
respective parameter must match one of the elements of the list. The
syntax of the allowed\_values constraint is
allowed\_values: [ <value>, <value>, ... ]
Alternatively, the following YAML list notation can be used
allowed\_values:
- <value>
- <value>
- ...
- Other <constraint type> are optional, they may be used (e.g., length,
modulo, allowed\_pattern, custom\_constraint, allowed\_values (for
string types))
- Note that constrains must not be defined for any parameter enumerated
in a nested heat template.
- Some ONAP parameters must never have constraints defined. See
`ONAP Resource ID and Parameter Naming Convention`_ for the
use cases where these exceptions exist.
- immutable:
- Defines whether the parameter is updatable. Stack update fails, if
this is set to true and the parameter value is changed.
- This attribute is optional and defaults to false.
resources
++++++++++
R-23664 The VNF Heat **MUST** have a resources: section with the
declaration of at least one resource.
This section
contains the declaration of the single resources of the template. This
section with at least one resource must be defined in the Heat
Orchestration Template, or the template would not create any resources
when being instantiated.
Each resource is defined as a separate block in the resources section
with the following syntax.
.. code-block:: yaml
resources:
<resource ID>:
type: <resource type>
properties:
<property name>: <property value>
metadata:
<resource specific metadata>
depends\_on: <resource ID or list of ID>
update\_policy: <update policy>
deletion\_policy: <deletion policy>
external\_id: <external resource ID>
condition: <condition name or expression or boolean>
- resource ID
- A resource ID that must be unique within the resources section of
the Heat Orchestration Template.
- R-16447 The VNF Heat **MUST** have unique resource IDs across all Heat
Orchestration Templates that compose the VNF. This requirement
also applies when a VNF is composed of more than one Heat
Orchestration Template (see ONAP VNF Modularity Overview).
- The naming convention for a resource ID is provided in `Resource IDs`_.
- type
- The resource type, such as OS::Nova::Server or OS::Neutron::Port.
Note that the type may specify a nested heat file. This attribute
is required.
- properties
- A list of resource-specific properties. The property value can be
provided in place, or via a function (e.g., Intrinsic functions).
This section is optional.
- The naming convention for property parameters is provided in
`ONAP Resource ID and Parameter Naming Convention`_.
- metadata
- Resource-specific metadata. This section is optional, except for
the resource OS::Nova::Server. See `Resource: OS::Nova::Server - Parameters`_.
- R-97199 The VNF Heat **MUST** use the metadata property for
OS::Nova::Server resource type.
- depends\_on
- Dependencies of the resource on one or more resources of the
template. This attribute is optional. See
`Resource Data Synchronization`_ for additional details.
- update\_policy
- Update policy for the resource, in the form of a nested
dictionary. Whether update policies are supported and what the
exact semantics are depends on the type of the current resource.
This attribute is optional.
- deletion\_policy
- Deletion policy for the resource. The allowed deletion policies
are Delete, Retain, and Snapshot. Beginning with
heat\_template\_version 2016-10-14, the lowercase equivalents
delete, retain, and snapshot are also allowed. This attribute is
optional; the default policy is to delete the physical resource
when deleting a resource from the stack.
- external\_id
- Allows for specifying the resource\_id for an existing external
(to the stack) resource. External resources cannot depend on other
resources, but we allow other resources to depend on external
resource. This attribute is optional. Note: when this is
specified, properties will not be used for building the resource
and the resource is not managed by Heat. This is not possible to
update that attribute. Also, resource won’t be deleted by heat
when stack is deleted.
- condition
- Condition for the resource. The condition decides whether to
create the resource or not. This attribute is optional.
outputs
++++++++
This ONAP optional section allows for specifying output parameters
available to users once the template has been instantiated. If the
section is specified, it will need to adhere to specific requirements.
See `ONAP Parameter Classifications Overview`_ and
`ONAP Output Parameter Names`_ for additional details.
Environment File Format
^^^^^^^^^^^^^^^^^^^^^^^^
The environment file is a yaml text file.
(https://docs.openstack.org/developer/heat/template_guide/environment.html)
The environment file can contain the following sections:
- parameters: A list of key/value pairs.
- resource\_registry: Definition of custom resources.
- parameter\_defaults: Default parameters passed to all template
resources.
- encrypted\_parameters: List of encrypted parameters.
- event\_sinks: List of endpoints that would receive stack events.
- parameter\_merge\_strategies: Merge strategies for merging parameters
and parameter defaults from the environment file.
R-03324 The VNF Heat **MUST** contain the following sections in the
environment file:
- parameters:
Environment files for ONAP may contain the following sections:
- resource\_registry:
- parameter\_defaults:
- encrypted\_parameters:
- event\_sinks:
- parameter\_merge\_strategies:
The use of an environment file in OpenStack is optional. In ONAP, it is
mandatory. A Heat Orchestration Template uploaded to ONAP must have a
corresponding environment file, even if no parameters are enumerated in
the mandatory parameter section.
(Note that ONAP, the open source version of ONAP, does not
programmatically enforce the use of an environment file.)
SDC Treatment of Environment Files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Parameter values enumerated in the environment file are used by SDC as
the default value. However, the SDC user may use the SDC GUI to
overwrite the default values in the environment file.
SDC generates a new environment file for distribution to MSO based on
the uploaded environment file and the user provided GUI updates. The
user uploaded environment file is discarded when the new file is
created.
ONAP has requirements for what parameters must be enumerated in the
environment file and what parameter must not be enumerated in the
environment file. See `ONAP Parameter Classifications Overview`_ and
`ONAP Resource ID and Parameter Naming Convention`_ for more details.
Nested Heat Orchestration Templates Overview
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ONAP supports nested Heat Orchestration Templates per OpenStack
specifications.
A Base Module may utilize nested templates.
An Incremental Module may utilize nested templates.
A Cinder Volume Module may utilize nested templates.
A nested template must not define parameter constraints in the parameter
definition section.
Nested templates may be suitable for larger VNFs that contain many
repeated instances of the same VM type(s). A common usage pattern is to
create a nested template for each VM type along with its supporting
resources. The Heat Orchestration Template may then reference these
nested templates either statically (by repeated definition) or
dynamically (via OS::Heat::ResourceGroup).
See `Nested Heat Templates`_ for additional details.
ONAP Heat Orchestration Template Filenames
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In order to enable ONAP to understand the relationship between Heat
files, the following Heat file naming convention must be utilized.
In the examples below, <text> represents any alphanumeric string that
must not contain any special characters and must not contain the word
“base”.
Base Modules
~~~~~~~~~~~~~~
R-19473 The VNF Heat **MUST** include “base” in the filename for the
base module
R-81339 The VNF Heat **MUST** match one of the following options for
the base module file name:
- base\_<text>.y[a]ml
- <text>\_base.y[a]ml
- base.y[a]ml
- <text>\_base\_<text>.y[a]ml
R-91342 The VNF Heat **MUST** name the base module’s corresponding
environment file to be identical to the base module with “.y[a]ml”
replaced with “.env”.
Incremental Modules
~~~~~~~~~~~~~~~~~~~~~
There is no explicit naming convention for the incremental modules.
As noted above, <text> represents any alphanumeric string.
R-87247 The VNF Heat **MUST NOT** use any special characters or the
word “base” in the name of the incremental module.
- <text>.y[a]ml
R-94509 The VNF Heat **MUST** name the incremental module’s
corresponding environment file to be identical to the incremental
module with “.y[a]ml” replaced with “.env”.
To clearly identify the incremental module, it is recommended to use the
following naming options for modules:
- module\_<text>.y[a]ml
- <text>\_module.y[a]ml
- module.y[a]ml
Cinder Volume Modules
~~~~~~~~~~~~~~~~~~~~~~~
R-82732 The VNF Heat **MUST** name the Cinder volume module file name
to be the same as the corresponding module it is supporting (base
module or incremental module) with “\_volume” appended.
- <base module name>\_volume.y[a]ml
- <incremental module name>\_volume.y[a]ml
R-31141 The VNF Heat **MUST** name the volume module’s corresponding
environment file to be identical to the volume module with “.y[a]ml”
replaced with “.env”.
Nested Heat file
~~~~~~~~~~~~~~~~~~
There is no explicit naming convention for nested Heat files with the
following exceptions; the name should contain “nest”.
R-76057 The VNF Heat **MUST NOT** use special characters
or the word “base” in the file name for the nested template.
As noted above, <text> represents any alphanumeric string.
- <text>.y[a]m
Nested Heat files do not have corresponding environment files, per
OpenStack specifications.
R-18224 The VNF Heat **MUST** pass in as properties all parameter values
associated with the nested heat file in the resource definition defined
in the parent heat template.
ONAP Parameter Classifications Overview
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In order for ONAP to support workflow automation, Heat Orchestration
Template resource property parameters must adhere to specific naming
conventions and requirements.
Broadly, ONAP categorizes parameters into four categories:
1. ONAP metadata parameters
2. Instance specific parameters
3. Constant parameters
4. Output parameters.
ONAP Metadata Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~
There are both mandatory and optional ONAP metadata parameters
associated with the resource OS::Nova::Server.
- ONAP metadata parameters must not have parameter constraints defined.
- Both mandatory and optional (if specified) ONAP metadata parameter
names must follow the ONAP metadata parameter naming convention.
`Resource: OS::Nova::Server – Metadata Parameters`_ provides more details on
the metadata parameters.
Instance specific parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The instance specific parameters are VNF instance specific. The value of
the parameter will be different for every instance of a VNF (e.g., IP
address). The instance specific parameters are subdivided into two
categories: **ONAP Orchestration Parameters** and **VNF Orchestration
Parameters**
ONAP Orchestration Parameters
+++++++++++++++++++++++++++++++
ONAP Orchestration Parameters are per instance parameters where the
value is assigned via ONAP automation. (Note that in some cases,
automation is currently not available and the value is loaded into ONAP
prior to instantiation.)
- ONAP orchestration parameters must not be enumerated in the
environment file.
- When the ONAP orchestration parameter type is set to number, the
parameter must have constraints for range and/or allowed\_values.
- Parameter constraints for ONAP orchestration parameters are optional
for all parameter types other than number. If constraints are
specified, they must adhere to the OpenStack specifications.
- The ONAP orchestration parameter names must follow the ONAP
orchestration parameter naming convention.
`ONAP Resource ID and Parameter Naming Convention`_
provides additional details.
VNF Orchestration Parameters
+++++++++++++++++++++++++++++
VNF Orchestration Parameters are per instance parameters where the
values are assigned manually. They are not supported by ONAP automation.
The per instance values are loaded into ONAP prior to VNF instantiation.
- VNF orchestration parameters must not be enumerated in the
environment file.
- When the VNF orchestration parameter type is set to number, the
parameter must have constraints for range or allowed\_values.
- Parameter constraints for VNF orchestration parameters are optional
for all parameter types other than number. If constraints are
specified, they must adhere to the OpenStack specifications.
- The VNF orchestration parameter names should follow the VNF
orchestration parameter naming convention.
`ONAP Resource ID and Parameter Naming Convention`_
provides additional details.
Constant Parameters
~~~~~~~~~~~~~~~~~~~~~
The constant parameters are parameters that remain constant across many
VNF instances (e.g., image, flavor). The constant parameters are
subdivided into two categories: **ONAP Constant Parameters** and
**VNF Constant Parameters.**
ONAP Constant Parameters
++++++++++++++++++++++++++
- ONAP Constant Parameters must be enumerated in the environment file.
These parameter values are not assigned by ONAP.
- When the ONAP Constant Parameter type is set to number, the parameter
must have constraints for range and/or allowed\_values.
- Parameter constraints for ONAP constant parameters are optional for
all parameter types other than number. If constraints are specified,
they must adhere to the OpenStack specifications.
- The ONAP Constant Parameter names must follow the ONAP orchestration
parameter naming convention.
`ONAP Resource ID and Parameter Naming Convention`_
provides additional details.
VNF Constant Parameters
++++++++++++++++++++++++
- VNF Constant Parameters must be enumerated in the environment file.
These parameter values are not assigned by ONAP.
- When the VNF Constant Parameters type is set to number, the parameter
must have constraints for range and/or allowed\_values.
- Parameter constraints for ONAP constant parameters are optional for
all parameter types other than number. If constraints are specified,
they must adhere to the OpenStack specifications.
- The VNF Constant Parameters names should follow the ONAP
orchestration parameter naming convention.
`ONAP Resource ID and Parameter Naming Convention`_
provides additional details.
Output Parameters
~~~~~~~~~~~~~~~~~~~
The output parameters are parameters defined in the output section of a
Heat Orchestration Template. The ONAP output parameters are subdivided
into three categories:
1. ONAP Base Module Output Parameters
2. ONAP Volume Module Output Parameters
3. ONAP Predefined Output Parameters.
ONAP Base Module Output Parameters
++++++++++++++++++++++++++++++++++++
ONAP Base Module Output Parameters are declared in the outputs: section
of the base module Heat Orchestration Template. A Base Module Output
Parameter is available as an input parameter (i.e., declared in the
“parameters:” section) to all incremental modules in the VNF.
- A Base Module Output Parameter may be used as an input parameter in
an incremental module.
- The Output parameter name and type must match the input parameter
name and type unless the Output parameter is of the type
comma\_delimited\_list.
- If the Output parameter has a comma\_delimited\_list value (e.g.,
a collection of UUIDs from a Resource Group), then the
corresponding input parameter must be declared as type json and
not a comma\_delimited\_list, which is actually a string value
with embedded commas.
- When a Base Module Output Parameter is declared as an input parameter
in an incremental module Heat Orchestration Template, parameter
constraints must not be declared.
Additional details on ONAP Base Module Output Parameters are provided in
`ONAP Output Parameter Names`_ and ONAP VNF Modularity.
ONAP Volume Module Output Parameters
++++++++++++++++++++++++++++++++++++++
The volume template output parameters are only available for the module
(base or add on) that the volume is associated with.
- ONAP Volume Module Output Parameters are declared in the “outputs:”
section of the Cinder volume module Heat Orchestration Template
- An ONAP Volume Module Output Parameter is available as an input
parameter (i.e., declared in the parameters: section) only for the
module (base or incremental) that the Cinder volume module is
associated with.
- R-07443 The VNF Heat **MUST** match the Output parameter name and type with
the input parameter name and type unless the Output parameter is of the
type comma\_delimited\_list.
- If the Output parameter has a comma\_delimited\_list value (e.g., a
collection of UUIDs from a Resource Group), then the corresponding
input parameter must be declared as type json and not a
comma\_delimited\_list, which is actually a string value with
embedded commas.
- When an ONAP Volume Module Output Parameter is declared as an input
parameter in a base module or incremental module, parameter
constraints must not be declared.
Additional details on ONAP Base Module Output Parameters are provided in
`ONAP Output Parameter Names`_ and `Cinder Volume Templates`_.
ONAP Predefined Output Parameters
+++++++++++++++++++++++++++++++++++
ONAP will look for a small set of pre-defined Heat output parameters to
capture resource attributes for inventory in ONAP. These output
parameters are optional and are specified in `OAM Management IP Addresses`_.
Support of heat stack update
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
VNF Heat Orchestration Templates must not be designed to utilize the
OpenStack heat stack-update command for scaling (growth/de-growth). ONAP
does not support the use of heat stack-update command for scaling.
It is important to note that ONAP only supports heat stack-update for
image upgrades.
Networking
^^^^^^^^^^^^
ONAP defines two types of networks: External Networks and Internal
Networks.
ONAP defines an external network in relation to the VNF and not with
regard to the Network Cloud site. External networks may also be referred
to as “inter-VNF” networks. An external network connects VMs in a VNF to
- VMs in another VNF or
- an external gateway or router
ONAP defines an internal network in relation to the VNF and not with
regard to the Network Cloud site. Internal networks may also be referred
to as “intra-VNF” networks or “private” networks. An internal network
only connects VMs in a single VNF. It must not connect to other VNFs or
an external gateway or router.
External Networks
^^^^^^^^^^^^^^^^^^^
VNF Heat Orchestration Templates must not include any resources for
external networks connected to the VNF. External networks must be
orchestrated separately, as independent, stand-alone VNF Heat
Orchestration Templates, so they can be shared by multiple VNFs and
managed independently.
When the external network is created, it must be assigned a unique
{network-role}. The {network-role} should describe the network (e.g.,
oam). The {network-role} while unique to the LCP, can repeat across
LCPs.
An External Network may be a Neutron Network or a Contrail Network
R-23983 The VNF **MUST** pass the external networks into the VNF Heat
Orchestration Templates as parameters.
- Neutron Network-id (UUID)
- Neutron Network subnet ID (UUID)
- Contrail Network Fully Qualified Domain Name (FQDN)
ONAP enforces a naming convention for parameters associated with
external networks. `ONAP Resource ID and Parameter Naming Convention`_
provides additional details.
Parameter values associated with an external network will be generated
and/or assigned by ONAP at orchestration time. Parameter values
associated with an external network must not be enumerated in the
environment file. `ONAP Resource ID and Parameter Naming Convention`_
provides additional details.
VNFs may use **Cloud assigned IP addresses** or
**ONAP SDN-C assigned IP addresses**
when attaching VMs to an external network
- A Cloud assigned IP address is assigned by OpenStack’s DHCP Service.
- An ONAP SDN-C assigned IP address is assigned by the ONAP SDN-C
controller
- Note that Neutron Floating IPs must not be used. ONAP does not
support Neutron Floating IPs (e.g., OS::Neutron::FloatingIP)
- ONAP supports the property allowed\_address\_pairs in the resource
OS::Neutron:Port and the property
virtual\_machine\_interface\_allowed\_address\_pairs in
OS::ContrailV2::VirtualMachineInterfaces. This allows the assignment
of a virtual IP (VIP) address to a set of VMs.
R-63345 The VNF Heat **MUST** pass the appropriate external
network IDs into nested VM templates when nested Heat is used.
Internal Networks
-----------------
R-35666 The VNF Heat **MUST** include the resource(s) to
create the internal network. The internal network must be either a
Neutron Network or a Contrail Network.
R-86972 The VNF Heat **MUST** create internal networks in the Base
Module, in the modular approach, with their resource IDs exposed as outputs
(i.e., ONAP Base Module Output Parameters) for use by all incremental
modules. If the Network resource ID is required in the base template,
then a get\_resource must be used.
R-68936 The VNF Heat **SHOULD** assign a unique
{network-role} in the context of the VNF, when the internal network is
created. `ONAP Resource ID and Parameter Naming Convention`_ provides
additional details.
VNFs may use **Cloud assigned IP addresses** or
**predetermined static IPs** when attaching VMs to an internal network.
- A Cloud assigned IP address is assigned by OpenStack’s DHCP Service.
- A predetermined static IP address is enumerated in the Heat
environment file. Since an internal network is local to the VNF, IP
addresses can be re-used at every VNF instance.
- Note that Neutron Floating IPs must not be used. ONAP does not
support Neutron Floating IPs (e.g., OS::Neutron::FloatingIP)
- ONAP supports the property allowed\_address\_pairs in the resource
OS::Neutron:Port and the property
virtual\_machine\_interface\_allowed\_address\_pairs in
OS::ContrailV2::VirtualMachineInterfaces. This allows the assignment
of a virtual IP (VIP) address to a set of VMs.
ONAP does not programmatically enforce a naming convention for
parameters for internal network. However, a naming convention is
provided that must be followed.
`ONAP Resource ID and Parameter Naming Convention`_
provides additional details.
ONAP Resource ID and Parameter Naming Convention
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This section provides the ONAP naming requirements for
1. Resource IDs
2. Resource Property Parameters
{vm-type}
^^^^^^^^^^^
R-01455 The VNF Heat **MUST** assign a VNF unique
{vm-type} for each Virtual Machine type (i.e., OS::Nova::Server)
instantiated in the VNF. While the {vm-type} must be unique to the VNF,
it does not have to be globally unique across all VNFs that ONAP
supports.
R-82481 The VNF Heat **MUST** include {vm-type} as part of the parameter name
for any parameter that is associated with a unique Virtual Machine type.
R-66729 The VNF Heat **MUST** include {vm-type} as part of the resource ID
for any resource ID that is associated with a unique Virtual Machine type in
the VNF.
Note that {vm-type} must not be a substring of {network-role}. A
substring of a string is another string that occurs "in". For example,
"oam" is a substring of "oam\_protected". It will cause the
Pre-Amsterdam VNF Validation Program (i.e., ICE Project) process to
produce erroneous error messages.
The {vm-type} should not contain the string “\_int” or “int\_” or
“\_int\_”. It may cause the Pre-Amsterdam VNF Validation Program (i.e.,
ICE Project) process to produce erroneous error messages.
R-32394 The VNF Heat **MUST** use the same case for {vm-type} for all
parameter names in the VNF.
R-46839 The VNF Heat **MUST** use the same case for {vm-type} for all
Resource IDs in the VNF.
It is recommended that the {vm-type} case in the parameter names matches
the {vm-type} case in the Resource IDs.
There are two exceptions to the above rules:
1. R-05008 The VNF Heat **MUST NOT** be prefixed with a common
{vm-type} identifier for the six ONAP Metadata parameters.
They are *vnf\_name*, *vnf\_id*, *vf\_module\_id*, *vf\_module\_name,
vm\_role*. The ONAP Metadata parameters are described in
`Resource: OS::Nova::Server – Metadata Parameters`_.
2. R-15422 The VNF Heat **MUST NOT** be prefixed with a common {vm-type}
identifier the parameter referring to the OS::Nova::Server property
availability\_zone . availability\_zone is described in `Property: availability_zone`_.
{network-role}
^^^^^^^^^^^^^^^
The assignment of a {network-role} is discussed in `Networking`_.
R-21330 The VNF Heat **MUST** include the {network-role} as part of the
parameter name for any parameter that is associated with an external network.
R-11168 The VNF Heat **MUST** include the {network-role} as part of the
resource ID for any resource ID that is associated with an external network
must.
R-84322 The VNF Heat **MUST** include int\_{network-role} as part of the
parameter name for any parameter that is associated with an internal network.
R-96983 The VNF Heat **MUST** include int\_{network-role} as part of the
resource ID for any resource ID that is associated with an internal network.
Note that {network-role} must not be a substring of {vm-type}. A
substring of a string is another string that occurs "in". For example,
"oam" is a substring of "oam\_protected". It will cause the
Pre-Amsterdam VNF Validation Program (i.e., ICE Project) process to
produce erroneous error messages.
The {network-role} should not contain the string “\_int” or “int\_” or
“\_int\_”. It may cause the Pre-Amsterdam VNF Validation Program (i.e.,
ICE Project) process to produce erroneous error messages.
R-58424 The VNF Heat **MUST** use the same case for {network-role} for
all parameter names in the VNF.
R-21511 The VNF Heat **MUST** use the same case for {network-role} for
all Resource IDs in the VNF.
It is recommended that the {network-role} case in the parameter names
matches the {network-role} case in the Resource IDs.
Resource IDs
^^^^^^^^^^^^^
Heat Orchestration Template resources are described in `resources`_
R-59629 The VNF Heat **MUST** have unique resource IDs within the
resources section of a Heat Orchestration Template. This is an
OpenStack Requirement.
R-43319 The VNF Heat **MUST** have unique resource IDs
across all modules that compose the VNF,
when a VNF is composed of more than one Heat Orchestration Template
(i.e., modules).
R-54517 The VNF Heat **MUST** include {vm-type} in the resource ID
when a resource is associated with a single {vm-type}.
R-96482 The VNF Heat **MUST** include {network-role} in the resource ID
when a resource is associated with a single external network.
R-98138 The VNF Heat **MUST** include int\_{network-role} in the resource ID
when a resource is associated with a single internal network.
R-82115 The VNF Heat **MUST** include both the {vm-type} and
{network-role} in the resource ID,
when a resource is associated with a single {vm-type} and a single
external network.
- The {vm-type} must appear before the {network-role} and must be
separated by an underscore (i.e., {vm-type}\_{network-role}).
- Note that an {index} value may separate the {vm-type} and the
{network-role}. An underscore will separate the three values (i.e.,
{vm-type}\_{index}\_{network-role}).
R-82551 The VNF Heat **MUST** include both the {vm-type} and
int\_{network-role} in the resource ID,
when a resource is associated with a single {vm-type} and a single
internal network.
- The {vm-type} must appear before the int\_{network-role} and must be
separated by an underscore (i.e., {vm-type}\_int\_{network-role}).
- Note that an {index} value may separate the {vm-type} and the
int\_{network-role}. An underscore will separate the three values
(i.e., {vm-type}\_{index}\_int\_{network-role}).
When a resource is associated with more than one {vm-type} and/or more
than one network, the resource ID
- must not contain the {vm-type} and/or
{network-role}/int\_{network-role}
- should contain the term “shared” and/or contain text that identifies
the VNF.
R-69287 The VNF Heat **MUST** use only alphanumeric characters and “\_”
underscores in the resource ID. Special characters must not be used.
All {index} values must be zero based. That is, the {index} must start
at zero and increment by one.
The table below provides example OpenStack Heat resource ID for
resources only associated with one {vm-type} and/or one network.
+-----------------------------+--------------------------------------+
| Resource Type | Resource ID Format |
+=============================+======================================+
| OS::Cinder::Volume | {vm\_type}\_volume\_{index} |
+-----------------------------+--------------------------------------+
| OS::Cinder::VolumeAttachment| {vm\_type}\_volumeattachment\_{index}|
+-----------------------------+--------------------------------------+
| OS::Heat::CloudConfig | {vm\_type}\_RCC |
+-----------------------------+--------------------------------------+
| OS::Heat::MultipartMime | {vm\_type}\_RMM |
+-----------------------------+--------------------------------------+
| OS::Heat::ResourceGroup | {vm\_type}\_RRG |
+-----------------------------+--------------------------------------+
| OS::Heat::SoftwareConfig | {vm\_type}\_RSC |
+-----------------------------+--------------------------------------+
| OS::Neutron::Port | {vm\_type}\_{index}\ |
| | _{network\_role}\_{index}\_port |
+-----------------------------+--------------------------------------+
| | {vm\_type}\_{index}\ |
| | _int\_{network\_role}\_{index}\_port |
+-----------------------------+--------------------------------------+
| OS::Neutron::SecurityGroup | {vm\_type}\_RSG |
+-----------------------------+--------------------------------------+
| OS::Neutron::Subnet | {network\_role}\_subnet\_{index} |
+-----------------------------+--------------------------------------+
| OS::Nova::Server | {vm\_type}\_{index} |
+-----------------------------+--------------------------------------+
| OS::Nova::ServerGroup | {vm\_type}\_RSG |
+-----------------------------+--------------------------------------+
| OS::Swift::Container | {vm\_type}\_RSwiftC |
+-----------------------------+--------------------------------------+
Table 1: Example OpenStack Heat Resource ID
The table below provides example Contrail Heat resource ID for resources
only associated with one {vm-type} and/or one network.
+-------------------------------------------+---------------------------------+
| Resource Type | Resource ID Format |
+===========================================+=================================+
| OS::ContrailV2::InstanceIp | {vm\_type}\_{index}\ |
| | _{network\_role}\_RII |
+-------------------------------------------+---------------------------------+
| OS::ContrailV2::InterfaceRouteTable | {network\_role}\_RIRT |
+-------------------------------------------+---------------------------------+
| OS::ContrailV2::NetworkIpam | {network\_role}\_RNI |
+-------------------------------------------+---------------------------------+
| OS::ContrailV2::PortTuple | {vm\_type}\_RPT |
+-------------------------------------------+---------------------------------+
| OS::ContrailV2::ServiceHealthCheck | {vm\_type}\_RSHC\_{LEFT\|RIGHT} |
+-------------------------------------------+---------------------------------+
| OS::ContrailV2::ServiceTemplate | {vm\_type}\_RST\_{index} |
+-------------------------------------------+---------------------------------+
| OS::ContrailV2::VirtualMachineInterface | int\_{network\_role}\_RVMI |
+-------------------------------------------+---------------------------------+
| OS::ContrailV2::VirtualNetwork | int\_{network\_role}\_RVN |
+-------------------------------------------+---------------------------------+
Table 2: Example Contrail Heat resource ID
Resource: OS::Nova::Server - Parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The resource OS::Nova::Server manages the running virtual machine (VM)
instance within an OpenStack cloud. (See
https://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Nova::Server.)
Four properties of this resource must follow the ONAP parameter naming
convention. The four properties are:
1. image
2. flavor
3. name
4. availability\_zone
The table below provides a summary. The sections that follow provides
additional details.
Note that the {vm\_type} must be identical across all four property
parameters for a given OS::Nova::Server resource.
+----------------------------------------------------------------------------+
| Resource OS::Nova::Server |
+--------------+----------------+----------+----------------+----------------+
| Property Name| ONAP Parameter | Parameter| Parameter Value| ONAP Parameter |
| | Name | Type | Generation | Classification |
+==============+================+==========+================+================+
| image | {vm-type}\ | string | Environment | ONAP |
| | _image\_name | string | File | Constant |
+--------------+----------------+----------+----------------+----------------+
| flavor | {vm-type}\ | string | Environment | ONAP |
| | _flavor\_name | | File | Constant |
+--------------+----------------+----------+----------------+----------------+
| name | {vm-type}\ | string | ONAP | ONAP |
| | _name\_{index} | | | Orchestration |
+--------------+----------------+----------+----------------+----------------+
| | {vm-type}\ | CDL | ONAP | ONAP |
| | _names | | | Orchestration |
+--------------+----------------+----------+----------------+----------------+
| availability\| availability\ | string | ONAP | ONAP |
| _zone | _zone\_{index} | | | Orchestration |
+--------------+----------------+----------+----------------+----------------+
Table 3 Resource Property Parameter Names
Property: image
~~~~~~~~~~~~~~~~~
The parameter associated with the property image is an ONAP Constant
parameter.
The parameters must be named {vm-type}\_image\_name in the Heat
Orchestration Template.
R-71152 The VNF Heat **MUST** declare as type: string the parameter
for property image.
R-91125 The VNF Heat **MUST** enumerate the parameter for property
image in the Heat Orchestration Template environment file.
R-57282 The VNF Heat **MUST** have a separate parameter for image for
Each VM type (i.e., {vm-type}) even if more than one {vm-type} shares
the same image. This provides maximum clarity and flexibility.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
{vm-type}_image_name:
type: string
description: {vm-type} server image
Property: flavor
~~~~~~~~~~~~~~~~~~
The parameter associated with the property flavor is an ONAP Constant
parameter.
The parameters must be named {vm-type}\_flavor\_name in the Heat
Orchestration Template.
R-50436 The VNF Heat **MUST** declare the parameter property for
flavor as type: string.
R-69431 The VNF Heat **MUST** enumerate the parameter for property
flavor in the Heat Orchestration Template environment file.
R-40499 The VNF Heat **MUST** have a separate parameter for flavor for each
VM type (i.e., {vm-type}) even if more than one {vm-type} shares the same
flavor. This provides maximum clarity and flexibility.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
{vm-type}_flavor_name:
type: string
description: {vm-type} flavor
Property: Name
~~~~~~~~~~~~~~~~
The parameter associated with the property name is an ONAP Orchestration
parameter.
The parameter value is provided to the Heat template by ONAP.
R-22838 The VNF Heat **MUST NOT** enumerate the parameter for property name
in the environment file.
R-51430 The VNF Heat **MUST** declare the parameter for property name as
type: string or type: comma\_delimited\_list
If the parameter is declared as type:string, the parameter must be named
{vm-type}\_name\_{index}, where {index} is a numeric value that starts
at zero and increments by one.
If the parameter is declared as type:comma\_delimited\_list, the
parameter must be named as {vm-type}\_names
Each element in the VM Name list should be assigned to successive
instances of that VM type.
If a VNF contains more than three instances of a given {vm-type}, the
comma\_delimited\_list form of the parameter name (i.e.,
{vm-type}\_names) should be used to minimize the number of unique
parameters defined in the Heat.
*Example: Parameter Definition*
.. code-block:: yaml
parameters:
{vm-type}_names:
type: comma_delimited_list
description: VM Names for {vm-type} VMs
{vm-type}_name_{index}:
type: string
description: VM Name for {vm-type} VM {index}
*Example: comma\_delimited\_list*
In this example, the {vm-type} has been defined as “lb” for load
balancer.
.. code-block:: yaml
parameters:
lb_names:
type: comma_delimited_list
description: VM Names for lb VMs
resources:
lb_0:
type: OS::Nova::Server
properties:
name: { get_param: [lb_names, 0] }
...
lb_1:
type: OS::Nova::Server
properties:
name: { get_param: [lb_names, 1] }
...
*Example: fixed-index*
In this example, the {vm-type} has been defined as “lb” for load
balancer.
.. code-block:: yaml
parameters:
lb_name_0:
type: string
description: VM Name for lb VM 0
lb_name_1:
type: string
description: VM Name for lb VM 1
resources:
lb_0:
type: OS::Nova::Server
properties:
name: { get_param: lb_name_0 }
...
lb_1:
type: OS::Nova::Server
properties:
name: { get_param: lb_name_1 }
...
Contrail Issue with Values for OS::Nova::Server Property Name
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
The Contrail GUI has a limitation displaying special characters. The
issue is documented in
https://bugs.launchpad.net/juniperopenstack/+bug/1590710. It is
recommended that special characters be avoided. However, if special
characters must be used, the only special characters supported are:
- “ ! $ ‘ ( ) = ~ ^ \| @ \` { } [ ] > , . \_
Property: availability\_zone
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The parameter associated with the property availability\_zone is an ONAP
Orchestration parameter.
The parameter value is provided to the Heat template by ONAP. The
parameter must not be enumerated in the environment file.
R-98450 The VNF Heat **MUST** name the parameter availability\_zone\_{index}
in the Heat Orchestration Template.
R-13561 The VNF Heat **MUST** start the {index} at zero.
R-60204 The VNF Heat **MUST** increment the {index} by one.
R-36887 The VNF Heat **MUST NOT** include the {vm-type} in the parameter name.
The parameter must be declared as type: string
The parameter must not be declared as type: comma\_delimited\_list
Example
~~~~~~~~~
The example below depicts part of a Heat Orchestration Template that
uses the four OS::Nova::Server properties discussed in this section.
In the Heat Orchestration Template below, four Virtual Machines
(OS::Nova::Server) are created: two dns servers with {vm-type} set to
“dns” and two oam servers with {vm-type} set to “oam”. Note that the
parameter associated with the property name is a comma\_delimited\_list
for dns and a string for oam.
.. code-block:: yaml
parameters:
dns_image_name:
type: string
description: dns server image
dns_flavor_name:
type: string
description: dns server flavor
dns_names:
type: comma_delimited_list
description: dns server names
oam_image_name:
type: string
description: oam server image
oam_flavor_name:
type: string
description: oam server flavor
oam_name_0:
type: string
description: oam server name 0
oam_name_1:
type: string
description: oam server name 1
availability_zone_0:
type: string
description: availability zone ID or Name
availability_zone_1:
type: string
description: availability zone ID or Name
resources:
dns_server_0:
type: OS::Nova::Server
properties:
name: { get_param: [ dns_names, 0 ] }
image: { get_param: dns_image_name }
flavor: { get_param: dns_flavor_name }
availability_zone: { get_param: availability_zone_0 }
. . .
dns_server_1:
type: OS::Nova::Server
properties:
name: { get_param: [ dns_names, 1 ] }
image: { get_param: dns_image_name }
flavor: { get_param: dns_flavor_name }
availability_zone: { get_param: availability_zone_1 }
. . .
oam_server_0:
type: OS::Nova::Server
properties:
name: { get_param: oam_name_0 }
image: { get_param: oam_image_name }
flavor: { get_param: oam_flavor_name }
availability_zone: { get_param: availability_zone_0 }
. . .
oam_server_1:
type: OS::Nova::Server
properties:
name: { get_param: oam_name_1 }
image: { get_param: oam_image_name }
flavor: { get_param: oam_flavor_name }
availability_zone: { get_param: availability_zone_1 }
. . .
Resource: OS::Nova::Server – Metadata Parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The resource OS::Nova::Server has an OpenStack optional property
metadata. The metadata property is mandatory for ONAP Heat Orchestration
Templates; it must be included.
R-17020 The VNF Heat **MUST** include the following three mandatory
metadata parameters for an OS::Nova::Server resource:
- vnf\_id
- vf\_module\_id
- vnf\_name
ONAP allows the following three optional metadata parameters for an
OS::Nova::Server resource. They may be included
- vm\_role
- vf\_module\_name
Note that the metadata parameters do not and must not contain {vm-type}
in their name.
When Metadata parameters are past into a nested heat template, the
parameter names must not change.
The table below provides a summary. The sections that follow provides
additional details.
+-------------------+----------+-------------------+----------------+
| Metadata Parameter| Parameter| Mandatory/Optional| Parameter Value|
| Name | Type | | Generation |
+===================+==========+===================+================+
| vnf\_id | string | Mandatory | ONAP |
+-------------------+----------+-------------------+----------------+
| vf\_module\_id | string | Mandatory | ONAP |
+-------------------+----------+-------------------+----------------+
| vnf\_name | string | Mandatory | ONAP |
+-------------------+----------+-------------------+----------------+
| vf\_module\_name | string | Optional | ONAP |
+-------------------+----------+-------------------+----------------+
| vm\_role | string | Optional | YAML or |
| | | | Environment |
| | | | File |
+-------------------+----------+-------------------+----------------+
Table 4: ONAP Metadata
vnf\_id
~~~~~~~~~
The vnf\_id parameter is mandatory; it must be included in the Heat
Orchestration Template.
The vnf\_id parameter value will be supplied by ONAP. ONAP generates the
UUID that is the vnf\_id and supplies it to the Heat Orchestration
Template at orchestration time.
The parameter must be declared as type: string
R-55218 The VNF Heat **MUST NOT** have parameter constraints defined
for the OS::Nova::Server metadata parameter vnf\_id.
R-20856 The VNF Heat **MUST NOT** enumerate the OS::Nova::Server
metadata parameter vnf\_id in environment file.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
vnf_id:
type: string
description: Unique ID for this VNF instance
vf\_module\_id
~~~~~~~~~~~~~~~~
The vf\_module\_id parameter is mandatory; it must be included in the
Heat Orchestration Template.
The vf\_module\_id parameter value will be supplied by ONAP. ONAP
generates the UUID that is the vf\_module\_id and supplies it to the
Heat Orchestration Template at orchestration time.
The parameter must be declared as type: string
R-98374 The VNF Heat **MUST NOT** have parameter constraints
defined for the OS::Nova::Server metadata parameter vf\_module\_id.
R-72871 The VNF Heat **MUST NOT** enumerate the OS::Nova::Server
metadata parameter vf\_module\_id in environment file.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
vnf_module_id:
type: string
description: Unique ID for this VNF module instance
vnf\_name
~~~~~~~~~~~
The vnf\_name parameter is mandatory; it must be included in the Heat
Orchestration Template.
The vnf\_name parameter value will be generated and/or assigned by ONAP
and supplied to the Heat Orchestration Template by ONAP at orchestration
time.
The parameter must be declared as type: string
R-44318 The VNF Heat **MUST NOT** have parameter constraints defined
for the OS::Nova::Server metadata parameter vnf\_name.
R-36542 The VNF Heat **MUST NOT** enumerate the OS::Nova::Server
metadata parameter vnf\_name in the environment file.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
vnf_name:
type: string
description: Unique name for this VNF instance
vf\_module\_name
~~~~~~~~~~~~~~~~~~
The vf\_module\_name parameter is optional; it may be included in the
Heat Orchestration Template.
The vf\_module\_name parameter is the name of the name of the Heat stack
(e.g., <STACK\_NAME>) in the command “Heat stack-create” (e.g., Heat
stack-create [-f <FILE>] [-e <FILE>] <STACK\_NAME>). The <STACK\_NAME>
needs to be specified as part of the orchestration process.
The parameter must be declared as type: string
Parameter constraints must not be defined.
The parameter must not be enumerated in the Heat environment file.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
vf_module_name:
type: string
description: Unique name for this VNF Module instance
vm\_role
~~~~~~~~~~
The vm\_role parameter is optional; it may be included in the Heat
Orchestration Template.
Any roles tagged to the VMs via metadata will be stored in ONAP’s A&AI
system and available for use by other ONAP components and/or north bound
systems.
The vm\_role values must be either
- hard-coded into the Heat Orchestration Template or
- enumerated in the environment file.
Defining the vm\_role as the {vm-type} is a recommended convention
The parameter must be declared as type: string
Parameter constraints must not be defined.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
vm_role:
type: string
description: Unique role for this VM
*Example Resource Definition: Hard Coded*
In this example, the {vm-role} is hard coded in the Heat Orchestration
Template.
.. code-block:: yaml
resources:
dns_servers:
type: OS::Nova::Server
properties:
. . . .
metadata:
vm_role: lb
*Example Resource Definition: get\_param*
In this example, the {vm-role} is enumerated in the environment file.
.. code-block:: yaml
resources:
dns_servers:
type: OS::Nova::Server
properties:
. . . .
metadata:
vm_role: { get_param: vm_role }
Example
~~~~~~~~~
The example below depicts part of a Heat Orchestration Template that
uses the five of the OS::Nova::Server metadata parameter discussed in
this section. The {vm-type} has been defined as lb for load balancer.
.. code-block:: yaml
parameters:
lb_name_0
type: string
description: VM Name for lb VM 0
vnf_name:
type: string
description: Unique name for this VNF instance
vnf_id:
type: string
description: Unique ID for this VNF instance
vf_module_name:
type: string
description: Unique name for this VNF Module instance
vf_module_id:
type: string
description: Unique ID for this VNF Module instance
vm_role:
type: string
description: Unique role for this VM
resources:
lb_vm_0:
type: OS::Nova::Server
properties:
name: { get_param: lb_name_0 }
...
metadata:
vnf_name: { get_param: vnf_name }
vnf_id: { get_param: vnf_id }
vf_module_name: { get_param: vf_module_name }
vf_module_id: { get_param: vf_module_id }
vm_role: lb
Resource: OS::Neutron::Port - Parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The resource OS::Neutron::Port is for managing Neutron ports (See
https://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Neutron::Port.)
Introduction
~~~~~~~~~~~~~~
Four properties of the resource OS::Neutron::Port that must follow the
ONAP parameter naming convention. The four properties are:
1. network
2. fixed\_ips, ip\_address
3. fixed\_ips, subnet\_id
4. allowed\_address\_pairs, ip\_address
The parameters associated with these properties may reference an
external network or internal network. External networks and internal
networks are defined in `Networking`_.
External Networks
++++++++++++++++++
When the parameter references an external network
- R-72050 The VNF Heat **MUST** contain {network-role} in the parameter name
- the parameter must not be enumerated in the Heat environment file
- the parameter is classified as an ONAP Orchestration Parameter
+----------------------+---------------------------+--------------------------+
| Property Name | ONAP Parameter Name | Parameter Type |
+======================+===========================+==========================+
| network | {network-role}\_net\_id | string |
| +---------------------------+--------------------------+
| | {network-role}\_net\_name | string |
+----------------------+---------------------------+--------------------------+
| fixed\_ips, | {vm-type}\_{network-role}\| string |
| ip\_address | _ip\_{index} | |
| +---------------------------+--------------------------+
| | {vm-type}\_{network-role}\| comma\_delimited\_list |
| | _ips | |
| +---------------------------+--------------------------+
| | {vm-type}\_{network-role}\| string |
| | _v6\_ip\_{index} | |
| +---------------------------+--------------------------+
| | {vm-type}\_{network-role}\| comma\_delimited\_list |
| | _v6\_ips | |
+----------------------+---------------------------+--------------------------+
| fixed\_ips, subnet | {network-role}\ | string |
| | _subnet\_id | |
| +---------------------------+--------------------------+
| | {network-role}\ | string |
| | _v6\_subnet\_id | |
+----------------------+---------------------------+--------------------------+
| allowed\_address | {vm-type}\_{network-role}\| string |
| \_pairs, ip\_address | _floating\_ip | |
| +---------------------------+--------------------------+
| | {vm-type}\_{network-role}\| string |
| | _floating\_v6\_ip | |
| +---------------------------+--------------------------+
| | {vm-type}\_{network-role}\| string |
| | _ip\_{index} | |
| +---------------------------+--------------------------+
| | {vm-type}\_{network-role}\| comma\_delimited\_list |
| | _ips | |
| +---------------------------+--------------------------+
| | {vm-type}\_{network-role}\| string |
| | _v6\_ip\_{index} | |
| +---------------------------+--------------------------+
| | {vm-type}\_{network-role}\| comma\_delimited\_list |
| | _v6\_ips | |
+----------------------+---------------------------+--------------------------+
Table 5: OS::Neutron::Port Resource Property Parameters (External
Networks)
Internal Networks
+++++++++++++++++++
When the parameter references an internal network
- R-57576 The VNF Heat **MUST** contain int\_{network-role}
in the parameter name.
- the parameter may be enumerated in the environment file.
+-------------------------+--------------------------------+-----------------+
| Property | Parameter Name for | Parameter Type |
| | Internal Networks | |
+=========================+================================+=================+
| network | int\_{network-role}\ | string |
| | _net\_id | |
| +--------------------------------+-----------------+
| | int\_{network-role}\ | string |
| | _net\_name | |
+-------------------------+--------------------------------+-----------------+
| fixed\_ips, ip\_address | {vm-type}\_int\_{network-role}\| string |
| | _ip\_{index} | |
| +--------------------------------+-----------------+
| | {vm-type}\_int\_{network-role}\| comma\ |
| | _ips | _delimited\_list|
| +--------------------------------+-----------------+
| | {vm-type}\_int\_{network-role}\| string |
| | _v6\_ip\_{index} | |
| +--------------------------------+-----------------+
| | {vm-type}\_int\_{network-role}\| comma\ |
| | _v6\_ips | _delimited\_list|
+-------------------------+--------------------------------+-----------------+
| fixed\_ips, subnet | int\_{network-role}\ | string |
| | _subnet\_id | |
| +--------------------------------+-----------------+
| | int\_{network-role}\ | string |
| | _v6\_subnet\_id | |
+-------------------------+--------------------------------+-----------------+
| allowed\_address\_pairs,| {vm-type}\_int\_{network-role}\| string |
| ip\_address | _floating\_ip | |
| +--------------------------------+-----------------+
| | {vm-type}\_int\_{network-role}\| string |
| | _floating\_v6\_ip | |
| +--------------------------------+-----------------+
| | {vm-type}\_int\_{network-role}\| string |
| | _ip\_{index} | |
| +--------------------------------+-----------------+
| | {vm-type}\_int\_{network-role}\| comma\ |
| | _ips | _delimited\_list|
| +--------------------------------+-----------------+
| | {vm-type}\_int\_{network-role}\| string |
| | _v6\_ip\_{index} | |
| +--------------------------------+-----------------+
| | {vm-type}\_int\_{network-role}\| comma\ |
| | _v6\_ips | _delimited\_list|
+-------------------------+--------------------------------+-----------------+
Table 6: Port Resource Property Parameters (Internal Networks)
Property: network
~~~~~~~~~~~~~~~~~~~
The property networks in the resource OS::Neutron::Port must be
referenced by Neutron Network ID, a UUID value, or by the network name
defined in OpenStack.
External Networks
++++++++++++++++++
R-93272 The VNF Heat **MUST** adhere to the following parameter naming
convention in the Heat Orchestration Template, when the parameter
associated with the property network is referencing an “external” network:
- {network-role}\_net\_id for the Neutron network ID
- {network-role}\_net\_name for the network name in OpenStack
The parameter must be declared as type: string
The parameter must not be enumerated in the Heat environment file.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
{network-role}_net_id:
type: string
description: Neutron UUID for the {network-role} network
{network-role}_net_name:
type: string
description: Neutron name for the {network-role} network
*Example: One Cloud Assigned IP Address (DHCP) assigned to a network
that has only one subnet*
In this example, the {network-role} has been defined as oam to represent
an oam network and the {vm-type} has been defined as lb for load
balancer. The Cloud Assigned IP Address uses the OpenStack DHCP service
to assign IP addresses.
.. code-block:: yaml
parameters:
oam_net_id:
type: string
description: Neutron UUID for the oam network
resources:
lb_port_1:
type: OS::Neutron::Port
network: { get_param: oam_net_id }
Internal Networks
++++++++++++++++++
R-65373 The VNF Heat **MUST** adhere to the following parameter naming
convention, when the parameter associated with the property network is
referencing an “internal” network:
- int\_{network-role}\_net\_id for the Neutron network ID
- int\_{network-role}\_net\_name for the network name in OpenStack
The parameter must be declared as type: string
The assumption is that internal networks are created in the base module.
The Neutron Network ID will be passed as an output parameter (e.g., ONAP
Base Module Output Parameter) to the incremental modules. In the
incremental modules, it will be defined as input parameter.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
int_{network-role}_net_id:
type: string
description: Neutron UUID for the {network-role} network
int_{network-role}_net_name:
type: string
description: Neutron name for the {network-role} network
Property: fixed\_ips, Map Property: subnet\_id
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The property fixed\_ips is used to assign IPs to a port. The Map
Property subnet\_id specifies the subnet the IP is assigned from.
The property fixed\_ips and Map Property subnet\_id must be used if a
Cloud (i.e., DHCP) IP address assignment is being requested and the
Cloud IP address assignment is targeted at a specific subnet when two or
more subnets exist.
The property fixed\_ips and Map Property subnet\_id should not be used
if all IP assignments are fixed, or if the Cloud IP address assignment
does not target a specific subnet or there is only one subnet.
Note that DHCP assignment of IP addresses is also referred to as cloud
assigned IP addresses.
Subnet of an External Networks
+++++++++++++++++++++++++++++++
R-47716 The VNF Heat **MUST** adhere to the following parameter naming
convention for the property fixed\_ips and Map Property subnet\_id
parameter, when the parameter is referencing a subnet of an
“external” network.
- {network-role}\_subnet\_id if the subnet is an IPv4 subnet
- {network-role}\_v6\_subnet\_id if the subnet is an IPv6 subnet
The parameter must be declared as type: string
The parameter must not be enumerated in the Heat environment file.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
{network-role}_subnet_id:
type: string
description: Neutron subnet UUID for the {network-role} network
{network-role}_v6_subnet_id:
type: string
description: Neutron subnet UUID for the {network-role} network
*Example: One Cloud Assigned IPv4 Address (DHCP) assigned to a network
that has two or more subnets subnet:*
In this example, the {network-role} has been defined as oam to represent
an oam network and the {vm-type} has been defined as lb for load
balancer. The Cloud Assigned IP Address uses the OpenStack DHCP service
to assign IP addresses.
.. code-block:: yaml
parameters:
oam_net_id:
type: string
description: Neutron UUID for the oam network
oam_subnet_id:
type: string
description: Neutron subnet UUID for the oam network
resources:
lb_port_1:
type: OS::Neutron::Port
network: { get_param: oam_net_id }
fixed_ips:
- subnet_id: { get_param: oam_subnet_id }
*Example: One Cloud Assigned IPv4 address and one Cloud Assigned IPv6
address assigned to a network that has at least one IPv4 subnet and one
IPv6 subnet*
In this example, the {network-role} has been defined as oam to represent
an oam network and the {vm-type} has been defined as lb for load
balancer.
.. code-block:: yaml
parameters:
oam_net_id:
type: string
description: Neutron UUID for the oam network
oam_subnet_id:
type: string
description: Neutron subnet UUID for the oam network
oam_v6_subnet_id:
type: string
description: Neutron subnet UUID for the oam network
resources:
lb_port_1:
type: OS::Neutron::Port
properties:
network: { get_param: oam_net_id }
fixed_ips:
- subnet_id: { get_param: oam_subnet_id }
- subnet_id: { get_param: oam_v6_subnet_id }
Internal Networks
++++++++++++++++++
R-20106 The VNF Heat **MUST** adhere to the following naming convention for
the property fixed\_ips and Map Property subnet\_id parameter,
when the parameter is referencing the subnet of an “internal” network:
- int\_{network-role}\_subnet\_id if the subnet is an IPv4 subnet
- int\_{network-role}\_v6\_subnet\_id if the subnet is an IPv6 subnet
The parameter must be declared as type: string
The assumption is that internal networks are created in the base module.
The Neutron subnet network ID will be passed as an output parameter
(e.g., ONAP Base Module Output Parameter) to the incremental modules. In
the incremental modules, it will be defined as input parameter.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
int_{network-role}_subnet_id:
type: string
description: Neutron subnet UUID for the {network-role} network
int_{network-role}_v6_subnet_id:
type: string
description: Neutron subnet UUID for the {network-role} network
Property: fixed\_ips, Map Property: ip\_address
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The property fixed\_ips is used to assign IPs to a port. The Map
Property ip\_address specifies the IP address to be assigned to the
port.
The property fixed\_ips and Map Property ip\_address must be used when
statically assigning one or more IP addresses to a port. This is also
referred to as ONAP SDN-C IP address assignment. ONAP’s SDN-C provides
the IP address assignment.
An IP address is assigned to a port on a VM (referenced by {vm-type})
that is connected to an external network (referenced by {network-role})
or internal network (referenced by int\_{network-role}).
R-41177 The VNF Heat **MUST** include {vm-type} and {network-role}
in the parameter name, when a SDN-C IP assignment is made to a
port connected to an external network.
When a SDN-C IP assignment is made to a port connected to an internal
network, the parameter name must contain {vm-type} and
int\_{network-role}.
IP Address Assignments on External Networks
++++++++++++++++++++++++++++++++++++++++++++
When the property fixed\_ips and Map Property ip\_address is used to
assign IP addresses to an external network, the parameter name is
dependent on the parameter type (comma\_delimited\_list or string) and
IP address type (IPv4 or IPv6).
R-84898 The VNF Heat **MUST** adhere to the following naming convention,
when the parameter for property fixed\_ips and Map Property ip\_address
is declared type: comma\_delimited\_list:
- {vm-type}\_{network-role}\_ips for IPv4 address
- {vm-type}\_{network-role}\_v6\_ips for IPv6 address
Each element in the IP list should be assigned to successive instances
of {vm-type} on {network-role}.
The parameter must not be enumerated in the Heat environment file.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
{vm-type}_{network-role}_ips:
type: comma_delimited_list
description: Fixed IPv4 assignments for {vm-type} VMs on the {Network-role} network
{vm-type}_{network-role}_v6_ips:
type: comma_delimited_list
description: Fixed IPv6 assignments for {vm-type} VMs on the {network-role} network
*Example: comma\_delimited\_list parameters for IPv4 and IPv6 Address
Assignments to an external network*
In this example, the {network-role} has been defined as oam to represent
an oam network and the {vm-type} has been defined as db for database.
.. code-block:: yaml
parameters:
oam_net_id:
type: string
description: Neutron UUID for a oam network
db_oam_ips:
type: comma_delimited_list
description: Fixed IPv4 assignments for db VMs on the oam network
db_oam_v6_ips:
type: comma_delimited_list
description: Fixed IPv6 assignments for db VMs on the oam network
resources:
db_0_port_1:
type: OS::Neutron::Port
network: { get_param: oam_net_id }
fixed_ips: [ { “ip_address”: {get_param: [ db_oam_ips, 0 ]}}, {“ip_address”: {get_param: [ db_oam_v6_ips, 0 ]}}]
db_1_port_1:
type: OS::Neutron::Port
properties:
network: { get_param: oam_net_id }
fixed_ips:
- “ip_address”: {get_param: [ db_oam_ips, 1 ]}
- “ip_address”: {get_param: [ db_oam_v6_ips, 1 ]}
R-34960 The VNF Heat **MUST** adhere to the following
naming convention,
when the parameter for property fixed\_ips and Map Property ip\_address
is declared type: string:
- {vm-type}\_{network-role}\_ip\_{index} for an IPv4 address
- {vm-type}\_{network-role}\_v6\_ip\_{index} for an IPv6 address
The value for {index} must start at zero (0) and increment by one.
The parameter must not be enumerated in the Heat environment file.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
{vm-type}_{network-role}_ip_{index}:
type: string
description: Fixed IPv4 assignment for {vm-type} VM {index} on the{network-role} network
{vm-type}_{network-role}_v6_ip_{index}:
type: string
description: Fixed IPv6 assignment for {vm-type} VM {index} on the{network-role} network
*Example: string parameters for IPv4 and IPv6 Address Assignments
to an external network*
In this example, the {network-role} has been defined as “oam” to
represent an oam network and the {vm-type} has been defined as “db” for
database.
.. code-block:: yaml
parameters:
oam_net_id:
type: string
description: Neutron UUID for an OAM network
db_oam_ip_0:
type: string
description: Fixed IPv4 assignment for db VM 0 on the OAM network
db_oam_ip_1:
type: string
description: Fixed IPv4 assignment for db VM 1 on the OAM network
db_oam_v6_ip_0:
type: string
description: Fixed IPv6 assignment for db VM 0 on the OAM network
db_oam_v6_ip_1:
type: string
description: Fixed IPv6 assignment for db VM 1 on the OAM network
resources:
db_0_port_1:
type: OS::Neutron::Port
properties:
network: { get_param: oam_net_id }
fixed_ips: [ { “ip_address”: {get_param: db_oam_ip_0}}, {“ip_address”: {get_param: db_oam_v6_ip_0 ]}}]
db_1_port_1:
type: OS::Neutron::Port
properties:
network: { get_param: oam_net_id }
fixed_ips:
- “ip_address”: {get_param: db_oam_ip_1}}]
- “ip_address”: {get_param: db_oam_v6_ip_1}}]
IP Address Assignment on Internal Networks
++++++++++++++++++++++++++++++++++++++++++++
When the property fixed\_ips and Map Property ip\_address is used to
assign IP addresses to an internal network, the parameter name is
dependent on the parameter type (comma\_delimited\_list or string) and
IP address type (IPv4 or IPv6).
R-62584 The VNF Heat **MUST** adhere to
the following naming convention,
when the parameter for property fixed\_ips and Map Property ip\_address
is declared type: comma\_delimited\_list:
- {vm-type}\_int\_{network-role}\_ips for IPv4 address
- {vm-type}\_int\_{network-role}\_v6\_ips for IPv6 address
Each element in the IP list should be assigned to successive instances
of {vm-type} on {network-role}.
The parameter must be enumerated in the Heat environment file. Since an
internal network is local to the VNF, IP addresses can be re-used at
every VNF instance.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
{vm-type}_int_{network-role}_ips:
type: comma_delimited_list
description: Fixed IPv4 assignments for {vm-type} VMs on the int_{network-role} network
{vm-type}_int_{network-role}_v6_ips:
type: comma_delimited_list
description: Fixed IPv6 assignments for {vm-type} VMs on the int_{network-role} network
*Example: comma\_delimited\_list parameters for IPv4 and IPv6 Address
Assignments to an internal network*
In this example, the {network-role} has been defined as oam\_int to
represent an oam network internal to the vnf. The role oam\_int was
picked to differentiate from an external oam network with a
{network-role} of oam. The {vm-type} has been defined as db for
database.
.. code-block:: yaml
parameters:
int_oam_int_net_id:
type: string
description: Neutron UUID for the oam internal network
db_int_oam_int_ips:
type: comma_delimited_list
description: Fixed IPv4 assignments for db VMs on the oam internal network
db_int_oam_int_v6_ips:
type: comma_delimited_list
description: Fixed IPv6 assignments for db VMs on the oam internal network
resources:
db_0_port_1:
type: OS::Neutron::Port
properties:
network: { get_param: int_oam_int_net_id }
fixed_ips: [ { “ip_address”: {get_param: [ db_int_oam_int_ips, 0]}}, { “ip_address”: {get_param: [ db_int_oam_int_v6_ips, 0 ]}}]
db_1_port_1:
type: OS::Neutron::Port
properties:
network: { get_param: int_oam_int_net_id }
fixed_ips:
- “ip_address”: {get_param: [ db_int_oam_int_ips, 1 ]}
- “ip_address”: {get_param: [ db_int_oam_int_v6_ips, 1 ]}
R-29256 The VNF Heat **MUST** must adhere to the following
naming convention,
when the parameter for property fixed\_ips and Map Property ip\_address
is declared type: string:
- {vm-type}\_int\_{network-role}\_ip\_{index} for an IPv4 address
- {vm-type}\_int\_{network-role}\_v6\_ip\_{index} for an IPv6 address
The value for {index} must start at zero (0) and increment by one.
The parameter must be enumerated in the Heat environment file. Since an
internal network is local to the VNF, IP addresses can be re-used at
every VNF instance.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
{vm-type}_int_{network-role}_ip_{index}:
type: string
description: Fixed IPv4 assignment for {vm-type} VM {index} on the{network-role} network
{vm-type}_int_{network-role}_v6_ip_{index}:
type: string
description: Fixed IPv6 assignment for {vm-type} VM {index} on the{network-role} network
*Example: string parameters for IPv4 and IPv6 Address Assignments
to an internal network*
In this example, the {network-role} has been defined as oam\_int to
represent an oam network internal to the vnf. The role oam\_int was
picked to differentiate from an external oam network with a
{network-role} of oam. The {vm-type} has been defined as db for
database.
.. code-block:: yaml
parameters:
int_oam_int_net_id:
type: string
description: Neutron UUID for an OAM internal network
db_oam_int_ip_0:
type: string
description: Fixed IPv4 assignment for db VM on the oam_int network
db_oam_int_ip_1:
type: string
description: Fixed IPv4 assignment for db VM 1 on the oam_int network
db_oam_int_v6_ip_0:
type: string
description: Fixed IPv6 assignment for db VM 0 on the oam_int network
db_oam_int_v6_ip_1:
type: string
description: Fixed IPv6 assignment for db VM 1 on the oam_int network
resources:
db_0_port_0:
type: OS::Neutron::Port
properties:
network: { get_param: int_oam_int_net_id }
fixed_ips: [ { “ip_address”: {get_param: db_oam_int_ip_0}}, {“ip_address”: {get_param: db_oam_int_v6_ip_0 ]}}]
db_1_port_0:
type: OS::Neutron::Port
properties:
network: { get_param: int_oam_int_net_id }
fixed_ips:
- “ip_address”: {get_param: db_oam_int_ip_1}}]
- “ip_address”: {get_param: db_oam_int_v6_ip_1}}]
Property: allowed\_address\_pairs, Map Property: ip\_address
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The property allowed\_address\_pairs in the resource OS::Neutron::Port
allows the user to specify a mac\_address and/or ip\_address that will
pass through a port regardless of subnet. This enables the use of
protocols such as VRRP, which floats an IP address between two instances
to enable fast data plane failover. The map property ip\_address
specifies the IP address.
The allowed\_address\_pairs is an optional property. It is not required.
An ONAP Heat Orchestration Template allows the assignment of one IPv4
address allowed\_address\_pairs and/or one IPv6 address to a {vm-type}
and {network-role}/int\_{network-role} combination.
An ONAP Heat Orchestration Template allows the assignment of one IPv6
address allowed\_address\_pairs and/or one IPv6 address to a {vm-type}
and {network-role}/int\_{network-role} combination.
Note that the management of these IP addresses (i.e. transferring
ownership between active and standby VMs) is the responsibility of the
application itself.
Note that these parameters are **not** intended to represent Neutron
“Floating IP” resources, for which OpenStack manages a pool of public IP
addresses that are mapped to specific VM ports. In that case, the
individual VMs are not even aware of the public IPs, and all assignment
of public IPs to VMs is via OpenStack commands. ONAP does not support
Neutron-style Floating IPs.
External Networks
++++++++++++++++++
R-61282 The VNF Heat **MUST**
adhere to the following naming convention for the property
allowed\_address\_pairs and Map Property ip\_address parameter,
when the parameter is referencing an “external” network:
- {vm-type}\_{network-role}\_floating\_ip for an IPv4 address
- {vm-type}\_{network-role}\_floating\_v6\_ip for an IPv6 address
The parameter must be declared as type: string
The parameter must not be enumerated in the Heat environment file.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
{vm-type}_{network-role}_floating_ip:
type: string
description: VIP for {vm-type} VMs on the {network-role} network
{vm-type}_{network-role}_floating_v6_ip:
type: string
description: VIP for {vm-type} VMs on the {network-role} network
*Example:*
In this example, the {network-role} has been defined as oam to represent
an oam network and the {vm-type} has been defined as db for database.
.. code-block:: yaml
parameters:
oam_net_id:
type: string
description: Neutron UUID for the oam network
db_oam_ips:
type: comma_delimited_list
description: Fixed IPs for db VMs on the oam network
db_oam_floating_ip:
type: string
description: VIP IP for db VMs on the oam network
resources:
db_0_port_0:
type: OS::Neutron::Port
properties:
network: { get_param: oam_net_id }
fixed_ips: [ { “ip_address”: {get_param: [db_oam_ips,0] }}]
allowed_address_pairs: [ { “ip_address”: {get_param: db_oam_floating_ip}}]
db_1_port_0:
type: OS::Neutron::Port
properties:
network: { get_param: oam_net_id }
fixed_ips: [ { “ip_address”: {get_param: [db_oam_ips,1] }}]
allowed_address_pairs: [ { “ip_address”: {get_param: db_oam_floating_ip}}]
Internal Networks
+++++++++++++++++++
R-16805 The VNF Heat **MUST** adhere to the following naming convention
for the property allowed\_address\_pairs and Map Property ip\_address
parameter when the parameter is referencing an “internal” network.
- {vm-type}\_int\_{network-role}\_floating\_ip for an IPv4 address
- {vm-type}\_int\_{network-role}\_floating\_v6\_ip for an IPv6 address
The parameter must be declared as type: string
The parameter must be enumerated in the Heat environment file.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
{vm-type}_int_{network-role}_floating_ip:
type: string
description: VIP for {vm-type} VMs on the int_{network-role} network
{vm-type}_int_{network-role}_floating_v6_ip:
type: string
description: VIP for {vm-type} VMs on the int_{network-role} network
Multiple allowed\_address\_pairs for a {vm-type} / {network-role} combination
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
The parameter {vm-type}\_{network-role}\_floating\_ip provides only one
allowed address pair IPv4 address per {vm-type} and {network-role} pair.
The parameter {vm-type}\_{network-role}\_floating\_v6\_ip provides only
one allowed address pair IPv6 address per {vm-type} and {network-role}
pair.
If there is a need for multiple allowed address pair IPs for a given
{vm-type} and {network-role} combination within a VNF, then the
parameter names defined for the property fixed\_ips and Map Property
ip\_address should be used with the allowed\_address\_pairs property.
The examples below illustrate this.
*Example: A VNF has four load balancers. Each pair has a unique VIP.*
In this example, there are two administrative VM pairs. Each pair has
one VIP. The {network-role} has been defined as oam to represent an oam
network and the {vm-type} has been defined as admin for an
administrative VM.
Pair 1: Resources admin\_0\_port\_0 and admin\_1\_port\_0 share a unique
VIP, [admin\_oam\_ips,2]
Pair 2: Resources admin\_2\_port\_0 and admin\_3\_port\_0 share a unique
VIP, [admin\_oam\_ips,5]
.. code-block:: yaml
parameters:
oam_net_id:
type: string
description: Neutron UUID for the oam network
admin_oam_ips:
type: comma_delimited_list
description: Fixed IP assignments for admin VMs on the oam network
resources:
admin_0_port_0:
type: OS::Neutron::Port
properties:
network: { get_param: oam_net_id }
fixed_ips: [ { “ip_address”: {get_param: [admin_oam_ips,0] }}]
allowed_address_pairs: [{ “ip_address”: {get_param: [admin_oam_ips,2] }}]
admin_1_port_0:
type: OS::Neutron::Port
properties:
network: { get_param: oam_net_id }
fixed_ips: [ { “ip_address”: {get_param: [admin_oam_ips,1] }}]
allowed_address_pairs: [{ “ip_address”: {get_param: [admin_oam_ips,2] }}]
admin_2_port_0:
type: OS::Neutron::Port
properties:
network: { get_param: oam_net_id }
fixed_ips: [ { “ip_address”: {get_param: [admin_oam_ips,3] }}]
allowed_address_pairs: [{ “ip_address”: {get_param: [admin_oam_ips,5] }}]
admin_3_port_0:
type: OS::Neutron::Port
properties:
network: { get_param: oam_net_id }
fixed_ips: [ { “ip_address”: {get_param: [admin_oam_ips,4] }}]
allowed_address_pairs: [{ “ip_address”: {get_param: [admin_oam_ips,5] }}]
*Example: A VNF has two load balancers. The pair of load balancers share
two VIPs.*
In this example, there is one load balancer pairs. The pair has two
VIPs. The {network-role} has been defined as oam to represent an oam
network and the {vm-type} has been defined as lb for a load balancer VM.
.. code-block:: yaml
resources:
lb_0_port_0:
type: OS::Neutron::Port
properties:
network: { get_param: oam_net_id }
fixed_ips: [ { “ip_address”: {get_param: [lb_oam_ips,0] }}]
allowed_address_pairs: [{ "ip_address": {get_param: [lb_oam_ips,2]}, {get_param: [lb_oam_ips,3] }}]
lb_1_port_0:
type: OS::Neutron::Port
properties:
network: { get_param: oam_net_id }
fixed_ips: [ { “ip_address”: {get_param: [lb_oam_ips,1] }}]
allowed_address_pairs: [{ "ip_address": {get_param: [lb_oam_ips,2]}, {get_param: [lb_oam_ips,3] }}]
As a general rule, provide the fixed IPs for the VMs indexed first in
the CDL and then the VIPs as shown in the examples above.
ONAP SDN-C Assignment of allowed\_address\_pair IP Addresses
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
The following items must be taken into consideration when designing Heat
Orchestration Templates that expect ONAP’s SDN-C to assign
allowed\_address\_pair IP addresses via automation.
The VMs must be of the same {vm-type}.
The VMs must be created in the same module (base or incremental).
Resource Property “name”
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The parameter naming convention of the property name for the resource
OS::Nova::Server has been defined in
`Resource: OS::Nova::Server – Metadata Parameters`_.
This section provides the requirements how the property name for non
OS::Nova::Server resources must be defined when the property is used.
Not all resources require the property name (e.g., it is optional) and
some resources do not support the property.
R-85734 The VNF Heat **MUST** use the intrinsic function str\_replace
in conjunction with the ONAP supplied metadata parameter
vnf\_name to generate a unique value,
when the property name for a non OS::Nova::Server resources is defined
in a Heat Orchestration Template.
This prevents the enumeration of a
unique value for the property name in a per instance environment file.
Note that
- In most cases, only the use of the metadata value vnf\_name is
required to create a unique property name
- the Heat Orchestration Template pseudo parameter 'OS::stack\_name’
may also be used in the str\_replace construct to generate a unique
name when the vnf\_name does not provide uniqueness
*Example: Property* name *for resource* OS::Neutron::SecurityGroup
.. code-block:: yaml
resources:
DNS_SECURITY_GROUP:
type: OS::Neutron::SecurityGroup
properties:
description: vDNS security group
name:
str_replace:
template: VNF_NAME_sec_grp_DNS
params:
VNF_NAME: {get_param: vnf_name}
rules: [. . . . .
]
*Example: Property name for resource* OS::Cinder::Volume
.. code-block:: yaml
resources:
DNS_Cinder_Volume:
type: OS::Cinder::Volume
properties:
description: Cinder Volume
name:
str_replace:
template: VNF_NAME_STACK_NAME_dns_volume
params:
VNF_NAME: {get_param: vnf_name}
STACK_NAME: { get_param: 'OS::stack_name' }
. . . .
Contrail Issue with Values for the Property Name
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Contrail GUI has a limitation displaying special characters. The
issue is documented in
https://bugs.launchpad.net/juniperopenstack/+bug/1590710. It is
recommended that special characters be avoided. However, if special
characters must be used, note that for the following resources:
- Virtual Machine
- Virtual Network
- Port
- Security Group
- Policies
- IPAM Creation
the only special characters supported are:
- “ ! $ ‘ ( ) = ~ ^ \| @ \` { } [ ] > , . \_
ONAP Output Parameter Names
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ONAP defines three types of Output Parameters as detailed in
`Output Parameters`_.
ONAP Base Module Output Parameters:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ONAP Base Module Output Parameters do not have an explicit naming
convention. The parameter name must contain {vm-type} and {network-role}
when appropriate.
ONAP Volume Template Output Parameters:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ONAP Base Module Output Parameters do not have an explicit naming
convention. The parameter name must contain {vm-type} when appropriate.
Predefined Output Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ONAP currently defines one predefined output parameter the OAM
Management IP Addresses.
OAM Management IP Addresses
+++++++++++++++++++++++++++++
A VNF may have a management interface for application controllers to
interact with and configure the VNF. Typically, this will be via a
specific VM that performs a VNF administration function. The IP address
of this interface must be captured and inventoried by ONAP. The IP
address might be a VIP if the VNF contains an HA pair of management VMs,
or may be a single IP address assigned to one VM.
The Heat template may define either (or both) of the following Output
parameters to identify the management IP address.
- oam\_management\_v4\_address
- oam\_management\_v6\_address
*Notes*:
- The use of this output parameters are optional.
- The Management IP Address should be defined only once per VNF, so it
must only appear in one Module template
- If a fixed IP for the admin VM is passed as an input parameter, it
may be echoed in the output parameters. In this case, a IPv4 and/or
IPv6 parameter must be defined in the parameter section of the YAML
Heat template. The parameter maybe named oam\_management\_v4\_address
and/or oam\_management\_v6\_address or may be named differently.
- If the IP for the admin VM is obtained via DHCP, it may be obtained
from the resource attributes. In this case,
oam\_management\_v4\_address and/or oam\_management\_v6\_address must
not be defined in the parameter section of the YAML Heat template.
*Example: SDN-C Assigned IP Address echoed as*
oam\_management\_v4\_address
.. code-block:: yaml
parameters:
admin_oam_ip_0:
type: string
description: Fixed IPv4 assignment for admin VM 0 on the OAM network
. . .
resources:
admin_oam_net_0_port:
type: OS::Neutron::Port
properties:
name:
str_replace:
template: VNF_NAME_admin_oam_net_0_port
params:
VNF_NAME: {get_param: vnf_name}
network: { get_param: oam_net_id }
fixed_ips: [{ "ip_address": { get_param: admin_oam_ip_0 }}]
security_groups: [{ get_param: security_group }]
admin_server:
type: OS::Nova::Server
properties:
name: { get_param: admin_names }
image: { get_param: admin_image_name }
flavor: { get_param: admin_flavor_name }
availability_zone: { get_param: availability_zone_0 }
networks:
- port: { get_resource: admin_oam_net_0_port }
metadata:
vnf_id: { get_param: vnf_id }
vf_module_id: { get_param: vf_module_id }
vnf_name: {get_param: vnf_name }
Outputs:
oam_management_v4_address:
value: {get_param: admin_oam_ip_0 }
*Example: Cloud Assigned IP Address output as*
oam\_management\_v4\_address
.. code-block:: yaml
parameters:
. . .
resources:
admin_oam_net_0_port:
type: OS::Neutron::Port
properties:
name:
str_replace:
template: VNF_NAME_admin_oam_net_0_port
params:
VNF_NAME: {get_param: vnf_name}
network: { get_param: oam_net_id }
security_groups: [{ get_param: security_group }]
admin_server:
type: OS::Nova::Server
properties:
name: { get_param: admin_names }
image: { get_param: admin_image_name }
flavor: { get_param: admin_flavor_name }
availability_zone: { get_param: availability_zone_0 }
networks:
- port: { get_resource: admin_oam_net_0_port }
metadata:
vnf_id: { get_param: vnf_id }
vf_module_id: { get_param: vf_module_id }
vnf_name: {get_param: vnf_name }
Outputs:
oam_management_v4_address:
value: {get_attr: [admin_server, networks, {get_param: oam_net_id}, 0] }
Contrail Resource Parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ONAP requires the parameter names of certain Contrail Resources to
follow specific naming conventions. This section provides these
requirements.
Contrail Network Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Contrail based resources may require references to a Contrail network
using the network FQDN.
External Networks
++++++++++++++++++
When the parameter associated with the Contrail Network is referencing
an “external” network, the parameter must adhere to the following naming
convention in the Heat Orchestration Template
- {network-role}\_net\_fqdn
The parameter must be declared as type: string
The parameter must not be enumerated in the Heat environment file.
*Example: Parameter declaration*
.. code-block:: yaml
parameters:
{network-role}_net_fqdn:
type: string
description: Contrail FQDN for the {network-role} network
*Example: Contrail Resource OS::ContrailV2::VirtualMachineInterface
Reference to a Network FQDN.*
In this example, the {network-role} has been defined as oam to represent
an oam network and the {vm-type} has been defined as fw for firewall.
The Contrail resource OS::ContrailV2::VirtualMachineInterface property
virtual\_network\_refs references a contrail network FQDN.
.. code-block:: yaml
FW_OAM_VMI:
type: OS::ContrailV2::VirtualMachineInterface
properties:
name:
str_replace:
template: VM_NAME_virtual_machine_interface_1
params:
VM_NAME: { get_param: fw_name_0 }
virtual_machine_interface_properties:
virtual_machine_interface_properties_service_interface_type: { get_param: oam_protected_interface_type }
virtual_network_refs:
- get_param: oam_net_fqdn
security_group_refs:
- get_param: fw_sec_grp_id
Interface Route Table Prefixes for Contrail InterfaceRoute Table
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The parameter associated with the resource
OS::ContrailV2::InterfaceRouteTable property
interface\_route\_table\_routes, map property
interface\_route\_table\_routes\_route\_prefix is an ONAP Orchestration
Parameter.
The parameters must be named {vm-type}\_{network-role}\_route\_prefixes
in the Heat Orchestration Template.
The parameter must be declared as type: json
The parameter supports IP addresses in the format:
1. Host IP Address (e.g., 10.10.10.10)
2. CIDR Notation format (e.g., 10.0.0.0/28)
The parameter must not be enumerated in the Heat environment file.
*Example Parameter Definition*
.. code-block:: yaml
parameters:
{vm-type}_{network-role}_route_prefixes:
type: json
description: JSON list of Contrail Interface Route Table route prefixes
*Example:*
.. code-block:: yaml
parameters:
vnf_name:
type: string
description: Unique name for this VF instance
fw_int_fw_route_prefixes:
type: json
description: prefix for the ServiceInstance InterfaceRouteTable
int_fw_dns_trusted_interface_type:
type: string
description: service_interface_type for ServiceInstance
<resource name>:
type: OS::ContrailV2::InterfaceRouteTable
depends_on: [*resource name of* *OS::ContrailV2::ServiceInstance*]
properties:
name:
str_replace:
template: VNF_NAME_interface_route_table
params:
VNF_NAME: { get_param: vnf_name }
interface_route_table_routes:
interface_route_table_routes_route: { get_param: fw_int_fw_route_prefixes }
service_instance_refs:
- get_resource: < *resource name of* *OS::ContrailV2::ServiceInstance* >
service_instance_refs_data:
- service_instance_refs_data_interface_type: { get_param: int_fw_interface_type }
Parameter Names in Contrail Resources
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Contrail Heat resource properties will use, when appropriate, the same
naming convention as OpenStack Heat resources. For example, the resource
OS::ContrailV2::InstanceIp has two properties that the parameter naming
convention is identical to properties in OS::Neutron::Port.
*Example: Contrail Resource OS::ContrailV2::InstanceIp, Property
instance\_ip\_address*
The property instance\_ip\_address uses the same parameter naming
convention as the property fixed\_ips and Map Property ip\_address in
OS::Neutron::Port. The resource is assigning an ONAP SDN-C Assigned IP
Address. The {network-role} has been defined as oam\_protected to
represent an oam protected network and the {vm-type} has been defined as
fw for firewall.
.. code-block:: yaml
CMD_FW_OAM_PROTECTED_RII:
type: OS::ContrailV2::InstanceIp
depends_on:
- FW_OAM_PROTECTED_RVMI
properties:
virtual_machine_interface_refs:
- get_resource: FW_OAM_PROTECTED_RVMI
virtual_network_refs:
- get_param: oam_protected_net_fqdn
instance_ip_address: { get_param: [fw_oam_protected_ips, get_param: index ] }
*Example: Contrail Resource OS::ContrailV2::InstanceIp, Property
subnet\_uuid*
The property instance\_ip\_address uses the same parameter naming
convention as the property fixed\_ips and Map Property subnet\_id in
OS::Neutron::Port. The resource is assigning a Cloud Assigned IP
Address. The {network-role} has been defined as “oam\_protected” to
represent an oam protected network and the {vm-type} has been defined as
“fw” for firewall.
.. code-block:: yaml
CMD_FW_SGI_PROTECTED_RII:
type: OS::ContrailV2::InstanceIp
depends_on:
- FW_OAM_PROTECTED_RVMI
properties:
virtual_machine_interface_refs:
- get_resource: FW_OAM_PROTECTED_RVMI
virtual_network_refs:
- get_param: oam_protected_net_fqdn
subnet_uuid: { get_param: oam_protected_subnet_id }
Cinder Volume Templates
^^^^^^^^^^^^^^^^^^^^^^^^
ONAP supports the independent deployment of a Cinder volume via separate
Heat Orchestration Templates, the Cinder Volume module. This allows the
volume to persist after VNF deletion so that they can be reused on
another instance (e.g., during a failover activity).
A Base Module or Incremental Module may have a corresponding volume
module. Use of separate volume modules is optional. A Cinder volume may
be embedded within the Base Module or Incremental Module if persistence
is not required.
R-47788 The VNF Heat **MUST** have a 1:1 scope of a cinder volume module,
when it exists, with the Base Module or Incremental Module
A single volume module must create only the volumes
required by a single Incremental module or Base module.
The following rules apply to independent volume Heat templates:
- Cinder volumes must be created in a separate Heat Orchestration
Template from the Base Module or Incremental Module.
- A single Cinder volume module must include all Cinder volumes
needed by the Base/Incremental module.
- R-79531 The VNF Heat **MUST** define “outputs” in the volume
template for each Cinder volume resource universally unique
identifier (UUID) (i.e. ONAP Volume Template Output Parameters).
- The VNF Incremental Module or Base Module must define input
parameters that match each Volume output parameter (i.e., ONAP Volume
Template Output Parameters).
- ONAP will supply the volume template outputs automatically to the
bases/incremental template input parameters.
- Volume modules may utilize nested Heat templates.
*Examples: Volume Template*
A VNF has a Cinder volume module, named incremental\_volume.yaml, that
creates an independent Cinder volume for a VM in the module
incremental.yaml. The incremental\_volume.yaml defines a parameter in
the output section, lb\_volume\_id\_0 which is the UUID of the cinder
volume. lb\_volume\_id\_0 is defined as a parameter in incremental.yaml.
ONAP captures the UUID value of lb\_volume\_id\_0 from the volume module
output statement and provides the value to the incremental module.
Note that the example below is not a complete Heat Orchestration
Template. The {vm-type} has been defined as “lb” for load balancer
incremental\_volume.yaml
.. code-block:: yaml
parameters:
vnf_name:
type: string
lb_volume_size_0:
type: number
...
resources:
dns_volume_0:
type: OS::Cinder::Volume
properties:
name:
str_replace:
template: VNF_NAME_volume_0
params:
VNF_NAME: { get_param: vnf_name }
size: {get_param: dns_volume_size_0}
...
outputs:
lb_volume_id_0:
value: {get_resource: dns_volume_0}
...
incremental.yaml
.. code-block:: yaml
parameters:
lb_name_0:
type: string
lb_volume_id_0:
type: string
...
resources:
lb_0:
type: OS::Nova::Server
properties:
name: {get_param: dns_name_0}
networks:
...
lb_0_volume_attach:
type: OS::Cinder::VolumeAttachment
properties:
instance_uuid: { get_resource: lb_0 }
volume_id: { get_param: lb_volume_id_0 }
ONAP Support of Environment Files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The use of an environment file in OpenStack is optional. In ONAP, it is
mandatory.
R-86285 The VNF Heat **MUST** have a
corresponding environment file, even if no parameters are required to be
enumerated.
(Note that ONAP, the open source version of ONAP, does not
programmatically enforce the use of an environment file.)
R-67205 The VNF Heat **MUST** have a corresponding
environment file for a Base Module.
R-35727 The VNF Heat **MUST** have a
corresponding environment file for an Incremental module.
R-22656 The VNF Heat **MUST** have a corresponding environment file
for a Cinder Volume Module.
A nested heat template must not have an environment file; OpenStack does
not support it.
The environment file must contain parameter values for the ONAP
Orchestration Constants and VNF Orchestration Constants. These
parameters are identical across all instances of a VNF type, and
expected to change infrequently. The ONAP Orchestration Constants are
associated with OS::Nova::Server image and flavor properties (See
`Property: image`_ and `Property: flavor`_). Examples of VNF
Orchestration Constants are the networking parameters associated
with an internal network (e.g., private IP ranges) and Cinder
volume sizes.
The environment file must not contain parameter values for parameters
that are instance specific (ONAP Orchestration Parameters, VNF
Orchestration Parameters). These parameters are supplied to the Heat by
ONAP at orchestration time.
SDC Treatment of Environment Files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Parameter values enumerated in the environment file are used by SDC as
the default value. However, the SDC user may use the SDC GUI to
overwrite the default values in the environment file.
SDC generates a new environment file for distribution to MSO based on
the uploaded environment file and the user provided GUI updates. The
user uploaded environment file is discarded when the new file is
created. Note that if the user did not change any values via GUI
updates, the SDC generated environment file will contain the same values
as the uploaded file.
Use of Environment Files when using OpenStack “heat stack-create” CLI
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When ONAP is instantiating the Heat Orchestration Template, certain
parameter must not be enumerated in the environment file. This document
provides the details of what parameters should not be enumerated.
If the Heat Orchestration Template is to be instantiated from the
OpenStack Command Line Interface (CLI) using the command “heat
stack-create”, all parameters must be enumerated in the environment
file.
Heat Template Constructs
^^^^^^^^^^^^^^^^^^^^^^^^^
Nested Heat Templates
~~~~~~~~~~~~~~~~~~~~~~~
ONAP supports nested Heat templates per the OpenStack specifications.
Nested templates may be suitable for larger VNFs that contain many
repeated instances of the same VM type(s). A common usage pattern is to
create a nested template for each {vm-type} along with its supporting
resources. The VNF module may then reference these component templates
either statically by repeated definition or dynamically by using the
resource OS::Heat::ResourceGroup.
Nested Heat Template Requirements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ONAP supports nested Heat Orchestration Templates. A Base Module,
Incremental Module, and Cinder Volume Module may use nested heat.
A Heat Orchestration Template may reference the nested heat statically
by repeated definition.
A Heat Orchestration Template may reference the nested heat dynamically
using the resource OS::Heat::ResourceGroup.
A Heat Orchestration template must have no more than three levels of
nesting. ONAP supports a maximum of three levels.
Nested heat templates must be referenced by file name. The use of
resource\_registry in the environment file is not supported and must not
be used.
R-89868 The VNF Heat **MUST** have unique file names within the scope
of the VNF for a nested heat yaml file.
R-52530 The VNF Heat **MUST NOT** use a directory hierarchy for
nested templates. All templates must be in a single, flat directory
(per VNF).
A nested heat template may be used by any module within a given VNF.
Note that:
- Constrains must not be defined for any parameter enumerated in a
nested heat template.
- R-11041 The VNF Heat **MUST** have the resource calling the
nested yaml file pass in as properties all parameters defined
in nested yaml file.
- R-61183 The VNF Heat **MUST NOT** change the parameter names, when OS::Nova::Server metadata parameters are past into a nested heat
template.
- With nested templates, outputs are required to expose any resource
properties of the child templates to the parent template. Those would
not explicitly be declared as parameters but simply referenced as
get\_attribute targets against the “parent” resource.
Nested Heat Template Example: Static
++++++++++++++++++++++++++++++++++++++
incremental.yaml
.. code-block:: yaml
Resources:
dns_server_0:
type: nested.yaml
properties:
dns_image_name: { get_param: dns_image_name }
dns_flavor_name: { get_param: dns_flavor_name }
availability_zone: { get_param: availability_zone_0 }
security_group: { get_param: DNS_shared_sec_grp_id }
oam_net_id: { get_param: oam_protected_net_id }
dns_oam_ip: { get_param: dns_oam_ip_0 }
dns_name: { get_param: dns_name_0 }
vnf_name: { get_param: vnf_name }
vnf_id: { get_param: vnf_id }
vf_module_id: {get_param: vf_module_id}
dns_server_1:
type: nested.yaml
properties:
dns_image_name: { get_param: dns_image_name }
dns_flavor_name: { get_param: dns_flavor_name }
availability_zone: { get_param: availability_zone_1 }
security_group: { get_param: DNS_shared_sec_grp_id }
oam_net_id: { get_param: oam_protected_net_id }
dns_oam_ip: { get_param: dns_oam_ip_1 }
dns_name: { get_param: dns_name_1 }
vnf_name: { get_param: vnf_name }
vnf_id: { get_param: vnf_id }
vf_module_id: {get_param: vf_module_id}
nested.yaml
.. code-block:: yaml
dns_oam_0_port:
type: OS::Neutron::Port
properties:
name:
str_replace:
template: VNF_NAME_dns_oam_port
params:
VNF_NAME: {get_param: vnf_name}
network: { get_param: oam_net_id }
fixed_ips: [{ "ip_address": { get_param: dns_oam_ip }}]
security_groups: [{ get_param: security_group }]
dns_servers:
type: OS::Nova::Server
properties:
name: { get_param: dns_names }
image: { get_param: dns_image_name }
flavor: { get_param: dns_flavor_name }
availability_zone: { get_param: availability_zone }
networks:
- port: { get_resource: dns_oam_0_port }
metadata:
vnf_id: { get_param: vnf_id }
vf_module_id: { get_param: vf_module_id }
vnf_name {get_param: vnf_name }
Use of Heat ResourceGroup
~~~~~~~~~~~~~~~~~~~~~~~~~~~
The OS::Heat::ResourceGroup is a useful Heat element for creating
multiple instances of a given resource or collection of resources.
Typically, it is used with a nested Heat template, to create, for
example, a set of identical OS::Nova::Server resources plus their
related OS::Neutron::Port resources via a single resource in a master
template.
ResourceGroup may be used in ONAP to simplify the structure of a Heat
template that creates multiple instances of the same VM type.
However, there are important caveats to be aware of:
ResourceGroup does not deal with structured parameters
(comma-delimited-list and json) as one might typically expect. In
particular, when using a list-based parameter, where each list element
corresponds to one instance of the ResourceGroup, it is not possible to
use the intrinsic “loop variable” %index% in the ResourceGroup
definition.
For instance, the following is **not** valid Heat for ResourceGroup:
.. code-block:: yaml
type: OS::Heat::ResourceGroup
resource_def:
type: my_nested_vm_template.yaml
properties:
name: {get_param: [vm_name_list, %index%]}
Although this appears to use the nth entry of the vm\_name\_list list
for the nth element of the ResourceGroup, it will in fact result in a
Heat exception. When parameters are provided as a list (one for each
element of a ResourceGroup), you must pass the complete parameter to the
nested template along with the current index as separate parameters.
Below is an example of an **acceptable** Heat Syntax for a
ResourceGroup:
.. code-block:: yaml
type: OS::Heat::ResourceGroup
resource_def:
type: my_nested_vm_template.yaml
properties:
names: {get_param: vm_name_list}
index: %index%
You can then reference within the nested template as:
{ get\_param: [names, {get\_param: index} ] }
ResourceGroup Property count
+++++++++++++++++++++++++++++
ONAP requires that the OS::Heat::ResourceGroup property count be defined
(even if the value is one) and that the value must be enumerated in the
environment file. This is required for ONAP to build the TOSCA model for
the VNF.
.. code-block:: yaml
type: OS::Heat::ResourceGroup
properties:
count: { get_param: count }
index_var: index
resource_def:
type: my_nested_vm_template.yaml
properties:
names: {get_param: vm_name_list}
index: index
Availability Zone and ResourceGroups
+++++++++++++++++++++++++++++++++++++
The resource OS::Heat::ResourceGroup and the property availability\_zone
has been an “issue” with a few VNFs since ONAP only supports
availability\_zone as a string parameter and not a
comma\_delimited\_list. This makes it difficult to use a ResourceGroup
to create Virtual Machines in more than one availability zone.
There are numerous solutions to this issue. Below are two suggested
usage patterns.
**Option 1:** create a CDL in the OS::Heat::ResourceGroup. In the
resource type: OS::Heat::ResourceGroup, create a comma\_delimited\_list
availability\_zones by using the intrinsic function list\_join.
.. code-block:: yaml
<resource name>:
type: OS::Heat::ResourceGroup
properties:
count: { get_param: node_count }
index_var: index
resource_def:
type: nested.yaml
properties:
index: index
avaialability_zones: { list_join: [',', [ { get_param: availability_zone_0 }, { get_param: availability_zone_1 } ] ] }
In the nested heat
.. code-block:: yaml
parameters:
avaialability_zones:
type: comma_delimited_list
description:
resources:
servers:
type: OS::Nova::Server
properties:
name: { get_param: [ dns_names, get_param: index ] }
image: { get_param: dns_image_name }
flavor: { get_param: dns_flavor_name }
availability_zone: { get_param: [ avaialability_zones, get_param: index ] }
**Option 2:** Create a resource group per availability zone. A separate
OS::Heat::ResourceGroup is created for each availability zone.
External References
^^^^^^^^^^^^^^^^^^^^
Heat templates *should not* reference any HTTP-based resource
definitions, any HTTP-based nested configurations, or any HTTP-based
environment files.
- During orchestration, ONAP *should not* retrieve any such resources
from external/untrusted/unknown sources.
- VNF images should not contain such references in user-data or other
configuration/operational scripts that are specified via Heat or
encoded into the VNF image itself.
*Note:* HTTP-based references are acceptable if the HTTP-based reference
is accessing information with the VM private/internal network.
Heat Files Support (get\_file)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Heat Templates may contain the inclusion of text files into Heat
templates via the Heat get\_file directive. This may be used, for
example, to define a common “user-data” script, or to inject files into
a VM on startup via the “personality” property.
Support for Heat Files is subject to the following limitations:
R-76718 The VNF Heat **MUST** reference the get\_files targets in
Heat templates by file name, and the corresponding files should be
delivered to ONAP along with the Heat templates.
R-41888 The VNE Heat **MUST NOT** use URL-based file retrieval.
R-62177 The VNF Heat **MUST** have unique file names for the included
files within the scope of the VNF.
R-87848 The VNF Heat **MUST** have all included files in a single, flat
directory per VNF. ONAP does not support a directory hierarchy.
- Included files may be used by all Modules within a given VNF.
- get\_file directives may be used in both non-nested and nested
templates
Key Pairs
^^^^^^^^^^
When Nova Servers are created via Heat templates, they may be passed a
“keypair” which provides an ssh key to the ‘root’ login on the newly
created VM. This is often done so that an initial root key/password does
not need to be hard-coded into the image.
Key pairs are unusual in OpenStack, because they are the one resource
that is owned by an OpenStack User as opposed to being owned by an
OpenStack Tenant. As a result, they are usable only by the User that
created the keypair. This causes a problem when a Heat template attempts
to reference a keypair by name, because it assumes that the keypair was
previously created by a specific ONAP user ID.
When a keypair is assigned to a server, the SSH public-key is
provisioned on the VMs at instantiation time. They keypair itself is not
referenced further by the VM (i.e. if the keypair is updated with a new
public key, it would only apply to subsequent VMs created with that
keypair).
Due to this behavior, the recommended usage of keypairs is in a more
generic manner which does not require the pre-requisite creation of a
keypair. The Heat should be structured in such a way as to:
- Pass a public key as a parameter value instead of a keypair name
- Create a new keypair within the VNF Heat templates (in the base
module) for use within that VNF
By following this approach, the end result is the same as pre-creating
the keypair using the public key – i.e., that public key will be
provisioned in the new VM. However, this recommended approach also makes
sure that a known public key is supplied (instead of having OpenStack
generate a public/private pair to be saved and tracked outside of ONAP).
It also removes any access/ownership issues over the created keypair.
The public keys may be enumerated as a VNF Orchestration Constant in the
environment file (since it is public, it is not a secret key), or passed
at run-time as instance-specific parameters. ONAP will never
automatically assign a public/private key pair.
*Example (create keypair with an existing ssh public-key for {vm-type}
of lb (for load balancer)):*
.. code-block:: yaml
parameters:
vnf_name:
type: string
lb_ssh_public_key:
type: string
resources:
my_keypair:
type: OS::Nova::Keypair
properties:
name:
str_replace:
template: VNF_NAME_key_pair
params:
VNF_NAME: { get_param: vnf_name }
public_key: {get_param: lb_ssh_public_key}
save_private_key: false
Security Groups
^^^^^^^^^^^^^^^^^
OpenStack allows a tenant to create Security groups and define rules
within the security groups.
Security groups, with their rules, may either be created in the Heat
Orchestration Template or they can be pre-created in OpenStack and
referenced within the Heat template via parameter(s). There can be a
different approach for security groups assigned to ports on internal
(intra-VNF) networks or external networks (inter-VNF). Furthermore,
there can be a common security group across all VMs for a specific
network or it can vary by VM (i.e., {vm-type}) and network type (i.e.,
{network-role}).
Anti-Affinity and Affinity Rules
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Anti-affinity or affinity rules are supported using normal OpenStack
OS::Nova::ServerGroup resources. Separate ServerGroups are typically
created for each VM type to prevent them from residing on the same host,
but they can be applied to multiple VM types to extend the
affinity/anti-affinity across related VM types as well.
*Example:*
In this example, the {network-role} has been defined as oam to represent
an oam network and the {vm-type} have been defined as lb for load
balancer and db for database.
.. code-block:: yaml
resources:
db_server_group:
type: OS::Nova::ServerGroup
properties:
name:
str_replace:
params:
$vnf_name: {get_param: vnf_name}
template: $vnf_name-server_group1
policies:
- anti-affinity
lb_server_group:
type: OS::Nova::ServerGroup
properties:
name:
str_replace:
params:
$vnf_name: {get_param: vnf_name}
template: $vnf_name-server_group2
policies:
- affinity
db_0:
type: OS::Nova::Server
properties:
...
scheduler_hints:
group: {get_resource: db_server_group}
db_1:
type: OS::Nova::Server
properties:
...
scheduler_hints:
group: {get_resource: db_server_group}
lb_0:
type: OS::Nova::Server
properties:
...
scheduler_hints:
group: {get_resource: lb_server_group}
Resource Data Synchronization
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For cases where synchronization is required in the orchestration of Heat
resources, two approaches are recommended:
- Standard Heat depends\_on property for resources
- Assures that one resource completes before the dependent resource
is orchestrated.
- Definition of completeness to OpenStack may not be sufficient
(e.g., a VM is considered complete by OpenStack when it is ready
to be booted, not when the application is up and running).
- Use of Heat Notifications
- Create OS::Heat::WaitCondition and OS::Heat::WaitConditionHandle
resources.
- Pre-requisite resources issue *wc\_notify* commands in user\_data.
- Dependent resource define depends\_on in the
OS::Heat::WaitCondition resource.
*Example: “depends\_on” case*
In this example, the {network-role} has been defined as oam to represent
an oam network and the {vm-type} has been defined as oam to represent an
oam server.
.. code-block:: yaml
resources:
oam_server_01:
type: OS::Nova::Server
properties:
name: {get_param: [oam_ names, 0]}
image: {get_param: oam_image_name}
flavor: {get_param: oam_flavor_name}
availability_zone: {get_param: availability_zone_0}
networks:
- port: {get_resource: oam01_port_0}
- port: {get_resource: oam01_port_1}
user_data:
scheduler_hints: {group: {get_resource: oam_servergroup}}
user_data_format: RAW
oam_01_port_0:
type: OS::Neutron::Port
properties:
network: {get_resource: oam_net_name}
fixed_ips: [{"ip_address": {get_param: [oam_oam_net_ips, 1]}}]
security_groups: [{get_resource: oam_security_group}]
oam_01_port_1:
type: OS::Neutron::Port
properties:
network: {get_param: oam_net_name}
fixed_ips: [{"ip_address": {get_param: [oam_oam_net_ips, 2]}}]
security_groups: [{get_resource: oam_security_group}]
oam_01_vol_attachment:
type: OS::Cinder::VolumeAttachment
depends_on: oam_server_01
properties:
volume_id: {get_param: oam_vol_1}
mountpoint: /dev/vdb
instance_uuid: {get_resource: oam_server_01}
High Availability
^^^^^^^^^^^^^^^^^^^^
VNF/VM parameters may include availability zone IDs for VNFs that
require high availability.
The Heat must comply with the following requirements to specific
availability zone IDs:
- The Heat template should spread Nova and Cinder resources across the
availability zones as desired
Post Orchestration & VNF Configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Heat templates should contain a minimum amount of post-orchestration
configuration data. For instance, *do not* embed complex user-data
scripts in the template with large numbers of configuration parameters
to the Heat template.
- VNFs may provide configuration APIs for use after VNF creation. Such
APIs will be invoked via application and/or SDN controllers.
*Note:* It is important to follow this convention to the extent possible
even in the short-term as of the long-term direction.
VNFM Driver Development Steps
-----------------------------------------------------------
Refer to the ONAP documentation for VNF Provider instructions on integrating
vendor-specific VNFM adaptors with VF-C. The VNF driver development steps are
highlighted below.
1. Use the VNF SDK tools to design the VNF with TOSCA models to output
the VNF TOSCA package. Using the VNF SDK tools, the VNF package can be
validated and tested.
2. The VNF Provider supplies a vendor-specific VNFM driver in ONAP, which
is a microservice providing a translation interface from VF-C to
the vendor-specific VNFM. The interface definitions of vendor-specific
VNFM adaptors are supplied by the VNF Providers themselves.
Creating Vendor-Specific VNFM Adaptor Microservices
------------------------------------------------------------------------------------------------
VNFs can be managed by vendor-specific VNFMs. To add a vendor-specific
VNFM to ONAP, a vendor-specific VNFM adaptor is added to ONAP implementing
the interface of the vendor-specific VNFM.
A vendor-specific VNFM adaptor is a microservice with a unique name and
an appointed port. When started up, the vendor-specific VNFM adaptor
microservice is automatically registered to the Microservices Bus (MSB).
The following RESTful example describes the scenario of registering a
vendor-specific VNFM adaptor to MSB:
.. code-block:: java
POST /api/microservices/v1/services
{
"serviceName": "catalog",
"version": "v1",
"url": "/api/catalog/v1",
"protocol": "REST",
"visualRange": "1",
"nodes": [
{
"ip": "10.74.56.36",
"port": "8988",
"ttl": 0
}
]
}
|
