Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1 | tosca_definitions_version: tosca_simple_yaml_1_0 |
| 2 | |
| 3 | # Note: Tosca derived_from isn't working the way I think it should, it's not |
| 4 | # inheriting from the parent template. Until we get that figured out, use |
| 5 | # m4 macros do our inheritance |
| 6 | |
| 7 | |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 8 | # Service |
| 9 | |
| 10 | |
| 11 | # Subscriber |
| 12 | |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 13 | |
| 14 | |
| 15 | |
| 16 | # end m4 macros |
| 17 | # |
| 18 | # compile this with "m4 custom_types/xos.m4 > custom_types/xos.yaml" |
| 19 | |
| 20 | node_types: |
| 21 | tosca.nodes.Service: |
| 22 | derived_from: tosca.nodes.Root |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 23 | description: > |
| 24 | An XOS Service object. Services may be listed in the Service |
| 25 | directory and may be linked together via Tenancy Relationships. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 26 | capabilities: |
| 27 | scalable: |
| 28 | type: tosca.capabilities.Scalable |
| 29 | service: |
| 30 | type: tosca.capabilities.xos.Service |
| 31 | properties: |
Scott Baker | 9d9b675 | 2016-02-04 10:40:34 -0800 | [diff] [blame] | 32 | no-delete: |
| 33 | type: boolean |
| 34 | default: false |
| 35 | description: Do not allow Tosca to delete this object |
| 36 | no-create: |
| 37 | type: boolean |
| 38 | default: false |
| 39 | description: Do not allow Tosca to create this object |
| 40 | no-update: |
| 41 | type: boolean |
| 42 | default: false |
| 43 | description: Do not allow Tosca to update this object |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 44 | kind: |
| 45 | type: string |
| 46 | default: generic |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 47 | description: Type of service. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 48 | view_url: |
| 49 | type: string |
| 50 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 51 | description: URL to follow when icon is clicked in the Service Directory. |
Scott Baker | 5deb33d | 2015-08-10 17:08:54 -0700 | [diff] [blame] | 52 | icon_url: |
| 53 | type: string |
| 54 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 55 | description: ICON to display in the Service Directory. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 56 | enabled: |
| 57 | type: boolean |
| 58 | default: true |
| 59 | published: |
| 60 | type: boolean |
| 61 | default: true |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 62 | description: If True then display this Service in the Service Directory. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 63 | public_key: |
| 64 | type: string |
| 65 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 66 | description: Public key to install into Instances to allows Services to SSH into them. |
Scott Baker | f60c010 | 2015-11-12 16:22:52 -0800 | [diff] [blame] | 67 | private_key_fn: |
| 68 | type: string |
| 69 | required: false |
| 70 | description: Location of private key file |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 71 | versionNumber: |
| 72 | type: string |
| 73 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 74 | description: Version number of Service. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 75 | |
Scott Baker | eeb6252 | 2015-12-10 23:04:44 -0800 | [diff] [blame] | 76 | tosca.nodes.Tenant: |
| 77 | derived_from: tosca.nodes.Root |
| 78 | description: > |
| 79 | An ONOS Tenant. |
| 80 | properties: |
| 81 | kind: |
| 82 | type: string |
| 83 | default: generic |
| 84 | description: Kind of tenant |
| 85 | service_specific_id: |
| 86 | type: string |
| 87 | required: false |
| 88 | description: Service specific ID opaque to XOS but meaningful to service |
| 89 | service_specific_attribute: |
| 90 | type: string |
| 91 | required: false |
Scott Baker | 3e3d538 | 2015-12-10 23:24:12 -0800 | [diff] [blame] | 92 | description: Service-specific attribute, usually a string containing a json dictionary |
| 93 | model: |
| 94 | type: string |
| 95 | required: false |
| 96 | description: Name of model to use when instantiating tenant |
Scott Baker | eeb6252 | 2015-12-10 23:04:44 -0800 | [diff] [blame] | 97 | |
Scott Baker | 2abd6a5 | 2015-10-16 17:47:22 -0700 | [diff] [blame] | 98 | tosca.nodes.ONOSService: |
| 99 | derived_from: tosca.nodes.Root |
| 100 | description: > |
| 101 | ONOS Service |
| 102 | capabilities: |
| 103 | scalable: |
| 104 | type: tosca.capabilities.Scalable |
| 105 | service: |
| 106 | type: tosca.capabilities.xos.Service |
| 107 | properties: |
Scott Baker | 9d9b675 | 2016-02-04 10:40:34 -0800 | [diff] [blame] | 108 | no-delete: |
| 109 | type: boolean |
| 110 | default: false |
| 111 | description: Do not allow Tosca to delete this object |
| 112 | no-create: |
| 113 | type: boolean |
| 114 | default: false |
| 115 | description: Do not allow Tosca to create this object |
| 116 | no-update: |
| 117 | type: boolean |
| 118 | default: false |
| 119 | description: Do not allow Tosca to update this object |
Scott Baker | 2abd6a5 | 2015-10-16 17:47:22 -0700 | [diff] [blame] | 120 | kind: |
| 121 | type: string |
| 122 | default: generic |
| 123 | description: Type of service. |
| 124 | view_url: |
| 125 | type: string |
| 126 | required: false |
| 127 | description: URL to follow when icon is clicked in the Service Directory. |
| 128 | icon_url: |
| 129 | type: string |
| 130 | required: false |
| 131 | description: ICON to display in the Service Directory. |
| 132 | enabled: |
| 133 | type: boolean |
| 134 | default: true |
| 135 | published: |
| 136 | type: boolean |
| 137 | default: true |
| 138 | description: If True then display this Service in the Service Directory. |
| 139 | public_key: |
| 140 | type: string |
| 141 | required: false |
| 142 | description: Public key to install into Instances to allows Services to SSH into them. |
Scott Baker | f60c010 | 2015-11-12 16:22:52 -0800 | [diff] [blame] | 143 | private_key_fn: |
| 144 | type: string |
| 145 | required: false |
| 146 | description: Location of private key file |
Scott Baker | 2abd6a5 | 2015-10-16 17:47:22 -0700 | [diff] [blame] | 147 | versionNumber: |
| 148 | type: string |
| 149 | required: false |
| 150 | description: Version number of Service. |
Scott Baker | ed0ae7b | 2015-12-07 22:20:02 -0800 | [diff] [blame] | 151 | rest_onos/v1/network/configuration/: |
| 152 | type: string |
| 153 | required: false |
Scott Baker | f510bf8 | 2016-02-10 14:05:01 -0800 | [diff] [blame] | 154 | rest_hostname: |
| 155 | type: string |
| 156 | required: false |
| 157 | rest_port: |
| 158 | type: string |
| 159 | required: false |
| 160 | no_container: |
| 161 | type: boolean |
| 162 | default: false |
Scott Baker | 7b897e3 | 2016-02-12 17:31:04 -0800 | [diff] [blame] | 163 | node_key: |
Scott Baker | c8ef20a | 2016-02-11 20:39:34 -0800 | [diff] [blame] | 164 | type: string |
| 165 | required: false |
Scott Baker | ed0ae7b | 2015-12-07 22:20:02 -0800 | [diff] [blame] | 166 | |
Scott Baker | 2abd6a5 | 2015-10-16 17:47:22 -0700 | [diff] [blame] | 167 | |
| 168 | tosca.nodes.ONOSApp: |
| 169 | derived_from: tosca.nodes.Root |
| 170 | description: > |
| 171 | An ONOS Application. |
| 172 | properties: |
| 173 | kind: |
| 174 | type: string |
| 175 | default: generic |
| 176 | description: Kind of tenant |
| 177 | service_specific_id: |
| 178 | type: string |
| 179 | required: false |
| 180 | description: Service specific ID opaque to XOS but meaningful to service |
Scott Baker | 881f745 | 2015-10-19 16:24:02 -0700 | [diff] [blame] | 181 | dependencies: |
| 182 | type: string |
| 183 | required: false |
Scott Baker | 2abd6a5 | 2015-10-16 17:47:22 -0700 | [diff] [blame] | 184 | |
| 185 | tosca.nodes.ONOSvBNGApp: |
| 186 | derived_from: tosca.nodes.Root |
| 187 | description: > |
Scott Baker | 535640b | 2015-10-21 10:54:29 -0700 | [diff] [blame] | 188 | An ONOS vBNG Application. |
Scott Baker | 2abd6a5 | 2015-10-16 17:47:22 -0700 | [diff] [blame] | 189 | properties: |
| 190 | kind: |
| 191 | type: string |
| 192 | default: generic |
| 193 | description: Kind of tenant |
| 194 | service_specific_id: |
| 195 | type: string |
| 196 | required: false |
| 197 | description: Service specific ID opaque to XOS but meaningful to service |
Scott Baker | 881f745 | 2015-10-19 16:24:02 -0700 | [diff] [blame] | 198 | dependencies: |
| 199 | type: string |
| 200 | required: false |
Srikanth Vavilapalli | 6ff5598 | 2016-01-22 14:35:50 -0500 | [diff] [blame] | 201 | install_dependencies: |
| 202 | type: string |
| 203 | required: false |
| 204 | component_config: |
| 205 | type: string |
| 206 | required: false |
Scott Baker | 907f991 | 2015-10-20 17:12:36 -0700 | [diff] [blame] | 207 | config_addresses.json: |
Scott Baker | 2abd6a5 | 2015-10-16 17:47:22 -0700 | [diff] [blame] | 208 | type: string |
| 209 | required: false |
Andy Bavier | b90a462 | 2015-10-26 11:53:22 -0400 | [diff] [blame] | 210 | config_network-cfg.json: |
| 211 | type: string |
| 212 | required: false |
Scott Baker | 907f991 | 2015-10-20 17:12:36 -0700 | [diff] [blame] | 213 | config_virtualbng.json: |
Scott Baker | 2abd6a5 | 2015-10-16 17:47:22 -0700 | [diff] [blame] | 214 | type: string |
| 215 | required: false |
| 216 | |
Scott Baker | 535640b | 2015-10-21 10:54:29 -0700 | [diff] [blame] | 217 | tosca.nodes.ONOSvOLTApp: |
| 218 | derived_from: tosca.nodes.Root |
| 219 | description: > |
| 220 | An ONOS vOLT Application. |
| 221 | properties: |
| 222 | kind: |
| 223 | type: string |
| 224 | default: generic |
| 225 | description: Kind of tenant |
| 226 | service_specific_id: |
| 227 | type: string |
| 228 | required: false |
| 229 | description: Service specific ID opaque to XOS but meaningful to service |
| 230 | dependencies: |
| 231 | type: string |
| 232 | required: false |
Srikanth Vavilapalli | 6ff5598 | 2016-01-22 14:35:50 -0500 | [diff] [blame] | 233 | install_dependencies: |
| 234 | type: string |
| 235 | required: false |
| 236 | component_config: |
| 237 | type: string |
| 238 | required: false |
Andy Bavier | 28c3f17 | 2015-11-02 15:43:59 -0500 | [diff] [blame] | 239 | config_network-cfg.json: |
| 240 | type: string |
| 241 | required: false |
Scott Baker | a758d82 | 2015-12-03 21:14:39 -0800 | [diff] [blame] | 242 | rest_onos/v1/network/configuration/: |
| 243 | type: string |
| 244 | required: false |
Scott Baker | 535640b | 2015-10-21 10:54:29 -0700 | [diff] [blame] | 245 | |
Scott Baker | 49cad89 | 2015-12-15 17:59:26 -0800 | [diff] [blame] | 246 | tosca.nodes.ONOSVTNApp: |
| 247 | derived_from: tosca.nodes.Root |
| 248 | description: > |
| 249 | An ONOS VTN Application. |
| 250 | properties: |
| 251 | kind: |
| 252 | type: string |
| 253 | default: generic |
| 254 | description: Kind of tenant |
| 255 | service_specific_id: |
| 256 | type: string |
| 257 | required: false |
| 258 | description: Service specific ID opaque to XOS but meaningful to service |
| 259 | dependencies: |
| 260 | type: string |
| 261 | required: false |
| 262 | rest_onos/v1/network/configuration/: |
| 263 | type: string |
| 264 | required: false |
Andy Bavier | 7532cef | 2016-04-14 15:13:12 -0400 | [diff] [blame] | 265 | autogenerate: |
| 266 | type: string |
| 267 | required: false |
Scott Baker | 49cad89 | 2015-12-15 17:59:26 -0800 | [diff] [blame] | 268 | |
Scott Baker | 4698b92 | 2016-02-11 12:07:10 -0800 | [diff] [blame] | 269 | tosca.nodes.VSGService: |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 270 | description: > |
Scott Baker | 4698b92 | 2016-02-11 12:07:10 -0800 | [diff] [blame] | 271 | CORD: The vSG Service. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 272 | derived_from: tosca.nodes.Root |
| 273 | capabilities: |
| 274 | scalable: |
| 275 | type: tosca.capabilities.Scalable |
| 276 | service: |
| 277 | type: tosca.capabilities.xos.Service |
| 278 | properties: |
Scott Baker | 9d9b675 | 2016-02-04 10:40:34 -0800 | [diff] [blame] | 279 | no-delete: |
| 280 | type: boolean |
| 281 | default: false |
| 282 | description: Do not allow Tosca to delete this object |
| 283 | no-create: |
| 284 | type: boolean |
| 285 | default: false |
| 286 | description: Do not allow Tosca to create this object |
| 287 | no-update: |
| 288 | type: boolean |
| 289 | default: false |
| 290 | description: Do not allow Tosca to update this object |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 291 | kind: |
| 292 | type: string |
| 293 | default: generic |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 294 | description: Type of service. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 295 | view_url: |
| 296 | type: string |
| 297 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 298 | description: URL to follow when icon is clicked in the Service Directory. |
Scott Baker | 5deb33d | 2015-08-10 17:08:54 -0700 | [diff] [blame] | 299 | icon_url: |
| 300 | type: string |
| 301 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 302 | description: ICON to display in the Service Directory. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 303 | enabled: |
| 304 | type: boolean |
| 305 | default: true |
| 306 | published: |
| 307 | type: boolean |
| 308 | default: true |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 309 | description: If True then display this Service in the Service Directory. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 310 | public_key: |
| 311 | type: string |
| 312 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 313 | description: Public key to install into Instances to allows Services to SSH into them. |
Scott Baker | f60c010 | 2015-11-12 16:22:52 -0800 | [diff] [blame] | 314 | private_key_fn: |
| 315 | type: string |
| 316 | required: false |
| 317 | description: Location of private key file |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 318 | versionNumber: |
| 319 | type: string |
| 320 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 321 | description: Version number of Service. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 322 | backend_network_label: |
| 323 | type: string |
| 324 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 325 | description: Label that matches network used to connect HPC and BBS services. |
Scott Baker | da3122a | 2016-02-23 14:58:49 -0800 | [diff] [blame] | 326 | dns_servers: |
| 327 | type: string |
| 328 | required: false |
Scott Baker | 6526f55 | 2016-03-04 11:29:02 -0800 | [diff] [blame] | 329 | node_label: |
| 330 | type: string |
| 331 | required: false |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 332 | |
Scott Baker | 5deb33d | 2015-08-10 17:08:54 -0700 | [diff] [blame] | 333 | tosca.nodes.VBNGService: |
| 334 | derived_from: tosca.nodes.Root |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 335 | description: > |
| 336 | CORD: The vBNG Service. |
Scott Baker | 5deb33d | 2015-08-10 17:08:54 -0700 | [diff] [blame] | 337 | capabilities: |
| 338 | scalable: |
| 339 | type: tosca.capabilities.Scalable |
| 340 | service: |
| 341 | type: tosca.capabilities.xos.Service |
| 342 | properties: |
Scott Baker | 9d9b675 | 2016-02-04 10:40:34 -0800 | [diff] [blame] | 343 | no-delete: |
| 344 | type: boolean |
| 345 | default: false |
| 346 | description: Do not allow Tosca to delete this object |
| 347 | no-create: |
| 348 | type: boolean |
| 349 | default: false |
| 350 | description: Do not allow Tosca to create this object |
| 351 | no-update: |
| 352 | type: boolean |
| 353 | default: false |
| 354 | description: Do not allow Tosca to update this object |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 355 | kind: |
| 356 | type: string |
| 357 | default: generic |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 358 | description: Type of service. |
Scott Baker | 5deb33d | 2015-08-10 17:08:54 -0700 | [diff] [blame] | 359 | view_url: |
| 360 | type: string |
| 361 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 362 | description: URL to follow when icon is clicked in the Service Directory. |
Scott Baker | 5deb33d | 2015-08-10 17:08:54 -0700 | [diff] [blame] | 363 | icon_url: |
| 364 | type: string |
| 365 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 366 | description: ICON to display in the Service Directory. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 367 | enabled: |
| 368 | type: boolean |
| 369 | default: true |
| 370 | published: |
| 371 | type: boolean |
| 372 | default: true |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 373 | description: If True then display this Service in the Service Directory. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 374 | public_key: |
| 375 | type: string |
| 376 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 377 | description: Public key to install into Instances to allows Services to SSH into them. |
Scott Baker | f60c010 | 2015-11-12 16:22:52 -0800 | [diff] [blame] | 378 | private_key_fn: |
| 379 | type: string |
| 380 | required: false |
| 381 | description: Location of private key file |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 382 | versionNumber: |
| 383 | type: string |
| 384 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 385 | description: Version number of Service. |
Scott Baker | 5deb33d | 2015-08-10 17:08:54 -0700 | [diff] [blame] | 386 | vbng_url: |
| 387 | type: string |
| 388 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 389 | description: URL of REST API endpoint for vBNG Service. |
Scott Baker | 5deb33d | 2015-08-10 17:08:54 -0700 | [diff] [blame] | 390 | |
Scott Baker | b1acdbb | 2016-04-13 11:26:17 -0700 | [diff] [blame] | 391 | tosca.nodes.VRouterService: |
| 392 | derived_from: tosca.nodes.Root |
| 393 | description: > |
| 394 | CORD: The vRouter Service. |
| 395 | capabilities: |
| 396 | scalable: |
| 397 | type: tosca.capabilities.Scalable |
| 398 | service: |
| 399 | type: tosca.capabilities.xos.Service |
| 400 | properties: |
| 401 | no-delete: |
| 402 | type: boolean |
| 403 | default: false |
| 404 | description: Do not allow Tosca to delete this object |
| 405 | no-create: |
| 406 | type: boolean |
| 407 | default: false |
| 408 | description: Do not allow Tosca to create this object |
| 409 | no-update: |
| 410 | type: boolean |
| 411 | default: false |
| 412 | description: Do not allow Tosca to update this object |
| 413 | kind: |
| 414 | type: string |
| 415 | default: generic |
| 416 | description: Type of service. |
| 417 | view_url: |
| 418 | type: string |
| 419 | required: false |
| 420 | description: URL to follow when icon is clicked in the Service Directory. |
| 421 | icon_url: |
| 422 | type: string |
| 423 | required: false |
| 424 | description: ICON to display in the Service Directory. |
| 425 | enabled: |
| 426 | type: boolean |
| 427 | default: true |
| 428 | published: |
| 429 | type: boolean |
| 430 | default: true |
| 431 | description: If True then display this Service in the Service Directory. |
| 432 | public_key: |
| 433 | type: string |
| 434 | required: false |
| 435 | description: Public key to install into Instances to allows Services to SSH into them. |
| 436 | private_key_fn: |
| 437 | type: string |
| 438 | required: false |
| 439 | description: Location of private key file |
| 440 | versionNumber: |
| 441 | type: string |
| 442 | required: false |
| 443 | description: Version number of Service. |
| 444 | |
Scott Baker | 7475539 | 2016-04-20 17:18:39 -0700 | [diff] [blame] | 445 | tosca.nodes.VTNService: |
| 446 | derived_from: tosca.nodes.Root |
| 447 | description: > |
| 448 | CORD: The vRouter Service. |
| 449 | capabilities: |
| 450 | scalable: |
| 451 | type: tosca.capabilities.Scalable |
| 452 | service: |
| 453 | type: tosca.capabilities.xos.Service |
| 454 | properties: |
| 455 | no-delete: |
| 456 | type: boolean |
| 457 | default: false |
| 458 | description: Do not allow Tosca to delete this object |
| 459 | no-create: |
| 460 | type: boolean |
| 461 | default: false |
| 462 | description: Do not allow Tosca to create this object |
| 463 | no-update: |
| 464 | type: boolean |
| 465 | default: false |
| 466 | description: Do not allow Tosca to update this object |
| 467 | kind: |
| 468 | type: string |
| 469 | default: generic |
| 470 | description: Type of service. |
| 471 | view_url: |
| 472 | type: string |
| 473 | required: false |
| 474 | description: URL to follow when icon is clicked in the Service Directory. |
| 475 | icon_url: |
| 476 | type: string |
| 477 | required: false |
| 478 | description: ICON to display in the Service Directory. |
| 479 | enabled: |
| 480 | type: boolean |
| 481 | default: true |
| 482 | published: |
| 483 | type: boolean |
| 484 | default: true |
| 485 | description: If True then display this Service in the Service Directory. |
| 486 | public_key: |
| 487 | type: string |
| 488 | required: false |
| 489 | description: Public key to install into Instances to allows Services to SSH into them. |
| 490 | private_key_fn: |
| 491 | type: string |
| 492 | required: false |
| 493 | description: Location of private key file |
| 494 | versionNumber: |
| 495 | type: string |
| 496 | required: false |
| 497 | description: Version number of Service. |
| 498 | privateGatewayMac: |
| 499 | type: string |
| 500 | required: false |
| 501 | localManagementIp: |
| 502 | type: string |
| 503 | required: false |
| 504 | ovsdbPort: |
| 505 | type: string |
| 506 | required: false |
| 507 | sshPort: |
| 508 | type: string |
| 509 | required: false |
| 510 | sshUser: |
| 511 | type: string |
| 512 | required: false |
| 513 | sshKeyFile: |
| 514 | type: string |
| 515 | required: false |
| 516 | mgmtSubnetBits: |
| 517 | type: string |
| 518 | required: false |
| 519 | |
Scott Baker | 5deb33d | 2015-08-10 17:08:54 -0700 | [diff] [blame] | 520 | tosca.nodes.CDNService: |
| 521 | derived_from: tosca.nodes.Root |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 522 | description: > |
| 523 | Content Delivery Network Service. Includes Request Routing and Hypercache. |
Scott Baker | 5deb33d | 2015-08-10 17:08:54 -0700 | [diff] [blame] | 524 | capabilities: |
| 525 | scalable: |
| 526 | type: tosca.capabilities.Scalable |
| 527 | service: |
| 528 | type: tosca.capabilities.xos.Service |
| 529 | properties: |
Scott Baker | 9d9b675 | 2016-02-04 10:40:34 -0800 | [diff] [blame] | 530 | no-delete: |
| 531 | type: boolean |
| 532 | default: false |
| 533 | description: Do not allow Tosca to delete this object |
| 534 | no-create: |
| 535 | type: boolean |
| 536 | default: false |
| 537 | description: Do not allow Tosca to create this object |
| 538 | no-update: |
| 539 | type: boolean |
| 540 | default: false |
| 541 | description: Do not allow Tosca to update this object |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 542 | kind: |
| 543 | type: string |
| 544 | default: generic |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 545 | description: Type of service. |
Scott Baker | 5deb33d | 2015-08-10 17:08:54 -0700 | [diff] [blame] | 546 | view_url: |
| 547 | type: string |
| 548 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 549 | description: URL to follow when icon is clicked in the Service Directory. |
Scott Baker | 5deb33d | 2015-08-10 17:08:54 -0700 | [diff] [blame] | 550 | icon_url: |
| 551 | type: string |
| 552 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 553 | description: ICON to display in the Service Directory. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 554 | enabled: |
| 555 | type: boolean |
| 556 | default: true |
| 557 | published: |
| 558 | type: boolean |
| 559 | default: true |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 560 | description: If True then display this Service in the Service Directory. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 561 | public_key: |
| 562 | type: string |
| 563 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 564 | description: Public key to install into Instances to allows Services to SSH into them. |
Scott Baker | f60c010 | 2015-11-12 16:22:52 -0800 | [diff] [blame] | 565 | private_key_fn: |
| 566 | type: string |
| 567 | required: false |
| 568 | description: Location of private key file |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 569 | versionNumber: |
| 570 | type: string |
| 571 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 572 | description: Version number of Service. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 573 | |
Scott Baker | ad2cb4a | 2016-04-06 17:09:22 -0700 | [diff] [blame] | 574 | tosca.nodes.ExampleService: |
| 575 | derived_from: tosca.nodes.Root |
| 576 | description: > |
| 577 | Example Service |
| 578 | capabilities: |
| 579 | scalable: |
| 580 | type: tosca.capabilities.Scalable |
| 581 | service: |
| 582 | type: tosca.capabilities.xos.Service |
| 583 | properties: |
| 584 | no-delete: |
| 585 | type: boolean |
| 586 | default: false |
| 587 | description: Do not allow Tosca to delete this object |
| 588 | no-create: |
| 589 | type: boolean |
| 590 | default: false |
| 591 | description: Do not allow Tosca to create this object |
| 592 | no-update: |
| 593 | type: boolean |
| 594 | default: false |
| 595 | description: Do not allow Tosca to update this object |
| 596 | kind: |
| 597 | type: string |
| 598 | default: generic |
| 599 | description: Type of service. |
| 600 | view_url: |
| 601 | type: string |
| 602 | required: false |
| 603 | description: URL to follow when icon is clicked in the Service Directory. |
| 604 | icon_url: |
| 605 | type: string |
| 606 | required: false |
| 607 | description: ICON to display in the Service Directory. |
| 608 | enabled: |
| 609 | type: boolean |
| 610 | default: true |
| 611 | published: |
| 612 | type: boolean |
| 613 | default: true |
| 614 | description: If True then display this Service in the Service Directory. |
| 615 | public_key: |
| 616 | type: string |
| 617 | required: false |
| 618 | description: Public key to install into Instances to allows Services to SSH into them. |
| 619 | private_key_fn: |
| 620 | type: string |
| 621 | required: false |
| 622 | description: Location of private key file |
| 623 | versionNumber: |
| 624 | type: string |
| 625 | required: false |
| 626 | description: Version number of Service. |
| 627 | |
| 628 | |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 629 | tosca.nodes.Subscriber: |
| 630 | derived_from: tosca.nodes.Root |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 631 | description: XOS subscriber base class. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 632 | capabilities: |
| 633 | subscriber: |
| 634 | type: tosca.capabilities.xos.Subscriber |
| 635 | properties: |
| 636 | kind: |
| 637 | type: string |
| 638 | default: generic |
Scott Baker | 2f341b4 | 2015-10-06 14:13:56 -0700 | [diff] [blame] | 639 | description: Kind of subscriber |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 640 | service_specific_id: |
| 641 | type: string |
| 642 | required: false |
Scott Baker | 6f156fa | 2015-10-08 16:49:51 -0700 | [diff] [blame] | 643 | description: Service specific ID opaque to XOS but meaningful to service |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 644 | |
| 645 | tosca.nodes.CORDSubscriber: |
| 646 | derived_from: tosca.nodes.Root |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 647 | description: > |
| 648 | CORD: Subscriber. The Subscriber object contains all of the settings |
| 649 | for a CORD household. For example, it contains parental control |
| 650 | filter settings. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 651 | capabilities: |
| 652 | subscriber: |
| 653 | type: tosca.capabilities.xos.Subscriber |
| 654 | properties: |
| 655 | kind: |
| 656 | type: string |
| 657 | default: generic |
Scott Baker | 2f341b4 | 2015-10-06 14:13:56 -0700 | [diff] [blame] | 658 | description: Kind of subscriber |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 659 | service_specific_id: |
| 660 | type: string |
| 661 | required: false |
Scott Baker | 6f156fa | 2015-10-08 16:49:51 -0700 | [diff] [blame] | 662 | description: Service specific ID opaque to XOS but meaningful to service |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 663 | firewall_enable: |
| 664 | type: boolean |
| 665 | default: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 666 | description: If True, then firewalling is enabled. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 667 | url_filter_enable: |
| 668 | type: boolean |
| 669 | default: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 670 | description: If True, then parental controls are enabled. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 671 | url_filter_level: |
| 672 | type: string |
| 673 | default: PG |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 674 | description: The default URL filter level for the household. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 675 | cdn_enable: |
| 676 | type: boolean |
| 677 | default: true |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 678 | description: If True, then the CDN is enabled. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 679 | |
| 680 | tosca.nodes.CORDUser: |
| 681 | derived_from: tosca.nodes.Root |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 682 | description: > |
| 683 | CORD: User. The CORD user represents an individual device beloning |
| 684 | to the CORD Subscriber. Each device may have its own parental |
| 685 | controls. |
Scott Baker | 2f341b4 | 2015-10-06 14:13:56 -0700 | [diff] [blame] | 686 | capabilities: |
| 687 | device: |
| 688 | type: tosca.capabilities.xos.Device |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 689 | properties: |
| 690 | level: |
| 691 | type: string |
| 692 | default: PG_13 |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 693 | description: Parental control level for this device. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 694 | mac: |
| 695 | type: string |
| 696 | required: true |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 697 | description: MAC address for this device. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 698 | |
| 699 | tosca.nodes.VOLTTenant: |
| 700 | derived_from: tosca.nodes.Root |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 701 | description: > |
| 702 | CORD: A Tenant of the vOLT Service. Each Tenant is tied to a |
| 703 | specific vlan_id. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 704 | properties: |
| 705 | kind: |
| 706 | type: string |
| 707 | default: generic |
Scott Baker | 2f341b4 | 2015-10-06 14:13:56 -0700 | [diff] [blame] | 708 | description: Kind of tenant |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 709 | service_specific_id: |
| 710 | type: string |
| 711 | required: false |
Scott Baker | 6f156fa | 2015-10-08 16:49:51 -0700 | [diff] [blame] | 712 | description: Service specific ID opaque to XOS but meaningful to service |
Scott Baker | 294a532 | 2015-11-10 12:06:18 -0800 | [diff] [blame] | 713 | s_tag: |
Scott Baker | afc09ee | 2015-09-17 10:07:52 -0700 | [diff] [blame] | 714 | type: string |
| 715 | required: false |
Scott Baker | 294a532 | 2015-11-10 12:06:18 -0800 | [diff] [blame] | 716 | description: s_tag, identifies which volt port |
| 717 | c_tag: |
| 718 | type: string |
| 719 | required: false |
| 720 | description: c_tag, identifies which subscriber within s_tag |
Scott Baker | 5deb33d | 2015-08-10 17:08:54 -0700 | [diff] [blame] | 721 | |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 722 | tosca.nodes.User: |
| 723 | derived_from: tosca.nodes.Root |
| 724 | |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 725 | description: > |
| 726 | An XOS User record. Users are able to login and use the XOS GUI. |
| 727 | |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 728 | capabilities: |
| 729 | user: |
| 730 | type: tosca.capabilities.xos.User |
| 731 | |
| 732 | properties: |
| 733 | password: |
| 734 | type: string |
Scott Baker | 398bbca | 2015-09-28 15:17:40 -0700 | [diff] [blame] | 735 | required: false |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 736 | firstname: |
| 737 | type: string |
| 738 | required: true |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 739 | description: First name of User. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 740 | lastname: |
| 741 | type: string |
| 742 | required: true |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 743 | description: Last name of User. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 744 | phone: |
| 745 | type: string |
| 746 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 747 | description: Phone number of User. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 748 | user_url: |
| 749 | type: string |
| 750 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 751 | description: URL to User web page. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 752 | public_key: |
| 753 | type: string |
| 754 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 755 | description: Public key that will be installed in Instances. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 756 | is_active: |
| 757 | type: boolean |
| 758 | default: true |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 759 | description: If True, the user may log in. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 760 | is_admin: |
| 761 | type: boolean |
| 762 | default: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 763 | description: If True, the user has root admin privileges. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 764 | login_page: |
| 765 | type: string |
| 766 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 767 | description: Indicates what page the user should go to on login. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 768 | |
Scott Baker | 2d13d8b | 2015-11-16 14:31:02 -0800 | [diff] [blame] | 769 | tosca.nodes.NetworkParameterType: |
| 770 | derived_from: tosca.nodes.Root |
| 771 | |
| 772 | description: > |
| 773 | An XOS network parameter type. May be applied to Networks and/or |
| 774 | Ports. |
| 775 | |
| 776 | capabilities: |
| 777 | network_parameter_type: |
| 778 | type: tosca.capabilities.xos.NetworkParameterType |
| 779 | |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 780 | tosca.nodes.NetworkTemplate: |
| 781 | derived_from: tosca.nodes.Root |
| 782 | |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 783 | description: > |
| 784 | An XOS network template. Network templates contain settings associated |
| 785 | with a particular class of network. |
| 786 | |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 787 | capabilities: |
| 788 | network_template: |
| 789 | type: tosca.capabilities.xos.NetworkTemplate |
| 790 | |
| 791 | properties: |
| 792 | visibility: |
| 793 | type: string |
| 794 | default: private |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 795 | description: Indicates whether network is publicly routable. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 796 | translation: |
| 797 | type: string |
| 798 | default: none |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 799 | description: Indicates whether network uses address translation. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 800 | shared_network_name: |
| 801 | type: string |
| 802 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 803 | description: Attaches this template to a specific OpenStack network. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 804 | shared_network_id: |
| 805 | type: string |
| 806 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 807 | description: Attaches this template to a specific OpenStack network. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 808 | topology_kind: |
| 809 | type: string |
| 810 | default: BigSwitch |
Scott Baker | 2f341b4 | 2015-10-06 14:13:56 -0700 | [diff] [blame] | 811 | description: Describes the topology of the network. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 812 | controller_kind: |
| 813 | type: string |
| 814 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 815 | description: Indicates the type of controller that the network is connected to. |
Scott Baker | 4e921a4 | 2015-12-09 16:51:52 -0800 | [diff] [blame] | 816 | access: |
| 817 | type: string |
| 818 | required: false |
| 819 | description: The type of access semantics for this network |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 820 | |
Scott Baker | 2edd4f3 | 2015-08-14 12:41:18 -0700 | [diff] [blame] | 821 | tosca.nodes.network.Network.XOS: |
| 822 | # Due to bug? in implementation, we have to copy everything from |
| 823 | # tosca definitions tosca.nodes.network.Network here rather than |
| 824 | # using derived_from. |
| 825 | derived_from: tosca.nodes.Root |
| 826 | description: >
|
Scott Baker | 2f341b4 | 2015-10-06 14:13:56 -0700 | [diff] [blame] | 827 | This is a variant of the TOSCA Network object that includes additional
|
| 828 | XOS-specific properties.
|
Scott Baker | 2edd4f3 | 2015-08-14 12:41:18 -0700 | [diff] [blame] | 829 | properties:
|
Scott Baker | 0b1d4df | 2016-02-13 15:00:11 -0800 | [diff] [blame] | 830 | no-delete: |
| 831 | type: boolean |
| 832 | default: false |
| 833 | description: Do not allow Tosca to delete this object |
| 834 | no-create: |
| 835 | type: boolean |
| 836 | default: false |
| 837 | description: Do not allow Tosca to create this object |
| 838 | no-update: |
| 839 | type: boolean |
| 840 | default: false |
| 841 | description: Do not allow Tosca to update this object
|
Scott Baker | 2edd4f3 | 2015-08-14 12:41:18 -0700 | [diff] [blame] | 842 | ip_version:
|
| 843 | type: integer
|
| 844 | required: no
|
| 845 | default: 4
|
| 846 | constraints:
|
| 847 | - valid_values: [ 4, 6 ]
|
| 848 | description: >
|
| 849 | The IP version of the requested network. Valid values are 4 for ipv4
|
| 850 | or 6 for ipv6.
|
| 851 | cidr:
|
| 852 | type: string
|
| 853 | required: no
|
| 854 | description: >
|
| 855 | The cidr block of the requested network.
|
| 856 | start_ip:
|
| 857 | type: string
|
| 858 | required: no
|
| 859 | description: >
|
| 860 | The IP address to be used as the start of a pool of addresses within
|
| 861 | the full IP range derived from the cidr block.
|
| 862 | end_ip:
|
| 863 | type: string
|
| 864 | required: no
|
| 865 | description: >
|
| 866 | The IP address to be used as the end of a pool of addresses within
|
| 867 | the full IP range derived from the cidr block.
|
| 868 | gateway_ip:
|
| 869 | type: string
|
| 870 | required: no
|
| 871 | description: >
|
| 872 | The gateway IP address.
|
| 873 | network_name:
|
| 874 | type: string
|
| 875 | required: no
|
| 876 | description: >
|
| 877 | An identifier that represents an existing Network instance in the
|
| 878 | underlying cloud infrastructure or can be used as the name of the
|
| 879 | newly created network. If network_name is provided and no other
|
| 880 | properties are provided (with exception of network_id), then an
|
| 881 | existing network instance will be used. If network_name is provided
|
| 882 | alongside with more properties then a new network with this name will
|
| 883 | be created.
|
| 884 | network_id:
|
| 885 | type: string
|
| 886 | required: no
|
| 887 | description: >
|
| 888 | An identifier that represents an existing Network instance in the
|
| 889 | underlying cloud infrastructure. This property is mutually exclusive
|
| 890 | with all other properties except network_name. This can be used alone
|
| 891 | or together with network_name to identify an existing network.
|
| 892 | segmentation_id:
|
| 893 | type: string
|
| 894 | required: no
|
| 895 | description: >
|
| 896 | A segmentation identifier in the underlying cloud infrastructure.
|
| 897 | E.g. VLAN ID, GRE tunnel ID, etc..
|
| 898 | dhcp_enabled:
|
| 899 | type: boolean
|
| 900 | required: no
|
| 901 | default: true
|
| 902 | description: >
|
| 903 | Indicates should DHCP service be enabled on the network or not.
|
| 904 | # XOS-specific
|
| 905 | ports:
|
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 906 | type: string |
| 907 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 908 | description: > |
| 909 | A comma-separated list of protocols and ports. For example, |
| 910 | "tcp/123, tcp/456-459, udp/111" |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 911 | labels: |
| 912 | type: string |
| 913 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 914 | description: A comma-separated list of labels for this network. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 915 | permit_all_slices: |
| 916 | type: boolean |
Scott Baker | 2edd4f3 | 2015-08-14 12:41:18 -0700 | [diff] [blame] | 917 | # In the data model, this is defaulted to false. However, to |
| 918 | # preserve Tosca semantics, we default it to true instead. |
| 919 | default: true |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 920 | description: If True, then any slice may be attached to this network. |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 921 | capabilities: |
Scott Baker | 2edd4f3 | 2015-08-14 12:41:18 -0700 | [diff] [blame] | 922 | link:
|
| 923 | type: tosca.capabilities.network.Linkable |
| 924 | |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 925 | tosca.nodes.Deployment: |
| 926 | derived_from: tosca.nodes.Root |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 927 | description: > |
| 928 | An XOS Deployment. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 929 | capabilities: |
| 930 | deployment: |
| 931 | type: tosca.capabilities.xos.Deployment |
Scott Baker | e71ab8b | 2015-09-22 17:26:31 -0700 | [diff] [blame] | 932 | properties: |
Scott Baker | 6759c70 | 2015-09-25 09:08:57 -0700 | [diff] [blame] | 933 | no-delete: |
| 934 | type: boolean |
| 935 | default: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 936 | description: Do not allow Tosca to delete this object |
Scott Baker | 6759c70 | 2015-09-25 09:08:57 -0700 | [diff] [blame] | 937 | no-create: |
| 938 | type: boolean |
| 939 | default: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 940 | description: Do not allow Tosca to create this object |
Scott Baker | 6f156fa | 2015-10-08 16:49:51 -0700 | [diff] [blame] | 941 | no-update: |
| 942 | type: boolean |
| 943 | default: false |
| 944 | description: Do not allow Tosca to update this object |
Scott Baker | e71ab8b | 2015-09-22 17:26:31 -0700 | [diff] [blame] | 945 | accessControl: |
| 946 | type: string |
| 947 | default: allow all |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 948 | description: ACL that describes who may use this deployment. |
Scott Baker | 143de8f | 2015-09-23 21:48:08 -0700 | [diff] [blame] | 949 | flavors: |
| 950 | type: string |
| 951 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 952 | description: Comma-separated list of flavors that this deployment supports. |
Scott Baker | 143de8f | 2015-09-23 21:48:08 -0700 | [diff] [blame] | 953 | |
Scott Baker | 7b897e3 | 2016-02-12 17:31:04 -0800 | [diff] [blame] | 954 | tosca.nodes.AddressPool: |
| 955 | derived_from: tosca.nodes.Root |
| 956 | description: > |
| 957 | A pool of addresses |
Scott Baker | 380e738 | 2016-04-12 16:41:03 -0700 | [diff] [blame] | 958 | capabilities: |
| 959 | addresspool: |
| 960 | type: tosca.capabilities.xos.AddressPool |
Scott Baker | 7b897e3 | 2016-02-12 17:31:04 -0800 | [diff] [blame] | 961 | properties: |
| 962 | no-delete: |
| 963 | type: boolean |
| 964 | default: false |
| 965 | description: Do not allow Tosca to delete this object |
| 966 | no-create: |
| 967 | type: boolean |
| 968 | default: false |
| 969 | description: Do not allow Tosca to create this object |
| 970 | no-update: |
| 971 | type: boolean |
| 972 | default: false |
| 973 | description: Do not allow Tosca to update this object |
| 974 | addresses: |
| 975 | type: string |
| 976 | required: false |
| 977 | description: space-separated list of addresses |
Scott Baker | 380e738 | 2016-04-12 16:41:03 -0700 | [diff] [blame] | 978 | gateway_ip: |
| 979 | type: string |
| 980 | required: false |
| 981 | description: gateway ip address |
| 982 | gateway_mac: |
| 983 | type: string |
| 984 | required: false |
| 985 | description: gateway mac address |
Scott Baker | 7b897e3 | 2016-02-12 17:31:04 -0800 | [diff] [blame] | 986 | |
Scott Baker | 143de8f | 2015-09-23 21:48:08 -0700 | [diff] [blame] | 987 | tosca.nodes.Image: |
| 988 | derived_from: tosca.nodes.Root |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 989 | description: > |
| 990 | An XOS Operating System Image. |
Scott Baker | 143de8f | 2015-09-23 21:48:08 -0700 | [diff] [blame] | 991 | capabilities: |
| 992 | image: |
| 993 | type: tosca.capabilities.xos.Image |
| 994 | properties: |
Scott Baker | 4f6558a | 2015-11-11 20:12:43 -0800 | [diff] [blame] | 995 | kind: |
| 996 | type: string |
| 997 | required: false |
| 998 | description: Type of image (container | VM) |
Scott Baker | 143de8f | 2015-09-23 21:48:08 -0700 | [diff] [blame] | 999 | disk_format: |
| 1000 | type: string |
| 1001 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1002 | description: Glance disk format. |
Scott Baker | 143de8f | 2015-09-23 21:48:08 -0700 | [diff] [blame] | 1003 | container_format: |
| 1004 | type: string |
| 1005 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1006 | description: Glance container format. |
Scott Baker | 143de8f | 2015-09-23 21:48:08 -0700 | [diff] [blame] | 1007 | path: |
| 1008 | type: string |
| 1009 | required: false |
Scott Baker | ac69b6a | 2015-12-14 09:25:57 -0800 | [diff] [blame] | 1010 | description: Path to Image file |
| 1011 | tag: |
| 1012 | type: string |
| 1013 | required: false |
| 1014 | description: For Docker images, tag of image |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1015 | |
| 1016 | tosca.nodes.Controller: |
| 1017 | derived_from: tosca.nodes.Root |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1018 | description: > |
| 1019 | An XOS controller. Controllers serve as the interface between |
| 1020 | XOS and services such as OpenStack. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1021 | capabilities: |
| 1022 | controller: |
| 1023 | type: tosca.capabilities.xos.Controller |
| 1024 | properties: |
Scott Baker | 6f156fa | 2015-10-08 16:49:51 -0700 | [diff] [blame] | 1025 | no-delete: |
| 1026 | type: boolean |
| 1027 | default: false |
| 1028 | description: Do not allow Tosca to delete this object |
| 1029 | no-create: |
| 1030 | type: boolean |
| 1031 | default: false |
| 1032 | description: Do not allow Tosca to create this object |
| 1033 | no-update: |
| 1034 | type: boolean |
| 1035 | default: false |
| 1036 | description: Do not allow Tosca to update this object |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1037 | backend_type: |
| 1038 | type: string |
| 1039 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1040 | description: Type of backend. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1041 | version: |
| 1042 | type: string |
| 1043 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1044 | description: Version of backend. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1045 | auth_url: |
| 1046 | type: string |
| 1047 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1048 | description: Keystone auth_url. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1049 | admin_user: |
| 1050 | type: string |
| 1051 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1052 | description: Keystone username. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1053 | admin_password: |
| 1054 | type: string |
| 1055 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1056 | description: Keystone password. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1057 | admin_tenant: |
| 1058 | type: string |
| 1059 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1060 | description: Tenant associated with admin account. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1061 | domain: |
| 1062 | type: string |
| 1063 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1064 | description: OpenStack domain (or "Default") |
Scott Baker | b718ec5 | 2015-10-27 10:29:39 -0700 | [diff] [blame] | 1065 | rabbit_host: |
| 1066 | type: string |
| 1067 | required: false |
| 1068 | description: Rabbit host |
| 1069 | rabbit_user: |
| 1070 | type: string |
| 1071 | required: false |
| 1072 | description: Rabbit user |
| 1073 | rabbit_password: |
| 1074 | type: string |
| 1075 | required: false |
| 1076 | description: Rabbit password |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1077 | |
| 1078 | tosca.nodes.Site: |
| 1079 | derived_from: tosca.nodes.Root |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1080 | description: > |
| 1081 | An XOS Site. Sites are containers for Users and/or Nodes. |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1082 | capabilities: |
| 1083 | site: |
| 1084 | type: tosca.capabilities.xos.Site |
| 1085 | properties: |
Scott Baker | 6f156fa | 2015-10-08 16:49:51 -0700 | [diff] [blame] | 1086 | no-delete: |
| 1087 | type: boolean |
| 1088 | default: false |
| 1089 | description: Do not allow Tosca to delete this object |
| 1090 | no-create: |
| 1091 | type: boolean |
| 1092 | default: false |
| 1093 | description: Do not allow Tosca to create this object |
| 1094 | no-update: |
| 1095 | type: boolean |
| 1096 | default: false |
| 1097 | description: Do not allow Tosca to update this object |
| 1098 | display_name: |
| 1099 | type: string |
| 1100 | required: false |
| 1101 | description: Name of the site. |
| 1102 | site_url: |
| 1103 | type: string |
| 1104 | required: false |
| 1105 | description: URL of site web page. |
| 1106 | enabled: |
| 1107 | type: boolean |
| 1108 | default: true |
| 1109 | hosts_nodes: |
| 1110 | type: boolean |
| 1111 | default: true |
| 1112 | description: If True, then this site hosts nodes where Instances may be instantiated. |
| 1113 | hosts_users: |
| 1114 | type: boolean |
| 1115 | default: true |
| 1116 | description: If True, then this site hosts users who may use XOS. |
| 1117 | is_public: |
| 1118 | type: boolean |
| 1119 | default: true |
| 1120 | # location, longitude, latitude |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1121 | |
| 1122 | tosca.nodes.Slice: |
| 1123 | derived_from: tosca.nodes.Root |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1124 | description: > |
| 1125 | An XOS Slice. A slice is a collection of instances that share |
| 1126 | common attributes. |
Scott Baker | 2f341b4 | 2015-10-06 14:13:56 -0700 | [diff] [blame] | 1127 | capabilities: |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1128 | slice: |
| 1129 | type: tosca.capabilities.xos.Slice |
Scott Baker | 69334ad | 2015-09-22 12:51:20 -0700 | [diff] [blame] | 1130 | properties: |
Scott Baker | 6f156fa | 2015-10-08 16:49:51 -0700 | [diff] [blame] | 1131 | no-delete: |
| 1132 | type: boolean |
| 1133 | default: false |
| 1134 | description: Do not allow Tosca to delete this object |
| 1135 | no-create: |
| 1136 | type: boolean |
| 1137 | default: false |
| 1138 | description: Do not allow Tosca to create this object |
| 1139 | no-update: |
| 1140 | type: boolean |
| 1141 | default: false |
| 1142 | description: Do not allow Tosca to update this object |
Scott Baker | 69334ad | 2015-09-22 12:51:20 -0700 | [diff] [blame] | 1143 | enabled: |
| 1144 | type: boolean |
| 1145 | default: true |
| 1146 | description: |
| 1147 | type: string |
| 1148 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1149 | description: Description of this slice. |
Scott Baker | 69334ad | 2015-09-22 12:51:20 -0700 | [diff] [blame] | 1150 | slice_url: |
| 1151 | type: string |
| 1152 | required: false |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1153 | description: URL to web page that describes slice. |
Scott Baker | 69334ad | 2015-09-22 12:51:20 -0700 | [diff] [blame] | 1154 | max_instances: |
| 1155 | type: integer |
| 1156 | default: 10 |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1157 | description: Quota of instances that this slice may create. |
Scott Baker | 7430bd3 | 2015-11-30 17:48:30 -0800 | [diff] [blame] | 1158 | default_isolation: |
| 1159 | type: string |
| 1160 | required: false |
| 1161 | description: default isolation to use when bringing up instances (default to 'vm') |
Scott Baker | ddf8009 | 2015-12-14 16:21:33 -0800 | [diff] [blame] | 1162 | network: |
| 1163 | type: string |
| 1164 | required: false |
| 1165 | description: type of networking to use for this slice |
Scott Baker | 3fe056a | 2016-02-04 15:58:19 -0800 | [diff] [blame] | 1166 | exposed_ports: |
| 1167 | type: string |
| 1168 | required: false |
| 1169 | description: comma-separated list of protocol _space_ port that represent ports the slice should expose |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1170 | |
Scott Baker | e058b18 | 2015-09-16 16:14:42 -0700 | [diff] [blame] | 1171 | tosca.nodes.Node: |
| 1172 | derived_from: tosca.nodes.Root |
Scott Baker | 3a6a1ab | 2015-10-05 17:54:31 -0700 | [diff] [blame] | 1173 | description: > |
| 1174 | An XOS Node. Nodes are physical machines that host virtual machines |
| 1175 | and/or containers. |
Scott Baker | 6f156fa | 2015-10-08 16:49:51 -0700 | [diff] [blame] | 1176 | properties: |
| 1177 | no-delete: |
| 1178 | type: boolean |
| 1179 | default: false |
| 1180 | description: Do not allow Tosca to delete this object |
| 1181 | no-create: |
| 1182 | type: boolean |
| 1183 | default: false |
| 1184 | description: Do not allow Tosca to create this object |
| 1185 | no-update: |
| 1186 | type: boolean |
| 1187 | default: false |
| 1188 | description: Do not allow Tosca to update this object |
| 1189 | capabilities: |
Scott Baker | e058b18 | 2015-09-16 16:14:42 -0700 | [diff] [blame] | 1190 | node: |
| 1191 | type: tosca.capabilities.xos.Node |
| 1192 | |
Scott Baker | c4d78da | 2016-03-04 10:44:41 -0800 | [diff] [blame] | 1193 | tosca.nodes.NodeLabel: |
| 1194 | derived_from: tosca.nodes.Root |
| 1195 | description: > |
| 1196 | An XOS NodeLabel. |
| 1197 | properties: |
| 1198 | no-delete: |
| 1199 | type: boolean |
| 1200 | default: false |
| 1201 | description: Do not allow Tosca to delete this object |
| 1202 | no-create: |
| 1203 | type: boolean |
| 1204 | default: false |
| 1205 | description: Do not allow Tosca to create this object |
| 1206 | no-update: |
| 1207 | type: boolean |
| 1208 | default: false |
| 1209 | description: Do not allow Tosca to update this object |
| 1210 | capabilities: |
| 1211 | node: |
| 1212 | type: tosca.capabilities.xos.NodeLabel |
| 1213 | |
Scott Baker | 786750b | 2016-04-25 09:21:08 -0700 | [diff] [blame] | 1214 | tosca.nodes.Flavor: |
| 1215 | derived_from: tosca.nodes.Root |
| 1216 | description: > |
| 1217 | An XOS Flavor. |
| 1218 | properties: |
| 1219 | no-delete: |
| 1220 | type: boolean |
| 1221 | default: false |
| 1222 | description: Do not allow Tosca to delete this object |
| 1223 | no-create: |
| 1224 | type: boolean |
| 1225 | default: false |
| 1226 | description: Do not allow Tosca to create this object |
| 1227 | no-update: |
| 1228 | type: boolean |
| 1229 | default: false |
| 1230 | description: Do not allow Tosca to update this object |
| 1231 | flavor: |
| 1232 | type: string |
| 1233 | required: false |
| 1234 | description: openstack flavor name |
| 1235 | capabilities: |
| 1236 | flavor: |
| 1237 | type: tosca.capabilities.xos.Flavor |
| 1238 | |
Scott Baker | 3389056 | 2015-10-28 14:52:14 -0700 | [diff] [blame] | 1239 | tosca.nodes.DashboardView: |
| 1240 | derived_from: tosca.nodes.Root |
| 1241 | description: > |
| 1242 | An XOS Dashboard View |
| 1243 | capabilities: |
| 1244 | dashboardview: |
| 1245 | type: tosca.capabilities.xos.DashboardView |
| 1246 | properties: |
| 1247 | no-delete: |
| 1248 | type: boolean |
| 1249 | default: false |
| 1250 | description: Do not allow Tosca to delete this object |
| 1251 | no-create: |
| 1252 | type: boolean |
| 1253 | default: false |
| 1254 | description: Do not allow Tosca to create this object |
| 1255 | no-update: |
| 1256 | type: boolean |
| 1257 | default: false |
| 1258 | description: Do not allow Tosca to update this object |
| 1259 | enabled: |
| 1260 | type: boolean |
| 1261 | default: true |
| 1262 | url: |
| 1263 | type: string |
| 1264 | required: false |
| 1265 | description: URL to the dashboard |
| 1266 | |
Scott Baker | 4f6558a | 2015-11-11 20:12:43 -0800 | [diff] [blame] | 1267 | tosca.nodes.Compute.Container: |
| 1268 | derived_from: tosca.nodes.Compute |
| 1269 | description: > |
| 1270 | The TOSCA Compute node represents a container on bare metal. |
| 1271 | attributes: |
| 1272 | private_address: |
| 1273 | type: string |
| 1274 | public_address: |
| 1275 | type: string |
| 1276 | capabilities: |
| 1277 | host: |
| 1278 | type: tosca.capabilities.Container |
| 1279 | binding: |
| 1280 | type: tosca.capabilities.network.Bindable |
| 1281 | os: |
| 1282 | type: tosca.capabilities.OperatingSystem |
| 1283 | scalable: |
| 1284 | type: tosca.capabilities.Scalable |
| 1285 | requirements: |
| 1286 | - local_storage: |
| 1287 | capability: tosca.capabilities.Attachment |
| 1288 | node: tosca.nodes.BlockStorage |
| 1289 | relationship: tosca.relationships.AttachesTo |
| 1290 | occurrences: [0, UNBOUNDED] |
| 1291 | |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1292 | tosca.relationships.MemberOfSlice: |
| 1293 | derived_from: tosca.relationships.Root |
| 1294 | valid_target_types: [ tosca.capabilities.xos.Slice ] |
| 1295 | |
| 1296 | tosca.relationships.MemberOfService: |
| 1297 | derived_from: tosca.relationships.Root |
| 1298 | valid_target_types: [ tosca.capabilities.xos.Service ] |
| 1299 | |
| 1300 | tosca.relationships.MemberOfSite: |
| 1301 | derived_from: tosca.relationships.Root |
| 1302 | valid_target_types: [ tosca.capabilities.xos.Site ] |
| 1303 | |
Scott Baker | e058b18 | 2015-09-16 16:14:42 -0700 | [diff] [blame] | 1304 | tosca.relationships.MemberOfDeployment: |
| 1305 | derived_from: tosca.relationships.Root |
| 1306 | valid_target_types: [ tosca.capabilities.xos.Deployment ] |
| 1307 | |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1308 | tosca.relationships.TenantOfService: |
| 1309 | derived_from: tosca.relationships.Root |
| 1310 | valid_target_types: [ tosca.capabilities.xos.Service ] |
| 1311 | |
Scott Baker | 5e5c0e3 | 2015-10-20 21:18:45 -0700 | [diff] [blame] | 1312 | tosca.relationships.UsedByService: |
| 1313 | derived_from: tosca.relationships.Root |
| 1314 | valid_target_types: [ tosca.capabilities.xos.Service ] |
| 1315 | |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1316 | tosca.relationships.ControllerDeployment: |
| 1317 | derived_from: tosca.relationships.Root |
| 1318 | valid_target_types: [ tosca.capabilities.xos.Deployment ] |
| 1319 | |
| 1320 | tosca.relationships SiteDeployment: |
| 1321 | derived_from: tosca.relationships.Root |
| 1322 | valid_target_types: [ tosca.capabilities.xos.Deployment ] |
| 1323 | |
| 1324 | tosca.relationships.UsesController: |
| 1325 | derived_from: tosca.relationships.Root |
| 1326 | valid_target_types: [ tosca.capabilities.xos.Controller ] |
| 1327 | |
| 1328 | tosca.relationships.ConnectsToNetwork: |
| 1329 | derived_from: tosca.relationships.Root |
| 1330 | valid_target_types: [ tosca.capabilities.xos.Network ] |
| 1331 | |
Scott Baker | 4f6558a | 2015-11-11 20:12:43 -0800 | [diff] [blame] | 1332 | tosca.relationships.UsesImage: |
| 1333 | derived_from: tosca.relationships.Root |
| 1334 | valid_target_types: [ tosca.capabilities.xos.Image ] |
| 1335 | |
Scott Baker | 8560e78 | 2015-12-14 13:09:33 -0800 | [diff] [blame] | 1336 | tosca.relationships.DefaultImage: |
| 1337 | derived_from: tosca.relationships.Root |
| 1338 | valid_target_types: [ tosca.capabilities.xos.Image ] |
| 1339 | |
Scott Baker | 143de8f | 2015-09-23 21:48:08 -0700 | [diff] [blame] | 1340 | tosca.relationships.SupportsImage: |
| 1341 | derived_from: tosca.relationships.Root |
| 1342 | valid_target_types: [ tosca.capabilities.xos.Image ] |
| 1343 | |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 1344 | tosca.relationships.ConnectsToSlice: |
| 1345 | derived_from: tosca.relationships.Root |
Scott Baker | 2f341b4 | 2015-10-06 14:13:56 -0700 | [diff] [blame] | 1346 | valid_target_types: [ tosca.capabilities.xos.Slice ] |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 1347 | |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1348 | # tosca.relationships.OwnsNetwork: |
| 1349 | # derived_from: tosca.relationships.Root |
| 1350 | # valid_target_types: [ tosca.capabilities.xos.Network ] |
| 1351 | |
| 1352 | tosca.relationships.UsesNetworkTemplate: |
| 1353 | derived_from: tosca.relationships.Root |
| 1354 | valid_target_types: [ tosca.capabilities.xos.NetworkTemplate ] |
| 1355 | |
| 1356 | tosca.relationships.AdminPrivilege: |
| 1357 | derived_from: tosca.relationships.Root |
Scott Baker | 2f341b4 | 2015-10-06 14:13:56 -0700 | [diff] [blame] | 1358 | valid_target_types: [ tosca.capabilities.xos.Slice, tosca.capabilities.xos.Site ] |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1359 | |
| 1360 | tosca.relationships.AccessPrivilege: |
| 1361 | derived_from: tosca.relationships.Root |
Scott Baker | 2f341b4 | 2015-10-06 14:13:56 -0700 | [diff] [blame] | 1362 | valid_target_types: [ tosca.capabilities.xos.Slice, tosca.capabilities.xos.Site ] |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1363 | |
| 1364 | tosca.relationships.PIPrivilege: |
| 1365 | derived_from: tosca.relationships.Root |
Scott Baker | 2f341b4 | 2015-10-06 14:13:56 -0700 | [diff] [blame] | 1366 | valid_target_types: [ tosca.capabilities.xos.Site ] |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1367 | |
| 1368 | tosca.relationships.TechPrivilege: |
| 1369 | derived_from: tosca.relationships.Root |
Scott Baker | 2f341b4 | 2015-10-06 14:13:56 -0700 | [diff] [blame] | 1370 | valid_target_types: [ tosca.capabilities.xos.Site ] |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1371 | |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 1372 | tosca.relationships.SubscriberDevice: |
| 1373 | derived_from: tosca.relationships.Root |
Scott Baker | 2f341b4 | 2015-10-06 14:13:56 -0700 | [diff] [blame] | 1374 | valid_target_types: [ tosca.capabilities.xos.Subscriber ] |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 1375 | |
| 1376 | tosca.relationships.BelongsToSubscriber: |
| 1377 | derived_from: tosca.relationships.Root |
Scott Baker | 2f341b4 | 2015-10-06 14:13:56 -0700 | [diff] [blame] | 1378 | valid_target_types: [ tosca.capabilities.xos.Subscriber ] |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 1379 | |
Scott Baker | 3389056 | 2015-10-28 14:52:14 -0700 | [diff] [blame] | 1380 | tosca.relationships.UsesDashboard: |
| 1381 | derived_from: tosca.relationships.Root |
| 1382 | valid_target_types: [ tosca.capabilities.xos.DashboardView ] |
| 1383 | |
Scott Baker | 0b18f61 | 2016-03-04 12:46:48 -0800 | [diff] [blame] | 1384 | tosca.relationships.HasLabel: |
| 1385 | derived_from: tosca.relationships.Root |
| 1386 | valid_target_types: [ tosca.capabilities.xos.NodeLabel ] |
| 1387 | |
Scott Baker | 786750b | 2016-04-25 09:21:08 -0700 | [diff] [blame] | 1388 | tosca.relationships.SupportsFlavor: |
| 1389 | derived_from: tosca.relationships.Root |
| 1390 | valid_target_types: [ tosca.capabilities.xos.Flavor ] |
| 1391 | |
| 1392 | tosca.relationships.DefaultFlavor: |
| 1393 | derived_from: tosca.relationships.Root |
| 1394 | valid_target_types: [ tosca.capabilities.xos.Flavor ] |
| 1395 | |
Scott Baker | 380e738 | 2016-04-12 16:41:03 -0700 | [diff] [blame] | 1396 | tosca.relationships.ProvidesAddresses: |
| 1397 | derived_from: tosca.relationships.Root |
| 1398 | valid_target_types: [ tosca.capabilities.xos.AddressPool ] |
| 1399 | |
Scott Baker | 65b9c80 | 2016-03-06 23:11:23 -0800 | [diff] [blame] | 1400 | tosca.relationships.DependsOn: |
| 1401 | derived_from: tosca.relationships.Root |
| 1402 | |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1403 | tosca.capabilities.xos.Service: |
| 1404 | derived_from: tosca.capabilities.Root |
| 1405 | description: An XOS Service |
| 1406 | |
| 1407 | tosca.capabilities.xos.Deployment: |
| 1408 | derived_from: tosca.capabilities.Root |
| 1409 | description: An XOS Deployment |
| 1410 | |
| 1411 | tosca.capabilities.xos.Controller: |
| 1412 | derived_from: tosca.capabilities.Root |
| 1413 | description: An XOS Controller |
| 1414 | |
| 1415 | tosca.capabilities.xos.Site: |
| 1416 | derived_from: tosca.capabilities.Root |
| 1417 | description: An XOS Site |
| 1418 | |
| 1419 | tosca.capabilities.xos.Slice: |
| 1420 | derived_from: tosca.capabilities.Root |
| 1421 | description: An XOS Slice |
| 1422 | |
| 1423 | tosca.capabilities.xos.NetworkTemplate: |
| 1424 | derived_from: tosca.capabilities.Root |
| 1425 | description: An XOS network template |
| 1426 | |
Scott Baker | 2edd4f3 | 2015-08-14 12:41:18 -0700 | [diff] [blame] | 1427 | # tosca.capabilities.xos.Network: |
| 1428 | # derived_from: tosca.capabilities.Root |
| 1429 | # description: An XOS network |
Scott Baker | 6821701 | 2015-08-10 17:06:23 -0700 | [diff] [blame] | 1430 | |
| 1431 | tosca.capabilities.xos.User: |
| 1432 | derived_from: tosca.capabilities.Root |
| 1433 | description: An XOS user |
Scott Baker | 304333e | 2015-09-02 16:27:47 -0700 | [diff] [blame] | 1434 | |
| 1435 | tosca.capabilities.xos.Subscriber: |
| 1436 | derived_from: tosca.capabilities.Root |
| 1437 | description: An XOS Subscriber |
| 1438 | |
Scott Baker | 2f341b4 | 2015-10-06 14:13:56 -0700 | [diff] [blame] | 1439 | tosca.capabilities.xos.Device: |
| 1440 | derived_from: tosca.capabilities.Root |
| 1441 | description: A device belonging to an XOS subscriber |
| 1442 | |
Scott Baker | e058b18 | 2015-09-16 16:14:42 -0700 | [diff] [blame] | 1443 | tosca.capabilities.xos.Node: |
| 1444 | derived_from: tosca.capabilities.Root |
| 1445 | description: An XOS Node |
| 1446 | |
Scott Baker | c4d78da | 2016-03-04 10:44:41 -0800 | [diff] [blame] | 1447 | tosca.capabilities.xos.NodeLabel: |
| 1448 | derived_from: tosca.capabilities.Root |
| 1449 | description: An XOS NodeLabel |
| 1450 | |
Scott Baker | 786750b | 2016-04-25 09:21:08 -0700 | [diff] [blame] | 1451 | tosca.capabilities.xos.Flavor: |
| 1452 | derived_from: tosca.capabilities.Root |
| 1453 | description: An XOS Flavor |
| 1454 | |
Scott Baker | 143de8f | 2015-09-23 21:48:08 -0700 | [diff] [blame] | 1455 | tosca.capabilities.xos.Image: |
| 1456 | derived_from: tosca.capabilities.Root |
| 1457 | description: An XOS Image |
Scott Baker | 3389056 | 2015-10-28 14:52:14 -0700 | [diff] [blame] | 1458 | |
| 1459 | tosca.capabilities.xos.DashboardView: |
| 1460 | derived_from: tosca.capabilities.Root |
| 1461 | description: An XOS DashboardView |
Scott Baker | 2d13d8b | 2015-11-16 14:31:02 -0800 | [diff] [blame] | 1462 | |
| 1463 | tosca.capabilities.xos.NetworkParameterType: |
| 1464 | derived_from: tosca.capabilities.Root |
| 1465 | description: An XOS NetworkParameterType |
Scott Baker | 380e738 | 2016-04-12 16:41:03 -0700 | [diff] [blame] | 1466 | |
| 1467 | tosca.capabilities.xos.AddressPool: |
| 1468 | derived_from: tosca.capabilities.Root |
| 1469 | description: An XOS AddressPool |