Versions Compared

Old Version 7

changes.mady.by.user maopeng zhang

Saved on

compared with

New Version Current

changes.mady.by.user Zhuoyao Huang

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

WAN R2


Same with R1

Panel
titledata type:Node Type
Code Block
titleonaporg.openecomp.datatyperesource.wanvl.UserDefineoverlaytunnel
collapsetrue
onaporg.openecomp.datatyperesource.wanvl.UserDefineoverlaytunnel:
        derived_from: tosca.datatypesnodes.Root
        propertiesdescription:
 This entity represents abstract overlay tunnel end point.
    nameproperties:
      id:
          type: string
        description: Identifier of the Tunnel Endpoint node.
  description: resful uri supported
   required: false
      template_name:
      required  type: truestring
        required: false
     value version:
        type: string
        typerequired: stringfalse
      name:
          requiredtype: false
Panel
titlecapability types:
Code Block
titleonap.capability.wan.host
collapsetrue
onap.capability.wan.host:
string
        description: Overlay  derived_from: tosca.capabilities.Node
Code Block
titleonap.capability.wan.component
collapsetrue
onap.capability.wan.component:
 tunnel name used by for reference by the administrator.
        required: false
      description:
        derived_from: tosca.capabilities.Roottype: string
Code Block
titleonap.capability.wan.dependable
collapsetrue
onap.capability.wan.dependable:
 description: Additional comments/information about overlay tunnel.
        required: false
      tunnelType:
        derived_from: tosca.capabilities.Root
Panel
titlerelationship types:
type: string
        constraints:
          - valid_values: ['L3-DCI','L2-DCI']
        description: type defines if the overlay tunnel is L3-DCI tunnel or L2-DCI tunnel.
        required: true
      site1_id:
        type: string
        description: Identifier of first DCI overlay tunnel endpoint. This could be IP address of domain controller.
        required: true
      site1_description:
        type: string
        description: Additional comments/information about overlay tunnel. Description can also be used to identify domain controller.
        required: false
      site1_networkName:
        type: string
        description: Name of the network that is being associated with overlay tunnel.
        required: true
      site1_routerId:
        type: string
        description: Identifier of router connected to L3 tunnel end point, while configuring L3-DCI tunnel.
        required: false
      site1_importRT1:
        type: string
        description: List of Route targets imported by the local router.
        required: false
      site1_exportRT1:
        type: string
        description: List of Route targets exported by the local router.
        required: false
      site1_vni:
        type: integer
        description: VXLAN ID
        required: false
      site1_fireWallEnable:
        type: boolean
        required: false
        description: Identifies if a firewall exists in the path of overlay tunnel.
        default: false
      site1_fireWallId:
        type: string
        description: Identifier of Firewall that is in overlay tunnel path
        required: false
      site1_localNetworkAll:
        type: boolean
        description: Identifies whether all the local networks associate with the tunnel or not.
        required: false
        default: 'false'
      site2_id:
        type: string
        description: Identifier of second DCI overlay tunnel endpoint. This could be IP address of domain controller.
        required: true
      site2_description:
        type: string
        description: Additional comments/information about overlay tunnel. Description can also be used to identify domain controller.
        required: false
      site2_networkName:
        type: string
        description: Name of the network that is being associated with overlay tunnel.
        required: true
      site2_routerId:
        type: string
        description: Identifier of router connected to L3 tunnel end point, while configuring L3-DCI tunnel.
        required: false
      site2_importRT1:
        type: string
        description: List of Route targets imported by the local router.
        required: false
      site2_exportRT1:
        type: string
        description: List of Route targets exported by the local router.
        required: false
      site2_vni:
        type: integer
        description: VXLAN ID
        required: false
      site2_fireWallEnable:
        type: boolean
        required: false
        description: Identifies if a firewall exists in the path of overlay tunnel.
        default: false
      site2_fireWallId:
        type: string
        description: Identifier of Firewall that is in overlay tunnel path
        required: false
      site2_localNetworkAll:
        type: boolean
        description: Identifies whether all the local networks associate with the tunnel or not.
        required: false
        default: 'false'
    requirements:
    - virtualLink:
        capability: tosca.capabilities.network.Linkable
        relationship: tosca.relationships.network.LinksTo
    capabilities:
      virtual_linkable:
        type: tosca.capabilities.network.Linkable
Code Block
titleorg.openecomp.resource.vl.underlayvpn
collapsetrue
org.openecomp.resource.vl.underlayvpn:
    derived_from: tosca.nodes.Root
    description: undelay vpn type definitions
    properties:
      id:
        type: string
        required: false
      template_name:
        type: string
        required: false
      version:
        type: string
        required: false
      vendor:
        type: string
        required: false
      template_author:
        type: string
        required: false
      name:
        type: string
        required: false
      description:
        type: string
        required: false
      serviceType:    
        type: string
        description: type of VPN service
        required: false
        default: 'l3vpn_sptn'
      topology:
        type: string
        description: type of VPN topology
        constraints:
          - valid_values: ['full-mesh','point_to_multipoint','point_to_point','singlePoint','hubspoke','hubspoke_via_hubce','hubspoke_disjoint','ADD_DROP_Z']
        required: false
        default: 'full-mesh'
      technology:
        type: string
        description: type of VPN technology
        constraints:
          - valid_values: ['mpls','rosen multivpn','vxlan overlay l3vpn','eth over sdh','vlan']
        required: false
        default: 'mpls'
      site1_name:       
        type: string
        description: name of first site
        required: false
      site2_name:       
        type: string
        description: name of second site
        required: false
      sna1_name:
        type: string
        description: name of site network accesses associated with the site1
        required: false
      sna2_name:
        type: string
        description: name of site network accesses associated with the site2  
        required: false
      pe1_id:    
        type: string
        description: id of provider edge1, it can be name or ip or uuid 
        required: false
      pe2_id:    
        type: string
        description: id of provider edge2, it can be name or ip or uuid 
        required: false
      ac1_id:
        type: string
        description: id of attachment circuit1, it can be port name or uuid    
        required: false
      ac1_svlan:
        type: integer
        description: ac1 svlan
        required: false
      ac1_ip:
        type: string
        description: ip of ac1, only for layer3 vpn, it should contain mask
        required: false
      ac1_peer_ip:
        type: string
        description: ip of ac1 peer CE tp, only for layer3 vpn, it should contain mask
        required: false
      ac1_route:
        type: string
        description: route configure of ac1, only for layer3 vpn    
        required: false
      ac1_protocol:
        type: string
        description: routing protocol type of ac1, only for layer3 vpn    
        constraints:
          - valid_values: ['STATIC','OSPF','ISIS','BGP','other']
        required: false    
      ac1_protocol_bgp_as:
        type: string
        description: autonomous-system number of ac1, , only required for ebgp protocol
        required: false                    
      ac2_id:
        type: string
        description: id of attachment circuit2, it can be port name or uuid  
        required: false    
      ac2_svlan:
        type: integer
        description: ac2 svlan
        required: false    
      ac2_ip:
        type: string
        description: ip of ac2, only for layer3 vpn, it should contain mask
        required: false    
      ac2_peer_ip:
        type: string
        description: ip of ac2 peer CE tp, only for layer3 vpn, it should contain mask
Code Block
titleonap.relationship.wan.HostOn
collapsetrue
onap.relationship.wan.HostOn:
        descriptionrequired: >- false    
      ac2_route:
      The relationship specifiestype: whatstring
 Node the Endpoint is hosted on. 
 description: route configure of ac2, only for derived_from: tosca.relationships.Rootlayer3 vpn
        valid_target_typesrequired: [onap.capability.wan.host]false
Code Block
titleonap.relationship.wan.Contains
collapsetrue
onap.relationship.wan.Contains:
        description: >-ac2_protocol:
            The relationship specifies what component is contained. 
        derived_from: tosca.relationships.Root
        valid_target_types: [onap.capability.wan.component]
Code Block
titleonap.relationship.wan.DependsOn
collapsetrue
onap.relationship.wan.DependsOntype: string
        description: routing protocol type of ac2, only for layer3 vpn   
        constraints:
        description:  >-
    valid_values: ['STATIC','OSPF','ISIS','BGP','other']        The
 relationship specifies what is depended on. 
 default: 'STATIC'      derived_from: tosca.relationships.Root
        valid_target_typesrequired: [onap.capability.wan.dependable]false
Panel
titlenode types:
Code Block
titleonap.node.wan.Component
collapsetrue
onap.node.wan.Component:
        derived_from: tosca.nodes.Rootac2_protocol_bgp_as:
        propertiestype: string
        description: autonomous-system number of uuid:
ac2, , only required for ebgp protocol        
  type: string
     required:   false    name:
      af_type:
          type: string
        description: address family type
 version:
       default: 'ipv4'
        typerequired: stringfalse
    requirements:
       - descriptionvirtualLink:
        capability: tosca.capabilities.network.Linkable
       type relationship: stringtosca.relationships.network.LinksTo
    capabilities:
      virtual_linkable:
        type: tosca.capabilities.network.Linkable


WAN R3+


Panel
titleNode Types:
Code Block
titleonap.node.wan.Resource
collapsetrue
onap.node.wan.Resource:

                typederived_from: stringtosca.nodes.Root
                description: component typeproperties:
            parasuuid:
                type: liststring
                entry_schemaname:
                    type: onap.datatype.wan.UserDefine   string
            deploy-mode:
                type: stringversion:
                descriptiontype: all-in-one means SO will send FC and all component related in one request to SDN-C, step-by-step means SO will send each component in a single request.
     string
            label:
                type: list
           constraints:
        entry_schema:
            - valid_values: ['all-in-one','step-by-step']      type: string   
            deploy-order?type:
                type: integerstring
                description: effective while deploy-mode equals 'step-by-step', smaller number first component type
            paras:
                type: org.openecomp.datatypes.Root
        capabilities:
            - component:
                type: onaptosca.capabilitycapabilities.wannetwork.component Bindable           
        requirements:
            - configurationspecifications: 
                node: onap.node.wan.ComponentResourece 
                capabilitycapabilities: onaptosca.capabilitycapabilities.wannetwork.componentBindable
                relationship: onaprelationships.relationshipnetwork.wan.ContainsBindsTo
Code Block
titleonap.node.wan.ComponentResource.NodeConnection
collapsetrue
onap.node.wan.ComponentResource.Node:
        derived_from: onap.node.wan.Component
        description: Node resource, it could be site or ne or anything else which can be a host for endPointConnection:
        derived_from: onap.node.wan.Resource
        properties:
            addresscapabilities:
     
			- connection:
				type: tosca.capabilities.network.Linkable
         typerequirements: string
            - fcs: 
  description: ip, or mac, or geo address
            vendor:node: onap.node.wan.Resource.Fc 
                typecapabilities: stringtosca.capabilities.Node
        capabilities:
        relationship: tosca.relationships.DependsOn  
			-  host: 
links:
				node: onap.node.wan.Resource.Link
				capabilities: tosca.capabilities.Node
                relationship:    typetosca.relationships.DependsOn
			- fds:
				node: onap.capabilitynode.wan.host
 Resource.Fd
				capabilities: tosca.capabilities.Node
       requirements:
         relationship: tosca.relationships.DependsOn
Code Block
titleonap.node.wan.Resource.Fd
collapsetrue
onap.node.wan.Resource.Fd  parentNode:
                nodederived_from: onap.node.wan.Component.NodeResource
        description: The Forwarding Domain (FD) class models the topological capability:component  onap.capability.wan.host
                relationship: onap.relationship.wan.HostOn
Code Block
titleonap.node.wan.Component.FC
collapsetrue
onap.node.wan.Component.FC:that represents a forwarding capability that provides the opportunity to enable forwarding (of specific transport characteristic information at one or more protocol layers) between points.
        descriptionproperties:
 The ForwardingConstruct (FC) class models enabled constrained potential for forwarding between twoaddress:
 or more interfaces at a particular specific layerProtocol. 
        derived_fromtype: onap.node.wan.Component
string
          properties:
      description: ip, or mac, or geo topology:
address
        capabilities:
            - typedomain: string
                type:  constraints:
 tosca.capabilities.Attachment
			- node:
				type: tosca.capabilities.Node
        requirements:
            - valid_values: ['hub-spoke','fullmesh','p2p']higherLevelFd:
				node: onap.node.wan.Resource.Fd
    
            tenant:
capabilities: tosca.capabilities.Attachment
                relationship: tosca.relationships.AttachesTo     type: string

			- ltps:
				node: onap.node.wan.Resource.Ltp
             creator:   capabilities:  tosca.capabilities.Attachment
                typerelationship: tosca.relationships.AttachesTo string
Code Block
titleonap.node.wan.Resource.Fc
collapsetrue
onap.node.wan.Resource.Fc:
             description: The creatorForwardingConstruct 
(FC) class models enabled constrained potential for forwarding capabilities:
between two or more interfaces at a particular specific   layerProtocol. dependable:
                typederived_from: onap.capabilitynode.wan.dependableResource
            virtual_linkable:properties: 
                capabilities:
			- node:
				type: tosca.capabilities.wan.VirtualLinkableNode
        requirements: 
            - endPoint:
                node: onap.node.wan.ComponentResource.FCPointFcPort    
                capability				capabilities: tosca.capabilities.network.EndpointBindable
                relationship: toscarelationships.relationshipsnetwork.ConnectsToBindsTo 
            - subFcfcRoute:
                node: onap.node.wan.ComponentResource.FC
                capability: onap.capability.wan.dependableFcRoute
				capabilities: tosca.capabilities.network.Bindable
                relationship: relationships.network.BindsTo 
			- lowerLevelFc:
				node: onap.relationshipnode.wan.Resource.DependsOnFc 
               - fcRoute:capabilities: tosca.capabilities.Node
                node: relationship: tosca.relationships.DependsOn
Component.FCPoint
Code Block
titleonap.node.wan.Resource.FcPort
collapsetrue
onap.node.wan.Component.FCRoute
Resource.FcPort:
        description: Fowarding Construct Point. The association of the FC to interfaces is made capability:via onap.capability.wan.dependable
           FcPorts. The FcPort class models the access to the FC function.  
     relationship: onap.relationship.wan.DependsOn
Code Block
title
   derived_from: onap.node.wan.
collapsetrue
onap.node.wan.Component.FCPointResource
        properties:
        description: Fowarding Construct Point. The association of the FC to interfaces is made via FCPoints. The FCPoint class models the access to the FC function.  
    address:
                type: string
                description: ip, or mac    
          derived_from: onap.node.wan.Component
  FcPortDirection:
                 properties:
 type: string
			role:
				type: string
				constraints:
           interface:
         - valid_values: ['working','protection','protected','symmetric','hub', 'spoke', 'leaf', 'root']  type: string
        capabilities:
        addressrequirements:
                type: string- fd:
				node: onap.node.wan.Resource.Ltp
                descriptioncapabilities: ip, or mac tosca.capabilities.Attachment
     
            hub-spoke-role:relationship: tosca.relationships.AttachesTo
                type: string
    - ltp:
				node: onap.node.wan.Resource.Ltp
            description: role of the FC Pointcapabilities: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo
Code Block
titleonap.node.wan.Resource.LinkPort
collapsetrue
onap.node.wan.Resource.LinkPort constraints:
        description: The association of the Link to LTPs is made via LinkPort. - valid_values: ['hub','spoke']
         The LinkPort class models the access to the Link function.  
       required derived_from: falseonap.node.wan.Resource
        capabilitiesproperties:
            endPointrole:
                type: tosca.capabilities.Endpoint
  string
      requirements:
            nodedescription:
 Each LinkPort of the Link has a         node: onap.node.wan.Component.Node
                capability:  onap.capability.wan.hostrole (e.g., symmetric, hub, spoke, leaf, root) in the context of the Link with respect to the Link capability. 
                relationship: onap.relationship.wan.HostOn
Code Block
titleonap.node.wan.Component.XCPoint
collapsetrue
onap.node.wan.Component.XCPoint:
        description: Exchange Connection Point. Interfaces involved in exchange in a node
constraints:
               derived_from: onap.node.wan.Component
    - valid_values: ['symmetric','hub',  properties:
 'spoke', 'leaf', 'root']   
        hub-spoke-rolecapabilities:
        requirements:
        type: string
   - ltp:
            description: role of the FC Pointnode: onap.node.wan.Resource.Ltp
                constraints:capabilities: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo
Code Block
titleonap.node.wan.Resource.Ltp
collapsetrue
onap.node.wan.Resource.Ltp:    - valid_values: ['hub','spoke']
                requireddescription: falseThe Logical Termination  
            interface:
        Point (LTP) class encapsulates the termination and adaptation functions of one or more transport layers represented by instances of LayerProtocol.
        typederived_from: stringonap.node.wan.Resource
        capabilitiesproperties:
            endPointphysicalPortReference:
                type: tosca.capabilities.Endpoint
        requirements:string
            nodeltpDirection:
                nodetype: onap.node.wan.Component.Node
        string
        capabilitycapabilities:
  onap.capability.wan.host
          - endPoint:
     relationship: onap.relationship.wan.HostOn
Code Block
titleonap.node.wan.Component.XC
collapsetrue
onap.node.wan.Component.XC:
        descriptiontype: Exchange Connection. The exchange relationship within a node describes how the interfaces within the node are linked.
tosca.capabilities.Endpoint  
        requirements:
             derived_from- fd:
				node: onap.node.wan.Resource.ComponentFd
        properties:
        requirementscapabilities:  tosca.capabilities.Attachment
            - endPort:
   relationship: tosca.relationships.AttachesTo  
          node: onap.node.wan.Component.XcPoint   - serverLtp:
                capabilitynode: tosca.capabilities.Endpoint
                relationshiponap.node.wan.Resource.Ltp
				capabilities: tosca.relationships.ConnectsTo   capabilities.Node
                descriptionrelationship: all endPorts can access each othertosca.relationships.DependsOn  
            - nelp:
                node: onap.node.wan.Component.Node    Resource.LayerProtocol
                capabilitycapabilities:  onaptosca.capabilitycapabilities.wannetwork.hostBindable
                relationship: onaprelationships.relationship.wan.HostOnnetwork.BindsTo
Code Block
titleonap.node.wan.ComponentResource.LinkConnectionLayerProtocol
collapsetrue
onap.node.wan.ComponentResource.LinkConnectionLayerProtocol:
        description: The exchange relationship between nodes, describing how the interfaces between nodes are linked. The link can depend on the FC of the service layer projection of an LTP into each transport layer is represented by a LayerProtocol (LP) instance. A LayerProtocol instance can be 
used for controlling termination and monitoring functionality. 
        derived_from: onap.node.wan.ComponentResource
        properties:
           topology layerProtocolName:
                type: string
            address: string

                type: string
Code Block
titleonap.node.wan.Resource.Link
collapsetrue
onap.node.wan.Resource.Link:
        constraintsdescription:
 The Link class models effective adjacency between two or more ForwardingDomains (FD). 
       - validderived_values: ['hub-spoke','fullmesh','p2p']from: onap.node.wan.Resource
        properties:
		capabilities:
			- node:
				type: tosca.capabilities.Node
        requirements: 
            - fc:
                node: onap.node.wan.ComponentResource.FC
                capability: onap.capability.wan.dependableFc
				capabilities: tosca.capabilities.Node
                relationship: onaptosca.relationshiprelationships.wan.DependsOn  
            - endPoint:
                node: onap.node.wan.ComponentResource.XcPointLinkPort    
                capabilitycapabilities: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo    ConnectsTo
Code Block
titleonap.node.wan.ComponentResource.FCRouteFcRoute
collapsetrue
onap.node.wan.ComponentResource.FCRouteFcRoute:
        description: The routing relationships within FC are described, including routing between sub FC (interdomain links), and links between network elements and network elements.
        derived_from: onap.node.wan.ComponentResource
        properties:
        capabilities:
            dependable:
                type: onap.capability.wan.dependable        
        requirements:
            - xclink: 
                node: onap.node.wan.ComponentResource.XC
                capability: onap.capability.wan.componentLink
				capabilities: tosca.capabilities.Node
                relationship: onaptosca.relationship.wan.Contains  relationships.DependsOn
            - lcsubFc:
                node: onap.node.wan.ComponentResource.LinkConnection
                capability: onap.capability.wan.componentFc
				capabilities: tosca.capabilities.Node
                relationship: onaptosca.relationship.wan.Contains  relationships.DependsOn


R3 Class Explain

Wan Connection IM proposal