common/onap-tosca-datatype/src/main/resources/globalTypes/tosca/data.yml

   1 #
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at
   5 #
   6 #      http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13 #
  14
  15 tosca_definitions_version: tosca_simple_yaml_1_1
  16
  17 metadata:
  18   filename: tosca/data.yml
  19   version: '1.0'
  20
  21 imports:
  22 - tosca_index:
  23     file: _index.yml
  24
  25 data_types:
  26   tosca.datatypes.Root:
  27     description: The TOSCA root Data Type all other TOSCA base Data Types derive from
  28
  29   string:
  30     derived_from: tosca.datatypes.Root
  31
  32   integer:
  33     derived_from: tosca.datatypes.Root
  34
  35   boolean:
  36     derived_from: tosca.datatypes.Root
  37
  38   float:
  39     derived_from: tosca.datatypes.Root
  40
  41   range:
  42     derived_from: tosca.datatypes.Root
  43
  44   list:
  45     derived_from: tosca.datatypes.Root
  46
  47   map:
  48     derived_from: tosca.datatypes.Root
  49
  50   timestamp:
  51     derived_from: tosca.datatypes.Root
  52
  53   version:
  54     derived_from: tosca.datatypes.Root
  55
  56   scalar-unit.size:
  57     derived_from: tosca.datatypes.Root
  58
  59   scalar-unit.frequency:
  60     derived_from: tosca.datatypes.Root
  61
  62   scalar-unit.time:
  63     derived_from: tosca.datatypes.Root
  64
  65   tosca.datatypes.network.NetworkInfo:
  66     derived_from: tosca.datatypes.Root
  67     description: The Network type is a complex TOSCA data type used to describe logical network information.
  68     properties:
  69       network_name:
  70         description: The name of the logical network. e.g., "public", "private", "admin". etc.
  71         type: string
  72         required: false
  73       network_id:
  74         description: The unique ID of for the network generated by the network provider.
  75         type: string
  76         required: false
  77       addresses:
  78         description: The list of IP addresses assigned from the underlying network.
  79         type: list
  80         entry_schema:
  81           type: string
  82         required: false
  83
  84   tosca.datatypes.TimeInterval:
  85     derived_from: tosca.datatypes.Root
  86     properties:
  87       start_time:
  88         type: timestamp
  89         required: true
  90       end_time:
  91         type: timestamp
  92         required: true
  93
  94   tosca.datatypes.network.PortSpec:
  95     derived_from: tosca.datatypes.Root
  96     description: The PortSpec type is a complex TOSCA data Type used when describing port specifications for a network connection.
  97     properties:
  98       protocol:
  99         description: The required protocol used on the port.
 100         type: string
 101         default: tcp
 102         constraints:
 103         - valid_values:
 104           - udp
 105           - tcp
 106           - igmp
 107       source:
 108         description: The optional source port.
 109         type: tosca.datatypes.network.PortDef
 110         required: false
 111       source_range:
 112         description: The optional range for source port.
 113         type: range
 114         required: false
 115         constraints:
 116         - in_range:
 117           - 1
 118           - 65535
 119       target:
 120         description: The optional target port.
 121         type: tosca.datatypes.network.PortDef
 122         required: false
 123       target_range:
 124         description: The optional range for target port.
 125         type: range
 126         required: false
 127         constraints:
 128         - in_range:
 129           - 1
 130           - 65535
 131
 132   tosca.datatypes.network.PortDef:
 133     derived_from: integer
 134     description: The PortDef type is a TOSCA data Type used to define a network port.
 135     constraints:
 136     - in_range:
 137       - 1
 138       - 65535
 139
 140   tosca.datatypes.network.PortInfo:
 141     derived_from: tosca.datatypes.Root
 142     description: The PortInfo type is a complex TOSCA data type used to describe network port information.
 143     properties:
 144       port_name:
 145         description: The logical network port name.
 146         type: string
 147         required: false
 148       port_id:
 149         description: The unique ID for the network port generated by the network provider.
 150         type: string
 151         required: false
 152       network_id:
 153         description: The unique ID for the network.
 154         type: string
 155         required: false
 156       mac_address:
 157         description: The unique media access control address (MAC address) assigned to the port.
 158         type: string
 159         required: false
 160       addresses:
 161         description: The list of IP address(es) assigned to the port.
 162         type: list
 163         entry_schema:
 164           type: string
 165         required: false
 166
 167   tosca.datatypes.Credential:
 168     derived_from: tosca.datatypes.Root
 169     description: The Credential type is a complex TOSCA data Type used when describing authorization credentials used to access network accessible resources.
 170     properties:
 171       protocol:
 172         description: The optional protocol name.
 173         type: string
 174         required: false
 175       token_type:
 176         description: The required token type.
 177         type: string
 178         default: password
 179       token:
 180         description: The required token used as a credential for authorization or access to a networked resource.
 181         type: string
 182       keys:
 183         description: The optional list of protocol-specific keys or assertions.
 184         type: map
 185         entry_schema:
 186           type: string
 187         required: false
 188       user:
 189         description: The optional user (name or ID) used for non-token based credentials.
 190         type: string
 191         required: false