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
|
.. Licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
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`` must follow the ONAP
naming convention. The four properties are:
1. network
2. fixed_ips, ip_address
3. fixed_ips, subnet
* Note that earlier versions of this document mentioned the property
fixed_ips, subnet_id. This property has been removed from the document
since it has been deprecated.
See https://github.com/openstack/heat/blob/stable/ocata/heat/engine/resources/openstack/neutron/port.py
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 :ref:`ONAP Heat 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
~~~~~~~~~~~~~~
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.
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-45602
:target: VNF
:keyword: MUST NOT
:validation_mode: none
:updated: casablanca
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``
**MAY** be used
.. req::
:id: R-63956
:target: VNF
:keyword: MAY
:updated: casablanca
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
:validation_mode: none
:updated: casablanca
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``
**MUST NOT** be used
.. req::
:id: R-18001
:target: VNF
:keyword: MAY
:updated: casablanca
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
:validation_mode: none
:updated: casablanca
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``
**MUST NOT** be used
.. req::
:id: R-681859
:keyword: MUST
A VNF's Heat Orchestration Template's ``OS::Neutron::Port`` resource's
* Resource ID (defined in R-20453)
* property ``network`` parameter name (defined in R-62983 and
R-86182)
* property ``fixed_ips``, map property ``ip_address`` parameter name
(defined in R-40971, R-04697, R-71577, R-23503, R-78380, R-85235,
R-27818, and R-29765)
* property ``fixed_ips``, map property ``subnet`` parameter name
(defined in R-62802, R-15287, R-84123, R-76160)
* property ``allowed_address_pairs`` parameter name (defined in
R-41492 and R-83418)
**MUST** contain the identical ``{network-role}``.
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
:validation_mode: static
:updated: casablanca
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
:validation_mode: static
:updated: casablanca
When the VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` is attaching to an external network (per the
ONAP definition, see Requirement R-57424), 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
:validation_mode: static
:updated: casablanca
When the VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` is attaching to an internal network (per the
ONAP definition, see Requirements R-52425 and R-46461),
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
:validation_mode: static
:updated: casablanca
When the VNF's Heat Orchestration Template's resource
``OS::Neutron::Port`` is attaching to an internal network (per the
ONAP definition, see Requirements R-52425 and R-46461),
and the internal network is created in the
same Heat Orchestration Template as the ``OS::Neutron::Port``,
the ``network`` property value **MUST** obtain the UUID
of the internal network by using the intrinsic function
``get_resource``
and referencing the Resource ID of the internal network.
.. req::
:id: R-29872
:target: VNF
:keyword: MUST NOT
:validation_mode: static
:updated: casablanca
The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``
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
:validation_mode: static
:updated: casablanca
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
:validation_mode: static
:updated: casablanca
When the VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` is attaching to an external network (per the
ONAP definition, see Requirement R-57424),
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
* ``{index}`` is a numeric value that **MUST** start at zero in a
VNF's Heat Orchestration Template and **MUST** increment by one
.. req::
:id: R-39841
:target: VNF
:keyword: MUST NOT
:validation_mode: static
:updated: casablanca
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
:validation_mode: static
:updated: casablanca
When the VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` is attaching to an external network (per the
ONAP definition, see Requirement R-57424),
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
:validation_mode: static
:updated: casablanca
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
:validation_mode: static
:updated: casablanca
When the VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` is attaching to an external network (per the
ONAP definition, see Requirement R-57424),
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
* ``{index}`` is a numeric value that **MUST** start at zero in a
VNF's Heat Orchestration Template and **MUST** increment by one
.. req::
:id: R-87123
:target: VNF
:keyword: MUST NOT
:validation_mode: static
:updated: casablanca
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
:validation_mode: static
:updated: casablanca
When the VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` is attaching to an external network (per the
ONAP definition, see Requirement R-57424),
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
:validation_mode: static
:updated: casablanca
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
:validation_mode: static
:updated: casablanca
When the VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` is attaching to an internal network (per the
ONAP definition, see Requirements R-52425 and R-46461),
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
* ``{index}`` is a numeric value that **MUST** start at zero in a
VNF's Heat Orchestration Template and **MUST** increment by one
.. req::
:id: R-28795
:target: VNF
:keyword: MUST
:validation_mode: static
:updated: casablanca
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
:validation_mode: static
:updated: casablanca
When the VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` is attaching to an internal network (per the
ONAP definition, see Requirements R-52425 and R-46461),
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
:validation_mode: static
:updated: casablanca
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
:validation_mode: static
:updated: casablanca
When the VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` is attaching to an internal network (per the
ONAP definition, see Requirements R-52425 and R-46461),
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
* ``{index}`` is a numeric value that **MUST** start at zero in a
VNF's Heat Orchestration Template and **MUST** increment by one
.. req::
:id: R-97201
:target: VNF
:keyword: MUST
:validation_mode: static
:updated: casablanca
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
:validation_mode: static
:updated: casablanca
When the VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` is attaching to an internal network (per the
ONAP definition, see Requirements R-52425 and R-46461),
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
:validation_mode: static
:updated: casablanca
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.
.. 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-62590
:target: VNF
:keyword: MUST NOT
:validation_mode: static
:updated: casablanca
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}_v6_ip_{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
:validation_mode: static
:updated: casablanca
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}_v6_ip_{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 4 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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The resource ``OS::Neutron::Port`` property ``fixed_ips`` map
property ``subnet`` 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`` 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`` specifies the subnet the IP is assigned from.
.. req::
:id: R-38236
:target: VNF
:keyword: MUST
:validation_mode: static
:updated: casablanca
The VNF's Heat Orchestration Template's
resource ``OS::Neutron::Port`` property ``fixed_ips``
map property ``subnet`` parameter
**MUST** be declared type ``string``.
.. req::
:id: R-62802
:target: VNF
:keyword: MUST
:validation_mode: static
:updated: casablanca
When the VNF's Heat Orchestration Template's
resource ``OS::Neutron::Port`` is attaching
to an external network (per the ONAP definition, see
Requirement R-57424),
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``, the parameter
**MUST** follow the naming convention
* ``{network-role}_subnet_id``
where
* ``{network-role}`` is the network role of the network.
Note that ONAP only supports cloud assigned IP addresses from one IPv4 subnet
of a given network.
.. req::
:id: R-83677
:target: VNF
:keyword: MUST NOT
:validation_mode: static
:updated: casablanca
The VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` property ``fixed_ips``
map property ``subnet`` 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
:validation_mode: static
:updated: casablanca
When the VNF's Heat Orchestration Template's
resource ``OS::Neutron::Port`` is attaching
to an external network (per the ONAP definition, see
Requirement R-57424),
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``, the parameter
**MUST** follow the naming convention
* ``{network-role}_v6_subnet_id``
where
* ``{network-role}`` is the network role of the network.
Note that ONAP only supports cloud assigned IP addresses from one IPv6 subnet
of a given network.
.. req::
:id: R-80829
:target: VNF
:keyword: MUST NOT
:validation_mode: static
:updated: casablanca
The VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` property ``fixed_ips``
map property ``subnet`` parameter
``{network-role}_v6_subnet_id``
**MUST NOT** be enumerated in the
VNF's Heat Orchestration Template's Environment File.
*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: { 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: { get_param: oam_subnet_id }
- subnet: { get_param: oam_v6_subnet_id }
.. req::
:id: R-84123
:target: VNF
:keyword: MUST
:validation_mode: static
:updated: casablanca
When
* the VNF's Heat Orchestration Template's
resource ``OS::Neutron::Port`` in an Incremental Module is attaching
to an internal network (per the ONAP definition, see
Requirements R-52425 and R-46461)
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``,
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
:validation_mode: static
:updated: casablanca
The VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` property ``fixed_ips``
map property ``subnet`` 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
:validation_mode: static
:updated: casablanca
When
* the VNF's Heat Orchestration Template's
resource ``OS::Neutron::Port`` in an Incremental Module is attaching
to an internal network (per the ONAP definition, see Requirements
R-52425 and R-46461)
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``,
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
:validation_mode: static
:updated: casablanca
The VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` property ``fixed_ips``
map property ``subnet`` 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.
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
:validation_mode: static
:updated: casablanca
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
:validation_mode: static
:updated: casablanca
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
:validation_mode: static
:updated: casablanca
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
:validation_mode: static
:updated: casablanca
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
:validation_mode: static
:updated: casablanca
When the VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` is attaching to an external network (per the
ONAP definition, see Requirement R-57424),
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
:validation_mode: static
:updated: casablanca
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
:validation_mode: static
:updated: casablanca
When the VNF's Heat Orchestration Template's Resource
``OS::Neutron::Port`` is attaching to an external network (per the
ONAP definition, see Requirement R-57424),
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}_floating_v6_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
:validation_mode: static
:updated: casablanca
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
:validation_mode: static
:updated: casablanca
A VNF's Heat Orchestration Template's **MUST NOT**
contain the Resource ``OS::Neutron::FloatingIP``.
.. req::
:id: R-76449
:target: VNF
:keyword: MUST NOT
:validation_mode: static
:updated: casablanca
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 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 }
|