Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
titledata type:
Code Block
titleonap.datatype.wan.UserDefine
collapsetrue
onap.datatype.wan.UserDefine:
        derived_from: tosca.datatypes.Root
        properties:
            name:
                type: string
                description: resful uri supported
                required: true
            value:
                type: string
                required: false  
Panel
titlecapability types:
Code Block
titleonap.capability.wan.host
collapsetrue
onap.capability.wan.host:
         derived_from: tosca.capabilities.Node  
Code Block
titleonap.capability.wan.component
collapsetrue
onap.capability.wan.component:
         derived_from: tosca.capabilities.Root    
Code Block
titleonap.capability.wan.dependable
collapsetrue
onap.capability.wan.dependable:
         derived_from: tosca.capabilities.Root  
Panel
titlerelationship types:
Code Block
titleonap.relationship.wan.HostOn
collapsetrue
onap.relationship.wan.HostOn:
        description: >-
            The relationship specifies what Node the Endpoint is hosted on. 
        derived_from: tosca.relationships.Root
        valid_target_types: [onap.capability.wan.host]     
Code Block
titleonap.relationship.wan.Contains
collapsetrue
onap.relationship.wan.Contains:
        description: >-
            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.DependsOn:
        description: >-
            The relationship specifies what is depended on. 
        derived_from: tosca.relationships.Root
        valid_target_types: [onap.capability.wan.dependable]    
Panel
titlenode types?
Code Block
titleonap.node.wan.Component
collapsetrue
onap.node.wan.Component:
        derived_from: tosca.nodes.Root
        properties:
            uuid:
                type: string
            name:
                type: string
            version:
                type: string
            description:
                type: string    
            type:
                type: string
                description: component type
            paras:
                type: list
                entry_schema:
                    type: onap.datatype.wan.UserDefine   
            deploy-mode:
                type: string
                description: 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.
                constraints:
                    - valid_values: ['all-in-one','step-by-step']        
            deploy-order?
                type: integer
                description: effective while deploy-mode equals 'step-by-step', smaller number first
        capabilities:
            component:
                type: onap.capability.wan.component            
        requirements:
            - configuration: 
                node: onap.node.wan.Component 
                capability: onap.capability.wan.component
                relationship: onap.relationship.wan.Contains    
Code Block
titleonap.node.wan.Component.Node
collapsetrue
onap.node.wan.Component.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 endPoint
        properties:
            address:
                type: string
                description: ip, or mac, or geo address
            vendor:
                type: string
        capabilities:
            host: 
                type: onap.capability.wan.host
        requirements:
            parentNode:
                node: onap.node.wan.Component.Node
                capability:  onap.capability.wan.host
                relationship: onap.relationship.wan.HostOn     
Code Block
titleonap.node.wan.Component.FC
collapsetrue
onap.node.wan.Component.FC:
        description: The ForwardingConstruct (FC) class models enabled constrained potential for forwarding between two or more interfaces at a particular specific layerProtocol. 
        derived_from: onap.node.wan.Component
        properties:
            topology:
                type: string
                constraints:
                    - valid_values: ['hub-spoke','fullmesh','p2p']    
            tenant:
                type: string
            creator:
                type:  string
                description:  creator 
        capabilities:
            dependable:
                type: onap.capability.wan.dependable
            virtual_linkable:
                type: tosca.capabilities.nfv.VirtualLinkable
        requirements: 
            - endPoint:
                node: onap.node.wan.Component.FCPoint    
                capability: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo
            - subFc:
                node: onap.node.wan.Component.FC
                capability: onap.capability.wan.dependable
                relationship: onap.relationship.wan.DependsOn
            - fcRoute:
                node: onap.node.wan.Component.FCRoute
                capability: onap.capability.wan.dependable
                relationship: onap.relationship.wan.DependsOn
Code Block
titleonap.node.wan.Component.FCPoint
collapsetrue
onap.node.wan.Component.FCPoint:
        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.  
        derived_from: onap.node.wan.Component
        properties:
            interface:
                type: string
            address:
                type: string
                description: ip, or mac    
            hub-spoke-role:
                type: string
                description: role of the FC Point
                constraints:
                    - valid_values: ['hub','spoke']
                required: false
        capabilities:
            endPoint:
                type: tosca.capabilities.Endpoint
        requirements:
            node:
                node: onap.node.wan.Component.Node
                capability:  onap.capability.wan.host
                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
        derived_from: onap.node.wan.Component
        properties:
            hub-spoke-role:
                type: string
                description: role of the FC Point
                constraints:
                    - valid_values: ['hub','spoke']
                required: false    
            interface:
                type: string
            peerId
                type: string
        capabilities:
            endPoint:
                type: tosca.capabilities.Endpoint
        requirements:
            node:
                node: onap.node.wan.Component.Node
                capability:  onap.capability.wan.host
                relationship: onap.relationship.wan.HostOn  
Code Block
titleonap.node.wan.Component.XC
collapsetrue
onap.node.wan.Component.XC:
        description: Exchange Connection. The exchange relationship within a node describes how the interfaces within the node are linked.
        derived_from: onap.node.wan.Component
        properties:
        requirements: 
            - endPort:
                node: onap.node.wan.Component.XcPoint    
                capability: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo   
                description: all endPorts can access each other
            - ne:
                node: onap.node.wan.Component.Node    
                capability:  onap.capability.wan.host
                relationship: onap.relationship.wan.HostOn
Code Block
titleonap.node.wan.Component.LinkConnection
collapsetrue
onap.node.wan.Component.LinkConnection:
        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
        derived_from: onap.node.wan.Component
        properties:
          topology:
                type: string
                constraints:
                    - valid_values: ['hub-spoke','fullmesh','p2p']       
        requirements: 
            - fc:
                node: onap.node.wan.Component.FC
                capability: onap.capability.wan.dependable
                relationship: onap.relationship.wan.DependsOn
            - endPoint:
                node: onap.node.wan.Component.XcPoint    
                capability: tosca.capabilities.Endpoint
                relationship: tosca.relationships.ConnectsTo    
Code Block
titleonap.node.wan.Component.FCRoute
collapsetrue
onap.node.wan.Component.FCRoute:
        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.Component
        properties:
        capabilities:
            dependable:
                type: onap.capability.wan.dependable        
        requirements:
            - xc: 
                node: onap.node.wan.Component.XC
                capability: onap.capability.wan.component
                relationship: onap.relationship.wan.Contains  
            - lc:
                node: onap.node.wan.Component.LinkConnection
                capability: onap.capability.wan.component
                relationship: onap.relationship.wan.Contains