catalog-be/src/main/resources/import/tosca/heat-types/overlayTunnel/overlayTunnel.yml

   1 tosca_definitions_version: tosca_simple_yaml_1_0
   2 description: overlay L3 vpn type definitions
   3
   4 # *****************************************************************************
   5 # overlay tunnel type definitions
   6 # *****************************************************************************
   7
   8 metadata:
   9     id: overlayTunnelDefinition
  10     version: 0.1
  11     vendor: ONAP
  12     template_author: ONAP
  13
  14 # *****************************************************************************
  15 # node types
  16 # *****************************************************************************
  17
  18 node_types:
  19
  20     # *****************************************************************************
  21     #            Overlay tunnel service
  22     # *****************************************************************************
  23
  24     org.openecomp.resource.vl.overlaytunnel:
  25         derived_from: tosca.nodes.Root
  26         description: This entity represents abstract overlay tunnel end point.
  27         properties:
  28             id:
  29                 type: string
  30                 description: Identifier of the Tunnel Endpoint node.
  31                 required: false
  32             template_name:
  33                 type: string
  34                 required: false
  35             version:
  36                 type: string
  37                 required: false
  38             name:
  39                 type: string
  40                 description: Overlay tunnel name used by for reference by the administrator.
  41                 required: false
  42             description:
  43                 type: string
  44                 description: Additional comments/information about overlay tunnel.
  45                 required: false
  46             tunnelType:
  47                 type: string
  48                 constraints:
  49                       - valid_values: ['L3-DCI','L2-DCI']
  50                 description: type defines if the overlay tunnel is L3-DCI tunnel or L2-DCI tunnel.
  51                 required: true
  52             site1_id:
  53                 type: string
  54                 description: Identifier of first DCI overlay tunnel endpoint. This could be IP address of domain controller.
  55                 required: true
  56             site1_description:
  57                 type: string
  58                 description: Additional comments/information about overlay tunnel. Description can also be used to identify domain controller.
  59                 required: false
  60             site1_networkName:
  61                 type: string
  62                 description: Name of the network that is being associated with overlay tunnel.
  63                 required: true
  64             site1_routerId:
  65                 type: string
  66                 description: Identifier of router connected to L3 tunnel end point, while configuring L3-DCI tunnel.
  67                 required: false
  68             site1_importRT1:
  69                 type: string
  70                 description: List of Route targets imported by the local router.
  71                 required: false
  72             site1_exportRT1:
  73                 type: string
  74                 description: List of Route targets exported by the local router.
  75                 required: false
  76             site1_vni:
  77                 type: integer
  78                 description: VXLAN ID
  79                 required: false
  80             site1_fireWallEnable:
  81                 type: boolean
  82                 required: false
  83                 description: Identifies if a firewall exists in the path of overlay tunnel.
  84                 default: false
  85             site1_fireWallId:
  86                 type: string
  87                 description: Identifier of Firewall that is in overlay tunnel path
  88                 required: false
  89             site1_localNetworkAll:
  90                 type: boolean
  91                 description: Identifies whether all the local networks associate with the tunnel or not.
  92                 required: false
  93                 default: 'false'
  94             site2_id:
  95                 type: string
  96                 description: Identifier of second DCI overlay tunnel endpoint. This could be IP address of domain controller.
  97                 required: true
  98             site2_description:
  99                 type: string
 100                 description: Additional comments/information about overlay tunnel. Description can also be used to identify domain controller.
 101                 required: false
 102             site2_networkName:
 103                 type: string
 104                 description: Name of the network that is being associated with overlay tunnel.
 105                 required: true
 106             site2_routerId:
 107                 type: string
 108                 description: Identifier of router connected to L3 tunnel end point, while configuring L3-DCI tunnel.
 109                 required: false
 110             site2_importRT1:
 111                 type: string
 112                 description: List of Route targets imported by the local router.
 113                 required: false
 114             site2_exportRT1:
 115                 type: string
 116                 description: List of Route targets exported by the local router.
 117                 required: false
 118             site2_vni:
 119                 type: integer
 120                 description: VXLAN ID
 121                 required: false
 122             site2_fireWallEnable:
 123                 type: boolean
 124                 required: false
 125                 description: Identifies if a firewall exists in the path of overlay tunnel.
 126                 default: false
 127             site2_fireWallId:
 128                 type: string
 129                 description: Identifier of Firewall that is in overlay tunnel path
 130                 required: false
 131             site2_localNetworkAll:
 132                 type: boolean
 133                 description: Identifies whether all the local networks associate with the tunnel or not.
 134                 required: false
 135                 default: 'false'
 136         requirements:
 137             - virtualLink:
 138                 capability: tosca.capabilities.network.Linkable
 139                 relationship: tosca.relationships.network.LinksTo
 140         capabilities:
 141             virtual_linkable:
 142             type: tosca.capabilities.network.Linkable