diff options
| -rw-r--r-- | docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst | 54 | ||||
| -rw-r--r-- | docs/data/needs.json | 64 |
2 files changed, 60 insertions, 58 deletions
diff --git a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst index c3cd308..56775e2 100644 --- a/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst +++ b/docs/Chapter5/Heat/ONAP Heat Resource ID and Parameter Naming Convention/Neutron Parameters.rst @@ -17,12 +17,12 @@ naming convention. The four properties are: 1. network 2. fixed_ips, ip_address -3. fixed_ips, subnet_id or fixed_ips, subnet +3. fixed_ips, subnet - * These two properties represent the same construct. - ONAP currently has a Sev-2 issues associated with fixed_ips, subnet_id - and it is recommended to use fixed_ips, subnet - * Note that in many examples in this document fixed_ips, subnet_id is used. + * 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 @@ -109,7 +109,7 @@ Items to Note 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`` + * property ``fixed_ips`` map property ``subnet`` **MAY** be used .. req:: @@ -135,7 +135,7 @@ Items to Note the ``OS::Neutron::Port`` Resource's * property ``fixed_ips`` map property ``ip_address`` **MUST** be used - * property ``fixed_ips`` map property ``subnet``/``subnet_id`` + * property ``fixed_ips`` map property ``subnet`` **MUST NOT** be used .. req:: @@ -162,7 +162,7 @@ Items to Note 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`` + * property ``fixed_ips`` map property ``subnet`` **MUST NOT** be used Property: network @@ -982,11 +982,11 @@ The ``{vm-type}`` has been defined as ``db`` for database. - "ip_address": {get_param: db_oam_int_v6_ip_1} -Property: fixed_ips, Map Property: subnet_id -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Property: fixed_ips, Map Property: subnet +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The resource ``OS::Neutron::Port`` property ``fixed_ips`` map -property ``subnet``/``subnet_id`` is used when a +property ``subnet`` is used when a port is requesting an IP assignment via OpenStack’s DHCP Service (i.e., cloud assigned). @@ -1001,7 +1001,7 @@ 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 +``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 @@ -1010,7 +1010,7 @@ 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. +``subnet`` specifies the subnet the IP is assigned from. .. req:: :id: R-38236 @@ -1021,7 +1021,7 @@ The property ``fixed_ips`` is used to assign IPs to a port. The Map Property The VNF's Heat Orchestration Template's resource ``OS::Neutron::Port`` property ``fixed_ips`` - map property ``subnet``/``subnet_id`` parameter + map property ``subnet`` parameter **MUST** be declared type ``string``. .. req:: @@ -1038,7 +1038,7 @@ The property ``fixed_ips`` is used to assign IPs to a port. The Map Property 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 + map property ``subnet``, the parameter **MUST** follow the naming convention * ``{network-role}_subnet_id`` @@ -1054,9 +1054,10 @@ The property ``fixed_ips`` is used to assign IPs to a port. The Map Property :validation_mode: static :updated: casablanca + The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` - map property ``subnet``/``subnet_id`` parameter + map property ``subnet`` parameter ``{network-role}_subnet_id`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. @@ -1089,7 +1090,7 @@ value at orchestration to the Heat Orchestration Template. 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 + map property ``subnet``, the parameter **MUST** follow the naming convention * ``{network-role}_v6_subnet_id`` @@ -1107,7 +1108,7 @@ value at orchestration to the Heat Orchestration Template. The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` - map property ``subnet``/``subnet_id`` parameter + map property ``subnet`` parameter ``{network-role}_v6_subnet_id`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. @@ -1135,7 +1136,7 @@ to assign IP addresses. parameters: network: { get_param: oam_net_id } fixed_ips: - - subnet_id: { get_param: oam_subnet_id } + - 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 @@ -1163,8 +1164,8 @@ balancer. properties: network: { get_param: oam_net_id } fixed_ips: - - subnet_id: { get_param: oam_subnet_id } - - subnet_id: { get_param: oam_v6_subnet_id } + - subnet: { get_param: oam_subnet_id } + - subnet: { get_param: oam_v6_subnet_id } .. req:: :id: R-84123 @@ -1182,7 +1183,7 @@ balancer. 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``, + using the property ``fixed_ips`` map property ``subnet``, the parameter **MUST** follow the naming convention @@ -1204,7 +1205,7 @@ balancer. The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` - map property ``subnet``/``subnet_id`` parameter + map property ``subnet`` parameter ``int_{network-role}_subnet_id`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. @@ -1236,11 +1237,12 @@ input parameter. * 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 Requirement TBD) + 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``/``subnet_id``, + using the property ``fixed_ips`` map property ``subnet``, the parameter **MUST** follow the naming convention ``int_{network-role}_v6_subnet_id``, @@ -1258,7 +1260,7 @@ input parameter. The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port`` property ``fixed_ips`` - map property ``subnet``/``subnet_id`` parameter + map property ``subnet`` parameter ``int_{network-role}_v6_subnet_id`` **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's Environment File. diff --git a/docs/data/needs.json b/docs/data/needs.json index 146cd29..baaa8e1 100644 --- a/docs/data/needs.json +++ b/docs/data/needs.json @@ -1,5 +1,5 @@ { - "created": "2018-10-10T20:48:45.405167", + "created": "2018-10-11T12:59:57.386364", "current_version": "casablanca", "project": "", "versions": { @@ -21858,7 +21858,7 @@ "needs_amount": 750 }, "casablanca": { - "created": "2018-10-10T20:48:45.405167", + "created": "2018-10-11T12:59:57.386344", "needs": { "R-00011": { "description": "A VNF's Heat Orchestration Template's parameter defined\nin a nested YAML file\n**MUST NOT** have a parameter constraint defined.", @@ -24807,7 +24807,7 @@ "validation_mode": "" }, "R-15287": { - "description": "When the VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` is attaching\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv6 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv6 subnet is to be specified\nusing the property ``fixed_ips``\nmap property ``subnet``/``subnet_id``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_v6_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", + "description": "When the VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` is attaching\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv6 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv6 subnet is to be specified\nusing the property ``fixed_ips``\nmap property ``subnet``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_v6_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", "full_title": "", "hide_links": "", "id": "R-15287", @@ -24816,9 +24816,9 @@ "keyword": "MUST", "links": [], "notes": "", - "section_name": "Property: fixed_ips, Map Property: subnet_id", + "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ - "Property: fixed_ips, Map Property: subnet_id", + "Property: fixed_ips, Map Property: subnet", "Resource: OS::Neutron::Port - Parameters" ], "status": null, @@ -26427,7 +26427,7 @@ "validation_mode": "" }, "R-22288": { - "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet``/``subnet_id`` parameter\n``int_{network-role}_v6_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n``int_{network-role}_v6_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", "full_title": "", "hide_links": "", "id": "R-22288", @@ -26436,9 +26436,9 @@ "keyword": "MUST NOT", "links": [], "notes": "", - "section_name": "Property: fixed_ips, Map Property: subnet_id", + "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ - "Property: fixed_ips, Map Property: subnet_id", + "Property: fixed_ips, Map Property: subnet", "Resource: OS::Neutron::Port - Parameters" ], "status": null, @@ -30216,7 +30216,7 @@ "validation_mode": "" }, "R-38236": { - "description": "The VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet``/``subnet_id`` parameter\n**MUST** be declared type ``string``.", + "description": "The VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n**MUST** be declared type ``string``.", "full_title": "", "hide_links": "", "id": "R-38236", @@ -30225,9 +30225,9 @@ "keyword": "MUST", "links": [], "notes": "", - "section_name": "Property: fixed_ips, Map Property: subnet_id", + "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ - "Property: fixed_ips, Map Property: subnet_id", + "Property: fixed_ips, Map Property: subnet", "Resource: OS::Neutron::Port - Parameters" ], "status": null, @@ -31814,7 +31814,7 @@ "validation_mode": "static" }, "R-45602": { - "description": "If a VNF's Port is attached to a network (internal or external)\nand the port's IP addresses are cloud assigned by OpenStack's DHCP\nService, the ``OS::Neutron::Port`` Resource's\n\n* property ``fixed_ips`` map property ``ip_address`` **MUST NOT** be used\n* property ``fixed_ips`` map property ``subnet``/``subnet_id``\n **MAY** be used", + "description": "If a VNF's Port is attached to a network (internal or external)\nand the port's IP addresses are cloud assigned by OpenStack's DHCP\nService, the ``OS::Neutron::Port`` Resource's\n\n* property ``fixed_ips`` map property ``ip_address`` **MUST NOT** be used\n* property ``fixed_ips`` map property ``subnet``\n **MAY** be used", "full_title": "", "hide_links": "", "id": "R-45602", @@ -32667,7 +32667,7 @@ "validation_mode": "" }, "R-48880": { - "description": "If a VNF's Port is attached to an external network and the port's\nIP addresses are assigned by ONAP's SDN-Controller,\nthe ``OS::Neutron::Port`` Resource's\n\n* property ``fixed_ips`` map property ``ip_address`` **MUST** be used\n* property ``fixed_ips`` map property ``subnet``/``subnet_id``\n **MUST NOT** be used", + "description": "If a VNF's Port is attached to an external network and the port's\nIP addresses are assigned by ONAP's SDN-Controller,\nthe ``OS::Neutron::Port`` Resource's\n\n* property ``fixed_ips`` map property ``ip_address`` **MUST** be used\n* property ``fixed_ips`` map property ``subnet``\n **MUST NOT** be used", "full_title": "", "hide_links": "", "id": "R-48880", @@ -35348,7 +35348,7 @@ "validation_mode": "static" }, "R-62802": { - "description": "When the VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` is attaching\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv4 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv4 subnet is to be specified\nusing the property ``fixed_ips``\nmap property ``subnet``/``subnet_id``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", + "description": "When the VNF's Heat Orchestration Template's\nresource ``OS::Neutron::Port`` is attaching\nto an external network (per the ONAP definition, see\nRequirement R-57424),\nand an IPv4 address is being cloud assigned by OpenStack's DHCP Service\nand the external network IPv4 subnet is to be specified\nusing the property ``fixed_ips``\nmap property ``subnet``, the parameter\n**MUST** follow the naming convention\n\n * ``{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the network.", "full_title": "", "hide_links": "", "id": "R-62802", @@ -35357,9 +35357,9 @@ "keyword": "MUST", "links": [], "notes": "", - "section_name": "Property: fixed_ips, Map Property: subnet_id", + "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ - "Property: fixed_ips, Map Property: subnet_id", + "Property: fixed_ips, Map Property: subnet", "Resource: OS::Neutron::Port - Parameters" ], "status": null, @@ -36800,7 +36800,7 @@ "validation_mode": "" }, "R-69634": { - "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet``/``subnet_id`` parameter\n``int_{network-role}_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n``int_{network-role}_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", "full_title": "", "hide_links": "", "id": "R-69634", @@ -36809,9 +36809,9 @@ "keyword": "MUST NOT", "links": [], "notes": "", - "section_name": "Property: fixed_ips, Map Property: subnet_id", + "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ - "Property: fixed_ips, Map Property: subnet_id", + "Property: fixed_ips, Map Property: subnet", "Resource: OS::Neutron::Port - Parameters" ], "status": null, @@ -37198,7 +37198,7 @@ "validation_mode": "" }, "R-70964": { - "description": "If a VNF's Port is attached to an internal network and the port's\nIP addresses are statically assigned by the VNF's Heat Orchestration\\\nTemplate (i.e., enumerated in the Heat Orchestration Template's\nenvironment file), the ``OS::Neutron::Port`` Resource's\n\n* property ``fixed_ips`` map property ``ip_address`` **MUST** be used\n* property ``fixed_ips`` map property ``subnet``/``subnet_id``\n **MUST NOT** be used", + "description": "If a VNF's Port is attached to an internal network and the port's\nIP addresses are statically assigned by the VNF's Heat Orchestration\\\nTemplate (i.e., enumerated in the Heat Orchestration Template's\nenvironment file), the ``OS::Neutron::Port`` Resource's\n\n* property ``fixed_ips`` map property ``ip_address`` **MUST** be used\n* property ``fixed_ips`` map property ``subnet``\n **MUST NOT** be used", "full_title": "", "hide_links": "", "id": "R-70964", @@ -38164,7 +38164,7 @@ "validation_mode": "static" }, "R-76160": { - "description": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see Requirement TBD)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``/``subnet_id``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "description": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see Requirements\n R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv6 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n``int_{network-role}_v6_subnet_id``,\nwhere ``{network-role}`` is the network role of the internal network.\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", "full_title": "", "hide_links": "", "id": "R-76160", @@ -38173,9 +38173,9 @@ "keyword": "MUST", "links": [], "notes": "", - "section_name": "Property: fixed_ips, Map Property: subnet_id", + "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ - "Property: fixed_ips, Map Property: subnet_id", + "Property: fixed_ips, Map Property: subnet", "Resource: OS::Neutron::Port - Parameters" ], "status": null, @@ -38876,7 +38876,7 @@ "validation_mode": "static" }, "R-80829": { - "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet``/``subnet_id`` parameter\n``{network-role}_v6_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n``{network-role}_v6_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", "full_title": "", "hide_links": "", "id": "R-80829", @@ -38885,9 +38885,9 @@ "keyword": "MUST NOT", "links": [], "notes": "", - "section_name": "Property: fixed_ips, Map Property: subnet_id", + "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ - "Property: fixed_ips, Map Property: subnet_id", + "Property: fixed_ips, Map Property: subnet", "Resource: OS::Neutron::Port - Parameters" ], "status": null, @@ -39586,7 +39586,7 @@ "validation_mode": "" }, "R-83677": { - "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet``/``subnet_id`` parameter\n``{network-role}_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", + "description": "The VNF's Heat Orchestration Template's Resource\n``OS::Neutron::Port`` property ``fixed_ips``\nmap property ``subnet`` parameter\n``{network-role}_subnet_id``\n**MUST NOT** be enumerated in the\nVNF's Heat Orchestration Template's Environment File.", "full_title": "", "hide_links": "", "id": "R-83677", @@ -39595,9 +39595,9 @@ "keyword": "MUST NOT", "links": [], "notes": "", - "section_name": "Property: fixed_ips, Map Property: subnet_id", + "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ - "Property: fixed_ips, Map Property: subnet_id", + "Property: fixed_ips, Map Property: subnet", "Resource: OS::Neutron::Port - Parameters" ], "status": null, @@ -39702,7 +39702,7 @@ "validation_mode": "" }, "R-84123": { - "description": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``/``subnet_id``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", + "description": "When\n\n * the VNF's Heat Orchestration Template's\n resource ``OS::Neutron::Port`` in an Incremental Module is attaching\n to an internal network (per the ONAP definition, see\n Requirements R-52425 and R-46461)\n that is created in the Base Module, AND\n * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND\n * the internal network IPv4 subnet is to be specified\n using the property ``fixed_ips`` map property ``subnet``,\n\nthe parameter **MUST** follow the naming convention\n\n * ``int_{network-role}_subnet_id``\n\nwhere\n\n * ``{network-role}`` is the network role of the internal network\n\nNote that the parameter **MUST** be defined as an ``output`` parameter in\nthe base module.", "full_title": "", "hide_links": "", "id": "R-84123", @@ -39711,9 +39711,9 @@ "keyword": "MUST", "links": [], "notes": "", - "section_name": "Property: fixed_ips, Map Property: subnet_id", + "section_name": "Property: fixed_ips, Map Property: subnet", "sections": [ - "Property: fixed_ips, Map Property: subnet_id", + "Property: fixed_ips, Map Property: subnet", "Resource: OS::Neutron::Port - Parameters" ], "status": null, |