summaryrefslogtreecommitdiffstats
path: root/docs/Chapter5/Heat.rst
blob: 9cbfb570a53575318c1eb63bc9257d3bd5f22999 (plain)
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
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
.. Modifications Copyright © 2017-2018 AT&T Intellectual Property.

.. Licensed under the Creative Commons License, Attribution 4.0 Intl.
   (the "License"); you may not use this documentation except in compliance
   with the License. You may obtain a copy of the License at

.. https://creativecommons.org/licenses/by/4.0/

.. Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.


Heat
----

General Guidelines
^^^^^^^^^^^^^^^^^^
This section contains general Heat Orchestration Template guidelines.

YAML Format
~~~~~~~~~~~


.. req::
    :id: R-95303
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template **MUST** be defined using 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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

As stated above, Heat Orchestration templates must be defined in YAML.

YAML rules include:

 - Tabs are not allowed, use spaces ONLY

 - You must indent your 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

heat_template_version
+++++++++++++++++++++


.. req::
    :id: R-27078
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration template **MUST** contain
    the section "heat_template_version:".

The section "heat_template_version:" must be set to a date
that is supported by the OpenStack environment.

description
+++++++++++


.. req::
    :id: R-39402
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template **MUST**
    contain the section "description:".

parameter_groups
++++++++++++++++

A VNF Heat Orchestration template may
contain the section "parameter_groups:".

parameters
++++++++++


.. req::
    :id: R-35414
    :target: VNF
    :keyword: MUST

    A VNF Heat Orchestration's template **MUST**
    contain the section "parameters:".


.. 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>

This section allows for
specifying input parameters that have to be provided when instantiating
the template. Each parameter is specified in a separate nested block
with the name of the parameters defined in the first line and additional
attributes (e.g., type, label) defined as nested elements.


.. req::
    :id: R-90279
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration template's parameter **MUST**
    be used in a resource with the exception of the parameters
    for the OS::Nova::Server resource property availability_zone.

.. req::
    :id: R-91273
    :target: VNF
    :keyword: MAY NOT

    A VNF Heat Orchestration's template's parameter for
    the OS::Nova::Server resource property availability_zone
    **MAY NOT** be used in any OS::Nova::Resource.

That is, the parameter associated with the property 'availability_zone'
maybe declared but not used in a resource.

<param name>
____________

The name of the parameter.


.. req::
    :id: R-25877
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's parameter
    name (i.e., <param name>) **MUST** contain only
    alphanumeric characters and underscores ('_').

type
____


.. req::
    :id: R-36772
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's parameter
    **MUST** include the attribute "type:".

.. req::
    :id: R-11441
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's parameter
    type **MUST** be one of the following values: "string",
    "number", "json", "comma_delimited_list" or "boolean".

label
_____


.. req::
    :id: R-32094
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template parameter
    declaration **MAY** contain the attribute "label:".

description
___________


.. req::
    :id: R-44001
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template parameter
    declaration **MUST** contain the attribute "description".

Note that the parameter attribute "description:" is an OpenStack
optional attribute that provides a description of the parameter.
ONAP implementation requires this attribute.

default
_______


.. req::
    :id: R-90526
    :target: VNF
    :keyword: MUST

    A VNF Heat Orchestration Template parameter
    declaration **MUST** not contain the default attribute.

.. req::
    :id: R-26124
    :target: VNF
    :keyword: MUST

    If a VNF Heat Orchestration Template parameter
    requires a default value, it **MUST** be enumerated in the environment file.

Note that the parameter attribute "default:" is an OpenStack
optional attribute that declares the default value of the
parameter. ONAP implementation prohibits the use of this attribute.

hidden
______


.. req::
    :id: R-32557
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template parameter
    declaration **MAY** contain the attribute "hidden:".

The parameter attribute "hidden:" is an OpenStack optional
attribute that 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.

constraints
___________

The parameter attribute "constraints:" is an OpenStack optional
attribute that defines a list of constraints to apply to the parameter.


.. req::
    :id: R-88863
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's parameter defined as
    type "number" **MUST** have a parameter constraint of "range" or
    "allowed_values" defined.

.. req::
    :id: R-40518
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's parameter defined as
    type "string" **MAY** have a parameter constraint defined.

.. req::
    :id: R-96227
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's parameter defined as
    type "json" **MAY** have a parameter constraint defined.

.. req::
    :id: R-79817
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's parameter defined as
    type "comma_delimited_list" **MAY** have a parameter constraint defined.

.. req::
    :id: R-06613
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's parameter defined as
    type "boolean" **MAY** have a parameter constraint defined.

.. req::
    :id: R-00011
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's Nested YAML files
    parameter's **MUST NOT** have a parameter constraint defined.

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 VNF Heat Orchestration Template
are validated against the constraints at instantiation time.
The stack creation fails if the parameter value doesn't comply to
the constraints.

The constraints are defined as a list with the following syntax

.. code-block:: yaml

  constraints:

    <constraint type>: <constraint definition>

    description: <constraint description>

..

**<constraint type>** Provides the type of constraint to apply.
The list of OpenStack supported constraints can be found at
https://docs.openstack.org/heat/latest/template_guide/hot_spec.html .

**<constraint definition>** provides the actual constraint.
The syntax and constraint is dependent of the <constraint type> used.

**description** is an optional attribute that provides 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.

Below is a brief overview of the "range" and "allowed values" constraints.
For complete details on constraints, see
https://docs.openstack.org/heat/latest/template_guide/hot_spec.html#parameter-constraints

**range**

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

.. code-block:: yaml

    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**

allowed_values: The allowed_values constraint applies to parameters of
type \"string\" or type \"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

.. code-block:: yaml

    allowed_values: [ <value>, <value>, ... ]

    Alternatively, the following YAML list notation can be used

    allowed_values:

    - <value>

    - <value>

    - ...

. .

immutable
_________


.. req::
    :id: R-22589
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template parameter declaration
    **MAY** contain the attribute "immutable:".

The parameter attribute \"immutable:\" is an OpenStack optional
attribute that defines whether the parameter is updatable. A Heat
Orchestration Template stack update fails if immutable is set to
true and the parameter value is changed.  This attribute
\"immutable:\" defaults to false.

resources
+++++++++


.. req::
    :id: R-23664
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration template **MUST** contain
    the section "resources:".

.. req::
    :id: R-90152
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's "resources:"
    section **MUST** contain the declaration of at least one resource.

.. req::
    :id: R-40551
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's Nested YAML files
    **MAY** contain the section "resources:".

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
___________


.. req::
    :id: R-75141
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's resource name
    (i.e., <resource ID>) **MUST** only contain alphanumeric
    characters and underscores ('_').

.. req::
    :id: R-16447
    :target: VNF
    :keyword: MUST

    A VNF's <resource ID> **MUST** be unique across all
    Heat Orchestration Templates and all HEAT Orchestration Template
    Nested YAML files that are used to create the VNF.

Note that a VNF can be composed of one or more Heat Orchestration Templates.

Note that OpenStack requires the <resource ID> to be unique to the
Heat Orchestration Template and not unique across all Heat
Orchestration Templates the compose the VNF.

type
____

The resource attribute \"type:\" is an OpenStack required
attribute that defines the resource type, such as
OS::Nova::Server or OS::Neutron::Port.

The resource attribute \"type:\" may specify a VNF HEAT
Orchestration Template Nested YAML file.


.. req::
    :id: R-53952
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's Resource
    **MUST NOT** reference a HTTP-based resource definitions.

.. req::
    :id: R-71699
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's Resource
    **MUST NOT** reference a HTTP-based Nested YAML file.

properties
__________

The resource attribute \"properties:\" is an OpenStack optional
attribute that provides a list of resource-specific properties.
The property value can be provided in place, or via a function
(e.g., `Intrinsic functions <https://docs.openstack.org/developer/heat/template_guide/hot_spec.html#hot-spec-intrinsic-functions>`__).


.. req::
    :id: R-10834
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If a VNF Heat Orchestration Template resource attribute
    "property:" uses a nested "get_param", one level of nesting is
    supported and the nested "get_param" **MUST** reference an index.

metadata
________

The resource attribute \"metadata:\" is an OpenStack optional attribute.


.. req::
    :id: R-97199
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's OS::Nova::Server
    resource **MUST** contain the attribute "metadata".

Section 5.4 contains the OS::Nova::Server mandatory and optional metadata.

depends_on
__________

The resource attribute \"depends_on:\" is an OpenStack optional
attribute.
See `OpenStack documentation <https://docs.openstack.org/developer/heat/template_guide/hot_spec.html#hot-spec-resources-dependencies>`__
for additional details.


.. req::
    :id: R-46968
    :target: VNF
    :keyword: MAY

    VNF's Heat Orchestration Template's Resource **MAY**
    declare the attribute "depends_on:".

update_policy
_____________


.. req::
    :id: R-63137
    :target: VNF
    :keyword: MAY

    VNF's Heat Orchestration Template's Resource **MAY**
    declare the attribute "update_policy:".

deletion_policy
_______________


.. req::
    :id: R-43740
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's Resource
    **MAY** declare the attribute "deletion_policy:".

If specified, the \"deletion_policy:\" attribute for resources
allows values 'Delete', 'Retain', and 'Snapshot'.
Starting with heat_template_version 2016-10-14, lowercase
equivalents are also allowed.

The default policy is to delete the physical resource when
deleting a resource from the stack.

external_id
___________


.. req::
    :id: R-78569
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's Resouce **MAY**
    declare the attribute "external_id:".

This attribute 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
_________

The resource attribute \"condition:\" is an OpenStack optional attribute.

Support for the resource condition attribute was added
in the Newton release of OpenStack.

outputs
+++++++


.. req::
    :id: R-36982
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration template **MAY**
    contain the "outputs:" section.

This 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 `Output Parameters`_ 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)


.. req::
    :id: R-86285
    :target: VNF
    :keyword: MUST

    The VNF Heat Orchestration Template **MUST** have a corresponding
    environment file, even if no parameters are required to be enumerated.

The use of an environment file in OpenStack is optional.
In ONAP, it is mandatory.


.. req::
    :id: R-03324
    :target: VNF
    :keyword: MUST

    The VNF Heat Orchestration Template **MUST** contain the
    "parameters" section in the environment file.

.. req::
    :id: R-68198
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration template's Environment File's
    "parameters:" section **MAY** enumerate parameters.

ONAP implementation requires the parameters section in the
environmental file to be declared. The parameters section
contains a list of key/value pairs.


.. req::
    :id: R-59930
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration template's Environment
    File's **MAY** contain the "parameter_defaults:" section.

The "parameter_defaults:" section contains default parameters
that are passed to all template resources.


.. req::
    :id: R-46096
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration template's Environment File's
    **MAY** contain the "encrypted_parameters:" section.

The "encrypted_parameters:" section contains a list of encrypted parameters.


.. req::
    :id: R-24893
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration template's Environment File's
    **MAY** contain the "event_sinks:" section.

The "event_sinks:" section contains the list of endpoints that would
receive stack events.


.. req::
    :id: R-42685
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration template's Environment File's
    **MAY** contain the "parameter_merge_strategies:" section.

The "parameter_merge_strategies:" section provides the merge strategies
for merging parameters and parameter defaults from the environment file.


.. req::
    :id: R-67231
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration template's Environment File's **MUST NOT**
    contain the "resource_registry:" section.

ONAP implementation does not support the Environment File
resource_registry section. The resource_registry section
allows for the definition of custom resources.

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 `Output Parameters`_ and
`ONAP Resource ID and Parameter Naming Convention`_ for more details.

ONAP Heat Orchestration Templates: Overview
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ONAP supports a modular Heat Orchestration Template design pattern,
referred to as *VNF Modularity.*

ONAP VNF Modularity Overview
~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. req::
    :id: R-69663
    :target: VNF
    :keyword: MAY

    A VNF **MAY** be composed from one or more Heat Orchestration
    Templates, each of which represents a subset of the overall VNF.

The Heat Orchestration Templates can be thought of a components or
modules of the VNF and are referred to as "\ *VNF Modules*\ ".
During orchestration, these modules are
deployed incrementally to create the complete VNF.


.. req::
    :id: R-33132
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template **MAY** be

       * a Base Module Heat Orchestration Template
         (also referred to as a Base Module)

       * an Incremental Module Heat Orchestration Template
         (referred to as an Incremental Module)

       * a Cinder Volume Module Heat Orchestration Template
         (referred to as Cinder Volume Module).

.. req::
    :id: R-37028
    :target: VNF
    :keyword: MUST

    The VNF **MUST** be composed of one "base" module.

.. req::
    :id: R-13196
    :target: VNF
    :keyword: MAY

    A VNF **MAY** be composed of zero to many Incremental Modules.

.. req::
    :id: R-20974
    :target: VNF
    :keyword: MUST

    The VNF **MUST** deploy the base module first, prior to
    the incremental modules.

.. req::
    :id: R-28980
    :target: VNF
    :keyword: MAY

    A VNF's incremental module **MAY** be used for initial VNF
    deployment only.

.. req::
    :id: R-86926
    :target: VNF
    :keyword: MAY

    A VNF's incremental module **MAY** be used for scale out only.

A VNF's Incremental Module that is used for scale out is deployed
sometime after initial VNF deployment to add capacity.


.. req::
    :id: R-91497
    :target: VNF
    :keyword: MAY

    A VNF's incremental module **MAY** be used for both deployment
    and scale out.

.. req::
    :id: R-68122
    :target: VNF
    :keyword: MAY

    A VNF's incremental module **MAY** be deployed more than once,
    either during initial VNF deployment and/or scale out.

.. req::
    :id: R-46119
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume
    **MAY** be defined in a Base Module.

.. req::
    :id: R-90748
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume
    **MAY** be defined in an Incremental Module.

.. req::
    :id: R-03251
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's Resource OS::Heat::CinderVolume
    **MAY** be defined in a Cinder Volume Module.

ONAP also supports the concept of an optional, independently deployed Cinder
volume via a separate Heat Orchestration Templates, referred to as a Cinder
Volume Module. This allows the volume to persist after a Virtual Machine
(VM) (i.e., OS::Nova::Server) is deleted, allowing the volume to be reused
on another instance (e.g., during a failover activity).

.. req::
    :id: R-11200
    :target: VNF
    :keyword: MUST

    The VNF **MUST** keep the scope of a Cinder volume module,
    when it exists, to be 1:1 with the VNF Base Module or Incremental Module.

It is strongly recommended that Cinder Volumes be created in a Cinder Volume
Module.

.. req::
    :id: R-38474
    :target: VNF
    :keyword: MUST

    The VNF **MUST** have a corresponding environment file for a Base Module.

.. req::
    :id: R-81725
    :target: VNF
    :keyword: MUST

    The VNF **MUST** have a corresponding environment file for an Incremental Module.

.. req::
    :id: R-53433
    :target: VNF
    :keyword: MUST

    The VNF **MUST** have a corresponding environment file for a Cinder Volume Module.

These concepts will be described in more detail throughout the document.
This overview is provided to set the stage and help clarify the concepts
that will be introduced.

Nested Heat Orchestration Templates Overview
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

ONAP supports nested Heat Orchestration Templates per OpenStack
specifications.


.. req::
    :id: R-36582
    :target: VNF
    :keyword: MAY

    A VNF's Base Module **MAY** utilize nested heat.

.. req::
    :id: R-56721
    :target: VNF
    :keyword: MAY

    A VNF's Incremental Module **MAY** utilize nested heat.

.. req::
    :id: R-30395
    :target: VNF
    :keyword: MAY

    A VNF's Cinder Volume Module **MAY** utilize nested heat.

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".


.. req::
    :id: R-87485
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's file extension **MUST**
    be in the lower case format '.yaml' or '.yml'.

.. req::
    :id: R-56438
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's Nested YAML file extension
    **MUST** be in the lower case format '.yaml' or '.yml'.

.. req::
    :id: R-74304
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's Environment file extension
    **MUST** be in the lower case format '.env'.

.. req::
    :id: R-99646
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's YAML files (i.e, Heat Orchestration Template files and
    Nested files) **MUST** have a unique name in the scope of the VNF.

Base Modules
++++++++++++


.. req::
    :id: R-81339
    :target: VNF
    :keyword: MUST

    A VNF Heat Orchestration Template's Base Module file name **MUST**
    include 'base' in the filename and **MUST** match one of the following four
    formats:

       * 'base_<text>.y[a]ml'
       * '<text>_base.y[a]ml'
       * 'base.y[a]ml'
       * '<text>_base_<text>'.y[a]ml

    where 'base' is case insensitive and where '<text>'
    **MUST** contain only alphanumeric characters
    and underscores '_' and **MUST NOT** contain the case
    insensitive word 'base'.

.. req::
    :id: R-91342
    :target: VNF
    :keyword: MUST

    A VNF Heat Orchestration Template's Base Module's Environment File
    **MUST** be named identical to the VNF Heat Orchestration Template's Base
    Module with '.y[a]ml' replaced with '.env'.

Incremental Modules
+++++++++++++++++++


.. req::
    :id: R-87247
    :target: VNF
    :keyword: MUST

    A VNF Heat Orchestration Template's Incremental Module file name
    **MUST** contain only alphanumeric characters and underscores '_' and
    **MUST NOT** contain the case insensitive word 'base'.

.. req::
    :id: R-94509
    :target: VNF
    :keyword: MUST

    A VNF Heat Orchestration Template's Incremental Module's Environment
    File **MUST** be named identical to the VNF Heat Orchestration Template's
    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

 -  <text>_module_<text>.y[a]ml

Cinder Volume Modules
+++++++++++++++++++++


.. req::
    :id: R-82732
    :target: VNF
    :keyword: MUST

    A VNF Heat Orchestration Template's Cinder Volume Module **MUST** be
    named identical to the base or incremental module it is supporting with
    '_volume appended'

.. req::
    :id: R-31141
    :target: VNF
    :keyword: MUST

    A VNF Heat Orchestration Template's Cinder Volume Module's Environment
    File **MUST** be named identical to the VNF Heat Orchestration Template's
    Cinder Volume Module with .y[a]ml replaced with '.env'.

Nested Heat file
++++++++++++++++


.. req::
    :id: R-76057
    :target: VNF
    :keyword: MUST

    A VNF Heat Orchestration Template's Nested YAML file name **MUST**
    contain only alphanumeric characters and underscores '_' and **MUST NOT**
    contain the case insensitive word 'base'.

.. req::
    :id: R-70276
    :target: VNF
    :keyword: MUST NOT
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF HEAT's Orchestration Nested Template's YAML file
    name **MUST NOT** be in the format '{vm-type}.y[a]ml' where
    '{vm-type}' is defined in the Heat Orchestration Template.

Examples include

 -  <text>.y[a]ml

 -  nest_<text>.y[a]ml

 -  <text>_nest.y[a]ml

 -  nest.y[a]ml

 -  <text>_nest_<text>.y[a]ml

VNF Heat Orchestration Template's Nested YAML file does not have a
corresponding environment files, per OpenStack specifications.

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 VNF's Heat Orchestration Template's Base Module. 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 any
incremental module in the VNF.  Note that the parameter is not
available to other VNFs.


.. req::
    :id: R-52753
    :target: VNF
    :keyword: MUST

    VNF's Heat Orchestration Template's Base Module's output parameter's
    name and type **MUST** match the VNF's Heat Orchestration Template's
    incremental Module's name and type unless the output parameter is of type
    'comma_delimited_list', then the corresponding input parameter **MUST**
    be declared as type 'json'.

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.


.. req::
    :id: R-22608
    :target: VNF
    :keyword: MUST NOT

    When a VNF's Heat Orchestration Template's Base Module's output
    parameter is declared as an input parameter in an Incremental Module,
    the parameter attribute '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
++++++++++++++++++++++++++++++++++++


.. req::
    :id: R-89913
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's Cinder Volume Module Output
    Parameter(s) **MUST** include the UUID(s) of the Cinder Volumes created in
    template, while other Output Parameters **MAY** be included.

A VNF's Heat Orchestration Template's Cinder Volume Module Output Parameter(s)
are only available for the module (base or incremental) that the volume
template is associated with.


.. req::
    :id: R-07443
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Templates' Cinder Volume Module Output
    Parameter's name and type **MUST** match the input parameter name and type
    in the corresponding Base Module or Incremental Module unless the Output
    Parameter is of the type 'comma\_delimited\_list', then the corresponding input
    parameter **MUST** be declared as type 'json'.

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.


.. req::
    :id: R-20547
    :target: VNF
    :keyword: MUST NOT

    When an ONAP Volume Module Output Parameter is declared as an input
    parameter in a base or 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 `Cinder Volumes`_.

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 currently only two parameters are supported. These output
parameters are optional and are specified in `OAM Management IP Addresses`_.

Support of heat stack update
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

ONAP does not support the use of heat stack-update command for scaling
(growth/de-growth).


.. req::
    :id: R-39349
    :target: VNF
    :keyword: MUST NOT

    A VNF Heat Orchestration Template **MUST NOT** be designed to
    utilize the OpenStack 'heat stack-update' command for scaling
    (growth/de-growth).

.. req::
    :id: R-43413
    :target: VNF
    :keyword: MUST

    A VNF **MUST** utilize a modular Heat Orchestration Template
    design to support scaling (growth/de-growth).

Scope of a Heat Orchestration Template
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. req::
    :id: R-59482
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template **MUST NOT** be VNF instance
    specific or Cloud site specific.

ONAP provides the instance specific parameter values to the Heat
Orchestration Template at orchestration time.


.. req::
    :id: R-01896
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's parameter values that are
    constant across all deployments **MUST** be declared in a Heat Orchestration
    Template Environment File.

Networking
^^^^^^^^^^

ONAP defines two types of networks: External Networks and Internal Networks.

External 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 must connect VMs in a VNF to
VMs in another VNF or an external gateway or external router.

An External Network may be a Neutron Network or a Contrail Network.


.. req::
    :id: R-16968
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Templates **MUST NOT** include heat
    resources to create external networks.

External networks must be orchestrated separately, independent of the VNF.
This allows the network to be shared by multiple VNFs and managed
independently of VNFs.


.. req::
    :id: R-00606
    :target: VNF
    :keyword: MAY

    A VNF **MAY** be connected to zero, one or more than one external
    networks.

.. req::
    :id: R-57424
    :target: VNF
    :keyword: MUST

    A VNF's port connected to an external network **MUST**
    use the port for the purpose of reaching VMs in another VNF
    and/or an external gateway and/or external router. A VNF's port
    connected to an external network **MAY** use the port for
    the purpose of reaching VMs in the same VNF.

.. req::
    :id: R-29865
    :target: VNF
    :keyword: MUST

    When a VNF connects to an external network, a network role,
    referred to as the '{network-role}' **MUST** be assigned to the
    external network for use in the VNF's Heat Orchestration Template.

.. req::
    :id: R-69014
    :target: VNF
    :keyword: MUST

    When a VNF connects to an external network, a network role, referred
    to as the '{network-role}' **MUST** be assigned to the external network
    for use in the VNF's Heat Orchestration Template.

.. req::
    :id: R-05201
    :target: VNF
    :keyword: MUST

    When a VNF connects to two or more external networks, each external
    network **MUST** be assigned a unique '{network-role}' in the context of
    the VNF for use in the VNF's Heat Orchestration Template.

.. req::
    :id: R-83015
    :target: VNF
    :keyword: MUST

    A VNF's '{network-role}' assigned to an external network **MUST**
    be different than the '{network-role}' assigned to the VNF's internal
    networks, if internal networks exist.

.. req::
    :id: R-99794
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    An external network **MUST** have one subnet. An external network
    **MAY** have more than one subnet.

Note that this document refers to **'{network-role}'** which in reality
is the **'{network-role-tag}'**.  The value of the
'{network-role}' / '{network-role-tag}'
is determined by the designer of the VNF's Heat Orchestration Template and
there is no requirement for '{network-role}' / '{network-role-tag}'
uniqueness across Heat Orchestration Templates for
different VNFs.

When an external network is created by ONAP, the network is assigned a
'{network-role}'.  The '{network-role}' of the network is not required to
match the '{network-role}' of the VNF Heat Orchestration Template.

For example, the VNF Heat Orchestration Template can assign a '{network-role}'
of 'oam' to a network which attaches to an external network with a
'{network-role}' of 'oam_protected_1' .

When the Heat Orchestration Template is on-boarded into ONAP
  * each '{network-role}' value in the Heat Orchestration Template
    is mapped to the '{network-role-tag}' in the ONAP
    data structure.
  * each OS::Neutron::Port is associated with the external network it is
    connecting to, thus creating the VNF Heat Orchestration Template
    '{network-role}' / '{network-role-tag}' to external network '{network-role}'
    mapping.

ONAP enforces a naming convention for parameters associated with
external networks. `ONAP Resource ID and Parameter Naming Convention`_
provides additional details.

Internal Networks
~~~~~~~~~~~~~~~~~

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


.. req::
    :id: R-87096
    :target: VNF
    :keyword: MAY

    A VNF **MAY** contain zero, one or more than one internal networks.

.. req::
    :id: R-35666
    :target: VNF
    :keyword: MUST

    If a VNF has an internal network, the VNF Heat Orchestration
    Template **MUST** include the heat resources to create the internal network.

.. req::
    :id: R-86972
    :target: VNF
    :keyword: SHOULD

    A VNF **SHOULD** create the internal network in the VNF's Heat
    Orchestration Template Base Module.

An Internal Network may be created using Neutron Heat Resources and/or
Contrail Heat Resources.


.. req::
    :id: R-52425
    :target: VNF
    :keyword: MUST

    A VNF's port connected to an internal network **MUST** connect
    the port to VMs in the same VNF.

.. req::
    :id: R-46461
    :target: VNF
    :keyword: MUST NOT

    A VNF's port connected to an internal network **MUST NOT** connect
    the port to VMs in another VNF and/or an external gateway and/or
    external router.

.. req::
    :id: R-68936
    :target: VNF
    :keyword: MUST

    When a VNF creates an internal network, a network role, referred to
    as the '{network-role}' **MUST** be assigned to the internal network for
    use in the VNF's Heat Orchestration Template.

.. req::
    :id: R-32025
    :target: VNF
    :keyword: MUST

    When a VNF creates two or more internal networks, each internal
    network **MUST** be assigned a unique '{network-role}' in the context of
    the VNF for use in the VNF's Heat Orchestration Template.

.. req::
    :id: R-69874
    :target: VNF
    :keyword: MUST

    A VNF's '{network-role}' assigned to an internal network **MUST**
    be different than the '{network-role}' assigned to the VNF's external
    networks.

.. req::
    :id: R-16241
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's internal network **MUST** have one subnet.
    A VNF's internal network **MAY** have more than one subnet.

.. req::
    :id: R-34726
    :target: VNF
    :keyword: MUST

    If a VNF's port is connected to an internal network and the port
    is created in the same Heat Orchestration Template as the internal network,
    then the port resource **MUST** use a 'get_resource' to obtain
    the network UUID.

.. req::
    :id: R-22688
    :target: VNF
    :keyword: MUST

    If a VNF's port is connected to an internal network and the
    port is created in an Incremental Module and the internal
    network is created in the Base Module then the UUID of the
    internal network **MUST** be exposed
    as a parameter in the 'outputs:' section of the Base Module and the port
    resource **MUST** use a 'get_param' to obtain the network UUID.

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}
~~~~~~~~~


.. req::
    :id: R-01455
    :target: VNF
    :keyword: MUST

    When a VNF's Heat Orchestration Template creates a
    Virtual Machine  (i.e., 'OS::Nova::Server'), each 'class' of VMs
    **MUST** be assigned a VNF unique '{vm-type}'; where 'class'
    defines VMs that **MUST** have the following identical characteristics:

      1.) OS::Nova::Server property flavor value

      2.) OS::Nova::Server property image value

      3.) Cinder Volume attachments
        - Each VM in the 'class' **MUST** have the identical Cinder Volume
          configuration

      4.) Network attachments and IP address requirements
        - Each VM in the 'class' **MUST** have the the identical number
          of ports connecting to the identical networks and requiring the
          identical IP address configuration.

.. req::
    :id: R-82481
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's Resource property
    parameter that is associated with a unique Virtual Machine
    type **MUST** include '{vm-type}'  as part of the parameter
    name with two exceptions:

      1.) The Resource OS::Nova::Server property availability_zone parameter
      **MUST NOT** be prefixed with a common '{vm-type} identifier,

      2.) The Resource OS::Nova::Server eight mandatory and optional metadata
      parameters (vnf_name, vnf_id, vf_module_id, vf_module_name, vm_role,
      vf_module_index, environment_context, workload_context) **MUST NOT**
      be prefixed with a common '{vm-type}' identifier.

.. req::
    :id: R-66729
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's Resource that is
    associated with a unique Virtual Machine type **MUST** include
    '{vm-type}' as part of the resource ID.

.. req::
    :id: R-98407
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's '{vm-type}' **MUST** contain
    only alphanumeric characters and/or underscores '_' and
    **MUST NOT** contain any of the following strings: '_int' or 'int\_'
    or '\_int\_'.

.. req::
    :id: R-48067
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's {vm-type} **MUST NOT** be a
    substring of {network-role}.

It may cause the VNF Validation Program validation-scripts project
to produce erroneous error messages.


.. req::
    :id: R-32394
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's use of '{vm-type}'
    in all Resource property parameter names **MUST** be the same case.

.. req::
    :id: R-46839
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's use of
    '{vm-type}' in all Resource IDs **MUST** be the same case.

.. req::
    :id: R-36687
    :target: VNF
    :keyword: SHOULD

    A VNF's Heat Orchestration Template's '{vm-type}' case in
    Resource property parameter names **SHOULD** match the case of
    '{vm-type}' in Resource IDs and vice versa.

{network-role}
~~~~~~~~~~~~~~

The assignment of a {network-role} is discussed in `Networking`_.


.. req::
    :id: R-21330
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's Resource property
    parameter that is associated with external network **MUST**
    include the '{network-role}' as part of the parameter name.

.. req::
    :id: R-11168
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's Resource ID that is
    associated with an external network **MUST** include the
    '{network-role}' as part of the resource ID.

.. req::
    :id: R-84322
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's Resource property
    parameter that is associated with an internal network
    **MUST** include 'int\_{network-role}' as part of the parameter
    name, where 'int\_' is a hard coded string.

.. req::
    :id: R-96983
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's Resource ID that is
    associated with an internal network **MUST** include
    'int\_{network-role}' as part of the Resource ID, where
    'int\_' is a hard coded string.

.. req::
    :id: R-26506
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's '{network-role}'
    **MUST** contain only alphanumeric characters and/or
    underscores '_' and **MUST NOT** contain any of the following
    strings: '_int' or 'int\_' or '\_int\_'.

.. req::
    :id: R-00977
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's '{network-role}'
    **MUST NOT** be a substring of '{vm-type}'.

For example, if a VNF has a '{vm-type}' of 'oam' and a
'{network-role}' of 'oam\_protected' would be a violation of the requirement.


.. req::
    :id: R-58424
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's use of '{network-role}'
    in all Resource property parameter names **MUST** be the same case.

.. req::
    :id: R-21511
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's use of '{network-role}'
    in all Resource IDs **MUST** be the same case.

.. req::
    :id: R-86588
    :target: VNF
    :keyword: SHOULD

    A VNF's Heat Orchestration Template's '{network-role}' case
    in Resource property parameter names **SHOULD** match the case
    of '{network-role}' in Resource IDs and vice versa.

Resource IDs
~~~~~~~~~~~~

Requirement R-75141 states a VNF's Heat Orchestration Template's
resource name (i.e., <resource ID>) MUST only contain alphanumeric
characters and underscores ('_').*

Requirement R-16447 states a VNF's <resource ID> MUST be unique
across all Heat Orchestration Templates and all HEAT Orchestration
Template Nested YAML files that are used to create the VNF.

As stated previously, OpenStack requires the <resource ID> to be unique
to the Heat Orchestration Template and not unique across all Heat
Orchestration Templates the compose the VNF.

Heat Orchestration Template resources are described in `resources`_


.. req::
    :id: R-54517
    :target: VNF
    :keyword: MUST

    When a VNF's Heat Orchestration Template's resource is associated
    with a single '{vm-type}', the Resource ID **MUST** contain the '{vm-type}'.

.. req::
    :id: R-96482
    :target: VNF
    :keyword: MUST

    When a VNF's Heat Orchestration Template's resource is associated
    with a single external network, the Resource ID **MUST** contain the text
    '{network-role}'.

.. req::
    :id: R-98138
    :target: VNF
    :keyword: MUST

    When a VNF's Heat Orchestration Template's resource is associated
    with a single internal network, the Resource ID **MUST** contain the text
    'int\_{network-role}'.

.. req::
    :id: R-82115
    :target: VNF
    :keyword: MUST

    When a VNF's Heat Orchestration Template's resource is associated
    with a single '{vm-type}' and a single external network, the Resource
    ID text **MUST** contain both the '{vm-type}' and the '{network-role}'

      - the '{vm-type}' **MUST** appear before the '{network-role}' and **MUST**
        be separated by an underscore '_'

          - e.g.,'{vm-type}\_{network-role}', '{vm-type}\_{index}\_{network-role}'

      - note that an '{index}' value **MAY** separate the '{vm-type}' and the
        '{network-role}' and when this occurs underscores **MUST** separate the
        three values.

.. req::
    :id: R-82551
    :target: VNF
    :keyword: MUST

    When a VNF's Heat Orchestration Template's resource is associated
    with a single '{vm-type}' and a single internal network, the Resource ID
    **MUST** contain both the '{vm-type}' and the 'int\_{network-role}' and

      - the '{vm-type}' **MUST** appear before the 'int\_{network-role}' and
      **MUST** be separated by an underscore '_'

        - e.g.,'{vm-type}\_int\_{network-role}', '{vm-type}_{index}\_int\_{network-role}'

      - note that an '{index}' value **MAY** separate the '{vm-type}' and the
        'int\_{network-role}' and when this occurs underscores **MUST** separate
        the three values.

.. req::
    :id: R-67793
    :target: VNF
    :keyword: MUST NOT

    When a VNF's Heat Orchestration Template's resource is associated
    with more than one '{vm-type}' and/or more than one internal and/or
    external network, the Resource ID **MUST NOT** contain the '{vm-type}'
    and/or '{network-role}'/'int\_{network-role}'. It also should contain the
    term 'shared' and/or contain text that identifies the VNF

.. req::
    :id: R-27970
    :target: VNF
    :keyword: MAY

    When a VNF's Heat Orchestration Template's resource is associated
    with more than one '{vm-type}' and/or more than one internal and/or
    external network, the Resource ID **MAY** contain the term 'shared'
    and/or **MAY** contain text that identifies the VNF.

.. req::
    :id: R-11690
    :target: VNF
    :keyword: MUST

    When a VNF's Heat Orchestration Template's Resource ID contains
    an {index} value (e.g. multiple VMs of same {vm-type}), the '{index}'
    **MUST** start at zero and increment by one.

OpenStack Heat Resources Resource ID Naming Convention
++++++++++++++++++++++++++++++++++++++++++++++++++++++

Some OpenStack Heat Resources Resource IDs
have mandatory or suggested naming conventions.  They are provided
in the following sections.

OS::Cinder::Volume
__________________


.. req::
    :id: R-87004
    :target: VNF
    :keyword: SHOULD
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::Cinder::Volume Resource ID **SHOULD** use the naming convention

       * {vm-type}_volume_{index}

    where

       * {vm-type} is the vm-type
       * {index} starts at zero and increments by one

OS::Cinder::VolumeAttachment
____________________________


.. req::
    :id: R-86497
    :target: VNF
    :keyword: SHOULD
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::Cinder::VolumeAttachment Resource ID **SHOULD** use the naming convention

       * {vm-type}_volume_attachment_{index}

    where

       * {vm-type} is the vm-type
       * {index} starts at zero and increments by one

OS::Heat::CloudConfig
_____________________


.. req::
    :id: R-04747
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::Heat::CloudConfig' Resource ID **MUST** contain the '{vm-type}'.

.. req::
    :id: R-20319
    :target: VNF
    :keyword: MAY
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource 'OS::Heat::CloudConfig'
    Resource ID **MAY** use the naming convention

       * {vm-type}_RCC

    where

       * {vm-type} is the vm-type
       * 'RCC' signifies that it is the Resource Cloud Config

OS::Heat::MultipartMime
_______________________


.. req::
    :id: R-30804
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::Heat::MultipartMime' Resource ID **MUST** contain the '{vm-type}'.

.. req::
    :id: R-18202
    :target: VNF
    :keyword: MAY
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::Heat::MultipartMime' Resource ID **MAY** use the naming convention

       * {vm-type}_RMM

    where

       * {vm-type} is the vm-type
       * 'RMM' signifies that it is the Resource Multipart Mime

OS::Heat::ResourceGroup
_______________________

There is only a mandatory naming convention for a 'OS::Heat::ResourceGroup'
that is is creating sub-interfaces.


.. req::
    :id: R-64197
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::Heat::ResourceGroup Resource ID that creates sub-interfaces **MUST**
    use the naming convention

       * {vm-type}_{vm-type_index}_subint_{network-role}_port_{port-index}_subinterfaces

    where

       * {vm-type} is the vm-type
       * {vm-type_index} is the instance of the {vm-type}
       * {network-role} is the network-role of the networks
         that the sub-interfaces attach to
       * {port-index} is the instance of the the port on the vm-type
         attached to the network of {network-role}

OS::Heat::SoftwareConfig
________________________


.. req::
    :id: R-08975
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::Heat::SoftwareConfig' Resource ID **MUST** contain the '{vm-type}'.

.. req::
    :id: R-03656
    :target: VNF
    :keyword: MAY
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::Heat::SoftwareConfig' Resource ID **MAY** use the naming convention

       * {vm-type}_RSC

    where

       * {vm-type} is the vm-type
       * 'RSC' signifies that it is the Resource Software Config

OS::Neutron::Net
________________


.. req::
    :id: R-25720
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::Neutron::Net Resource ID **MUST** use the naming convention

       * int_{network-role}_network

VNF Heat Orchestration Templates can only create internal networks.
There is no {index} after {network-role} because {network-role}
**MUST** be unique in the scope of the VNF's
Heat Orchestration Template.

OS::Neutron::Port
_________________


.. req::
    :id: R-20453
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::Neutron::Port that is attaching to an external network Resource ID
    **MUST** use the naming convention

       * {vm-type}_{vm-type_index}_{network-role}_port_{port-index}

    where

       * {vm-type} is the vm-type
       * {vm-type_index} is the instance of the {vm-type}
       * {network-role} is the network-role of the network
         that the port is attached to
       * {port-index} is the instance of the the port on the vm-type
         attached to the network of {network-role}

.. req::
    :id: R-26351
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::Neutron::Port that is attaching to an internal network Resource ID
    **MUST** use the naming convention

       * {vm-type}_{vm-type_index}_int_{network-role}_port_{port-index}

    where

       * {vm-type} is the vm-type
       * {vm-type_index} is the instance of the {vm-type}
       * {network-role} is the network-role of the network
         that the port is attached to
       * {port-index} is the instance of the the port on the vm-type
         attached to the network of {network-role}

.. req::
    :id: R-27469
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::Neutron::Port that is creating a *Reserve Port* with an IPv4 address
    Resource ID **MUST** use the naming convention

       * reserve_port_{vm-type}_{network-role}_floating_ip_{index}

    where

       * {vm-type} is the vm-type
       * {network-role} is the network-role of the network
         that the port is attached to
       * {index} is the instance of the IPv4 *Reserve Port*
         for the vm-type attached to the network of {network-role}

.. req::
    :id: R-68520
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource OS::Neutron::Port
    that is creating a *Reserve Port* with an IPv6 address Resource ID
    **MUST** use the naming convention

       * reserve_port_{vm-type}_{network-role}_floating_v6_ip_{index}

    where

       * {vm-type} is the vm-type
       * {network-role} is the network-role of the network
         that the port is attached to
       * {index} is the instance of the IPv6 *Reserve Port*
         for the vm-type attached to the network of {network-role}

OS::Neutron::SecurityGroup
__________________________


.. req::
    :id: R-08775
    :target: VNF
    :keyword: SHOULD
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::Neutron::SecurityGroup that is applicable to one {vm-type} and
    more than one network (internal and/or external) Resource ID
    **SHOULD** use the naming convention

       * {vm-type}_security_group

    where

       * {vm-type} is the vm-type

.. req::
    :id: R-03595
    :target: VNF
    :keyword: SHOULD
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::Neutron::SecurityGroup that is applicable to more than
    one {vm-type} and one external network Resource ID **SHOULD**
    use the naming convention

       * {network-role}_security_group

    where

       * {network-role} is the network-role

.. req::
    :id: R-73213
    :target: VNF
    :keyword: SHOULD
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::Neutron::SecurityGroup that is applicable to more than
    one {vm-type} and one internal network Resource ID **SHOULD**
    use the naming convention

       * int_{network-role}_security_group

    where

       * {network-role} is the network-role

.. req::
    :id: R-17334
    :target: VNF
    :keyword: SHOULD
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::Neutron::SecurityGroup that is applicable to one {vm-type}
    and one external network Resource ID **SHOULD** use the naming convention

       * {vm-type}_{network-role}_security_group

    where

       * {vm-type} is the vm-type
       * {network-role} is the network-role

.. req::
    :id: R-14198
    :target: VNF
    :keyword: SHOULD
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::Neutron::SecurityGroup that is applicable to one {vm-type}
    and one internal network Resource ID **SHOULD** use the naming convention

       * {vm-type}_int_{network-role}_security_group

    where

       * {vm-type} is the vm-type
       * {network-role} is the network-role

.. req::
    :id: R-30005
    :target: VNF
    :keyword: MAY
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::Neutron::SecurityGroup that is applicable to more than one
    {vm-type} and more than one network (internal and/or external)
    Resource ID **MAY** use the naming convention

       * shared_security_group

    or

       * {vnf-type}_security_group

    where

       * {vnf-type} describes the VNF

OS::Neutron::Subnet
___________________


.. req::
    :id: R-59434
    :target: VNF
    :keyword: SHOULD
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::Neutron::Subnet Resource ID **SHOULD** use the naming convention

       * int_{network-role}_subnet_{index}

    where

       * {network-role} is the network-role
       * {index} is the {index} of the subnet of the network

OS::Nova::Keypair
_________________


.. req::
    :id: R-24997
    :target: VNF
    :keyword: SHOULD
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::Nova::Keypair applies to one {vm-type} Resource ID **SHOULD**
    use the naming convention

       * {vm-type}_keypair_{index}

    where

       * {network-role} is the network-role
       * {index} is the {index} of the keypair

.. req::
    :id: R-65516
    :target: VNF
    :keyword: SHOULD
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource OS::Nova::Keypair
    applies to all Virtual Machines in the the VNF, the Resource ID **SHOULD**
    use the naming convention

       * {vnf-type}_keypair

    where

       * {vnf-type} describes the VNF

OS::Nova::Server
________________


.. req::
    :id: R-29751
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource OS::Nova::Server
    Resource ID **MUST** use the naming convention

       * {vm-type}_server_{index}

    where

       * {vm-type} is the vm-type
       * {index} is the index

OS::Nova::ServerGroup
_____________________


.. req::
    :id: R-15189
    :target: VNF
    :keyword: MAY
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource OS::Nova::ServerGroup
    Resource ID **MAY** use the naming convention

       * {vm-type}_RSG

    or

       * {vm-type}_Server_Grp

    or

       * {vm-type}_ServerGroup

    or

       * {vm-type}_servergroup

Contrail Heat Resources Resource ID Naming Convention
+++++++++++++++++++++++++++++++++++++++++++++++++++++

Some Contrail Heat Resources Resource IDs
have mandatory or suggested naming conventions. They are provided
in the following sections.


OS::ContrailV2::InstanceIp
__________________________


.. req::
    :id: R-53310
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::InstanceIp' that is configuring an IPv4 Address
    on a port attached to an external network Resource ID **MUST**
    use the naming convention

       *  {vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_IP_{index}

    where

       * {vm-type} is the vm-type
       * {vm-type_index} is the instance of the {vm-type}
       * {network-role} is the network-role of the network
         that the port is attached to
       * {vmi_index} is the instance of the the virtual machine interface
         (e.g., port)  on the vm-type
         attached to the network of {network-role}
       * 'IP' signifies that an IPv4 address is being configured
       * {index} is the index of the IPv4 address

.. req::
    :id: R-46128
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::InstanceIp' that is configuring an
    IPv6 Address on a port attached to an external network
    Resource ID **MUST** use the naming convention

       *  {vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}_v6_IP_{index}

    where

       * {vm-type} is the vm-type
       * {vm-type_index} is the instance of the {vm-type}
       * {network-role} is the network-role of the network
         that the port is attached to
       * {vmi_index} is the instance of the the virtual machine interface
         (e.g., port)  on the vm-type
         attached to the network of {network-role}
       * 'v6_IP' signifies that an IPv6 address is being configured
       * {index} is the index of the IPv6 address

.. req::
    :id: R-62187
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::InstanceIp' that is configuring an
    IPv4 Address on a port attached to an internal network
    Resource ID **MUST** use the naming convention

       *  {vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_IP_{index}

    where

       * {vm-type} is the vm-type
       * {vm-type_index} is the instance of the {vm-type}
       * {network-role} is the network-role of the network
         that the port is attached to
       * {vmi_index} is the instance of the the virtual machine interface
         (e.g., port)  on the vm-type
         attached to the network of {network-role}
       * 'IP' signifies that an IPv4 address is being configured
       * {index} is the index of the IPv4 address

.. req::
    :id: R-87563
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::InstanceIp' that is configuring an
    IPv6 Address on a port attached to an internal network
    Resource ID **MUST** use the naming convention

       *  {vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}_v6_IP_{index}

    where

       * {vm-type} is the vm-type
       * {vm-type_index} is the instance of the {vm-type}
       * {network-role} is the network-role of the network
         that the port is attached to
       * {vmi_index} is the instance of the the virtual machine interface
         (e.g., port)  on the vm-type
         attached to the network of {network-role}
       * 'v6_IP' signifies that an IPv6 address is being configured
       * {index} is the index of the IPv6 address

.. req::
    :id: R-20947
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::InstanceIp' that is configuring an IPv4 Address
    on a sub-interface port attached to a sub-interface network
    Resource ID **MUST** use the naming convention

       *  {vm-type}_{vm-type_index}_subint_{network-role}_vmi_{vmi_index}_IP_{index}

    where

       * {vm-type} is the vm-type
       * {vm-type_index} is the instance of the {vm-type}
       * {network-role} is the network-role of the network
         that the port is attached to
       * {vmi_index} is the instance of the the virtual machine interface
         (e.g., port)  on the vm-type
         attached to the network of {network-role}
       * 'IP' signifies that an IPv4 address is being configured
       * {index} is the index of the IPv4 address

.. req::
    :id: R-88540
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::InstanceIp' that is configuring an IPv6 Address
    on a sub-interface port attached to a sub-interface network
    Resource ID **MUST** use the naming convention

       *  {vm-type}_{vm-type_index}_subint_{network-role}_vmi_{vmi_index}_v6_IP_{index}

    where

       * {vm-type} is the vm-type
       * {vm-type_index} is the instance of the {vm-type}
       * {network-role} is the network-role of the network
         that the port is attached to
       * {vmi_index} is the instance of the the virtual machine interface
         (e.g., port)  on the vm-type
         attached to the network of {network-role}
       * 'v6_IP' signifies that an IPv6 address is being configured
       * {index} is the index of the IPv6 address

OS::ContrailV2::InterfaceRouteTable
___________________________________


.. req::
    :id: R-81214
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::InterfaceRouteTable' Resource ID **MUST**
    contain the '{network-role}'.

.. req::
    :id: R-28189
    :target: VNF
    :keyword: MAY
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::InterfaceRouteTable' Resource ID **MAY**
    use the naming convention

       * {network-role}_RIRT

    where

       * {network-role} is the network-role
       * 'RIRT' signifies that it is the Resource Interface Route Table

OS::ContrailV2::NetworkIpam
___________________________


.. req::
    :id: R-30753
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::NetworkIpam' Resource ID **MUST**
    contain the '{network-role}'.

.. req::
    :id: R-81979
    :target: VNF
    :keyword: MAY
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::NetworkIpam' Resource ID **MAY**
    use the naming convention

       * {network-role}_RNI

    where

       * {network-role} is the network-role
       * 'RNI' signifies that it is the Resource Network IPAM

OS::ContrailV2::PortTuple
_________________________


.. req::
    :id: R-20065
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::PortTuple' Resource ID **MUST**
    contain the '{vm-type}'.

.. req::
    :id: R-84457
    :target: VNF
    :keyword: MAY
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::PortTuple' Resource ID **MAY**
    use the naming convention

       * {vm-type}_RPT

    where

       * {vm-type} is the vm-type
       * 'RPT' signifies that it is the Resource Port Tuple

OS::ContrailV2::ServiceHealthCheck
__________________________________


.. req::
    :id: R-76014
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::ServiceHealthCheck' Resource ID **MUST**
    contain the '{vm-type}'.

.. req::
    :id: R-65618
    :target: VNF
    :keyword: MAY
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::ServiceHealthCheck' Resource ID
    **MAY** use the naming convention

       * {vm-type}_RSHC_{LEFT|RIGHT}

    where

       * {vm-type} is the vm-type
       * 'RSHC' signifies that it is the Resource Service Health Check
       * 'LEFT' is used if the Service Health Check is on the left interface
       * 'RIGHT' is used if the Service Health Check is on the right interface

OS::ContrailV2::ServiceTemplate
_______________________________


.. req::
    :id: R-16437
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::ServiceTemplate' Resource ID **MUST**
    contain the '{vm-type}'.

.. req::
    :id: R-14447
    :target: VNF
    :keyword: MAY
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    'OS::ContrailV2::ServiceTemplate' Resource ID **MAY**
    use the naming convention

       * {vm-type}_RST_{index}

    where

       * {vm-type} is the vm-type
       * 'RST' signifies that it is the Resource Service Template
       * '{index}' is is the index

OS::ContrailV2::VirtualMachineInterface
_______________________________________


.. req::
    :id: R-96253
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::ContrailV2::VirtualMachineInterface that is attaching
    to an external network Resource ID **MUST**
    use the naming convention

       * {vm-type}_{vm-type_index}_{network-role}_vmi_{vmi_index}

    where

       * {vm-type} is the vm-type
       * {vm-type_index} is the instance of the {vm-type}
       * {network-role} is the network-role of the network
         that the port (i.e. virtual machine interface) is attached to
       * {vmi_index} is the instance of the the vmi on the vm-type
         attached to the network of {network-role}

.. req::
    :id: R-50468
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::ContrailV2::VirtualMachineInterface that is attaching
    to an internal network Resource ID **MUST** use the naming convention

       * {vm-type}_{vm-type_index}_int_{network-role}_vmi_{vmi_index}

    where

       * {vm-type} is the vm-type
       * {vm-type_index} is the instance of the {vm-type}
       * {network-role} is the network-role of the network
         that the port (i.e. virtual machine interface) is attached to
       * {vmi_index} is the instance of the the vmi on the vm-type
         attached to the network of {network-role}

.. req::
    :id: R-54458
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::ContrailV2::VirtualMachineInterface that is attaching to
    a sub-interface network Resource ID **MUST** use the naming convention

       * {vm-type}_{vm-type_index}_subint_{network-role}_vmi_{vmi_index}

    where

       * {vm-type} is the vm-type
       * {vm-type_index} is the instance of the {vm-type}
       * {network-role} is the network-role of the network
         that the port (i.e. virtual machine interface) is attached to
       * {vmi_index} is the instance of the the vmi on the vm-type
         attached to the network of {network-role}

OS::ContrailV2::VirtualNetwork
______________________________


.. req::
    :id: R-99110
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Resource
    OS::ContrailV2::VirtualNetwork Resource ID **MUST**
    use the naming convention

       * 'int_{network-role}_network'

    or

       * 'int_{network-role}_RVN' where RVN represents Resource Virtual Network

VNF Heat Orchestration Templates can only create internal networks.
There is no {index} after {network-role} because {network-role}
**MUST** be unique in the scope of the VNF's
Heat Orchestration Template.

Note that the first option is preferred.

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.)

The following four properties of the OS::Nova::Server must follow
the ONAP parameter naming convention. The four properties are:

1. image

2. flavor

3. name

4. availability\_zone

Requirement R-01455 defines how the '{vm-type}' is defined.

Requirement R-82481 defines how the '{vm-type}' is used.

The table below provides a summary. The sections that follow provides
the detailed requirements.

.. csv-table:: **Table 4 OS::Nova::Server Resource Property Parameter Naming Convention**
   :header: Property Name,Parameter Type,Parameter Name,Parameter Value Provided to Heat
   :align: center
   :widths: auto

   OS::Nova::Server, image, string, {vm-type}\_image\_name, Environment File
   OS::Nova::Server, flavor, string, {vm-type}\_flavor\_name, Environment File
   OS::Nova::Server, name, string, {vm-type}\_name\_{index}, ONAP
   OS::Nova::Server, name, CDL, {vm-type}\_names, ONAP
   OS::Nova::Server, availability\_zone, string, availability\_zone\_{index}, ONAP

Property: image
+++++++++++++++


.. req::
    :id: R-71152
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'image' parameter **MUST** be declared as
    type: 'string'.

.. req::
    :id: R-58670
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'image' parameter name **MUST** follow the
    naming convention '{vm-type}_image_name'.

.. req::
    :id: R-91125
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'image' parameter **MUST** be enumerated in
    the Heat Orchestration Template's Environment File and a value **MUST** be
    assigned.

.. req::
    :id: R-57282
    :target: VNF
    :keyword: MUST

    Each VNF's Heat Orchestration Template's '{vm-type}'
    **MUST** have a unique parameter name for the 'OS::Nova::Server'
    property 'image' even if more than one {vm-type} shares the same image.

*Example Parameter Definition*

.. code-block:: yaml

 parameters:
     {vm-type}_image_name:
         type: string
         description: {vm-type} server image

Property: flavor
++++++++++++++++


.. req::
    :id: R-50436
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'flavor' parameter **MUST** be declared as
    type: 'string'.

.. req::
    :id: R-45188
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'flavor' parameter name **MUST** follow the
    naming convention '{vm-type}_flavor_name'.

.. req::
    :id: R-69431
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'flavor' parameter **MUST** be enumerated in the
    Heat Orchestration Template's Environment File and a value **MUST** be
    assigned.

.. req::
    :id: R-40499
    :target: VNF
    :keyword: MUST

    Each VNF's Heat Orchestration Template's '{vm-type}' **MUST**
    have a unique parameter name for the 'OS::Nova::Server' property
    'flavor' even if more than one {vm-type} shares the same flavor.

*Example Parameter Definition*

.. code-block:: yaml

 parameters:
     {vm-type}_flavor_name:
         type: string
         description: {vm-type} flavor

Property: Name
++++++++++++++


.. req::
    :id: R-51430
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'name' parameter **MUST** be declared as
    either type 'string' or type 'comma\_delimited\_list".

.. req::
    :id: R-54171
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'name' parameter is defined as a 'string',
    the parameter name **MUST** follow the naming convention
    '{vm-type}\_name\_{index}', where {index} is a numeric value that starts
    at zero and increments by one.

.. req::
    :id: R-40899
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'name' parameter is defined as a 'string',
    a parameter **MUST** be declared for each 'OS::Nova::Server' resource
    associated with the '{vm-type}'.

.. req::
    :id: R-87817
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'name' parameter is defined as a
    'comma_delimited_list', the parameter name **MUST** follow the naming
    convention '{vm-type}_names'.

.. req::
    :id: R-85800
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'name' parameter is defined as a
    'comma_delimited_list', a parameter **MUST** be delcared once for all
    'OS::Nova::Server' resources associated with the '{vm-type}'.

.. req::
    :id: R-22838
    :target: VNF
    :keyword: MUST NOT

    The VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'name' parameter **MUST NOT** be enumerated
    in the Heat Orchestration Template's Environment File.

If a VNF's Heat Orchestration Template's contains more than three
OS::Nova::Server resources 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 template.


*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_server_0:
      type: OS::Nova::Server
      properties:
        name: { get_param: [lb_names, 0] }
        ...

    lb_server_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_server_0:
      type: OS::Nova::Server
      properties:
        name: { get_param: lb_name_0 }
        ...

    lb_server_1:
      type: OS::Nova::Server
      properties:
        name: { get_param: lb_name_1 }
        ...

Contrail Issue with Values for OS::Nova::Server Property Name
_____________________________________________________________


.. req::
    :id: R-44271
    :target: VNF
    :keyword: SHOULD NOT

    The VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'name' parameter value **SHOULD NOT**
    contain special characters since the Contrail GUI has a limitation
    displaying special characters.

However, if special characters must be used, the only special characters
supported are:

--- \" ! $ ' (\ \ ) = ~ ^ | @ ` { } [ ] > , . _


Property: availability\_zone
++++++++++++++++++++++++++++


.. req::
    :id: R-98450
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'availability\_zone' parameter name
    **MUST** follow the naming convention 'availability\_zone\_{index}'
    where the '{index}' **MUST** start at zero and increment by one.

.. req::
    :id: R-23311
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'availability_zone' parameter **MUST**
    be declared as type: 'string'.

The parameter must not be declared as type 'comma\_delimited\_list',
ONAP does not support it.


.. req::
    :id: R-59568
    :target: VNF
    :keyword: MUST NOT

    The VNF's Heat Orchestration Template's Resource
    'OS::Nova::Server' property 'availability_zone' parameter **MUST NOT**
    be enumerated in the Heat Orchestration Template's Environment File.

Example Parameter Definition

.. code-block:: yaml

  parameters:
    availability_zone_{index}:
      type: string
      description: availability zone {index} name

Requirement R-90279 states that a VNF Heat Orchestration's template's
parameter MUST be used in a resource with the exception of the parameters
for the OS::Nova::Server resource property availability_zone.


.. req::
    :id: R-01359
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchstration Template that contains an
    'OS::Nova:Server' Resource **MAY** define a parameter for the property
    'availability_zone' that is not utilized in any 'OS::Nova::Server'
    resources in the Heat Orchestration Template.

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 }

  . . .

Boot Options
++++++++++++


.. req::
    :id: R-99798
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's Virtual Machine
    (i.e., OS::Nova::Server Resource) **MAY** boot from an image or **MAY**
    boot from a Cinder Volume.

.. req::
    :id: R-83706
    :target: VNF
    :keyword: MUST

    When a VNF's Heat Orchestration Template's Virtual Machine
    (i.e., 'OS::Nova::Server' Resource) boots from an image, the
    'OS::Nova::Server' resource property 'image' **MUST** be used.

The requirements associated with
the 'image' property are detailed in `Property: image`_


.. req::
    :id: R-69588
    :target: VNF
    :keyword: MUST

    When a VNF's Heat Orchestration Template's Virtual Machine
    (i.e., 'OS::Nova::Server' Resource) boots from Cinder Volume, the
    'OS::Nova::Server' resource property 'block_device_mapping' or
    'block_device_mapping_v2' **MUST** be used.

There are currently no heat guidelines
associated with these two properties:
'block_device_mapping' and 'block_device_mapping_v2'.

Resource: OS::Nova::Server – Metadata Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The OS::Nova::Server Resource property metadata is an optional
OpenStack property.
The table below summarizes the mandatory and optional metadata
supported by ONAP.

The sections that follow provides the requirements associated with each
metadata parameter.

.. csv-table:: **Table 5 OS::Nova::Server Mandatory and Optional Metadata**
   :header: Metadata Parameter Name, Parameter Type, Required, Parameter Value Provided to Heat
   :align: center
   :widths: auto

   vnf_id, string, **MUST**, ONAP
   vf_module_id, string, **MUST**, ONAP
   vnf_name, string, **MUST**, ONAP
   vf_module_name, string, **SHOULD**, ONAP
   vm_role, string, **MAY**, YAML or Environment File
   vf_module_index, string, **MAY**, ONAP
   workload_context, string, **SHOULD**, ONAP
   environment_context, string, **SHOULD**, ONAP

vnf\_id
+++++++

The OS::Nova::Server Resource metadata map value parameter 'vnf_id'
is an ONAP generated UUID that identifies the VNF.  The value
is provided by ONAP to the VNF's Heat Orchestration
Template at orchestration time.


.. req::
    :id: R-37437
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource **MUST** contain the metadata map value parameter 'vnf_id'.

.. req::
    :id: R-07507
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vnf_id' **MUST** be declared
    as type: 'string'.

.. req::
    :id: R-55218
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vnf_id' **MUST NOT** have
    parameter contraints defined.

.. req::
    :id: R-20856
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vnf_id' **MUST NOT** be
    enumerated in the Heat Orchestration Template's environment file.

.. req::
    :id: R-44491
    :target: VNF
    :keyword: MUST NOT

    If a VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vnf_id' is passed into a
    Nested YAML file, the parameter name 'vnf_id' **MUST NOT** change.

*Example 'vnf_id' Parameter Definition*

.. code-block:: yaml

  parameters:

    vnf_id:
      type: string
      description: Unique ID for this VNF instance

vf\_module\_id
++++++++++++++

The OS::Nova::Server Resource metadata map value parameter 'vf\_module\_id'
is an ONAP generated UUID that identifies the VF Module (e.g., Heat
Orchestration Template).  The value
is provided by ONAP to the VNF's Heat Orchestration
Template at orchestration time.


.. req::
    :id: R-71493
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource **MUST** contain the metadata map value parameter
    'vf\_module\_id'.

.. req::
    :id: R-82134
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vf\_module\_id' **MUST**
    be declared as type: 'string'.

.. req::
    :id: R-98374
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vf\_module\_id' **MUST NOT**
    have parameter contraints defined.

.. req::
    :id: R-72871
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vf\_module\_id' **MUST NOT**
    be enumerated in the Heat Orchestration Template's environment file.

.. req::
    :id: R-86237
    :target: VNF
    :keyword: MUST NOT

    If a VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vf_module_id' is passed
    into a Nested YAML file, the parameter name 'vf\_module\_id'
    **MUST NOT** change.

*Example 'vf\_module\_id' Parameter Definition*

.. code-block:: yaml

  parameters:

    vnf_module_id:
      type: string
      description: Unique ID for this VNF module instance


vnf\_name
+++++++++

The OS::Nova::Server Resource metadata map value parameter 'vnf_name'
is the ONAP generated alphanumeric name of the deployed VNF instance.
The value
is provided by ONAP to the VNF's Heat Orchestration
Template at orchestration time.
The parameter must be declared as type: string


.. req::
    :id: R-72483
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource **MUST** contain the metadata map value parameter
    'vnf_name'.

.. req::
    :id: R-62428
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vnf_name' **MUST** be
    declared as type: 'string'.

.. req::
    :id: R-44318
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vnf\_name' **MUST NOT** have
    parameter contraints defined.

.. req::
    :id: R-36542
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vnf\_name' **MUST NOT** be
    enumerated in the Heat Orchestration Template's environment file.

.. req::
    :id: R-16576
    :target: VNF
    :keyword: MUST NOT

    If a VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vnf_name' is passed into a
    Nested YAML file, the parameter name 'vnf_name' **MUST NOT** change.

*Example 'vnf\_name' Parameter Definition*

.. code-block:: yaml

  parameters:

    vnf_name:
      type: string
      description: Unique name for this VNF instance

vf\_module\_name
++++++++++++++++

The OS::Nova::Server Resource metadata map value parameter 'vf_module_name'
is the deployment name of the heat stack created (e.g., <STACK_NAME>) from the
VNF's Heat Orchestration template
in the command 'Heat stack-create'
(e.g., 'Heat stack-create [-f <FILE>] [-e <FILE>] <STACK_NAME>').
The 'vf_module_name' (e.g., <STACK_NAME> is specified as
part of the orchestration process.


.. req::
    :id: R-68023
    :target: VNF
    :keyword: SHOULD

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource **SHOULD** contain the metadata map value parameter
    'vf\_module\_name'.

.. req::
    :id: R-39067
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vf\_module\_name' **MUST**
    be declared as type: 'string'.

.. req::
    :id: R-15480
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vf\_module\_name'
    **MUST NOT** have parameter contraints defined.

.. req::
    :id: R-80374
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vf\_module\_name'
    **MUST NOT** be enumerated in the Heat Orchestration Template's
    environment file.

.. req::
    :id: R-49177
    :target: VNF
    :keyword: MUST

    If a VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vf\_module\_name' is passed
    into a Nested YAML file, the parameter name 'vf\_module\_name'
    **MUST NOT** change.

*Example 'vf_module_name' Parameter Definition*

.. code-block:: yaml

  parameters:

    vf_module_name:
      type: string
      description: Unique name for this VNF Module instance

vm\_role
++++++++

The OS::Nova::Server Resource metadata map value parameter 'vm-role'
is a metadata tag that describes the role of the Virtual Machine.
The 'vm\_role' is stored in ONAP's A&AI module and is
available for use by other ONAP components and/or north bound systems.


.. req::
    :id: R-85328
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource **MAY** contain the metadata map value parameter 'vm_role'.

.. req::
    :id: R-95430
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vm_role' **MUST** be
    declared as type: 'string'.

.. req::
    :id: R-67597
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vm_role' **MUST NOT** have
    parameter contraints defined.


.. req::
    :id: R-46823
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vnf_name' **MUST** be
    either

     - enumerated in the VNF's Heat Orchestration
       Template's environment file.

     - hard coded in the VNF's Heat Orchestration
       Template's OS::Nova::Resource metadata property.

Defining the 'vm_role' as the '{vm-type}' is a recommended convention


.. req::
    :id: R-86476
    :target: VNF
    :keyword: MUST

    If a VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vm_role' value **MUST** only
    contain alphanumeric characters and underscores '_'.

.. req::
    :id: R-70757
    :target: VNF
    :keyword: MUST NOT

    If a VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vm_role' is passed into a
    Nested YAML file, the parameter name 'vm_role' **MUST NOT** change.

*Example 'vm\_role' Parameter Definition*

.. code-block:: yaml

  parameters:

    vm_role:
      type: string
      description: Unique role for this VM

*Example: 'vm-role' Definition: Hard Coded in
OS::Nova::Resource metadata property*

.. code-block:: yaml

  resources:

    dns_server_0
      type: OS::Nova::Server
      properties:
        . . . .
        metadata:
          vm_role: dns

*Example 'vm-role' Definition: Defined in Environment file
and retrieved via 'get_param'*

.. code-block:: yaml

  resources:

    dns_server_0:
      type: OS::Nova::Server
      properties:
        . . . .
        metadata:
          vm_role: { get_param: vm_role }

Example vnf_id, vf_module_id, vnf_name, vf_module_name, vm_role
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

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_server_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

vf\_module\_index
+++++++++++++++++


.. req::
    :id: R-50816
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource **MAY** contain the metadata map value parameter
    'vf\_module\_index'.

.. req::
    :id: R-54340
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vf\_module\_index' **MUST** be
    declared as type: 'number'.

.. req::
    :id: R-09811
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vf\_module\_index' **MUST NOT**
    have parameter contraints defined.

.. req::
    :id: R-37039
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vf\_module\_index' **MUST NOT**
    be enumerated in the Heat Orchestration Template's environment file.

.. req::
    :id: R-22441
    :target: VNF
    :keyword: MUST NOT

    If a VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vf\_module\_index' is passed
    into a Nested YAML file, the parameter name 'vf\_module\_index'
    **MUST NOT** change.

.. req::
    :id: R-55306
    :target: VNF
    :keyword: MUST NOT

    If a VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vf\_module\_index' **MUST NOT** be
    used in a VNF's Volume Template; it is not supported.

The vf\_module_index parameter indicates which instance of the module is being
deployed into the VNF.
This parameter may be used in cases where multiple instances of the same
incremental module may be instantiated for scaling purposes. The index
can be used in the Heat Orchestration Template for indexing into a
pseudo-constant array parameter when unique values are required for each
module instance, e.g., for fixed private IP addresses on VM types.

The vf\_module\_index will start at 0 for the first instance of a module
type. Subsequent instances of the same module type will receive the
lowest unused index. This means that indexes will be reused if a module
is deleted and re-added. As an example, if three copies of a module are
deployed with vf\_module\_index values of 0, 1, and 2 then subsequently
the second one is deleted (index 1), and then re-added, index 1 will be
reused.

*Example*

In this example, the {vm-type} has been defined as oam\_vm to represent
an OAM VM. An incremental heat module is used to deploy the OAM VM. The
OAM VM attaches to an internal control network which has a
{network-role} of ctrl. A maximum of four OAM VMs can be deployed. The
environment file contains the four IP addresses that each successive OAM
VM will be assigned. The vf\_module\_index is used as the index to
determine the IP assignment.

Environment File

.. code-block:: yaml

  parameters:
    oam_vm_int_ctrl_ips: 10.10.10.1,10.10.10.2,10.10.10.3,10.10.10.4

YAML File

.. code-block:: yaml

 parameters:
   vf_module_index:
     type: number
     description: Unique index for this VNF Module instance
   oam_vm_name_0:
     type: string
     description: VM Name for lb VM 0
   int_ctrl_net_id:
     type: string
     description: Neutron UUID for the internal control network
   oam_vm_int_ctrl_ips:
     type: comma_delimited_list
     description: Fixed IP assignments for oam VMs on the internal control
     network
 resources:
   oam_vm_server_0:
     type: OS::Nova::Server
     properties:
       name: { get_param: oam_vm_name_0 }
       networks:
         port: { get_resource: oam_vm_0_int_ctrl_port_0 }

       . . .

       metadata:
         vf_module_index: { get_param: vf_module_index }
   oam_vm_0_int_ctrl_port_0:
     type: OS::Neutron::Port
     properties:
       network: { get_param: int_ctrl_net_id }
       fixed_ips: [ { "ip_address": {get_param: [ oam_vm_int_ctrl_ips, { get_param, vf_module_index}]}}]

workload\_context
++++++++++++++++++


.. req::
    :id: R-47061
    :target: VNF
    :keyword: SHOULD

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource **SHOULD** contain the metadata map value parameter
    'workload_context'.

.. req::
    :id: R-74978
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'workload_context' **MUST** be
    declared as type: 'string'.

.. req::
    :id: R-34055
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'workload_context' **MUST NOT**
    have parameter contraints defined.

.. req::
    :id: R-02691
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'workload_context' **MUST NOT**
    be enumerated in the Heat Orchestration Template's environment file.

.. req::
    :id: R-75202
    :target: VNF
    :keyword: MUST NOT

    If a VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'workload_context' is passed
    into a Nested YAML file, the parameter name 'workload_context'
    **MUST NOT** change.

The 'workload\_context' parameter value will be chosen by the Service Model
Distribution context client in VID and will be supplied to the
Heat Orchestration Template by ONAP at orchestration time.

*Example Parameter Definition*

.. code-block:: yaml

  parameters:
    workload_context:
      type: string
      description: Workload Context for this VNF instance


*Example OS::Nova::Server with metadata*

.. code-block:: yaml

  resources:
    . . .

    {vm-type}_server_{index}:
       type: OS::Nova::Server
       properties:
         name:
         flavor:
         image:
        ...
       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 }
          workload_context: {get_param: workload_context}

environment\_context
++++++++++++++++++++++


.. req::
    :id: R-88536
    :target: VNF
    :keyword: SHOULD

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource **SHOULD** contain the metadata map value parameter
    'environment_context'.

.. req::
    :id: R-20308
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'environment_context' **MUST**
    be declared as type: 'string'.

.. req::
    :id: R-56183
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'environment_context' **MUST NOT**
    have parameter contraints defined.

.. req::
    :id: R-13194
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'environment_context' **MUST NOT**
    be enumerated in the Heat Orchestration Template's environment file.

.. req::
    :id: R-62954
    :target: VNF
    :keyword: MUST NOT

    If a VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'environment_context' is
    passed into a Nested YAML file, the parameter name
    'environment_context' **MUST NOT** change.

The 'environment\_context' parameter value will be defined by the
service designer as part of the service model during the SDC
on-boarding process and will be supplied to the Heat Orchestration
Template by ONAP at orchestration time.


*Example Parameter Definition*

.. code-block:: yaml

  parameters:
    environment_context:
      type: string
      description: Environment Context for this VNF instance


*Example OS::Nova::Server with metadata*

.. code-block:: yaml

  resources:
    . . .

    {vm-type}_server_{index}:
       type: OS::Nova::Server
       properties:
         name:
         flavor:
         image:
        ...
       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 }
          workload_context: {get_param: workload_context}
          environment_context: {get_param: environment_context }


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 or fixed_ips, subnet

 * Note that in many examples in this document fixed_ips, subnet_id is used.

4. allowed_address_pairs, ip_address

Below is a generic example. Note that for some parameters
comma_delimited_list are supported in addition to String.

.. code-block:: yaml

  resources:

  ...

  <resource ID>:
    type: OS::Neutron::Port
    properties:
      allowed_address_pairs: [{"ip_address": String, "mac_address": String},
      {"ip_address": String, "mac_address": String}, ...]
      fixed_ips: [{"ip_address": String, "subnet_id": String, "subnet":
      String}, {"ip_address": String, "subnet_id": String, "subnet": String},
      ...]
      network: String

The values associated with these properties may reference an external
network or internal network. External networks and internal
networks are defined in `Networking`_.

When the OS::Neutron::Port is attaching to an external network, all
property values are parameters that are retrieved via the intrinsic
function 'get_param'.

When the OS::Neutron::Port is attaching to an internal network, a
property value maybe retrieved via the intrinsic
function 'get_param', 'get_resource', or 'get_attr'.

This will be described in the forth coming sections.

Items to Note
_____________


.. req::
    :id: R-93272
    :target: VNF
    :keyword: MAY
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF **MAY** have one or more ports connected to a unique
    external network. All VNF ports connected to the unique external
    network **MUST** have Cloud Assigned IP Addresses
    or **MUST** have ONAP SDN-C assigned IP addresses.

.. req::
    :id: R-13841
    :target: VNF
    :keyword: MAY
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF **MAY** have one or more ports connected to a unique
    internal network. All VNF ports connected to the unique internal
    network **MUST** have Cloud Assigned IP Addresses
    or **MUST** have statically assigned IP addresses.

.. req::
    :id: R-07577
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If the VNF's ports connected to a unique network (internal or external)
    and the port's IP addresses are Cloud Assigned IP Addresses,
    all the IPv4 Addresses **MUST** be from
    the same subnet and all the IPv6 Addresses **MUST** be from the
    same subnet.

.. req::
    :id: R-45602
    :target: VNF
    :keyword: MUST NOT
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If a VNF's Port is attached to a network (internal or external)
    and the port's IP addresses are Cloud Assigned by OpenStack's DHCP
    Service, the 'OS::Neutron::Port' Resource's

       * property 'fixed_ips' map property 'ip_address' **MUST NOT** be used
       * property 'fixed_ips' map property 'subnet'/'subnet_id' **MAY** be used

.. req::
    :id: R-63956
    :target: VNF
    :keyword: MAY
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If the VNF's ports connected to a unique external network
    and the port's IP addresses are ONAP SDN-C assigned IP Addresses,
    the IPv4 Addresses **MAY** be from different subnets and the IPv6
    Addresses **MAY** be from different subnets.

.. req::
    :id: R-48880
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If a VNF's Port is attached to an external network and the port's
    IP addresses are assigned by ONAP's SDN-Controller,
    the 'OS::Neutron::Port' Resource's

       * property 'fixed_ips' map property 'ip_address' **MUST** be used
       * property 'fixed_ips' map property 'subnet'/'subnet_id' **MUST NOT** be used

.. req::
    :id: R-18001
    :target: VNF
    :keyword: MAY
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If the VNF's ports connected to a unique internal network
    and the port's IP addresses are statically assigned IP Addresses,
    the IPv4 Addresses **MAY** be from different subnets and the
    IPv6 Addresses **MAY** be from different subnets.

.. req::
    :id: R-70964
    :target: VNF
    :keyword: MUST NOT
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If a VNF's Port is attached to an internal network and the port's
    IP addresses are statically assigned by the VNF's Heat Orchestration\
    Template (i.e., enumerated in the Heat Orchestration Template's
    environment file), the 'OS::Neutron::Port' Resource's

       * property 'fixed_ips' map property 'ip_address' **MUST** be used
       * property 'fixed_ips' map property 'subnet'/'subnet_id'
         **MUST NOT** be used

Property: network
+++++++++++++++++

The Resource 'OS::Neutron::Port' property 'network' determines what network
the port is attached to.


.. req::
    :id: R-18008
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port'
    property 'network' parameter **MUST** be declared as type: 'string'.

.. req::
    :id: R-62983
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port'
    is attaching to an external network, the 'network' parameter name **MUST**

    - follow the naming convention '{network-role}_net_id' if the Neutron
      network UUID value is used to reference the network
    - follow the naming convention '{network-role}_net_name' if the OpenStack
      network name is used to reference the network.

    where '{network-role}' is the network-role of the external network and
    a 'get_param' **MUST** be used as the intrinsic function.

.. req::
    :id: R-86182
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port'
    is attaching to an internal network, and the internal network is created in a different
    Heat Orchestration Template than the 'OS::Neutron::Port', the 'network'
    parameter name **MUST**

    - follow the naming convention 'int\_{network-role}_net_id' if the Neutron
      network UUID value is used to reference the network
    - follow the naming convention 'int\_{network-role}_net_name' if the
      OpenStack network name in is used to reference the network.

    where '{network-role}' is the network-role of the internal network and a 'get_param' **MUST** be used as the intrinsic function.

In Requirement R-86182, the internal network is created in the VNF's
Base Module (Heat Orchestration Template) and the parameter name is
declared in the Base Module's outputs' section.
The output parameter name will be declared as a parameter in the
'parameters' section of the incremental module.


.. req::
    :id: R-93177
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's
    Resource 'OS::Neutron::Port' is attaching to an internal
    network, and the internal network is created in the same Heat
    Orchestration Template than the 'OS::Neutron::Port', the 'network'
    parameter name **MUST** obtain the UUID of the internal network
    by using the intrinsic function 'get_resource' or 'get_attr'
    and referencing the Resource ID of the internal network.

.. req::
    :id: R-29872
    :target: VNF
    :keyword: MUST NOT

    The VNF's Heat Orchestration Template's Resource 'OS::Nova::Server'
    property 'network' parameter **MUST NOT** be enumerated in the Heat
    Orchestration Template's Environment File.

The parameter values for external networks are provided by ONAP
to the VNF's Heat Orchestration Template at orchestration time.

The parameter values for internal networks created in the VNF's Base Module
Heat Orchestration Template
are provided to the VNF's Incremental Module Heat Orchestration Template
at orchestration time.

*Example Parameter Definition of External Networks*

.. code-block:: yaml

  parameters:

    {network-role}_net_id:
      type: string
      description: Neutron UUID for the external {network-role} network

    {network-role}_net_name:
      type: string
      description: Neutron name for the external {network-role} network


*Example Parameter Definition of Internal Networks in an Incremental Module*

.. code-block:: yaml

  parameters:

    int_{network-role}_net_id:
      type: string
      description: Neutron UUID for the internal int_{network-role} network

    int_{network-role}_net_name:
      type: string
      description: Neutron name for the internal int_{network-role} network

Property: fixed_ips, Map Property: ip_address
+++++++++++++++++++++++++++++++++++++++++++++

The resource 'OS::Neutron::Port' property 'fixed_ips'
map property 'ip_address'
is used to assign one IPv4 or IPv6
addresses to port.

One 'OS::Neutron::Port' resource may assign one or more
IPv4 and/or IPv6 addresses.


.. req::
    :id: R-34037
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's resource 'OS::Neutron::Port'
    property 'fixed_ips' map property 'ip_address' parameter **MUST**
    be declared as either type 'string' or type 'comma_delimited_list'.

.. req::
    :id: R-40971
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' is attaching to an external network, and an IPv4
    address is assigned using the property 'fixed_ips' map property
    'ip_address' and the parameter type is defined
    as a string, the parameter name **MUST** follow the naming
    convention
      - '{vm-type}_{network-role}\_ip\_{index}'

    where

      - '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
      - '{network-role}' is the {network-role} of the external network
      - the value for {index} must start at zero (0) and increment by one

.. req::
    :id: R-39841
    :target: VNF
    :keyword: MUST NOT

    The VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port'
    property 'fixed_ips' map property 'ip_address' parameter
    '{vm-type}_{network-role}\_ip\_{index}' **MUST NOT** be enumerated in the
    VNF's Heat Orchestration Template's Environment File.

ONAP's SDN-Controller assigns the IP Address and ONAP provides
the value at orchestration to the Heat Orchestration Template.

*Example External Network IPv4 Address string 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


.. req::
    :id: R-04697
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port'
    is attaching to an external network, and an IPv4 address is assigned using
    the property 'fixed_ips' map property 'ip_address' and the parameter type
    is defined as a comma_delimited_list, the parameter name **MUST** follow the
    naming convention

      * '{vm-type}_{network-role}_ips',

    where

      * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
      * '{network-role}' is the {network-role} of the external network

.. req::
    :id: R-98905
    :target: VNF
    :keyword: MUST NOT

    The VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port'
    property 'fixed_ips' map property 'ip_address' parameter
    '{vm-type}_{network-role}_ips' **MUST NOT** be enumerated in the VNF's
    Heat Orchestration Template's Environment File.

ONAP's SDN-Controller assigns the IP Address and ONAP provides
the value at orchestration to the Heat Orchestration Template.

*Example External Network IPv4 Address comma_delimited_list
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


.. req::
    :id: R-71577
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' is attaching to an external network, and an IPv6 address
    is assigned using the property 'fixed_ips' map property 'ip_address' and
    the parameter type is defined as a string, the parameter name **MUST** follow
    the naming convention

      * '{vm-type}_{network-role}\_v6\_ip\_{index}'

    where

      * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
      * '{network-role}' is the {network-role} of the external network
      * the value for {index} must start at zero (0) and increment by one

.. req::
    :id: R-87123
    :target: VNF
    :keyword: MUST NOT

    The VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
    parameter '{vm-type}_{network-role}\_v6\_ip\_{index}'
    **MUST NOT** be enumerated in the VNF's Heat Orchestration
    Template's Environment File.

ONAP's SDN-Controller assigns the IP Address and ONAP provides
the value at orchestration to the Heat Orchestration Template.

*Example External Network IPv6 Address string Parameter Definition*

.. code-block:: yaml

  parameters:

    {vm-type}_{network-role}_v6_ip_{index}:
      type: string
      description: Fixed IPv6 assignment for {vm-type} VM {index} on the {network-role} network


.. req::
    :id: R-23503
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' is attaching to an external network, and an IPv6
    address is assigned using the property 'fixed_ips' map property 'ip_address'
    and the parameter type is defined as a comma_delimited_list, the parameter
    name **MUST** follow the naming convention

      * '{vm-type}_{network-role}_v6_ips'

    where

      * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
      * '{network-role}' is the {network-role} of the external network

.. req::
    :id: R-93030
    :target: VNF
    :keyword: MUST NOT

    The VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
    parameter '{vm-type}_{network-role}_v6_ips' **MUST NOT** be enumerated in the
    VNF's Heat Orchestration Template's Environment File.

ONAP's SDN-Controller assigns the IP Address and ONAP provides
the value at orchestration to the Heat Orchestration Template.

*Example External Network IPv6 Address comma_delimited_list Parameter
Definition*

.. code-block:: yaml

  parameters:

    {vm-type}_{network-role}_v6_ips:
      type: comma_delimited_list
      description: Fixed IPv6 assignments for {vm-type} VMs on the {network-role} network


.. req::
    :id: R-78380
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' is attaching to an internal network, and an IPv4 address
    is assigned using the property 'fixed_ips' map property 'ip_address' and
    the parameter type is defined as a string, the parameter name **MUST** follow
    the naming convention

       * '{vm-type}\_int\_{network-role}\_ip\_{index}'

    where

       * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
       * '{network-role}' is the {network-role} of the internal network
       * the value for {index} must start at zero (0) and increment by one

.. req::
    :id: R-28795
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
    parameter '{vm-type}\_int\_{network-role}\_ip\_{index}' **MUST** be enumerated
    in the VNF's Heat Orchestration Template's Environment File.

The IP address is local to the VNF's internal network and is (re)used
in every VNF spin up, thus the constant value is declared in the VNF's
Heat Orchestration Template's Environment File.

*Example Internal Network IPv4 Address string 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 int_{network-role} network


.. req::
    :id: R-85235
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' is attaching to an internal network, and an IPv4
    address is assigned using the property 'fixed_ips' map property 'ip_address'
    and the parameter type is defined as a comma_delimited_list, the parameter
    name **MUST** follow the naming convention

       * '{vm-type}\_int\_{network-role}_ips'

    where

       * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
       * '{network-role}' is the {network-role} of the internal network

.. req::
    :id: R-90206
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
    parameter '{vm-type}\_int\_{network-role}_int_ips' **MUST** be enumerated in
    the VNF's Heat Orchestration Template's Environment File.

The IP address is local to the VNF's internal network and is (re)used
in every VNF spin up, thus the constant value is declared in the VNF's
Heat Orchestration Template's Environment File.

.. 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


.. req::
    :id: R-27818
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' is attaching to an internal network, and an IPv6 address
    is assigned using the property 'fixed_ips' map property 'ip_address' and
    the parameter type is defined as a string, the parameter name **MUST** follow
    the naming convention

       * '{vm-type}\_int\_{network-role}\_v6\_ip\_{index}'

    where

       * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
       * '{network-role}' is the {network-role} of the internal network
       * the value for {index} must start at zero (0) and increment by one

.. req::
    :id: R-97201
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
    parameter '{vm-type}\_int\_{network-role}\_v6\_ip\_{index}'
    **MUST** be enumerated in the VNF's Heat Orchestration
    Template's Environment File.

The IP address is local to the VNF's internal network and is (re)used
in every VNF spin up, thus the constant value is declared in the VNF's
Heat Orchestration Template's Environment File.

*Example Internal Network IPv6 Address string Parameter Definition*

.. code-block:: yaml

  parameters:

    {vm-type}_int_{network-role}_v6_ip_{index}:
      type: string
      description: Fixed IPv6 assignment for {vm-type} VM {index} on the int_{network-role} network


.. req::
    :id: R-29765
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' is attaching to an internal network, and an IPv6
    address is assigned using the property 'fixed_ips' map property 'ip_address'
    and the parameter type is defined as a comma_delimited_list, the parameter
    name **MUST** follow the naming convention

       * '{vm-type}\_int\_{network-role}_v6_ips'

    where

       * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
       * '{network-role}' is the {network-role} of the internal network

*Example Internal Network IPv6 Address comma_delimited_list Parameter
Definition*

.. code-block:: yaml

  parameters:

    {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


.. req::
    :id: R-98569
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
    parameter '{vm-type}\_int\_{network-role}_v6_ips' **MUST** be enumerated in
    the VNF's Heat Orchestration Template's Environment File.

The IP address is local to the VNF's internal network and is (re)used
in every VNF spin up, thus the constant value is declared in the VNF's
Heat Orchestration Template's Environment File.


.. req::
    :id: R-62590
    :target: VNF
    :keyword: MUST NOT

    The VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
    parameter associated with an external network, i.e.,

    - {vm-type}_{network-role}\_ip\_{index}
    - {vm-type}_{network-role}\_ip\_v6\_{index}
    - {vm-type}_{network-role}_ips
    - {vm-type}_{network-role}_v6_ips

    **MUST NOT** be enumerated in the Heat Orchestration Template's Environment File.
    ONAP provides the IP address assignments at orchestration time.

.. req::
    :id: R-93496
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' property 'fixed_ips' map property 'ip_address'
    parameter associated with an internal network, i.e.,

    - {vm-type}\_int\_{network-role}\_ip\_{index}
    - {vm-type}\_int\_{network-role}\_ip\_v6\_{index}
    - {vm-type}\_int\_{network-role}_ips
    - {vm-type}\_int\_{network-role}_v6_ips

    **MUST** be enumerated in the Heat Orchestration Template's Environment
    File and IP addresses **MUST** be assigned.

Summary Table
_____________

.. csv-table:: **Table # OS::Neutron::Port Property fixed_ips map property ip_address Parameter Naming Convention**
   :header: Resource,Property,Map Property,Network Type,IP Address,Parameter Type,Parameter Name, Environment File
   :align: center
   :widths: auto

   OS::Neutron::Port, fixed_ips, ip_address, external, IPv4, string, {vm-type}\_{network-role}\_ip\_{index}, NO
   OS::Neutron::Port, fixed_ips, ip_address, external, IPv4, comma\_delimited\_list, {vm-type}\_{network-role}\_ips, NO
   OS::Neutron::Port, fixed_ips, ip_address, external, IPv6, string, {vm-type}\_{network-role}\_v6\_ip\_{index}, NO
   OS::Neutron::Port, fixed_ips, ip_address, external, IPv6, comma\_delimited\_list, {vm-type}\_{network-role}\_v6\_ips, NO
   OS::Neutron::Port, fixed_ips, ip_address, internal, IPv4, string, {vm-type}\_int\_{network-role}\_ip\_{index}, YES
   OS::Neutron::Port, fixed_ips, ip_address, internal, IPv4, comma\_delimited\_list, {vm-type}\_int\_{network-role}\_ips, YES
   OS::Neutron::Port, fixed_ips, ip_address, internal, IPv6, string, {vm-type}\_int\_{network-role}\_v6\_ip\_{index}, YES
   OS::Neutron::Port, fixed_ips, ip_address, internal, IPv6, comma\_delimited\_list, {vm-type}\_int\_{network-role}\_v6\_ips, YES


Examples
________

*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_oam_port_0:
      type: OS::Neutron::Port
      properties:
        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_oam_port_0:
      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 ]}

*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_oam_port_0:
      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_oam_port_0:
      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}


*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 'ctrl' to
represent an ctrl network internal to the vnf.
The '{vm-type}' has been defined as 'db' for
database.

.. code-block:: yaml

  parameters:
    int_ctrl_net_id:
      type: string
      description: Neutron UUID for the ctrl internal network
    db_int_ctrl_ips:
      type: comma_delimited_list
      description: Fixed IPv4 assignments for db VMs on the ctrl internal
      network
    db_int_ctrl_v6_ips:
      type: comma_delimited_list
      description: Fixed IPv6 assignments for db VMs on the ctrl internal
      network
  resources:
    db_0_int_ctrl_port_0:
      type: OS::Neutron::Port
      properties:
        network: { get_param: int_ctrl_net_id }
        fixed_ips: [ { "ip_address": {get_param: [ db_int_ctrl_ips, 0 ]}}, {
        "ip_address": {get_param: [ db_int_ctrl_v6_ips, 0 ]}}]
    db_1_int_ctrl_port_0:
      type: OS::Neutron::Port
      properties:
        network: { get_param: int_ctrl_net_id }
        fixed_ips:
        - "ip_address": {get_param: [ db_int_ctrl_ips, 1 ]}
        - "ip_address": {get_param: [ db_int_ctrl_v6_ips, 1 ]}


*Example: string parameters for IPv4 and IPv6 Address Assignments to an
internal network*

In this example, the int\_{network-role} has been defined as
int_ctrl to represent a control network internal to the vnf.
The {vm-type} has been defined as db for database.

.. code-block:: yaml

  parameters:
    int_ctrl_net_id:
      type: string
      description: Neutron UUID for an OAM internal network
    db_int_ctrl_ip_0:
      type: string
      description: Fixed IPv4 assignment for db VM on the oam_int network
    db_int_ctrl_ip_1:
      type: string
      description: Fixed IPv4 assignment for db VM 1 on the oam_int network
    db_int_ctrl_v6_ip_0:
      type: string
      description: Fixed IPv6 assignment for db VM 0 on the oam_int network
    db_int_ctrl_v6_ip_1:
      type: string
      description: Fixed IPv6 assignment for db VM 1 on the oam_int network
  resources:
    db_0_int_ctrl_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_int_ctrl_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: fixed\_ips, Map Property: subnet\_id
++++++++++++++++++++++++++++++++++++++++++++++

The resource 'OS::Neutron::Port' property 'fixed_ips' map
property 'subnet'/'subnet_id' is used when a
port is requesting an IP assignment via
OpenStack's DHCP Service (i.e., Cloud Assigned).

The IP address assignment will be made from the specified subnet.

Specifying the subnet is not required; it is optional.

If the network (external or internal) that the port is attaching
to only contains one subnet, specifying the subnet is
superfluous.  The IP address will be assigned from the one existing
subnet.

If the network (external or internal) that the port is attaching
to contains two or more subnets, specifying the subnet in the
'fixed_ips' map property 'subnet'/'subnet_id' determines which
subnet the IP address will be assigned from.

If the network (external or internal) that the port is attaching
to contains two or more subnets, and the subnet is not is not
specified, OpenStack will randomly(?) determine which subnet
the IP address will be assigned from.

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.


.. req::
    :id: R-38236
    :target: VNF
    :keyword: MUST

    The VNF's Heat Orchestration Template's resource
    'OS::Neutron::Port' property 'fixed_ips' map property
    'subnet'/'subnet_id' parameter **MUST** be declared type 'string'.

.. req::
    :id: R-62802
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's resource
    'OS::Neutron::Port' is attaching to an external network, and an IPv4
    address is being Cloud Assigned by OpenStack's DHCP Service and the
    external network IPv4 subnet is to be specified using the property
    'fixed_ips' map property 'subnet'/'subnet_id', the parameter **MUST**
    follow the naming convention

       * '{network-role}_subnet_id'

    where

       * '{network-role}' is the network role of the network.

.. req::
    :id: R-83677
    :target: VNF
    :keyword: MUST NOT

    The VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' property 'fixed_ips' map property
    subnet'/'subnet_id' parameter '{network-role}_subnet_id'
    **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's
    Environment File.

ONAP's SDN-Controller provides the network's subnet's UUID
value at orchestration to the Heat Orchestration Template.

*Example Parameter Definition*

.. code-block:: yaml

  parameters:

    {network-role}_subnet_id:
      type: string
      description: Neutron IPv4 subnet UUID for the {network-role} network


.. req::
    :id: R-15287
    :target: VNF
    :keyword: MUST

    When the VNF's Heat Orchestration Template's resource
    'OS::Neutron::Port' is attaching to an external network, and an IPv6
    address is being Cloud Assigned by OpenStack's DHCP Service and the
    external network IPv6 subnet is to be specified using the property
    'fixed_ips' map property 'subnet'/'subnet_id', the parameter **MUST**
    follow the naming convention

       * '{network-role}_subnet_v6_id'

    where

       * '{network-role}' is the network role of the network.

.. req::
    :id: R-80829
    :target: VNF
    :keyword: MUST NOT

    The VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' property 'fixed_ips' map property
    subnet'/'subnet_id' parameter '{network-role}_subnet_v6_id'
    **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's
    Environment File.

ONAP's SDN-Controller provides the network's subnet's UUID
value at orchestration to the Heat Orchestration Template.

*Example Parameter Definition*

.. code-block:: yaml

  parameters:

    {network-role}_v6_subnet_id:
      type: string
      description: Neutron IPv6 subnet UUID for the {network-role} network


*Example: One Cloud Assigned IPv4 Address (DHCP) assigned to a network
that has two or more IPv4 subnets*

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 IPv4 subnet UUID for the oam network
  resources:
    lb_0_oam_port_0:
      type: OS::Neutron::Port
        parameters:
          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 IPv4 subnet UUID for the oam network
    oam_v6_subnet_id:
      type: string
      description: Neutron IPv6 subnet UUID for the oam network
  resources:
    lb_0_oam_port_0:
      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 }


.. req::
    :id: R-84123
    :target: VNF
    :keyword: MUST

    When

    - the VNF's Heat Orchestration Template's resource 'OS::Neutron::Port'
      in an Incremental Module is attaching to an internal network
      that is created in the Base Module, AND
    - an IPv4 address is being Cloud Assigned by OpenStack's DHCP Service AND
    - the internal network IPv4 subnet is to be specified using the
      property 'fixed_ips' map property 'subnet'/'subnet_id',

    the parameter **MUST** follow the naming convention
       * 'int\_{network-role}_subnet_id'
    where
       * '{network-role}' is the network role of the internal network

    - Note that the parameter **MUST** be defined as an 'output' parameter in
      the base module.

.. req::
    :id: R-69634
    :target: VNF
    :keyword: MUST NOT

    The VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' property 'fixed_ips' map property
    subnet'/'subnet_id' parameter 'int\_{network-role}_subnet_id'
    **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's
    Environment File.

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, the output parameter name will be defined as
input parameter.

*Example Parameter Definition*

.. code-block:: yaml

  parameters:

    int_{network-role}_subnet_id:
      type: string
      description: Neutron IPv4 subnet UUID for the int_{network-role} network


.. req::
    :id: R-76160
    :target: VNF
    :keyword: MUST

    When

    - the VNF's Heat Orchestration Template's resource
      'OS::Neutron::Port' in an Incremental Module is attaching to an
      internal network that is created in the Base Module, AND
    - an IPv6 address is being Cloud Assigned by OpenStack's DHCP Service AND
    - the internal network IPv6 subnet is to be specified using the property
      'fixed_ips' map property 'subnet'/'subnet_id',

    the parameter **MUST** follow the naming convention
       * 'int\_{network-role}_v6_subnet_id'
    where
       * '{network-role}' is the network role of the internal network

    - Note that the parameter **MUST** be defined as an 'output' parameter in
      the base module.

.. req::
    :id: R-22288
    :target: VNF
    :keyword: MUST NOT

    The VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' property 'fixed_ips' map property
    'subnet'/'subnet_id' parameter 'int\_{network-role}_v6_subnet_id'
    **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's
    Environment File.

*Example Parameter Definition*

.. code-block:: yaml

  parameters:

    int_{network-role}_v6_subnet_id:
      type: string
      description: Neutron subnet UUID for the int_{network-role} network


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 allow for a Virtual IP (VIP) address
to be shared among two or more ports, with one designated as the master
and the others as backups. In case the master fails,
the Virtual IP address is mapped to a backup's IP address and
the backup becomes the master.

Note that the management of the VIP IP addresses (i.e. transferring
ownership between active and standby VMs) is the responsibility of
the VNF application.


.. req::
    :id: R-62300
    :target: VNF
    :keyword: MUST

    If a VNF has two or more ports that require a Virtual IP Address (VIP),
    a VNF's Heat Orchestration Template's Resource 'OS::Neutron::Port' property
    'allowed_address_pairs' map property 'ip_address' parameter **MUST** be used.

The 'allowed_address_pairs' is an optional property. It is not required.

ONAP automation supports the assignment of VIP addresses
for external networks. ONAP support the assignment of one IPv4 VIP address
and/or one IPv6 VIP address to a set of ports associated with a
'{vm-type}' and '{network-role}'.

If a VNF requires more than one IPv4 VIP address
and/or more than one IPv6 VIP address to a set of ports associated with a
'{vm-type}' and '{network-role}', there are "manual" work-around
procedures that can be utilized.

VIP Assignment, External Networks, Supported by Automation
__________________________________________________________



.. req::
    :id: R-91810
    :target: VNF
    :keyword: MUST NOT
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If a VNF requires ONAP to assign a Virtual IP (VIP) Address to
    ports connected an external network, the port
    **MUST NOT** have more than one IPv4 VIP address.

.. req::
    :id: R-41956
    :target: VNF
    :keyword: MUST NOT
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If a VNF requires ONAP to assign a Virtual IP (VIP) Address to
    ports connected an external network, the port
    **MUST NOT** have more than one IPv6 VIP address.

.. req::
    :id: R-10754
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If a VNF has two or more ports that
    attach to an external network that require a Virtual IP Address (VIP),
    and the VNF requires ONAP automation to assign the IP address,
    all the Virtual Machines using the VIP address **MUST**
    be instantiated in the same Base Module Heat Orchestration Template
    or in the same Incremental Module Heat Orchestration Template.

.. req::
    :id: R-98748
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    The VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' property 'allowed_address_pairs'
    map property 'ip_address' parameter
    **MUST** be declared as type 'string'.

.. req::
    :id: R-41492
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    When the VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' is attaching to an external network,
    and an IPv4 Virtual IP (VIP) address is assigned via ONAP automation
    using the property 'allowed_address_pairs' map property 'ip_address' and
    the parameter name **MUST** follow the naming convention

       * '{vm-type}_{network-role}_floating_ip'

    where

       * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
       * '{network-role}' is the {network-role} of the external network

    And the parameter **MUST** be declared as type 'string'.

.. req::
    :id: R-83412
    :target: VNF
    :keyword: MUST NOT
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    The VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' property 'allowed_address_pairs'
    map property 'ip_address' parameter
    '{vm-type}_{network-role}_floating_ip'
    **MUST NOT** be enumerated in the
    VNF's Heat Orchestration Template's Environment File.

*Example Parameter Definition*

.. code-block:: yaml

  parameters:

    {vm-type}_{network-role}_floating_ip:
      type: string
      description: IPv4 VIP for {vm-type} VMs on the {network-role} network




.. req::
    :id: R-35735
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    When the VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' is attaching to an external network,
    and an IPv6 Virtual IP (VIP) address is assigned via ONAP automation
    using the property 'allowed_address_pairs' map property 'ip_address',
    the parameter name **MUST** follow the naming convention

       * '{vm-type}_{network-role}_v6_floating_ip'

    where

       * '{vm-type}' is the {vm-type} associated with the OS::Nova::Server
       * '{network-role}' is the {network-role} of the external network

    And the parameter **MUST** be declared as type 'string'.

.. req::
    :id: R-83418
    :target: VNF
    :keyword: MUST NOT
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    The VNF's Heat Orchestration Template's Resource
    'OS::Neutron::Port' property 'allowed_address_pairs'
    map property 'ip_address' parameter
    '{vm-type}_{network-role}_floating_v6_ip'
    **MUST NOT** be enumerated in the
    VNF's Heat Orchestration Template's Environment File.

*Example Parameter Definition*

.. code-block:: yaml

  parameters:

    {vm-type}_{network-role}_floating_v6_ip:
      type: string
      description: VIP for {vm-type} VMs on the {network-role} network

Note that these parameters are **not** intended to represent an OpenStack
"Floating IP", 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.  That is, ONAP does not support the
resources 'OS::Neutron::FloatingIP'
and 'OS::Neutron::FloatingIPAssociation'.


.. req::
    :id: R-05257
    :target: VNF
    :keyword: MUST NOT
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's **MUST NOT**
    contain the Resource 'OS::Neutron::FloatingIP'.

.. req::
    :id: R-76449
    :target: VNF
    :keyword: MUST NOT
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's **MUST NOT**
    contain the Resource 'OS::Neutron::FloatingIPAssociation'.

The Floating IP functions as a NAT.  They are allocated within
Openstack, and always "terminate" within the Openstack infrastructure.
When Openstack receives packets on a Floating IP, the packets will
be forwarded to the
Port that has been mapped to the Floating IP, using the private address of the
port.  The VM never sees or knows about the Openstack Floating IP.
The process to use is:

  - User allocates a floating IP from the Openstack pool.
  - User 'attaches' that floating IP to one of the VM ports.

If there is a high-availability VNF that wants to "float" the IP to a
different VM, it requires a Neutron command to request Openstack to 'attach'
the floating IP to a different VM port.
The pool of such addresses is managed by Openstack infrastructure.
Users cannot create new ones, they can only choose from those in the pool.
The pool is typically global (i.e. any user/tenant can grab them).

Allowed address pairs are for more typical Linux-level "virtual IPs".
They are additional IP addresses that are advertised by some port on the VM,
in addition to the primary private IP address.  Typically in a
high-availability VNF, an additional IP is assigned and will float between
VMs (e.g., via some health-check app that will plumb the IP on one or other
VM).  In order for this to work, the actual packets must be addressed to that
IP address (and the allowed_ip_address list will let it pass through
to the VM).  This generally requires provider network access
(i.e. direct access to a data center network for the VMs), such that these
IPs can pass through all of the virtual routers.
Contrail also provides the enhanced networking that allows routing of such
additional IPs.

Floating IPs are not used in ONAP due to the NAT-ting nature of the IPs,
the inability to reserve such IPs for specific use, the need to manage them
via Openstack commands (i.e. a HA VNF would require direct access to
Openstack to 'float' such an IP from one VM to another).

*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_oam_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_oam_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}}]


VIP Assignment, External Networks, Additional Options
_____________________________________________________

The parameter {'vm-type}_{network-role}_floating_ip' allows for only one
allowed address pair IPv4 address per '{vm-type}' and '{network-role}'
combination.

The parameter '{vm-type}_{network-role}_floating_v6_ip' allows for only one
allowed address pair IPv6 address per '{vm-type}' and '{network-role}'
combination.

If there is a need for multiple allowed address pair IPs for a given
{vm-type} and {network-role} combination within a VNF, there are two
options.

**Option One**

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' Map Property
'ip_address' should be used or the Property 'allowed_address_pairs'
Map Property 'ip_address'. The
parameter names are provided in the table below.

.. csv-table:: **Table 5 OS::Neutron::Port Property allowed_address_pairs map property ip_address Parameter Naming Convention**
   :header: IP Address,Parameter Type,Parameter Name
   :align: center
   :widths: auto

   IPv4, string, {vm-type}_{network-role}_ip_{index}
   IPv4, comma_delimited_list, {vm-type}_{network-role}_ips
   IPv6, string, {vm-type}_{network-role}_v6_ip_{index}
   IPv6, comma_delimited_list, {vm-type}_{network-role}_v6_ips

The examples below illustrate this concept.

*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_oam_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_oam_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_oam_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_oam_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_oam_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_oam_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.

**Option Two**

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 table below can be used.

**Resource OS::Neutron::Port**

Table 6: Multiple allowed_address_pairs Option 2A

.. csv-table:: **Table 6 OS::Neutron::Port Property allowed_address_pairs map property ip_address Parameter Naming Convention**
   :header: IP Address,Parameter Type,Parameter Name
   :align: center
   :widths: auto

   IPv4, string, {vm-type}_{network-role}_vip_{index}
   IPv4, comma_delimited_list, {vm-type}_{network-role}_vips
   IPv6, string, {vm-type}_{network-role}_v6_vip_{index}
   IPv6, comma_delimited_list, {vm-type}_{network-role}_v6_vips


If there is a need for multiple allowed address pair IPs for a given
'{vm-type}' and '{network-role}' combination within a VNF and the need to
differentiate the VIPs for different traffic types (e.g., 911 VIP,
fail-over VIP), then the parameter names defined for the table below can
be used.

**Resource OS::Neutron::Port**

Table 7: Multiple allowed_address_pairs Option 2B

.. csv-table:: **Table 7 OS::Neutron::Port Property allowed_address_pairs map property ip_address Parameter Naming Convention**
   :header: IP Address,Parameter Type,Parameter Name
   :align: center
   :widths: auto

   IPv4, string, {vm-type}_{network-role}_{vip_type}_vip
   IPv4, comma_delimited_list, {vm-type}_{network-role}_{vip_type}_vips
   IPv6, string, {vm-type}_{network-role}_{vip_type}_v6_vip
   IPv6, comma_delimited_list, {vm-type}_{network-role}_{vip_type}_v6_vips

Internal Networks
_________________

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 (to the cloud) gateway or an
external (to the cloud) router.

ONAP internal networks should be created in the base module.

As previously mentioned,
ports that connect to an internal network are assigned IP addresses
via one of two methods

 * Method 1: Cloud assigned by OpenStack's DHCP Service
 * Method 2: Statically assigned.  That is, predetermined by the VNF designer
   and are specified in the VNF's Heat Orchestration Template's
   Environment File

If Cloud assigned IP addressing is being used, output statements
are created in the base module.

If static assigned IP addressing is being used, the  IP addresses
are defined in the environment file.


  * {vm-type}_int_{network-role}_floating_ip
  * {vm-type}_int_{network-role}_floating_v6_ip

  * {vm-type}_int_{network-role}_vip_{index}
  * {vm-type}_int_{network-role}_vips
  * {vm-type}_int_{network-role}_v6_vip_{index}
  * {vm-type}_int_{network-role}_v6_vips


  * {vm-type}_int_{network-role}_{vip_type}_vip
  * {vm-type}_int_{network-role}_{vip_type}_vips
  * {vm-type}_int_{network-role}_{vip_type}_v6_vip
  * {vm-type}_int_{network-role}_{vip_type}_v6_vips



*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




allowed_address_pair IP Addresses Required in more than one module
__________________________________________________________________

If the IP address {vm-type}_{network-role}_floating_ip and/or
{vm-type}_{network-role}_floating_v6_ip must be used in more than module in the
VNF, the parameter values must be defined as output values in the base
module with output names: {vm-type}_{network-role}_shared_vip or
{vm-type}_{network-role}_v6_shared_vip

.. code-block:: yaml

  outputs:
    {vm-type}_{network-role}_shared_vip:
      description:
      value: { get_param: {vm-type}_{network-role}_floating_ip }

    {vm-type}_{network-role}_v6_shared_vip:
      description:
      value: { get_param: {vm-type}_{network-role}_v6_floating_ip }

The output parameters must be defined as input parameter in the
incremental modules that require the IP addresses. When defining the
allowed_address_pairs: in the OS::Neutron::Port, it should be as
follows:

.. code-block:: yaml

  allowed_address_pairs: [ { "ip_address": {get_param:
  {vm-type}_{network-role}_shared_vip }}, { "ip_address": {get_param:
  {vm-type}_{network-role}_v6_shared_vip }}]

Reserve Port Concept
____________________

A "Reserve Port" is an OS::Neutron::Port that fixed_ips, ip_address
property is assigned one or more IP addresses that are used as Virtual
IP (VIP) Addresses (i.e., allowed_address_pairs) on other ports.

A "Reserve Port" is never attached to a Virtual Machine
(OS::Nova::Server). The reserve port ensures that the intended
allowed_address_pair IP address is not inadvertently assigned as a
fixed_ips to a OS::Neutron::Port that is attached OS::Nova::Server and
thus causing routing issues.

A VNF may have one or more "Reserve Ports". A reserve port maybe created
in the base module or an incremental module. If created in the base
module, parameters may be defined in the outputs: section of the base
template so the IP Address assigned to the reserve port maybe assigned
to the allowed_address_pair property of an OS::Neutron::Port in one or
more incremental modules.

The parameter name of the IP address used in the "Reserve Port" depends
on the allowed_address_pair "option" utilized by the VNF.

When creating a Reserve Port, if only one allowed_address_pair is configured
on a port, then the parameter name depends upon the IP addresses type
(IPv4 or IPv6) and network type (internal or external).
The valid parameter names are:

  * {vm-type}_{network-role}_floating_ip
  * {vm-type}_{network-role}_floating_v6_ip
  * {vm-type}_int_{network-role}_floating_ip
  * {vm-type}_int_{network-role}_floating_v6_ip

When creating a Reserve Port, if more than one (e.g., multiple)
allowed_address_pair is configured on a port, then the parameter name depends
upon the IP addresses type (IPv4 or IPv6) and network type
(internal or external) and the option being used.  The valid parameter
names are:

  * {vm-type}_{network-role}_ip_{index}
  * {vm-type}_{network-role}_ips
  * {vm-type}_{network-role}_v6_ip_{index}
  * {vm-type}_{network-role}_v6_ips
  * {vm-type}_{network-role}_vip_{index}
  * {vm-type}_{network-role}_vips
  * {vm-type}_{network-role}_v6_vip_{index}
  * {vm-type}_{network-role}_v6_vips
  * {vm-type}_{network-role}_{vip-type}_vip
  * {vm-type}_{network-role}_v6_{vip-type}_vip
  * {vm-type}_{network-role}_{vip-type}_vips
  * {vm-type}_{network-role}_v6_{vip-type}_vips

*Example IPv4 Reserve Port Definition: one allowed_address_pair
configured on a port*

.. code-block:: yaml

  Reserve_Port_{vm-type}_{network-role}_floating_ip_{index}:
    type: OS::Neutron::Port
    properties:
      network: { get_param: {network-role}_net_id }
      fixed_ips:
        - ip_address : { get_param: {vm-type}_{network-role}_floating_ip }

*Example IPv6 Reserve Port Definition: one allowed_address_pair
configured on a port*

.. code-block:: yaml

  Reserve_Port_{vm-type}_{network-role}_floating_v6_ip_{index}:
    type: OS::Neutron::Port
    properties:
      network: { get_param: {network-role}_net_id }
      fixed_ips:
        - ip_address : { get_param: {vm-type}_{network-role}_floating_v6_ip }


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.


.. req::
    :id: R-85734
    :target: VNF
    :keyword: MUST

    If a VNF's Heat Orchestration Template contains the property 'name'
    for a non 'OS::Nova::Server' resource, the intrinsic function
    'str_replace' **MUST** be used in conjunction with the ONAP
    supplied metadata parameter 'vnf_name' to generate a unique value.

This prevents the enumeration of a
unique value for the property name in a per instance environment file.


.. req::
    :id: R-99812
    :target: VNF
    :keyword: MUST NOT
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A value for VNF's Heat Orchestration Template's property 'name'
    for a non 'OS::Nova::Server' resource **MUST NOT** be declared
    in the VNF's Heat Orchestration Template's Environment File.

In most cases the use of the metadata value 'vnf_name' is required to create a
unique property name.  If this will not provide a unique value,
additional options include:

 - Using the Heat Orchestration Template pseudo parameter
   'OS::stack_name' in the str_replace construct
 - Resources created in a nested heat file invoked by an
   'OS::Heat::ResourceGroup' can use the 'index' to construct a unique name


.. req::
    :id: R-32408
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If a VNF's Heat Orchestration Template property 'name'
    for a non 'OS::Nova::Server' resource uses the intrinsic function
    'str_replace' in conjunction with the ONAP
    supplied metadata parameter 'vnf_name' and does not create
    a unique value, additional data **MUST** be used in the
    'str_replace' to create a unique value, such as 'OS::stack_name'
    and/or the 'OS::Heat::ResourceGroup' 'index'.

*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_volume_0:
      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' }
  . . . .

*Example: Property 'name' for resource 'OS::Cinder::Volume' invoked by a
'OS::Heat::ResourceGroup'*

.. code-block:: yaml

  resources:
    dns_volume_0:
      type: OS::Cinder::Volume
      properties:
        description: Cinder Volume
        name:
          str_replace:
              template: VNF_NAME_STACK_NAME_dns_volume_INDEX
              params:
                  VNF_NAME: { get_param: vnf_name }
                  STACK_NAME: { get_param: 'OS::stack_name' }
                  INDEX: { get_param: index }
  . . . .

Contrail Issue with Values for the Property Name
++++++++++++++++++++++++++++++++++++++++++++++++


.. req::
    :id: R-84517
    :target: VNF
    :keyword: SHOULD
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    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 **SHOULD** 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.


.. req::
    :id: R-97726
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Base Module Output
    Parameter names **MUST** contain {vm-type} and/or {network-role}
    when appropriate.

ONAP Volume Template Output Parameters:
+++++++++++++++++++++++++++++++++++++++


.. req::
    :id: R-88524
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's Volume Template
    Output Parameter names **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.


.. req::
    :id: R-47874
    :target: VNF
    :keyword: MAY
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF **MAY** have

     * Only an IPv4 OAM Management IP Address
     * Only an IPv6 OAM Management IP Address
     * Both a IPv4 and IPv6 OAM Management IP Addresses

.. req::
    :id: R-18683
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If a VNF has one IPv4 OAM Management IP Address and the
    IP Address needs to be inventoried in ONAP's A&AI
    database, an output parameter **MUST** be declared in only one of the
    VNF's Heat Orchestration Templates and the parameter **MUST** be named
    'oam_management_v4_address'.

.. req::
    :id: R-94669
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If a VNF has one IPv6 OAM Management IP Address and the
    IP Address needs to be inventoried in ONAP's AAI
    database, an output parameter **MUST** be declared in only one of the
    VNF's Heat Orchestration Templates and the parameter **MUST** be named
    'oam_management_v6_address'.

The OAM Management IP Address maybe assigned either via
  *  ONAP SDN-C
  *  DHCP


.. req::
    :id: R-56287
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If the VNF's OAM Management IP Address is assigned by ONAP SDN-C and
    assigned in the VNF's Heat Orchestration Template's via a heat resource
    'OS::Neutron::Port' property 'fixed_ips' map property
    'ip_adress' parameter (e.g., '{vm-type}_{network-role}_ip_{index}',
    '{vm-type}_{network-role}_v6_ip_{index}')
    and the OAM IP Address is required to be inventoried in ONAP AAI,
    then the parameter **MUST** be echoed in an output statement.

.. code-block:: yaml

   outputs:
       oam_management_v4_address:
         value: {get_param: {vm-type}_{network-role}_ip_{index} }
       oam_management_v6_address:
         value: {get_param: {vm-type}_{network-role}_v6_ip_{index} }

*Example: ONAP 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_0_oam_port_0:
      type: OS::Neutron::Port
      properties:
        name:
          str_replace:
            template: VNF_NAME_admin_oam_port_0
            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_0:
      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_0_oam_net_port_0 }
      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 }


.. req::
    :id: R-48987
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If the VNF's OAM Management IP Address is Cloud assigned and
    and the OAM IP Address is required to be inventoried in ONAP AAI,
    then the parameter **MUST** be obtained by the resource 'OS::Neutron::Port'
    attribute 'ip_address'.

.. code-block:: yaml

   outputs:
       oam_management_v4_address:
         value: {get_attr: [ {OS::Neutron Port Resource ID}, fixed_ips, 0, ip_address] }

*Example: Cloud Assigned IP Address output as oam_management_v4_address*

.. code-block:: yaml

  parameters:
  . . .
  resources:
    admin_0_oam_port_0:
      type: OS::Neutron::Port
      properties:
        name:
          str_replace:
            template: VNF_NAME_admin_oam_0_port
            params:
              VNF_NAME: {get_param: vnf_name}
        network: { get_param: oam_net_id }
        security_groups: [{ get_param: security_group }]
    admin_server_0:
      type: OS::Nova::Server
      properties:
        name: { get_param: admin_name_0 }
        image: { get_param: admin_image_name }
        flavor: { get_param: admin_flavor_name }
        availability_zone: { get_param: availability_zone_0 }
        networks:
          - port: { get_resource: admin_0_oam_port_0 }
        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_0_oam_port_0, fixed_ips, 0, ip_address] }

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
_________________


.. req::
    :id: R-02164
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    When a VNF's Heat Orchestration Template's Contrail resource
    has a property that
    references an external network that requires the network's
    Fully Qualified Domain Name (FQDN), the property parameter

       * **MUST** follow the format '{network-role}_net_fqdn'
       * **MUST** be declared as type 'string'
       * **MUST NOT** be enumerated in the NF's Heat Orchestration Template's
         Environment File

.. req::
    :id: R-73228
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's parameter
    '{network-role}_net_fqdn'
    **MUST** be declared as type 'string'.

.. req::
    :id: R-92193
    :target: VNF
    :keyword: MUST NOT
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    A VNF's Heat Orchestration Template's parameter
    '{network-role}_net_fqdn'
    **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's
    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_0_oam_vmi_0:
    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
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++


.. req::
    :id: R-28222
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If a VNF's Heat Orchestration Template
    'OS::ContrailV2::InterfaceRouteTable' resource
    'interface_route_table_routes' property
    'interface_route_table_routes_route' map property parameter name
    **MUST** follow the format

       * {vm-type}_{network-role}_route_prefixes

.. req::
    :id: R-19756
    :target: VNF
    :keyword: MUST
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If a VNF's Heat Orchestration Template
    'OS::ContrailV2::InterfaceRouteTable' resource
    'interface_route_table_routes' property
    'interface_route_table_routes_route' map property parameter
    '{vm-type}_{network-role}_route_prefixes'
    **MUST** be defined as type 'json'.

.. req::
    :id: R-76682
    :target: VNF
    :keyword: MUST NOT
    :test: no test found
    :test_case: no test found
    :test_file: no test found

    If a VNF's Heat Orchestration Template
    'OS::ContrailV2::InterfaceRouteTable' resource
    'interface_route_table_routes' property
    'interface_route_table_routes_route' map property parameter
    '{vm-type}_{network-role}_route_prefixes'
    **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's
    Environment File.

The parameter '{vm-type}_{network-role}_route_prefixes'
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)


*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_oam_route_prefixes:
      type: json
      description: prefix for the ServiceInstance InterfaceRouteTable
    int_fw_dns_trusted_interface_type:
      type: string
      description: service_interface_type for ServiceInstance

  resources:
    <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_oam_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: oam_interface_type }

Resource OS::ContrailV2::InstanceIp
+++++++++++++++++++++++++++++++++++

The Contrail resource OS::ContrailV2::InstanceIp has two properties
that parameters **MUST** follow an explicit naming convention.  The
properties are 'instance_ip_address' and 'subnet_uuid'.

*Example OS::ContrailV2::InstanceIp Resource*

.. code-block:: yaml

  <resource ID>:
    type: OS::ContrailV2::InstanceIp
    properties:
      name: { get_param: name }
      fq_name: { get_param: fq_name }
      display_name: { get_param: display_name }
      secondary_ip_tracking_ip:
        {
          secondary_ip_tracking_ip_ip_prefix: { get_param: secondary_ip_tracking_ip_ip_prefix },
          secondary_ip_tracking_ip_ip_prefix_len: { get_param: secondary_ip_tracking_ip_ip_prefix_len },
        }
      instance_ip_address: { get_param: instance_ip_address }
      instance_ip_mode: { get_param: instance_ip_mode }
      subnet_uuid: { get_param: subnet_uuid }
      instance_ip_family: { get_param: instance_ip_family }
      annotations:
        {
          annotations_key_value_pair:
            [{
              annotations_key_value_pair_key: { get_param: annotations_key_value_pair_key },
              annotations_key_value_pair_value: { get_param: annotations_key_value_pair_value },
            }],
        }
      instance_ip_local_ip: { get_param: instance_ip_local_ip }
      instance_ip_secondary: { get_param: instance_ip_secondary }
      physical_router_refs: [{ get_param: physical_router_refs }]
      virtual_machine_interface_refs: [{ get_param: virtual_machine_interface_refs }]
      virtual_network_refs: [{ get_param: virtual_network_refs }]

Resource OS::ContrailV2::InstanceIp Property instance_ip_address
________________________________________________________________

A VNF's Heat Orchestration Templates resource 'OS::ContrailV2::InstanceIp'
property 'instance_ip_address' parameter
**MUST** follow the same requirements
that apply to the resource 'OS::Neutron' property 'fixed_ips' map
property 'ip_address' parameter.

*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

  fw_0_oam_protected_vmi_0_IP_0:
    type: OS::ContrailV2::InstanceIp
    depends_on:
      - fw_0_oam_protected_vmi_0
    properties:
      virtual_machine_interface_refs:
        - get_resource: fw_0_oam_protected_vmi_0
      virtual_network_refs:
        - get_param: oam_protected_net_fqdn
      instance_ip_address: { get_param: [fw_oam_protected_ips, get_param: index ] }

Resource OS::ContrailV2::InstanceIp Property subnet_uuid
________________________________________________________________

A VNF's Heat Orchestration Templates resource 'OS::ContrailV2::InstanceIp'
property 'subnet_uuid' parameter
**MUST** follow the same requirements
that apply to the resource 'OS::Neutron' property 'fixed_ips' map
property 'subnet'/'subnet_id' parameter.

*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

  fw_0_oam_protected_vmi_0_IP_0:
    type: OS::ContrailV2::InstanceIp
    depends_on:
    - fw_0_oam_protected_vmi_0
    properties:
      virtual_machine_interface_refs:
        - get_resource: fw_0_oam_protected_vmi_0
      virtual_network_refs:
        - get_param: oam_protected_net_fqdn
      subnet_uuid: { get_param: oam_protected_subnet_id }

OS::ContrailV2::VirtualMachineInterface Property virtual_machine_interface_allowed_address_pairs
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++


A VNF's Heat Orchestration Templates resource
'OS::ContrailV2::VirtualMachineInterface' map property,
virtual_machine_interface_allowed_address_pairs,
virtual_machine_interface_allowed_address_pairs_allowed_address_pair,
virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip,
virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix
parameter **MUST** follow the same requirements that apply to the
resource 'OS::Neutron::Port' property
'allowed_address_pairs', map property 'ip_address' parameter.

*Example OS::ContrailV2::VirtualMachineInterface*

.. code-block:: yaml

  <resource ID>:
    type: OS::ContrailV2::VirtualMachineInterface
    properties:
      name: { get_param: name }
      fq_name: { get_param: fq_name }
      ecmp_hashing_include_fields:
        {
          ecmp_hashing_include_fields_hashing_configured: { get_param: ecmp_hashing_include_fields_hashing_configured },
          ecmp_hashing_include_fields_source_ip: { get_param: ecmp_hashing_include_fields_source_ip },
          ecmp_hashing_include_fields_destination_ip: { get_param: ecmp_hashing_include_fields_destination_ip },
          ecmp_hashing_include_fields_ip_protocol: { get_param: ecmp_hashing_include_fields_ip_protocol },
          ecmp_hashing_include_fields_source_port: { get_param: ecmp_hashing_include_fields_source_port },
          ecmp_hashing_include_fields_destination_port: { get_param: ecmp_hashing_include_fields_destination_port },
        }
      virtual_machine_interface_host_routes:
        {
          virtual_machine_interface_host_routes_route:
            [{
              virtual_machine_interface_host_routes_route_prefix: { get_param: virtual_machine_interface_host_routes_route_prefix },
              virtual_machine_interface_host_routes_route_next_hop: { get_param: virtual_machine_interface_host_routes_route_next_hop },
              virtual_machine_interface_host_routes_route_next_hop_type: { get_param: virtual_machine_interface_host_routes_route_next_hop_type },
              virtual_machine_interface_host_routes_route_community_attributes:
                {
                  virtual_machine_interface_host_routes_route_community_attributes_community_attribute: [{ get_param: virtual_machine_interface_host_routes_route_community_attributes_community_attribute }],
                },
            }],
        }
      virtual_machine_interface_mac_addresses:
        {
          virtual_machine_interface_mac_addresses_mac_address: [{ get_param: virtual_machine_interface_mac_addresses_mac_address }],
        }
      virtual_machine_interface_dhcp_option_list:
        {
          virtual_machine_interface_dhcp_option_list_dhcp_option:
            [{
              virtual_machine_interface_dhcp_option_list_dhcp_option_dhcp_option_name: { get_param: virtual_machine_interface_dhcp_option_list_dhcp_option_dhcp_option_name },
              virtual_machine_interface_dhcp_option_list_dhcp_option_dhcp_option_value: { get_param: virtual_machine_interface_dhcp_option_list_dhcp_option_dhcp_option_value },
              virtual_machine_interface_dhcp_option_list_dhcp_option_dhcp_option_value_bytes: { get_param: virtual_machine_interface_dhcp_option_list_dhcp_option_dhcp_option_value_bytes },
            }],
        }
      virtual_machine_interface_bindings:
        {
          virtual_machine_interface_bindings_key_value_pair:
            [{
              virtual_machine_interface_bindings_key_value_pair_key: { get_param: virtual_machine_interface_bindings_key_value_pair_key },
              virtual_machine_interface_bindings_key_value_pair_value: { get_param: virtual_machine_interface_bindings_key_value_pair_value },
            }],
        }
      virtual_machine_interface_disable_policy: { get_param: virtual_machine_interface_disable_policy }
      virtual_machine_interface_allowed_address_pairs:
        {
          virtual_machine_interface_allowed_address_pairs_allowed_address_pair:
            [{
              virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip:
                {
                  virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix: { get_param: virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix },
                  virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix_len: { get_param: virtual_machine_interface_allowed_address_pairs_allowed_address_pair_ip_ip_prefix_len },
                },
              virtual_machine_interface_allowed_address_pairs_allowed_address_pair_mac: { get_param: virtual_machine_interface_allowed_address_pairs_allowed_address_pair_mac },
              virtual_machine_interface_allowed_address_pairs_allowed_address_pair_address_mode: { get_param: virtual_machine_interface_allowed_address_pairs_allowed_address_pair_address_mode },
            }],
        }
      annotations:
        {
          annotations_key_value_pair:
            [{
              annotations_key_value_pair_key: { get_param: annotations_key_value_pair_key },
              annotations_key_value_pair_value: { get_param: annotations_key_value_pair_value },
            }],
        }
      virtual_machine_interface_fat_flow_protocols:
        {
          virtual_machine_interface_fat_flow_protocols_fat_flow_protocol:
            [{
              virtual_machine_interface_fat_flow_protocols_fat_flow_protocol_protocol: { get_param: virtual_machine_interface_fat_flow_protocols_fat_flow_protocol_protocol },
              virtual_machine_interface_fat_flow_protocols_fat_flow_protocol_port: { get_param: virtual_machine_interface_fat_flow_protocols_fat_flow_protocol_port },
            }],
        }
      virtual_machine_interface_device_owner: { get_param: virtual_machine_interface_device_owner }
      port_security_enabled: { get_param: port_security_enabled }
      virtual_machine_interface_properties:
        {
          virtual_machine_interface_properties_service_interface_type: { get_param: virtual_machine_interface_properties_service_interface_type },
          virtual_machine_interface_properties_interface_mirror:
            {
              virtual_machine_interface_properties_interface_mirror_traffic_direction: { get_param: virtual_machine_interface_properties_interface_mirror_traffic_direction },
              virtual_machine_interface_properties_interface_mirror_mirror_to:
                {
                  virtual_machine_interface_properties_interface_mirror_mirror_to_analyzer_name: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_analyzer_name },
                  virtual_machine_interface_properties_interface_mirror_mirror_to_encapsulation: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_encapsulation },
                  virtual_machine_interface_properties_interface_mirror_mirror_to_analyzer_ip_address: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_analyzer_ip_address },
                  virtual_machine_interface_properties_interface_mirror_mirror_to_analyzer_mac_address: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_analyzer_mac_address },
                  virtual_machine_interface_properties_interface_mirror_mirror_to_routing_instance: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_routing_instance },
                  virtual_machine_interface_properties_interface_mirror_mirror_to_udp_port: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_udp_port },
                  virtual_machine_interface_properties_interface_mirror_mirror_to_juniper_header: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_juniper_header },
                  virtual_machine_interface_properties_interface_mirror_mirror_to_nh_mode: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_nh_mode },
                  virtual_machine_interface_properties_interface_mirror_mirror_to_static_nh_header:
                    {
                      virtual_machine_interface_properties_interface_mirror_mirror_to_static_nh_header_vtep_dst_ip_address: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_static_nh_header_vtep_dst_ip_address },
                      virtual_machine_interface_properties_interface_mirror_mirror_to_static_nh_header_vtep_dst_mac_address: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_static_nh_header_vtep_dst_mac_address },
                      virtual_machine_interface_properties_interface_mirror_mirror_to_static_nh_header_vni: { get_param: virtual_machine_interface_properties_interface_mirror_mirror_to_static_nh_header_vni },
                    },
                },
            },
          virtual_machine_interface_properties_local_preference: { get_param: virtual_machine_interface_properties_local_preference },
          virtual_machine_interface_properties_sub_interface_vlan_tag: { get_param: virtual_machine_interface_properties_sub_interface_vlan_tag },
        }
      display_name: { get_param: display_name }
      service_health_check_refs: [{ get_param: service_health_check_refs }]
      routing_instance_refs: [{ get_param: routing_instance_refs }]
      routing_instance_refs_data:
        [{
          routing_instance_refs_data_direction: { get_param: routing_instance_refs_data_direction },
          routing_instance_refs_data_vlan_tag: { get_param: routing_instance_refs_data_vlan_tag },
          routing_instance_refs_data_src_mac: { get_param: routing_instance_refs_data_src_mac },
          routing_instance_refs_data_dst_mac: { get_param: routing_instance_refs_data_dst_mac },
          routing_instance_refs_data_mpls_label: { get_param: routing_instance_refs_data_mpls_label },
          routing_instance_refs_data_service_chain_address: { get_param: routing_instance_refs_data_service_chain_address },
          routing_instance_refs_data_ipv6_service_chain_address: { get_param: routing_instance_refs_data_ipv6_service_chain_address },
          routing_instance_refs_data_protocol: { get_param: routing_instance_refs_data_protocol },
        }]
      security_group_refs: [{ get_param: security_group_refs }]
      physical_interface_refs: [{ get_param: physical_interface_refs }]
      port_tuple_refs: [{ get_param: port_tuple_refs }]
      interface_route_table_refs: [{ get_param: interface_route_table_refs }]
      virtual_machine_interface_refs: [{ get_param: virtual_machine_interface_refs }]
      virtual_network_refs: [{ get_param: virtual_network_refs }]
      virtual_machine_refs: [{ get_param: virtual_machine_refs }]
      qos_config_refs: [{ get_param: qos_config_refs }]
      virtual_machine: { get_param: virtual_machine }
      project: { get_param: project }



Suggested Naming Convention for Common Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Many VNFs use the parameters in the table below are used in user_data.
The table below provides a suggested naming convention for these common
parameters.

Netmask
+++++++

.. csv-table:: **Table 8: Suggested Naming Convention for Common Parameters:  Netmask**
   :header: Parameter Name,Parameter Type,Notes
   :align: center
   :widths: auto

   {network-role}_subnet_<index>_netmask, string,
   int_<network-role>_subnet_<index>_netmask, string,
   {network-role}_v6_subnet_<index>_netmask , string,
   int_{network-role}_v6_subnet_<index>_netmask, string,

CIDR
++++

.. csv-table:: **Table 9: Suggested Naming Convention for Common Parameters:  CIDR**
   :header: Parameter Name,Parameter Type,Notes
   :align: center
   :widths: auto

   <network-role>_subnet_<index>_cidr, string,
   int_<network-role>_subnet_<index>_cidr, string,
   <network-role>_v6_subnet_<index>_cidr, string,
   int_<network-role>_v6_subnet_<index>_cidr, string,

Default Gateway
+++++++++++++++

.. csv-table:: **Table 10: Suggested Naming Convention for Common Parameters:  Default Gateway**
   :header: Parameter Name,Parameter Type,Notes
   :align: center
   :widths: auto

   {network-role}_subnet_<index>_default_gateway, string,
   {network-role}_v6_subnet_<index>_default_gateway, string,

DCAE Collector IP Address
+++++++++++++++++++++++++

.. csv-table:: **Table 11: Suggested Naming Convention for Common Parameters:  DCAE Collector Address**
   :header: Parameter Name,Parameter Type,Notes
   :align: center
   :widths: auto

   dcae_collector_ip_<index>, string,
   dcae_collector_v6_ip_<index>, string,

NTP Server IP Address
+++++++++++++++++++++

.. csv-table:: **Table 12: Suggested Naming Convention for Common Parameters:  NTP Server IP Address**
   :header: Parameter Name,Parameter Type,Notes
   :align: center
   :widths: auto

   ntp_ip_<index>, string,
   ntp_v6_ip_<index>, string,

DNS
++++++++

.. csv-table:: **Table 13: Suggested Naming Convention for Common Parameters:  DCAE Collector Address**
   :header: Parameter Name,Parameter Type,Notes
   :align: center
   :widths: auto

   dns_{network-role}_ip_<index>, string,
   dns_{network-role}_v6_ip_<index>, string,

Security Group
++++++++++++++

.. csv-table:: **Table 14: Suggested Naming Convention for Common Parameters:  Security Group**
   :header: Parameter Name,Parameter Type,Notes
   :align: center
   :widths: auto

   {vm-type}_security_group, string, Security Group applicable to one {vm-type} and more than one network (internal and/or external)
   {network-role}_security_group, string, Security Group applicable to more than one {vm-type} and one external network
   int_{network-role}_security_group, string, Security Group applicable to more than one {vm-type} and one internal network
   {vm-type}_{network-role}_security_group, string, Security Group applicable to one {vm-type} and one external network
   {vm-type}_int_{network-role}_security_group, string, Security Group applicable to one {vm-type} and one internal network
   shared_security_group, string, Security Group applicable to more than one {vm-type} and more than one network (internal and/or external)

ONAP VNF Modularity
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ONAP supports a modular Heat Orchestration Template design pattern,
referred to as *VNF Modularity.* With this approach, a single VNF **MAY** be
composed from one or more Heat Orchestration Templates, each of which
represents a subset of the overall VNF. These component parts are
referred to as *VNF Modules*. During orchestration, these modules
are deployed incrementally to create the complete VNF.

As stated in R-33132, a VNF's Heat Orchestration Template **MAY** be
     1.) Base Module Heat Orchestration Template (also referred to as a
      Base Module),
     2.) Incremental Module Heat Orchestration Template (referred to as
      an Incremental Module), or
     3.) a Cinder Volume Module Heat Orchestration Template (referred to as
      Cinder Volume  Module).

As stated in R-20974, at orchestration time, the VNF's Base Module **MUST**
be deployed first, prior to any incremental modules.

As stated in R-28980, R-86926, and R-91497, a
VNF's incremental module **MAY** be used for

  * initial VNF deployment only
  * scale out only
  * both deployment and scale out

As stated in R-68122, a VNF's incremental module **MAY** be deployed
more than once, either during initial VNF deployment and/or scale out

As stated in R-37028 and R-13196, a VNF **MUST** be composed
of one Base Module and *MAY** be composed of zero to many Incremental
Modules.

ONAP also supports the concept of an optional, independently deployed
Cinder volume via a separate Heat Orchestration Templates, referred to
as a Cinder Volume Module. This allows the volume to persist after a VM
(i.e., OS::Nova::Server) is deleted, allowing the volume to be reused on
another instance (e.g., during a fail over activity).

The scope of a Cinder volume module, when it exists, must be 1:1 with a
Base module or Incremental Module.

A VNF module (base, incremental, cinder) **MAY** support nested templates.

A shared Heat Resource is a resource that **MAY** be used by
other Heat Resources either in the Base Module or an
Incremental Module.



.. req::
    :id: R-61001
    :target: VNF
    :keyword: MUST

    A shared Heat Orchestration Template resource must be defined
    in the base module. A shared resource is a resource that that will
    be referenced by another resource that is defined in the Base Module
    and/or one or more incremental modules. When the shared resource needs
    to be referenced by a resource in an incremental module, the UUID of
    the shared resource **MUST** be exposed by declaring an ONAP Base
    Module Output Parameter.

When the shared resource needs to be referenced by a resource in an
incremental module, the UUID of the shared resource must be exposed by
declaring an ONAP Base Module Output Parameter.

An example of a shared resource is the resource
OS::Neutron::SecurityGroup. Security groups are sets of IP filter rules
that are applied to a VNF’s networking. The resource OS::Neutron::Port
has a property security_groups which provides the security groups
associated with port. The value of parameter(s) associated with this
property must be the UUIDs of the resource(s)
OS::Neutron::SecurityGroup.

*Note:* A Cinder volume is not considered a shared resource. A volume
template must correspond 1:1 with a base template or add-on module
template.

Suggested Patterns for Modular VNFs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

There are numerous variations of VNF modularity. Below are two suggested
usage patterns.

**Option 1: Incremental Modules per VNFC type**

a. Base module contains only the shared resources.

b. Group all VMs (e.g., VNFCs) of a given type (i.e. {vm-type}) into its
   own incremental module. That is, the VNF has an incremental module
   for each {vm-type}.

c. For a given {vm-type} incremental module, the VNF may have

   i.  One incremental module used for both initial turn up and re-used
       for scaling. This approach is used when the number of VMs
       instantiated will be the same for initial deployment and scaling.

   ii. Two incremental modules, where one is used for initial turn up
       and one is used for scaling. This approach is used when the
       number of VMs instantiated will be different for initial
       deployment and scaling.

**Option 2: Base VNF with Incremental Growth Modules**

a. Base module contains a complete initial VNF instance

b. Incremental modules for incremental scaling units

   i.  May contain VMs of multiple types in logical scaling combinations

   ii. May be separated by VM type for multi-dimensional scaling

With no growth units, Option 2 is equivalent to the "One Heat Template
per VNF" model.

Note that modularization of VNFs is not required. A single Heat
Orchestration Template (a base module) may still define a complete VNF,
which might be appropriate for smaller VNFs that do not have any scaling
options.

Modularity Rules
~~~~~~~~~~~~~~~~~~~~~

There are some rules to follow when building modular VNF templates:

1. All VNFs must have one Base VNF Module (template) that must be the
   first one deployed. The base template:

   a. Must include all shared resources (e.g., private networks, server
      groups, security groups)

   b. Must expose all shared resources (by UUID) as "outputs" in its
      associated Heat template (i.e., ONAP Base Module Output
      Parameters)

   c. May include initial set of VMs

   d. May be operational as a stand-alone "minimum" configuration of the
      VNF

2. VNFs may have one or more incremental modules which:

   a. Defines additional resources that can be added to an existing VNF

   b. Must be complete Heat templates

      i. i.e. not snippets to be incorporated into some larger template

   c. Should define logical growth-units or sub-components of an overall
      VNF

   d. On creation, receives appropriate Base Module outputs as
      parameters

      i.  Provides access to all shared resources (by UUID)

      ii. *VNFs may have one or more incremental modules which must not be
          dependent on other Add-On VNF Modules*

   e. Multiple instances of an incremental Module may be added to the
      same VNF (e.g., incrementally grow a VNF by a fixed "add-on"
      growth units)

3. Each VNF Module (base or incremental) may have (optional) an
   associated Cinder Volume Module (see Cinder Volumes)

   a. Volume modules must correspond 1:1 with a base module or
      incremental module

   b. A Cinder volume may be embedded within the base module or
      incremental module if persistence is not required

4. Shared resource UUIDs are passed between the base module and
   incremental modules via Heat Outputs Parameters (i.e., Base Module
   Output Parameters)

   a. The output parameter name in the base must match the parameter
      name in the add-on module

VNF Modularity Examples
~~~~~~~~~~~~~~~~~~~~~~~~~

*Example: Base Module creates SecurityGroup*

A VNF has a base module, named base.yaml, that defines a
OS::Neutron::SecurityGroup. The security group will be referenced by an
OS::Neutron::Port resource in an incremental module, named
INCREMENTAL_MODULE.yaml. The base module defines a parameter in the
outputs:section named dns_sec_grp_id. dns_sec_grp_id is defined as a
parameter in the incremental module. ONAP captures the UUID value of
dns_sec_grp_id from the base module output statement and provides the
value to the incremental module.

Note that the example below is not a complete Heat Orchestration
Template. The {network-role} has been defined as oam to represent an oam
network and the {vm-type} has been defined as dns.

base_MODULE.yaml

.. code-block:: yaml

  parameters:
  . . .
  resources:
    DNS_SECURITY_GROUP:
      type: OS::Neutron::SecurityGroup
      properties:
        description: vDNS security group
        name:
        str_replace:
          template: VNF_NAME_sec_grp_DNS
          params:
            VMF_NAME: {get_param: vnf_name}
        rules: [. . . . .
        ]
  . . .
  outputs:
    dns_sec_grp_id:
      description: UUID of DNS Resource SecurityGroup
      value: { get_resource: DNS_SECURITY_GROUP }

INCREMENTAL_MODULE.yaml

.. code-block:: yaml

  parameters:
    dns_sec_grp_id:
      type: string
      description: security group UUID
  . . .

  resources:
    dns_0_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_name }
          fixed_ips: [{ "ip_address": { get_param: dns_oam_ip_0 }}]
          security_groups: [{ get_param: dns_sec_grp_id }]

*Examples: Base Module creates an internal network*

A VNF has a base module, named base_module.yaml, that creates an
internal network. An incremental module, named incremental_module.yaml,
will create a VM that will connect to the internal network. The base
module defines a parameter in the out section named int_oam_net_id.
int_oam_net_id is defined as a parameter in the incremental module.
ONAP captures the UUID value of int_oam_net_id from the base module
output statement and provides the value to the incremental module.

Note that the example below is not a complete Heat Orchestration
Template. 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.

base.yaml

.. code-block:: yaml

  heat_template_version: 2013-05-23

  resources:
    int_oam_network:
      type: OS::Neutron::Network
      properties:
        name: { }
  . . .

  outputs:
    int_oam_net_id:
    value: {get_resource: int_oam_network }

incremental.yaml

.. code-block:: yaml

  heat_template_version: 2013-05-23

  parameters:
    int_oam_net_id:
      type: string
      description: ID of shared private network from Base template
    lb_name_0:
      type: string
      description: name for the add-on VM instance

  resources:
    lb_server_0:
      type: OS::Nova::Server
      properties:
        name: {get_param: lb_name_0}
        networks:
          - port: { get_resource: get_resource: lb_0_int_oam_port_0  }
  . . .
    lb_0_int_oam_port_0:
      type: OS::Neutron::Port
        properties:
        network: { get_param: int_oam_net_id }
  ...


Cinder Volumes
^^^^^^^^^^^^^^^^^^^^^^^^

Cinder Volumes are created with the heat resource OS::Cinder::Volume.

As stated in R-46119, R-90748, R-03251, a VNF's Heat Orchestration
Template's Resource OS::Heat::CinderVolume **MAY** be defined in a
Base Module, Incremental Module, or Cinder Volume Module.

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.

If a VNF Base Module or Incremental Module has an independent volume
module, the scope of volume templates must be 1:1 with Base module or
Incremental module. A single volume module must create only the volumes
required by a single Incremental module or Base module.

As stated in R-11200, a VNF's Cinder Volume Module, when it exists,
**MUST** be 1:1 with a Base module or Incremental module.  That is,
A single volume module must create only the volumes required by a
single Incremental module or Base module.

As stated in R-30395, a VNF's Cinder Volume Module **MAY** utilize
nested heat.

As stated in R-89913, a VNF's Heat Orchestration Template's Cinder Volume
Module Output Parameter(s) **MUST** include the
UUID(s) of the Cinder Volumes created in template,
while others **MAY** be included.

As stated in R-07443, a VNF's Heat Orchestration Templates' Cinder Volume
Module Output Parameter's name and type **MUST** match the input parameter
name and type in the corresponding Base Module or Incremental Module unless
the Output Parameter is of the type 'comma_delimited_list',
then the corresponding input parameter **MUST** be declared as type 'json'.

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:


.. req::
    :id: R-79531
    :target: VNF
    :keyword: MUST

    The VNF Heat Orchestration Template **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.

Optional Property availability_zone
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. req::
    :id: R-25190
    :target: VNF
    :keyword: SHOULD NOT

    A VNF's Heat Orchestration Template's Resource 'OS::Cinder::Volume'
    **SHOULD NOT** declare the property 'availability_zone'.

If the property is used, the value **MUST**
be enumerated in the environment file and must be set to nova', which
is the default. There are no requirements on the parameter naming
convention with the exception that the naming convention **MUST NOT** be the
same as the 'OS::Nova::Server' property 'availability_zone' (i.e.,
'availability_zone_{index}').

Optional Property volume_type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

OpenStack supports multiple volume types. If the OS::Cinder::Volume optional
property volume_type is not specified, the OpenStack default volume type is
used. If a specific volume type is required, the property is used and
the value **MUST** be enumerated in the environment file. There are no
requirements on the parameter naming convention

Cinder Volume Examples
~~~~~~~~~~~~~~~~~~~~~~~~~

*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. A Heat Orchestration Template uploaded to ONAP must have a
corresponding environment file, even if no parameters are required to
be enumerated.

(Note that ONAP does not programmatically enforce the use of
an environment file.)


.. req::
    :id: R-67205
    :target: VNF
    :keyword: MUST

    The VNF Heat Orchestration Template **MUST** have a corresponding
    environment file for a Base Module.

.. req::
    :id: R-35727
    :target: VNF
    :keyword: MUST

    The VNF Heat Orchestration Template **MUST** have a
    corresponding environment file for an Incremental module.

.. req::
    :id: R-22656
    :target: VNF
    :keyword: MUST

    The VNF Heat Orchestration Template **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 SO 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.


.. req::
    :id: R-00228
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template **MAY**
    reference the nested heat statically by repeated definition.

.. req::
    :id: R-01101
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Template **MAY**
    reference the nested heat dynamically using the resource
    'OS::Heat::ResourceGroup'.

.. req::
    :id: R-60011
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template **MUST** have no more than
    two levels of nesting.

As stated in R-67231 a VNF's Heat Orchestration template's
Environment File's **MUST NOT** contain the "resource_registry:" section.

Two levels of nesting is defined as follows:  A base module, incremental
module, or cinder volume module references a nested heat file either
statically or by using the resource 'OS::Heat::ResourceGroup'.
This file is the first level of nesting.
If first level file then references a nested file, that file is
the second level of nesting.


.. req::
    :id: R-89868
    :target: VNF
    :keyword: MUST

    The VNF Heat Orchestration Template **MUST** have unique
    file names within the scope of the VNF for a nested heat yaml file.

.. req::
    :id: R-52530
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's Nested YAML file
    **MUST** be in the same directory hierarchy as the VNF's Heat
    Orchestration Templates.

.. req::
    :id: R-90022
    :target: VNF
    :keyword: MAY

    A VNF's Nested YAML file **MAY** be invoked more than
    once by a VNF's Heat Orchestration Template.

.. req::
    :id: R-04344
    :target: VNF
    :keyword: MAY

    A VNF's Nested YAML file **MAY** be invoked by more than one of
    a VNF's Heat Orchestration Templates (when the VNF is composed of two
    or more Heat Orchestration Templates).

.. req::
    :id: R-11041
    :target: VNF
    :keyword: MUST

    All parameters defined in a VNFs Nested YAML file
    **MUST** be passed in as properties of the resource calling
    the nested yaml file.

Note that:

-  As stated in requirement R-00011, a VNF's Heat Orchestration
   Template's Nested YAML file's parameter's **MUST NOT** have
   a parameter constraint defined.

-  As stated in Requirement R-44491, if a VNF's Heat Orchestration
   Template's OS::Nova::Server Resource metadata map value parameter
   'vnf\_id' is passed into a Nested YAML
   file, the parameter name 'vnf\_id' **MUST NOT** change.

-  As stated in Requirement R-86237, if a VNF's Heat Orchestration
   Template's OS::Nova::Server Resource metadata map value parameter
   'vf\_module\_id' is passed into a Nested YAML
   file, the parameter name 'vf\_module\_id' **MUST NOT** change.

-  As stated in Requirement R-16576, if a VNF's Heat Orchestration
   Template's OS::Nova::Server Resource metadata map value parameter
   'vnf\_name' is passed into a Nested YAML
   file, the parameter name 'vnf\_name' **MUST NOT** change.

-  As stated in Requirement R-49177, if a VNF's Heat Orchestration
   Template's OS::Nova::Server Resource metadata map value parameter
   'vf\_module\_name' is passed into a Nested YAML
   file, the parameter name 'vf\_module\_name' **MUST NOT** change.

-  As stated in Requirement R-70757, if a VNF's Heat Orchestration
   Template's OS::Nova::Server Resource metadata map value parameter
   'vm\_role' is passed into a Nested YAML
   file, the parameter name 'vm\_role' **MUST NOT** change.

-  As stated in Requirement R-22441, if a VNF's Heat Orchestration
   Template's OS::Nova::Server Resource metadata map value parameter
   'vf\_module\_index' is passed into a Nested YAML
   file, the parameter name 'vf\_module\_index' **MUST NOT** change.

-  As stated in Requirement R-75202, if a VNF's Heat Orchestration
   Template's OS::Nova::Server Resource metadata map value parameter
   'workload\_context' is passed into a Nested YAML
   file, the parameter name 'workload\_context' **MUST NOT** change.

-  As stated in Requirement R-62954, if a VNF's Heat Orchestration
   Template's OS::Nova::Server Resource metadata map value parameter
   'environment\_context' is passed into a Nested YAML
   file, the parameter name 'environment\_context' **MUST NOT** change.

-  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.

-  A parameter declared in the outputs: section of a nested template can
   be accessed from the parent template as an attribute (i.e., via
   get\_attr) of the "pseudo resource" whose type is in the nested
   template. In the case of a OS::Heat::ResourceGroup, an output will be
   an attribute of the OS::Heat::ResourceGroup itself, and will be an
   array from the perspective of the parent template.

.. req::
    :id: R-17528
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's first level Nested YAML file
    **MUST NOT** contain more than one ``OS::Nova::Server`` resource.
    A VNF's Heat Orchestration Template's second level Nested YAML file
    **MUST NOT** contain an ``OS::Nova::Server`` 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.

OS::Heat::ResourceGroup may be used 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:

OS::Heat::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 OS::Heat::ResourceGroup
definition.

For instance, the following is **not** valid Heat for
OS::Heat::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 OS::Heat::ResourceGroup, it will in fact result
in a Heat exception. When parameters are provided as a list (one for
each element of a OS::Heat::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} ] }

OS::Heat::ResourceGroup Property count
________________________________________


.. req::
    :id: R-50011
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's 'OS::Heat::ResourceGroup'
    property 'count' **MUST** be enumerated in the VNF's
    Heat Orchestration Template's Environment File and **MUST** be
    assigned a value.

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
OS::Heat::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 CDL by passing the availability zone parameter
into a nested heat template. An example is provided below.

base.yaml

.. code-block:: yaml

  availability_zone_list:
     type: az_list_generate.yaml
     properties:
       availability_zone_0: { get_param: availability_zone_0 }
       availability_zone_1: { get_param: availability_zone_1 }

    create_virtual_machines:
      type: OS::Heat::ResourceGroup
      properties:
        count: { get_param: count }
        index_var: $INDEX
        resource_def:
          type: nest_file.yaml
          properties:
            index: $INDEX
            availability_zone_0 : { get_attr: [availability_zone_list, general_zones ] }
            . . .

az_list_generate.yaml

.. code-block:: yaml

  parameters:
    availability_zone_0:
      type: string
      description: availability zone 0

    availability_zone_1:
      type: string
      description: availability zone 1

  outputs:

    general_zones:
      value: [
        { get_param: availability_zone_0 },
        { get_param: availability_zone_1 },
        { get_param: availability_zone_0 },
        { get_param: availability_zone_1 },
        { get_param: availability_zone_0 },
        { get_param: availability_zone_1 },
  ]


Nested Heat Template Example: OS::Heat::ResourceGroup
_________________________________________________________

In this example, ocgapp\_volume.yml creates volumes using a
OS::Heat::ResourceGroup that uses nested heat by calling
ocgapp_nested_volume.yml. ocgapp\_volume.yml has an outputs: parameter
ocgapp\_volume\_ids which is declared a input parameter of type: json in
ocgapp\_volume.yml.


This is an example of requirement R-07443, where
a VNF's Heat Orchestration Templates' Cinder Volume Module Output
Parameter's name and type **MUST** match the input parameter name and type
in the corresponding Base Module or Incremental Module unless the Output
Parameter is of the type 'comma\_delimited\_list', then the corresponding
input parameter **MUST** be declared as type 'json'.

ocgapp\_volume.yml

.. code-block:: yaml

  heat_template_version: 2014-10-16

  description: Template for the volumes

  parameters:
    vnf_name:
      type: string
      label: OCG VNF Name
      description: OCG VNF Name
    ocgapp_volume_size_0:
      type: number
      label: Cinder volume 1 size
      description: the size of the Cinder volume
      constraints:
      - range: { min: 100, max: 400 }
    ocgapp_volume_type_0:
      type: string
      label: app vm 1 volume type
      description: the name of the target volume backend for the first OCG APP
    volume_count:
      type: number
      label: volume count
      description: number of volumes needed

  resources:
    ocgapp_volume_resource_group:
      type: OS::Heat::ResourceGroup
      properties:
        count: {get_param: volume_count}
        index_var: index
        resource_def:
          type: ocgapp_nested_volume.yml
          properties:
            index: index
            size: {get_param: ocgapp_volume_size_0}
            volume_type: {get_param: ocgapp_volume_type_0}
            vnf_name: {get_param: vnf_name}

  outputs:
    ocgapp_volume_ids:
    description: ocgapp volume ids
    value: {get_attr: [ocgapp_volume_resource_group, ocgapp_volume_id_0]}

ocgapp_nested_volume.yml

.. code-block:: yaml

 heat_template_version: 2014-10-16

 description: nested heat

 parameters:
   index:
     type: number
     label: Volume Index
     description: number of volumes to spin up
   size:
     type: number
     label: Volume Size
     description: size of the cinder volumes
   volume_type:
     type: string
     label: Volume Type
     description: type of cinder volumes
   vnf_name:
     type: string
     label: VNF Name
     description: vnf name

 resources:
   ocgapp_volume_0:
     type: OS::Cinder::Volume
     properties:
       size: {get_param: size}
       volume_type: {get_param: volume_type}
       name:
         str_replace:
           template: VF_NAME_STACK_NAME_INDEX
           params:
             VF_NAME: { get_param: vnf_name }
             STACK_NAME: { get_param: 'OS::stack_name' }
             INDEX: {get_param: index}

 outputs:
   ocgapp_volume_id_0:
   description: the ocgapp volume uuid
   value: {get_resource: ocgapp_volume_0}

The heat template below is a partial heat template,

ocgapp.yml

.. code-block:: yaml

  heat_template_version: 2014-10-16

  #file version 1.0
  description: OCG Apps template

  parameters:
    ocgapp_volume_ids:
      type: json
      description: Unique IDs for volumes

  resources:
    ocgapp_server_0:
      type: OS::Nova::Server
      properties:
    . . . .
    ocgapp_server_1:
      type: OS::Nova::Server
      properties:
    . . . .
    ocgapp_volume_attachment_0:
      type: OS::Cinder::VolumeAttachment
      properties:
        volume_id: {get_param: [ocgapp_volume_ids, 0]}
        instance_uuid: {get_resource: ocgapp_server_0}
    ocgapp_volume_attachment_1:
      type: OS::Cinder::VolumeAttachment
      properties:
        volume_id: {get_param: [ocgapp_volume_ids, 1]}
        instance_uuid: {get_resource: ocgapp_server_1}

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.

Note that Namespaces in XML (defined at
http://www.w3.org/TR/2009/REC-xml-names-20091208/) are allowed if the
Heat Orchestration Template is describing and storing software
configuration information. An XML namespace is identified by a URI
reference. A Uniform Resource Identifier (URI) is a string of characters
which identifies an Internet Resource. The most common URI is the
Uniform Resource Locator (URL) which identifies an Internet domain
address. Another, not so common type of URI is the Universal Resource
Name (URN). The namespace URI is not used by XML the parser to look up
information. The purpose of using an URI is to give the namespace a
unique name.

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:


.. req::
    :id: R-76718
    :target: VNF
    :keyword: MUST

    If a VNF's Heat Orchestration Template uses the intrinsic function
    'get\_file', the 'get\_file' target **MUST** be referenced in
    the Heat Orchestration Template by file name.

The 'get\_file' target files are on-boarded to SDC in the same package
that contains the VNF's complete Heat Orchestration Template.


.. req::
    :id: R-41888
    :target: VNF
    :keyword: MUST NOT

    A VNF's Heat Orchestration Template intrinsic function
    'get\_file' **MUST NOT** utilize URL-based file retrieval.

.. req::
    :id: R-62177
    :target: VNF
    :keyword: MUST

    When using the intrinsic function get_file, the included files
    **MUST** have unique file names within the scope of the VNF.

.. req::
    :id: R-87848
    :target: VNF
    :keyword: MUST

    A VNF's Heat Orchestration Template's 'get\_file' target files
    **MUST** be in the same directory hierarchy as the VNF's Heat
    Orchestration Templates.

ONAP does not support a hierarchical structure.  A VNF's YAML files
must be in a single, flat directory.


.. req::
    :id: R-05050
    :target: VNF
    :keyword: MAY

    A VNF's Heat Orchestration Templates intrinsic function
    'get\_file' <content key> **MAY** be used:

        * more than once in a VNF's Heat Orchestration Template
        * in two or more of a VNF's Heat Orchestration Templates
        * in a VNF's Heat Orchestration Templates nested YAML file

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 Orchestration Template (in the
   base module) based on an existing public key 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 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.