diff options
Diffstat (limited to 'docs/ONAP release 1 spec/im')
| -rw-r--r-- | docs/ONAP release 1 spec/im/index.rst | 17 | ||||
| -rw-r--r-- | docs/ONAP release 1 spec/im/ns-im.rst | 200 | ||||
| -rw-r--r-- | docs/ONAP release 1 spec/im/overlay-im.rst | 122 | ||||
| -rw-r--r-- | docs/ONAP release 1 spec/im/service-im.rst | 85 |
4 files changed, 0 insertions, 424 deletions
diff --git a/docs/ONAP release 1 spec/im/index.rst b/docs/ONAP release 1 spec/im/index.rst deleted file mode 100644 index 3820ed6..0000000 --- a/docs/ONAP release 1 spec/im/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -.. onap-documentation documentation master file, created by - sphinx-quickstart on Mon Sep 18 15:12:14 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -ONAP Information Model Specifications -============================================== - -.. toctree:: - :titlesonly: - - service-im - ns-im - overlay-im diff --git a/docs/ONAP release 1 spec/im/ns-im.rst b/docs/ONAP release 1 spec/im/ns-im.rst deleted file mode 100644 index c7bb8a4..0000000 --- a/docs/ONAP release 1 spec/im/ns-im.rst +++ /dev/null @@ -1,200 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -=========================================================================== -ONAP Network Service Descriptor Information Model Specification (Amsterdam) -=========================================================================== - -Scope ------ - -The scope of the present document is to describe the Network Service Descriptor (NSD) Information Model. - - -Terms, Definitions and Abbreviations ------------------------------------- - -For the purposes of the present document, the following abbreviations apply: - -+------------+--------------------------------------------+ -|Abbreviation| Definition | -+------------+--------------------------------------------+ -| CM | Conditional Mandatory | -+------------+--------------------------------------------+ -| CO | Conditional Optional | -+------------+--------------------------------------------+ -| CP | Connection Point | -+------------+--------------------------------------------+ -| CPD | Connection Point Description | -+------------+--------------------------------------------+ -| DSL | Domain Specific Language | -+------------+--------------------------------------------+ -| NCT | Network Connectivity Topology | -+------------+--------------------------------------------+ -| NF | Network Function | -+------------+--------------------------------------------+ -| NFVO | NFV Orchestrator | -+------------+--------------------------------------------+ -| NSD | Network Service Descriptor | -+------------+--------------------------------------------+ -| UML | Unified Modeling Language | -+------------+--------------------------------------------+ -| VL | Virtual Link | -+------------+--------------------------------------------+ -| VNF | Virtual Network Function | -+------------+--------------------------------------------+ - -NSD Information Model Overview ------------------------------- - -Network Service (NS) is a set of functions with unspecified connectivity between them or according to one or more forwarding graphs. - -The Network Service Descriptor (NSD) is a deployment template which consists of information used by the NFV Orchestrator (NFVO) for life cycle management of an NS. - -As illustrated in the following figure, the description of a NS used to deploy an NS instance includes or references the description of its constituent objects: - -* Zero, one or more Virtualized Network Function Nodes Descriptors; -* Zero, one or more Physical Network connect PNFs to VLs; -* Zero, one or more nested NSD; -* Zero, one or more Virtual Link Description used by the NFVO to deploy Virtual Links (VL) ; and -* Zero, one or more VNF Forwarding Graph Descriptions. - -Functional Requirements ------------------------ - -The following table specifies requirements to the templates for NSD instances in R1. - -+-----------------+-----------------------------------------------------------------+ -| Numbering | Requirement Description | -+-----------------+-----------------------------------------------------------------+ -| NST_NSD001 | The NSD shall reference the VNF Node description of constituent | -| | VNFs. | -+-----------------+-----------------------------------------------------------------+ -| NST_NSD002 | The NSD shall include the VLDs applicable to the VLs used by the| -| | NS to interconnect its constituent NFs. | -+-----------------+-----------------------------------------------------------------+ -| NST_NSD003 | The NSD shall include a globally unique identifier for identify-| -| | ing each descriptor instance. | -+-----------------+-----------------------------------------------------------------+ -| NST_NSD004 | The NSD shall include an identifier to select the controller co-| -| | mpatible with the NSD. | -+-----------------+-----------------------------------------------------------------+ -| NST_NSD005 | The NSD shall support the capability to include or reference NS | -| | life cycle management scripts describing how to react upon spec-| -| | ific life cycle events, fault detection, performance threshold | -| | crossing detection and other events. | -+-----------------+-----------------------------------------------------------------+ -| NST_NSD006 | The NSD shall support the capability to provide monitoring para-| -| | meters to be tracked during the lifetime of a NS instance. | -+-----------------+-----------------------------------------------------------------+ - - -The following table specifies requirements to the templates for VLD instances. - -+-----------------+-----------------------------------------------------------------+ -| Numbering | Requirement Description | -+-----------------+-----------------------------------------------------------------+ -| NST_VLD001 | A VLD shall enable specifying the type of connectivity provided | -| | by the link between VNFs. | -| | In the R1, the VL should support ELAN type at least. | -+-----------------+-----------------------------------------------------------------+ - - - -NSD Information Model Definitions ---------------------------------- - -NSD -^^^ - -The NSD information element is a template whose instances are used by the VF-C for the lifecycle management of NSs. Note that NSD is actually defined as a special type of service descriptor, whose serviceType is set to "Network". In the same time, NSD can be included into an End-to-End service descriptor, as a resource or in other words, nested service. - -+---------------+-----------+-------------+----------+--------------------------------------------+ -| Attribute | Qualifier | Cardinality | Content | Description | -+---------------+-----------+-------------+----------+--------------------------------------------+ -| id | M | 1 |Identifier| Identifier of this NSD information element.| -| | | | | It globally uniquely identifies an instance| -| | | | | of the NSD. | -+---------------+-----------+-------------+----------+--------------------------------------------+ -| name | M | 1 | String | The name of the NSD. | -+---------------+-----------+-------------+----------+--------------------------------------------+ -| serviceType | M | 1 | String | Identifies the type of the SD, which is set| -| | | | | to "Network" for NSD. | -+---------------+-----------+-------------+----------+--------------------------------------------+ -| vnfd | M | 0..N | VNF id | Consituent VNF node information of this NSD| -+---------------+-----------+-------------+----------+--------------------------------------------+ -|virtualLinkDesc| M | 0..N | VLD | Speficies the constituent VLDs. | -+---------------+-----------+-------------+----------+--------------------------------------------+ - -VL Description -^^^^^^^^^^^^^^ - -The VL information element provides general information enabling the instantiation of virtual links. - -+------------------+-----------+-------------+----------+--------------------------------------------+ -| Attribute | Qualifier | Cardinality | Content | Description | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| id | M | 1 |Identifier| Identifier of this VirtualLinkDesc informa-| -| | | | | tion element. It globally uniquely identif-| -| | | | | ies a VL Description. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| name | M | 1 | String | Specifies the name of the VL Description. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| description | M | 0..1 | String | Specifies human-readable information on the| -| | | | | purpose of the VL (e.g. control plane traf-| -| | | | | fic). | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| isExternalNetwork| M | 1 | Boolean | Whether the VL is external network. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| shared | O | 0..1 | Boolean | Whether the VL is shared. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| network_type | O | 0..1 | String | Network type of the VL. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| segmentation_id | O | 0..1 | String | Network segmentation id of the VL. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| physical_network | O | 0..1 | String | Physical network of the VL. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| mtu | O | 0..1 | Integer | Network MTU of the VL. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| cidr | O | 0..1 | String | Subnetwork cidr of the VL. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| ip_version | O | 0..1 | String | Subnetwork IP protocol version of the VL. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| enable_dhcp | O | 0..1 | Boolean | Whether or not th subnetwork enables DHCP. | -+------------------+-----------+-------------+----------+--------------------------------------------+ -| gateway_ip | O | 0..1 | String | Subnetwork gateway IP address. | -+------------------+-----------+-------------+----------+--------------------------------------------+ - -VNF Node Description Information -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| Attribute | Qualifier | Cardinality | Content | Description | -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| id | M | 1 |Identifier| Identifier of this VNF Descriptjion. | -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| name | M | 1 | String | Specifies the name of the VNF Description. | -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| description | M | 0..1 | String | Specifies human-readable information on the| -| | | | | purpose of the VNF. | -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| vnfminfo | M | 0..1 | String | Identifies VNFM(s) compatible with the VNF | -| | | | | described in the VNF Description. | -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| vnfExtCpd | M | 0..N | vnfExtCpd| VNF External Connection Points. | -+-----------------+-----------+-------------+----------+--------------------------------------------+ - - -vnfExtCpd -^^^^^^^^^ - -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| Attribute | Qualifier | Cardinality | Content | Description | -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| cpdid | M | 1..N |Identifier| Reference to the correspondent internal CPD| -+-----------------+-----------+-------------+----------+--------------------------------------------+ -| vldid | M | 1..N |Identifier| Reference to the external VLD(s).(TBD) | -+-----------------+-----------+-------------+----------+--------------------------------------------+ - - diff --git a/docs/ONAP release 1 spec/im/overlay-im.rst b/docs/ONAP release 1 spec/im/overlay-im.rst deleted file mode 100644 index be7419c..0000000 --- a/docs/ONAP release 1 spec/im/overlay-im.rst +++ /dev/null @@ -1,122 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -=========================================================================== -ONAP VoLTE Overlay Descriptor Information Model Specification (Amsterdam) -=========================================================================== - -Scope ------ - -The scope of the present document is to describe the Overlay VPN Descriptor Information Model. -For Amsterdam release, this descriptor is currently leveraged by VoLTE usecase to provision the L2/L2 VPN tunnel between the core DC and edage DC, but it is in nature a generic descriptor which could be used by other usecase for L2/L3 VPN tunnel provision as well. - - -Terms, Definitions and Abbreviations ------------------------------------- - -For the purposes of the present document, the following abbreviations apply: - -+------------+--------------------------------------------+ -|Abbreviation| Definition | -+------------+--------------------------------------------+ -| L3-DCI | Layer-3 Data Center Interconnection | -+------------+--------------------------------------------+ -| L2-DCI | Layer-2 Data Center Interconnectio | -+------------+--------------------------------------------+ - - -Overlay Descriptor Infomration Model Overview ---------------------------------------------- - -This document defines the configuration information model for overlay descriptor that enables user to input configuration -parameters required to associate local network within dataceter to a VXLAN tunnel between data centers. - -For example, VoLTE use case contains a VXLAN tunnel between edge and core datacenters. -Local network within data center is created dynamically while provisioning either vIMS or vEPC services. This model enables configuration of VXLAN gateways to forward local network traffic through inter-DC VXLAN tunnel. - -From the perspective of deployment, the overlay descriptor is actually a specific type of resource, a special type of Virtual Link (VL) in precise, as defined by Service Descriptor. - -Functional Requirements ------------------------ - -The following table specifies requirements to the templates for Overlay descriptor in R1. - -+-----------------+-----------------------------------------------------------------+ -| Numbereing | Requirement Description | -+-----------------+-----------------------------------------------------------------+ -| NST_OVED001 | The Overlay VPN Descriptor shall reference to its constituent 2 | -| | sites. | -+-----------------+-----------------------------------------------------------------+ -| NST_OVED002 | The Overlay VPN Descriptor shall enable L2/L3 VxLAN VPN options.| -+-----------------+-----------------------------------------------------------------+ - - -Overlay VPN Descriptor Information Model Definitions ----------------------------------------------------- - -The Overlay VPN Descriptor information element is a template whose instances are used by the Service Orchestrator (SO) and SDN-C (Network Controller) for the deployment and configuration of L2/L3 VxLAN -VPN for DCI connections. - -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| Attribute | Qualifier | Cardinality | Content | Description | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| id | M | 1 |Identifier| Identifier of the Tunnel Endpoint node. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| name | O | 1 | String | Overlay tunnel name. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| version | O | 1 | String | Overlay tunnel template version. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| description | O | 1 | String | Addtional comments/information about the | -| | | | | the overlay tunnel. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| tunneltype | M | 1 | Enum | The type of overlay tunnel. | -| | | | | Valid values include 'L3-DCI' and 'L2-DCI'.| -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_id | M | 1 | String | Identifies site1. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_description | O | 1 | String | Information about overlay tunnel endpoint. | -| | | | | Identifies local domain controller. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_networkName | M | 1 | String | A comma seperated list of network names | -| | | | | associated with tunnel in site1. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_routerId | O | 1 | String | Router ID connected to L3 end point. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_importRT1 | M | 1 | String | Imported Route Target | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_exportRT1 | M | 1 | String | Exported Route Target | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_vni | M | 1 | Integer | Tunnel local VXLAN Identfier in site1 | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_fireWallEnable | O | 1 | Boolean | Identifies if firewall is in tunnel path | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_fireWallId | O | 1 | String | Firewall Id, if exists in tunnel path | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site1_localNetworkAll| O | 1 | Boolean | Identifies if all local networks associate | -| | | | | with the VXLAN tunnel. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_id | M | 1 | String | Identifies site2. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_description | O | 1 | String | Information about tunnel site2 endpoint. | -| | | | | Identifies local domain controller. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_networkName | M | 1 | String | A comma seperated list of network names | -| | | | | associated with tunnel in site2. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_routerId | O | 1 | String | Router ID connected to L3 end point. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_importRT1 | M | 1 | String | Imported Route Target | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_exportRT1 | M | 1 | String | Exported Route Target | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_vni | M | 1 | Integer | Tunnel local VXLAN Identfier in site2 | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_fireWallEnable | O | 1 | Boolean | Identifies if firewall is in tunnel path | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_fireWallId | O | 1 | String | Firewall Id, if exists in tunnel path | -+----------------------+-----------+-------------+----------+--------------------------------------------+ -| site2_localNetworkAll| O | 1 | Boolean | Identifies if all local networks associate | -| | | | | with the VXLAN tunnel. | -+----------------------+-----------+-------------+----------+--------------------------------------------+ diff --git a/docs/ONAP release 1 spec/im/service-im.rst b/docs/ONAP release 1 spec/im/service-im.rst deleted file mode 100644 index b183de4..0000000 --- a/docs/ONAP release 1 spec/im/service-im.rst +++ /dev/null @@ -1,85 +0,0 @@ -.. Copyright 2017 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - -=================================================================== -ONAP Service Descriptor Information Model Specification (Amsterdam) -=================================================================== - -Scope ------ - -The scope of the present document is to describe the Service Descriptor (SD) Information Model Specification. - -Terms, Definitions and Abbreviations ------------------------------------- - -For the purposes of the present document, the following abbreviations apply: - -+-----------------+---------------------------------------------------------------------+ -| Abbreviation | Definition | -+-----------------+---------------------------------------------------------------------+ -| RD | Resource Descriptor | -+-----------------+---------------------------------------------------------------------+ -| SD | Service Descriptor | -+-----------------+---------------------------------------------------------------------+ -| SO | Service Orchestrator | -+-----------------+---------------------------------------------------------------------+ -| VF | Virtual Function | -+-----------------+---------------------------------------------------------------------+ -| VL | Virtual Link | -+-----------------+---------------------------------------------------------------------+ - -SD Information Model Overview ------------------------------ - -The Service Descriptor (SD) is a deployment template which consists of information used by the Service Orchestrator (SO) for life cycle management of a service. -A service is a composition of resources. The description of a service as used by the Service Orchestration (SO) to deploy a service instance includes or references the descriptors of its constituent objects: one or more resources; -A resource could be a VL, VF, WAN Descriptor etc. - -Functional Requirements ------------------------ - -The following table specifies requirements to the templates for SD instances. - -+------------------+-------------------------------------------------------+ -| Numbering | Requirement Description | -+------------------+-------------------------------------------------------+ -| NST_SD001 | The SD shall reference the resource applicable to its | -| | constituent services. | -+------------------+-------------------------------------------------------+ - -SD Information Model Definitions --------------------------------- -The SD information element is a template whose instances are used by the SO for the lifecycle management of Services. - -+-----------+-----------+-------------+----------+-------------------------------------------+ -|Attribute | Qualifier | Cardinality | Content | Description | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| id | M | 1 |Identifier| Identifier of this SD information element.| -| | | | | It globally uniquely identifies an | -| | | | | instance of the SD. | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| designer | M | 1 | String | Designer of this SD. | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| name | M | 1 | String | The name of the SD. | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| version | M | 1 | String | The vesion of the SD. | -+-----------+-----------+-------------+----------+-------------------------------------------+ -|description| M | 1 | String | The description of the SD. | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| vendor | M | 1 | String | The vendor of the SD. (TBD) | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| type | M | 1 | String | Value set to "Service". | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| category | M | 1 | String | Value set to either "E2E" or "NS". | -+-----------+-----------+-------------+----------+-------------------------------------------+ -|serviceType| M | 1 | String | The service type of the SD. | -+-----------+-----------+-------------+----------+-------------------------------------------+ -|ServiceRole| M | 1 | String | The service role of the SD. | -+-----------+-----------+-------------+----------+-------------------------------------------+ -| resource | M | 1..N | RD | The consituent RDs of the SD. | -| | | | | It could be VF/WAN Descriptor etc. | -+-----------+-----------+-------------+----------+-------------------------------------------+ - - |