blob: a89641ca026bb92f1c8d46282cf0043a2c1faf4d [file] [log] [blame]
Scott Baker68217012015-08-10 17:06:23 -07001tosca_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 Baker304333e2015-09-02 16:27:47 -07008# Service
9
10
11# Subscriber
12
Scott Baker68217012015-08-10 17:06:23 -070013
14
15
16# end m4 macros
17#
18# compile this with "m4 custom_types/xos.m4 > custom_types/xos.yaml"
19
20node_types:
21 tosca.nodes.Service:
22 derived_from: tosca.nodes.Root
Scott Baker3a6a1ab2015-10-05 17:54:31 -070023 description: >
24 An XOS Service object. Services may be listed in the Service
25 directory and may be linked together via Tenancy Relationships.
Scott Baker68217012015-08-10 17:06:23 -070026 capabilities:
27 scalable:
28 type: tosca.capabilities.Scalable
29 service:
30 type: tosca.capabilities.xos.Service
31 properties:
Scott Baker9d9b6752016-02-04 10:40:34 -080032 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 Baker304333e2015-09-02 16:27:47 -070044 kind:
45 type: string
46 default: generic
Scott Baker3a6a1ab2015-10-05 17:54:31 -070047 description: Type of service.
Scott Baker68217012015-08-10 17:06:23 -070048 view_url:
49 type: string
50 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -070051 description: URL to follow when icon is clicked in the Service Directory.
Scott Baker5deb33d2015-08-10 17:08:54 -070052 icon_url:
53 type: string
54 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -070055 description: ICON to display in the Service Directory.
Scott Baker304333e2015-09-02 16:27:47 -070056 enabled:
57 type: boolean
58 default: true
59 published:
60 type: boolean
61 default: true
Scott Baker3a6a1ab2015-10-05 17:54:31 -070062 description: If True then display this Service in the Service Directory.
Scott Baker304333e2015-09-02 16:27:47 -070063 public_key:
64 type: string
65 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -070066 description: Public key to install into Instances to allows Services to SSH into them.
Scott Bakerf60c0102015-11-12 16:22:52 -080067 private_key_fn:
68 type: string
69 required: false
70 description: Location of private key file
Scott Baker304333e2015-09-02 16:27:47 -070071 versionNumber:
72 type: string
73 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -070074 description: Version number of Service.
Scott Baker68217012015-08-10 17:06:23 -070075
Scott Bakereeb62522015-12-10 23:04:44 -080076 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 Baker3e3d5382015-12-10 23:24:12 -080092 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 Bakereeb62522015-12-10 23:04:44 -080097
Scott Baker2abd6a52015-10-16 17:47:22 -070098 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 Baker9d9b6752016-02-04 10:40:34 -0800108 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 Baker2abd6a52015-10-16 17:47:22 -0700120 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 Bakerf60c0102015-11-12 16:22:52 -0800143 private_key_fn:
144 type: string
145 required: false
146 description: Location of private key file
Scott Baker2abd6a52015-10-16 17:47:22 -0700147 versionNumber:
148 type: string
149 required: false
150 description: Version number of Service.
Scott Bakered0ae7b2015-12-07 22:20:02 -0800151 rest_onos/v1/network/configuration/:
152 type: string
153 required: false
Scott Bakerf510bf82016-02-10 14:05:01 -0800154 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 Baker7b897e32016-02-12 17:31:04 -0800163 node_key:
Scott Bakerc8ef20a2016-02-11 20:39:34 -0800164 type: string
165 required: false
Scott Bakered0ae7b2015-12-07 22:20:02 -0800166
Scott Baker2abd6a52015-10-16 17:47:22 -0700167
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 Baker881f7452015-10-19 16:24:02 -0700181 dependencies:
182 type: string
183 required: false
Scott Baker2abd6a52015-10-16 17:47:22 -0700184
185 tosca.nodes.ONOSvBNGApp:
186 derived_from: tosca.nodes.Root
187 description: >
Scott Baker535640b2015-10-21 10:54:29 -0700188 An ONOS vBNG Application.
Scott Baker2abd6a52015-10-16 17:47:22 -0700189 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 Baker881f7452015-10-19 16:24:02 -0700198 dependencies:
199 type: string
200 required: false
Srikanth Vavilapalli6ff55982016-01-22 14:35:50 -0500201 install_dependencies:
202 type: string
203 required: false
204 component_config:
205 type: string
206 required: false
Scott Baker907f9912015-10-20 17:12:36 -0700207 config_addresses.json:
Scott Baker2abd6a52015-10-16 17:47:22 -0700208 type: string
209 required: false
Andy Bavierb90a4622015-10-26 11:53:22 -0400210 config_network-cfg.json:
211 type: string
212 required: false
Scott Baker907f9912015-10-20 17:12:36 -0700213 config_virtualbng.json:
Scott Baker2abd6a52015-10-16 17:47:22 -0700214 type: string
215 required: false
216
Scott Baker535640b2015-10-21 10:54:29 -0700217 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 Vavilapalli6ff55982016-01-22 14:35:50 -0500233 install_dependencies:
234 type: string
235 required: false
236 component_config:
237 type: string
238 required: false
Andy Bavier28c3f172015-11-02 15:43:59 -0500239 config_network-cfg.json:
240 type: string
241 required: false
Scott Bakera758d822015-12-03 21:14:39 -0800242 rest_onos/v1/network/configuration/:
243 type: string
244 required: false
Scott Baker535640b2015-10-21 10:54:29 -0700245
Scott Baker49cad892015-12-15 17:59:26 -0800246 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 Bavier7532cef2016-04-14 15:13:12 -0400265 autogenerate:
266 type: string
267 required: false
Scott Baker49cad892015-12-15 17:59:26 -0800268
Scott Baker4698b922016-02-11 12:07:10 -0800269 tosca.nodes.VSGService:
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700270 description: >
Scott Baker4698b922016-02-11 12:07:10 -0800271 CORD: The vSG Service.
Scott Baker68217012015-08-10 17:06:23 -0700272 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 Baker9d9b6752016-02-04 10:40:34 -0800279 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 Baker304333e2015-09-02 16:27:47 -0700291 kind:
292 type: string
293 default: generic
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700294 description: Type of service.
Scott Baker68217012015-08-10 17:06:23 -0700295 view_url:
296 type: string
297 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700298 description: URL to follow when icon is clicked in the Service Directory.
Scott Baker5deb33d2015-08-10 17:08:54 -0700299 icon_url:
300 type: string
301 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700302 description: ICON to display in the Service Directory.
Scott Baker304333e2015-09-02 16:27:47 -0700303 enabled:
304 type: boolean
305 default: true
306 published:
307 type: boolean
308 default: true
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700309 description: If True then display this Service in the Service Directory.
Scott Baker304333e2015-09-02 16:27:47 -0700310 public_key:
311 type: string
312 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700313 description: Public key to install into Instances to allows Services to SSH into them.
Scott Bakerf60c0102015-11-12 16:22:52 -0800314 private_key_fn:
315 type: string
316 required: false
317 description: Location of private key file
Scott Baker304333e2015-09-02 16:27:47 -0700318 versionNumber:
319 type: string
320 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700321 description: Version number of Service.
Scott Baker68217012015-08-10 17:06:23 -0700322 backend_network_label:
323 type: string
324 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700325 description: Label that matches network used to connect HPC and BBS services.
Scott Bakerda3122a2016-02-23 14:58:49 -0800326 dns_servers:
327 type: string
328 required: false
Scott Baker6526f552016-03-04 11:29:02 -0800329 node_label:
330 type: string
331 required: false
Scott Baker68217012015-08-10 17:06:23 -0700332
Scott Baker5deb33d2015-08-10 17:08:54 -0700333 tosca.nodes.VBNGService:
334 derived_from: tosca.nodes.Root
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700335 description: >
336 CORD: The vBNG Service.
Scott Baker5deb33d2015-08-10 17:08:54 -0700337 capabilities:
338 scalable:
339 type: tosca.capabilities.Scalable
340 service:
341 type: tosca.capabilities.xos.Service
342 properties:
Scott Baker9d9b6752016-02-04 10:40:34 -0800343 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 Baker304333e2015-09-02 16:27:47 -0700355 kind:
356 type: string
357 default: generic
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700358 description: Type of service.
Scott Baker5deb33d2015-08-10 17:08:54 -0700359 view_url:
360 type: string
361 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700362 description: URL to follow when icon is clicked in the Service Directory.
Scott Baker5deb33d2015-08-10 17:08:54 -0700363 icon_url:
364 type: string
365 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700366 description: ICON to display in the Service Directory.
Scott Baker304333e2015-09-02 16:27:47 -0700367 enabled:
368 type: boolean
369 default: true
370 published:
371 type: boolean
372 default: true
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700373 description: If True then display this Service in the Service Directory.
Scott Baker304333e2015-09-02 16:27:47 -0700374 public_key:
375 type: string
376 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700377 description: Public key to install into Instances to allows Services to SSH into them.
Scott Bakerf60c0102015-11-12 16:22:52 -0800378 private_key_fn:
379 type: string
380 required: false
381 description: Location of private key file
Scott Baker304333e2015-09-02 16:27:47 -0700382 versionNumber:
383 type: string
384 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700385 description: Version number of Service.
Scott Baker5deb33d2015-08-10 17:08:54 -0700386 vbng_url:
387 type: string
388 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700389 description: URL of REST API endpoint for vBNG Service.
Scott Baker5deb33d2015-08-10 17:08:54 -0700390
Scott Bakerb1acdbb2016-04-13 11:26:17 -0700391 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 Baker74755392016-04-20 17:18:39 -0700445 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 Baker5deb33d2015-08-10 17:08:54 -0700520 tosca.nodes.CDNService:
521 derived_from: tosca.nodes.Root
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700522 description: >
523 Content Delivery Network Service. Includes Request Routing and Hypercache.
Scott Baker5deb33d2015-08-10 17:08:54 -0700524 capabilities:
525 scalable:
526 type: tosca.capabilities.Scalable
527 service:
528 type: tosca.capabilities.xos.Service
529 properties:
Scott Baker9d9b6752016-02-04 10:40:34 -0800530 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 Baker304333e2015-09-02 16:27:47 -0700542 kind:
543 type: string
544 default: generic
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700545 description: Type of service.
Scott Baker5deb33d2015-08-10 17:08:54 -0700546 view_url:
547 type: string
548 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700549 description: URL to follow when icon is clicked in the Service Directory.
Scott Baker5deb33d2015-08-10 17:08:54 -0700550 icon_url:
551 type: string
552 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700553 description: ICON to display in the Service Directory.
Scott Baker304333e2015-09-02 16:27:47 -0700554 enabled:
555 type: boolean
556 default: true
557 published:
558 type: boolean
559 default: true
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700560 description: If True then display this Service in the Service Directory.
Scott Baker304333e2015-09-02 16:27:47 -0700561 public_key:
562 type: string
563 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700564 description: Public key to install into Instances to allows Services to SSH into them.
Scott Bakerf60c0102015-11-12 16:22:52 -0800565 private_key_fn:
566 type: string
567 required: false
568 description: Location of private key file
Scott Baker304333e2015-09-02 16:27:47 -0700569 versionNumber:
570 type: string
571 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700572 description: Version number of Service.
Scott Baker304333e2015-09-02 16:27:47 -0700573
Scott Bakerad2cb4a2016-04-06 17:09:22 -0700574 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 Baker304333e2015-09-02 16:27:47 -0700629 tosca.nodes.Subscriber:
630 derived_from: tosca.nodes.Root
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700631 description: XOS subscriber base class.
Scott Baker304333e2015-09-02 16:27:47 -0700632 capabilities:
633 subscriber:
634 type: tosca.capabilities.xos.Subscriber
635 properties:
636 kind:
637 type: string
638 default: generic
Scott Baker2f341b42015-10-06 14:13:56 -0700639 description: Kind of subscriber
Scott Baker304333e2015-09-02 16:27:47 -0700640 service_specific_id:
641 type: string
642 required: false
Scott Baker6f156fa2015-10-08 16:49:51 -0700643 description: Service specific ID opaque to XOS but meaningful to service
Scott Baker304333e2015-09-02 16:27:47 -0700644
645 tosca.nodes.CORDSubscriber:
646 derived_from: tosca.nodes.Root
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700647 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 Baker304333e2015-09-02 16:27:47 -0700651 capabilities:
652 subscriber:
653 type: tosca.capabilities.xos.Subscriber
654 properties:
655 kind:
656 type: string
657 default: generic
Scott Baker2f341b42015-10-06 14:13:56 -0700658 description: Kind of subscriber
Scott Baker304333e2015-09-02 16:27:47 -0700659 service_specific_id:
660 type: string
661 required: false
Scott Baker6f156fa2015-10-08 16:49:51 -0700662 description: Service specific ID opaque to XOS but meaningful to service
Scott Baker304333e2015-09-02 16:27:47 -0700663 firewall_enable:
664 type: boolean
665 default: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700666 description: If True, then firewalling is enabled.
Scott Baker304333e2015-09-02 16:27:47 -0700667 url_filter_enable:
668 type: boolean
669 default: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700670 description: If True, then parental controls are enabled.
Scott Baker304333e2015-09-02 16:27:47 -0700671 url_filter_level:
672 type: string
673 default: PG
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700674 description: The default URL filter level for the household.
Scott Baker304333e2015-09-02 16:27:47 -0700675 cdn_enable:
676 type: boolean
677 default: true
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700678 description: If True, then the CDN is enabled.
Scott Baker304333e2015-09-02 16:27:47 -0700679
680 tosca.nodes.CORDUser:
681 derived_from: tosca.nodes.Root
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700682 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 Baker2f341b42015-10-06 14:13:56 -0700686 capabilities:
687 device:
688 type: tosca.capabilities.xos.Device
Scott Baker304333e2015-09-02 16:27:47 -0700689 properties:
690 level:
691 type: string
692 default: PG_13
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700693 description: Parental control level for this device.
Scott Baker304333e2015-09-02 16:27:47 -0700694 mac:
695 type: string
696 required: true
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700697 description: MAC address for this device.
Scott Baker304333e2015-09-02 16:27:47 -0700698
699 tosca.nodes.VOLTTenant:
700 derived_from: tosca.nodes.Root
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700701 description: >
702 CORD: A Tenant of the vOLT Service. Each Tenant is tied to a
703 specific vlan_id.
Scott Baker304333e2015-09-02 16:27:47 -0700704 properties:
705 kind:
706 type: string
707 default: generic
Scott Baker2f341b42015-10-06 14:13:56 -0700708 description: Kind of tenant
Scott Baker304333e2015-09-02 16:27:47 -0700709 service_specific_id:
710 type: string
711 required: false
Scott Baker6f156fa2015-10-08 16:49:51 -0700712 description: Service specific ID opaque to XOS but meaningful to service
Scott Baker294a5322015-11-10 12:06:18 -0800713 s_tag:
Scott Bakerafc09ee2015-09-17 10:07:52 -0700714 type: string
715 required: false
Scott Baker294a5322015-11-10 12:06:18 -0800716 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 Baker5deb33d2015-08-10 17:08:54 -0700721
Scott Baker68217012015-08-10 17:06:23 -0700722 tosca.nodes.User:
723 derived_from: tosca.nodes.Root
724
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700725 description: >
726 An XOS User record. Users are able to login and use the XOS GUI.
727
Scott Baker68217012015-08-10 17:06:23 -0700728 capabilities:
729 user:
730 type: tosca.capabilities.xos.User
731
732 properties:
733 password:
734 type: string
Scott Baker398bbca2015-09-28 15:17:40 -0700735 required: false
Scott Baker68217012015-08-10 17:06:23 -0700736 firstname:
737 type: string
738 required: true
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700739 description: First name of User.
Scott Baker68217012015-08-10 17:06:23 -0700740 lastname:
741 type: string
742 required: true
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700743 description: Last name of User.
Scott Baker68217012015-08-10 17:06:23 -0700744 phone:
745 type: string
746 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700747 description: Phone number of User.
Scott Baker68217012015-08-10 17:06:23 -0700748 user_url:
749 type: string
750 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700751 description: URL to User web page.
Scott Baker68217012015-08-10 17:06:23 -0700752 public_key:
753 type: string
754 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700755 description: Public key that will be installed in Instances.
Scott Baker68217012015-08-10 17:06:23 -0700756 is_active:
757 type: boolean
758 default: true
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700759 description: If True, the user may log in.
Scott Baker68217012015-08-10 17:06:23 -0700760 is_admin:
761 type: boolean
762 default: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700763 description: If True, the user has root admin privileges.
Scott Baker68217012015-08-10 17:06:23 -0700764 login_page:
765 type: string
766 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700767 description: Indicates what page the user should go to on login.
Scott Baker68217012015-08-10 17:06:23 -0700768
Scott Baker2d13d8b2015-11-16 14:31:02 -0800769 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 Baker68217012015-08-10 17:06:23 -0700780 tosca.nodes.NetworkTemplate:
781 derived_from: tosca.nodes.Root
782
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700783 description: >
784 An XOS network template. Network templates contain settings associated
785 with a particular class of network.
786
Scott Baker68217012015-08-10 17:06:23 -0700787 capabilities:
788 network_template:
789 type: tosca.capabilities.xos.NetworkTemplate
790
791 properties:
792 visibility:
793 type: string
794 default: private
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700795 description: Indicates whether network is publicly routable.
Scott Baker68217012015-08-10 17:06:23 -0700796 translation:
797 type: string
798 default: none
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700799 description: Indicates whether network uses address translation.
Scott Baker68217012015-08-10 17:06:23 -0700800 shared_network_name:
801 type: string
802 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700803 description: Attaches this template to a specific OpenStack network.
Scott Baker68217012015-08-10 17:06:23 -0700804 shared_network_id:
805 type: string
806 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700807 description: Attaches this template to a specific OpenStack network.
Scott Baker68217012015-08-10 17:06:23 -0700808 topology_kind:
809 type: string
810 default: BigSwitch
Scott Baker2f341b42015-10-06 14:13:56 -0700811 description: Describes the topology of the network.
Scott Baker68217012015-08-10 17:06:23 -0700812 controller_kind:
813 type: string
814 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700815 description: Indicates the type of controller that the network is connected to.
Scott Baker4e921a42015-12-09 16:51:52 -0800816 access:
817 type: string
818 required: false
819 description: The type of access semantics for this network
Scott Baker68217012015-08-10 17:06:23 -0700820
Scott Baker2edd4f32015-08-14 12:41:18 -0700821 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 Baker2f341b42015-10-06 14:13:56 -0700827 This is a variant of the TOSCA Network object that includes additional
828 XOS-specific properties.
Scott Baker2edd4f32015-08-14 12:41:18 -0700829 properties:
Scott Baker0b1d4df2016-02-13 15:00:11 -0800830 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 Baker2edd4f32015-08-14 12:41:18 -0700842 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 Baker68217012015-08-10 17:06:23 -0700906 type: string
907 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700908 description: >
909 A comma-separated list of protocols and ports. For example,
910 "tcp/123, tcp/456-459, udp/111"
Scott Baker68217012015-08-10 17:06:23 -0700911 labels:
912 type: string
913 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700914 description: A comma-separated list of labels for this network.
Scott Baker68217012015-08-10 17:06:23 -0700915 permit_all_slices:
916 type: boolean
Scott Baker2edd4f32015-08-14 12:41:18 -0700917 # 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 Baker3a6a1ab2015-10-05 17:54:31 -0700920 description: If True, then any slice may be attached to this network.
Scott Baker304333e2015-09-02 16:27:47 -0700921 capabilities:
Scott Baker2edd4f32015-08-14 12:41:18 -0700922 link:
923 type: tosca.capabilities.network.Linkable
924
Scott Baker68217012015-08-10 17:06:23 -0700925 tosca.nodes.Deployment:
926 derived_from: tosca.nodes.Root
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700927 description: >
928 An XOS Deployment.
Scott Baker68217012015-08-10 17:06:23 -0700929 capabilities:
930 deployment:
931 type: tosca.capabilities.xos.Deployment
Scott Bakere71ab8b2015-09-22 17:26:31 -0700932 properties:
Scott Baker6759c702015-09-25 09:08:57 -0700933 no-delete:
934 type: boolean
935 default: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700936 description: Do not allow Tosca to delete this object
Scott Baker6759c702015-09-25 09:08:57 -0700937 no-create:
938 type: boolean
939 default: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700940 description: Do not allow Tosca to create this object
Scott Baker6f156fa2015-10-08 16:49:51 -0700941 no-update:
942 type: boolean
943 default: false
944 description: Do not allow Tosca to update this object
Scott Bakere71ab8b2015-09-22 17:26:31 -0700945 accessControl:
946 type: string
947 default: allow all
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700948 description: ACL that describes who may use this deployment.
Scott Baker143de8f2015-09-23 21:48:08 -0700949 flavors:
950 type: string
951 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700952 description: Comma-separated list of flavors that this deployment supports.
Scott Baker143de8f2015-09-23 21:48:08 -0700953
Scott Baker7b897e32016-02-12 17:31:04 -0800954 tosca.nodes.AddressPool:
955 derived_from: tosca.nodes.Root
956 description: >
957 A pool of addresses
Scott Baker380e7382016-04-12 16:41:03 -0700958 capabilities:
959 addresspool:
960 type: tosca.capabilities.xos.AddressPool
Scott Baker7b897e32016-02-12 17:31:04 -0800961 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 Baker380e7382016-04-12 16:41:03 -0700978 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 Baker7b897e32016-02-12 17:31:04 -0800986
Scott Baker143de8f2015-09-23 21:48:08 -0700987 tosca.nodes.Image:
988 derived_from: tosca.nodes.Root
Scott Baker3a6a1ab2015-10-05 17:54:31 -0700989 description: >
990 An XOS Operating System Image.
Scott Baker143de8f2015-09-23 21:48:08 -0700991 capabilities:
992 image:
993 type: tosca.capabilities.xos.Image
994 properties:
Scott Baker4f6558a2015-11-11 20:12:43 -0800995 kind:
996 type: string
997 required: false
998 description: Type of image (container | VM)
Scott Baker143de8f2015-09-23 21:48:08 -0700999 disk_format:
1000 type: string
1001 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001002 description: Glance disk format.
Scott Baker143de8f2015-09-23 21:48:08 -07001003 container_format:
1004 type: string
1005 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001006 description: Glance container format.
Scott Baker143de8f2015-09-23 21:48:08 -07001007 path:
1008 type: string
1009 required: false
Scott Bakerac69b6a2015-12-14 09:25:57 -08001010 description: Path to Image file
1011 tag:
1012 type: string
1013 required: false
1014 description: For Docker images, tag of image
Scott Baker68217012015-08-10 17:06:23 -07001015
1016 tosca.nodes.Controller:
1017 derived_from: tosca.nodes.Root
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001018 description: >
1019 An XOS controller. Controllers serve as the interface between
1020 XOS and services such as OpenStack.
Scott Baker68217012015-08-10 17:06:23 -07001021 capabilities:
1022 controller:
1023 type: tosca.capabilities.xos.Controller
1024 properties:
Scott Baker6f156fa2015-10-08 16:49:51 -07001025 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 Baker68217012015-08-10 17:06:23 -07001037 backend_type:
1038 type: string
1039 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001040 description: Type of backend.
Scott Baker68217012015-08-10 17:06:23 -07001041 version:
1042 type: string
1043 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001044 description: Version of backend.
Scott Baker68217012015-08-10 17:06:23 -07001045 auth_url:
1046 type: string
1047 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001048 description: Keystone auth_url.
Scott Baker68217012015-08-10 17:06:23 -07001049 admin_user:
1050 type: string
1051 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001052 description: Keystone username.
Scott Baker68217012015-08-10 17:06:23 -07001053 admin_password:
1054 type: string
1055 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001056 description: Keystone password.
Scott Baker68217012015-08-10 17:06:23 -07001057 admin_tenant:
1058 type: string
1059 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001060 description: Tenant associated with admin account.
Scott Baker68217012015-08-10 17:06:23 -07001061 domain:
1062 type: string
1063 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001064 description: OpenStack domain (or "Default")
Scott Bakerb718ec52015-10-27 10:29:39 -07001065 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 Baker68217012015-08-10 17:06:23 -07001077
1078 tosca.nodes.Site:
1079 derived_from: tosca.nodes.Root
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001080 description: >
1081 An XOS Site. Sites are containers for Users and/or Nodes.
Scott Baker68217012015-08-10 17:06:23 -07001082 capabilities:
1083 site:
1084 type: tosca.capabilities.xos.Site
1085 properties:
Scott Baker6f156fa2015-10-08 16:49:51 -07001086 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 Baker68217012015-08-10 17:06:23 -07001121
1122 tosca.nodes.Slice:
1123 derived_from: tosca.nodes.Root
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001124 description: >
1125 An XOS Slice. A slice is a collection of instances that share
1126 common attributes.
Scott Baker2f341b42015-10-06 14:13:56 -07001127 capabilities:
Scott Baker68217012015-08-10 17:06:23 -07001128 slice:
1129 type: tosca.capabilities.xos.Slice
Scott Baker69334ad2015-09-22 12:51:20 -07001130 properties:
Scott Baker6f156fa2015-10-08 16:49:51 -07001131 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 Baker69334ad2015-09-22 12:51:20 -07001143 enabled:
1144 type: boolean
1145 default: true
1146 description:
1147 type: string
1148 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001149 description: Description of this slice.
Scott Baker69334ad2015-09-22 12:51:20 -07001150 slice_url:
1151 type: string
1152 required: false
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001153 description: URL to web page that describes slice.
Scott Baker69334ad2015-09-22 12:51:20 -07001154 max_instances:
1155 type: integer
1156 default: 10
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001157 description: Quota of instances that this slice may create.
Scott Baker7430bd32015-11-30 17:48:30 -08001158 default_isolation:
1159 type: string
1160 required: false
1161 description: default isolation to use when bringing up instances (default to 'vm')
Scott Bakerddf80092015-12-14 16:21:33 -08001162 network:
1163 type: string
1164 required: false
1165 description: type of networking to use for this slice
Scott Baker3fe056a2016-02-04 15:58:19 -08001166 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 Baker68217012015-08-10 17:06:23 -07001170
Scott Bakere058b182015-09-16 16:14:42 -07001171 tosca.nodes.Node:
1172 derived_from: tosca.nodes.Root
Scott Baker3a6a1ab2015-10-05 17:54:31 -07001173 description: >
1174 An XOS Node. Nodes are physical machines that host virtual machines
1175 and/or containers.
Scott Baker6f156fa2015-10-08 16:49:51 -07001176 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 Bakere058b182015-09-16 16:14:42 -07001190 node:
1191 type: tosca.capabilities.xos.Node
1192
Scott Bakerc4d78da2016-03-04 10:44:41 -08001193 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 Baker786750b2016-04-25 09:21:08 -07001214 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 Baker33890562015-10-28 14:52:14 -07001239 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 Baker4f6558a2015-11-11 20:12:43 -08001267 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 Baker68217012015-08-10 17:06:23 -07001292 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 Bakere058b182015-09-16 16:14:42 -07001304 tosca.relationships.MemberOfDeployment:
1305 derived_from: tosca.relationships.Root
1306 valid_target_types: [ tosca.capabilities.xos.Deployment ]
1307
Scott Baker68217012015-08-10 17:06:23 -07001308 tosca.relationships.TenantOfService:
1309 derived_from: tosca.relationships.Root
1310 valid_target_types: [ tosca.capabilities.xos.Service ]
1311
Scott Baker5e5c0e32015-10-20 21:18:45 -07001312 tosca.relationships.UsedByService:
1313 derived_from: tosca.relationships.Root
1314 valid_target_types: [ tosca.capabilities.xos.Service ]
1315
Scott Baker68217012015-08-10 17:06:23 -07001316 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 Baker4f6558a2015-11-11 20:12:43 -08001332 tosca.relationships.UsesImage:
1333 derived_from: tosca.relationships.Root
1334 valid_target_types: [ tosca.capabilities.xos.Image ]
1335
Scott Baker8560e782015-12-14 13:09:33 -08001336 tosca.relationships.DefaultImage:
1337 derived_from: tosca.relationships.Root
1338 valid_target_types: [ tosca.capabilities.xos.Image ]
1339
Scott Baker143de8f2015-09-23 21:48:08 -07001340 tosca.relationships.SupportsImage:
1341 derived_from: tosca.relationships.Root
1342 valid_target_types: [ tosca.capabilities.xos.Image ]
1343
Scott Baker304333e2015-09-02 16:27:47 -07001344 tosca.relationships.ConnectsToSlice:
1345 derived_from: tosca.relationships.Root
Scott Baker2f341b42015-10-06 14:13:56 -07001346 valid_target_types: [ tosca.capabilities.xos.Slice ]
Scott Baker304333e2015-09-02 16:27:47 -07001347
Scott Baker68217012015-08-10 17:06:23 -07001348 # 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 Baker2f341b42015-10-06 14:13:56 -07001358 valid_target_types: [ tosca.capabilities.xos.Slice, tosca.capabilities.xos.Site ]
Scott Baker68217012015-08-10 17:06:23 -07001359
1360 tosca.relationships.AccessPrivilege:
1361 derived_from: tosca.relationships.Root
Scott Baker2f341b42015-10-06 14:13:56 -07001362 valid_target_types: [ tosca.capabilities.xos.Slice, tosca.capabilities.xos.Site ]
Scott Baker68217012015-08-10 17:06:23 -07001363
1364 tosca.relationships.PIPrivilege:
1365 derived_from: tosca.relationships.Root
Scott Baker2f341b42015-10-06 14:13:56 -07001366 valid_target_types: [ tosca.capabilities.xos.Site ]
Scott Baker68217012015-08-10 17:06:23 -07001367
1368 tosca.relationships.TechPrivilege:
1369 derived_from: tosca.relationships.Root
Scott Baker2f341b42015-10-06 14:13:56 -07001370 valid_target_types: [ tosca.capabilities.xos.Site ]
Scott Baker68217012015-08-10 17:06:23 -07001371
Scott Baker304333e2015-09-02 16:27:47 -07001372 tosca.relationships.SubscriberDevice:
1373 derived_from: tosca.relationships.Root
Scott Baker2f341b42015-10-06 14:13:56 -07001374 valid_target_types: [ tosca.capabilities.xos.Subscriber ]
Scott Baker304333e2015-09-02 16:27:47 -07001375
1376 tosca.relationships.BelongsToSubscriber:
1377 derived_from: tosca.relationships.Root
Scott Baker2f341b42015-10-06 14:13:56 -07001378 valid_target_types: [ tosca.capabilities.xos.Subscriber ]
Scott Baker304333e2015-09-02 16:27:47 -07001379
Scott Baker33890562015-10-28 14:52:14 -07001380 tosca.relationships.UsesDashboard:
1381 derived_from: tosca.relationships.Root
1382 valid_target_types: [ tosca.capabilities.xos.DashboardView ]
1383
Scott Baker0b18f612016-03-04 12:46:48 -08001384 tosca.relationships.HasLabel:
1385 derived_from: tosca.relationships.Root
1386 valid_target_types: [ tosca.capabilities.xos.NodeLabel ]
1387
Scott Baker786750b2016-04-25 09:21:08 -07001388 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 Baker380e7382016-04-12 16:41:03 -07001396 tosca.relationships.ProvidesAddresses:
1397 derived_from: tosca.relationships.Root
1398 valid_target_types: [ tosca.capabilities.xos.AddressPool ]
1399
Scott Baker65b9c802016-03-06 23:11:23 -08001400 tosca.relationships.DependsOn:
1401 derived_from: tosca.relationships.Root
1402
Scott Baker68217012015-08-10 17:06:23 -07001403 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 Baker2edd4f32015-08-14 12:41:18 -07001427# tosca.capabilities.xos.Network:
1428# derived_from: tosca.capabilities.Root
1429# description: An XOS network
Scott Baker68217012015-08-10 17:06:23 -07001430
1431 tosca.capabilities.xos.User:
1432 derived_from: tosca.capabilities.Root
1433 description: An XOS user
Scott Baker304333e2015-09-02 16:27:47 -07001434
1435 tosca.capabilities.xos.Subscriber:
1436 derived_from: tosca.capabilities.Root
1437 description: An XOS Subscriber
1438
Scott Baker2f341b42015-10-06 14:13:56 -07001439 tosca.capabilities.xos.Device:
1440 derived_from: tosca.capabilities.Root
1441 description: A device belonging to an XOS subscriber
1442
Scott Bakere058b182015-09-16 16:14:42 -07001443 tosca.capabilities.xos.Node:
1444 derived_from: tosca.capabilities.Root
1445 description: An XOS Node
1446
Scott Bakerc4d78da2016-03-04 10:44:41 -08001447 tosca.capabilities.xos.NodeLabel:
1448 derived_from: tosca.capabilities.Root
1449 description: An XOS NodeLabel
1450
Scott Baker786750b2016-04-25 09:21:08 -07001451 tosca.capabilities.xos.Flavor:
1452 derived_from: tosca.capabilities.Root
1453 description: An XOS Flavor
1454
Scott Baker143de8f2015-09-23 21:48:08 -07001455 tosca.capabilities.xos.Image:
1456 derived_from: tosca.capabilities.Root
1457 description: An XOS Image
Scott Baker33890562015-10-28 14:52:14 -07001458
1459 tosca.capabilities.xos.DashboardView:
1460 derived_from: tosca.capabilities.Root
1461 description: An XOS DashboardView
Scott Baker2d13d8b2015-11-16 14:31:02 -08001462
1463 tosca.capabilities.xos.NetworkParameterType:
1464 derived_from: tosca.capabilities.Root
1465 description: An XOS NetworkParameterType
Scott Baker380e7382016-04-12 16:41:03 -07001466
1467 tosca.capabilities.xos.AddressPool:
1468 derived_from: tosca.capabilities.Root
1469 description: An XOS AddressPool