summaryrefslogtreecommitdiffstats
path: root/tosca2heat/tosca-parser-0.3.0/toscaparser/elements/TOSCA_definition_1_0.yaml
blob: 2f50ff01567a512e860c8fd7fd4e86d25a985da4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.

##########################################################################
# The content of this file reflects TOSCA Simple Profile in YAML version
# 1.0.0. It describes the definition for TOSCA types including Node Type,
# Relationship Type, Capability Type and Interfaces.
##########################################################################
tosca_definitions_version: tosca_simple_yaml_1_0

##########################################################################
# Node Type.
# A Node Type is a reusable entity that defines the type of one or more
# Node Templates.
##########################################################################
tosca.nodes.Root:
  description: >
    The TOSCA root node all other TOSCA base node types derive from.
  attributes:
    tosca_id:
      type: string
    tosca_name:
      type: string
    state:
      type: string
    capabilities:
      feature:
        type: tosca.capabilities.Node
  requirements:
    - dependency:
        capability: tosca.capabilities.Node
        node: tosca.nodes.Root
        relationship: tosca.relationships.DependsOn
        occurrences: [ 0, UNBOUNDED ]
  interfaces:
    Standard:
      type: tosca.interfaces.node.lifecycle.Standard

tosca.nodes.Compute:
  derived_from: tosca.nodes.Root
  attributes:
    private_address:
      type: string
    public_address:
      type: string
  capabilities:
      host:
         type: tosca.capabilities.Container
      binding:
         type: tosca.capabilities.network.Bindable
      os:
         type: tosca.capabilities.OperatingSystem
      scalable:
         type: tosca.capabilities.Scalable
  requirements:
    - local_storage:
        capability: tosca.capabilities.Attachment
        node: tosca.nodes.BlockStorage
        relationship: tosca.relationships.AttachesTo
        occurrences: [0, UNBOUNDED]

tosca.nodes.SoftwareComponent:
  derived_from: tosca.nodes.Root
  properties:
    # domain-specific software component version
    component_version:
      type: version
      required: false
      description: >
        Software component version.
    admin_credential:
      type: tosca.datatypes.Credential
      required: false
  requirements:
    - host:
        capability: tosca.capabilities.Container
        node: tosca.nodes.Compute
        relationship: tosca.relationships.HostedOn

tosca.nodes.DBMS:
  derived_from: tosca.nodes.SoftwareComponent
  properties:
    port:
      required: no
      type: integer
      description: >
        The port the DBMS service will listen to for data and requests.
    root_password:
      required: no
      type: string
      description: >
        The root password for the DBMS service.
  capabilities:
    host:
      type: tosca.capabilities.Container
      valid_source_types: [tosca.nodes.Database]

tosca.nodes.Database:
  derived_from: tosca.nodes.Root
  properties:
    user:
      required: no
      type: string
      description: >
        User account name for DB administration
    name:
      required: no
      type: string
      description: >
        The name of the database.
    password:
      required: no
      type: string
      description: >
        The password for the DB user account
  requirements:
    - host:
        capability: tosca.capabilities.Container
        node: tosca.nodes.DBMS
        relationship: tosca.relationships.HostedOn
  capabilities:
    database_endpoint:
      type: tosca.capabilities.Endpoint.Database

tosca.nodes.WebServer:
  derived_from: tosca.nodes.SoftwareComponent
  capabilities:
    data_endpoint:
      type: tosca.capabilities.Endpoint
    admin_endpoint:
      type: tosca.capabilities.Endpoint.Admin
    host:
      type: tosca.capabilities.Container
      valid_source_types: [tosca.nodes.WebApplication]

tosca.nodes.WebApplication:
  derived_from: tosca.nodes.Root
  properties:
    context_root:
      type: string
      required: false
  requirements:
    - host:
        capability: tosca.capabilities.Container
        node: tosca.nodes.WebServer
        relationship: tosca.relationships.HostedOn
  capabilities:
    app_endpoint:
      type: tosca.capabilities.Endpoint

tosca.nodes.BlockStorage:
  derived_from: tosca.nodes.Root
  properties:
    size:
      type: scalar-unit.size
      constraints:
        - greater_or_equal: 1 MB
    volume_id:
      type: string
      required: false
    snapshot_id:
      type: string
      required: false
  attributes:
    volume_id:
      type: string
  capabilities:
    attachment:
      type: tosca.capabilities.Attachment

tosca.nodes.network.Network:
  derived_from: tosca.nodes.Root
  description: >
    The TOSCA Network node represents a simple, logical network service.
  properties:
    ip_version:
      type: integer
      required: no
      default: 4
      constraints:
        - valid_values: [ 4, 6 ]
      description: >
        The IP version of the requested network. Valid values are 4 for ipv4
        or 6 for ipv6.
    cidr:
      type: string
      required: no
      description: >
        The cidr block of the requested network.
    start_ip:
      type: string
      required: no
      description: >
         The IP address to be used as the start of a pool of addresses within
         the full IP range derived from the cidr block.
    end_ip:
      type: string
      required: no
      description: >
          The IP address to be used as the end of a pool of addresses within
          the full IP range derived from the cidr block.
    gateway_ip:
      type: string
      required: no
      description: >
         The gateway IP address.
    network_name:
      type: string
      required: no
      description: >
         An identifier that represents an existing Network instance in the
         underlying cloud infrastructure or can be used as the name of the
         newly created network. If network_name is provided and no other
         properties are provided (with exception of network_id), then an
         existing network instance will be used. If network_name is provided
         alongside with more properties then a new network with this name will
         be created.
    network_id:
      type: string
      required: no
      description: >
         An identifier that represents an existing Network instance in the
         underlying cloud infrastructure. This property is mutually exclusive
         with all other properties except network_name. This can be used alone
         or together with network_name to identify an existing network.
    segmentation_id:
      type: string
      required: no
      description: >
         A segmentation identifier in the underlying cloud infrastructure.
         E.g. VLAN ID, GRE tunnel ID, etc..
    dhcp_enabled:
      type: boolean
      required: no
      default: true
      description: >
        Indicates should DHCP service be enabled on the network or not.
  capabilities:
    link:
      type: tosca.capabilities.network.Linkable

tosca.nodes.network.Port:
  derived_from: tosca.nodes.Root
  description: >
    The TOSCA Port node represents a logical entity that associates between
    Compute and Network normative types. The Port node type effectively
    represents a single virtual NIC on the Compute node instance.
  properties:
    ip_address:
      type: string
      required: no
      description: >
        Allow the user to set a static IP.
    order:
      type: integer
      required: no
      default: 0
      constraints:
        - greater_or_equal: 0
      description: >
        The order of the NIC on the compute instance (e.g. eth2).
    is_default:
      type: boolean
      required: no
      default: false
      description: >
        If is_default=true this port will be used for the default gateway
        route. Only one port that is associated to single compute node can
        set as is_default=true.
    ip_range_start:
      type: string
      required: no
      description: >
        Defines the starting IP of a range to be allocated for the compute
        instances that are associated with this Port.
    ip_range_end:
      type: string
      required: no
      description: >
        Defines the ending IP of a range to be allocated for the compute
        instances that are associated with this Port.
  attributes:
    ip_address:
      type: string
  requirements:
    - binding:
        description: >
          Binding requirement expresses the relationship between Port and
          Compute nodes. Effectevely it indicates that the Port will be
          attached to specific Compute node instance
        capability: tosca.capabilities.network.Bindable
        relationship: tosca.relationships.network.BindsTo
    - link:
        description: >
          Link requirement expresses the relationship between Port and Network
          nodes. It indicates which network this port will connect to.
        capability: tosca.capabilities.network.Linkable
        relationship: tosca.relationships.network.LinksTo

tosca.nodes.ObjectStorage:
  derived_from: tosca.nodes.Root
  description: >
    The TOSCA ObjectStorage node represents storage that provides the ability
    to store data as objects (or BLOBs of data) without consideration for the
    underlying filesystem or devices
  properties:
    name:
      type: string
      required: yes
      description: >
        The logical name of the object store (or container).
    size:
      type: scalar-unit.size
      required: no
      constraints:
        - greater_or_equal: 0 GB
      description: >
        The requested initial storage size.
    maxsize:
      type: scalar-unit.size
      required: no
      constraints:
        - greater_or_equal: 0 GB
      description: >
        The requested maximum storage size.
  capabilities:
    storage_endpoint:
      type: tosca.capabilities.Endpoint

##########################################################################
# Relationship Type.
# A Relationship Type is a reusable entity that defines the type of one
# or more relationships between Node Types or Node Templates.
##########################################################################
tosca.relationships.Root:
  description: >
    The TOSCA root Relationship Type all other TOSCA base Relationship Types
    derive from.
  attributes:
    tosca_id:
      type: string
    tosca_name:
      type: string
  interfaces:
    Configure:
      type: tosca.interfaces.relationship.Configure

tosca.relationships.DependsOn:
  derived_from: tosca.relationships.Root

tosca.relationships.HostedOn:
  derived_from: tosca.relationships.Root
  valid_target_types: [ tosca.capabilities.Container ]

tosca.relationships.ConnectsTo:
  derived_from: tosca.relationships.Root
  valid_target_types: [ tosca.capabilities.Endpoint ]
  credential:
    type: tosca.datatypes.Credential
    required: false

tosca.relationships.AttachesTo:
  derived_from: tosca.relationships.Root
  valid_target_types: [ tosca.capabilities.Attachment ]
  properties:
    location:
      required: true
      type: string
      constraints:
        - min_length: 1
    device:
      required: false
      type: string

tosca.relationships.network.LinksTo:
  derived_from: tosca.relationships.DependsOn
  valid_target_types: [ tosca.capabilities.network.Linkable ]

tosca.relationships.network.BindsTo:
  derived_from: tosca.relationships.DependsOn
  valid_target_types: [ tosca.capabilities.network.Bindable ]

##########################################################################
# Capability Type.
# A Capability Type is a reusable entity that describes a kind of
# capability that a Node Type can declare to expose.
##########################################################################
tosca.capabilities.Root:
  description: >
    The TOSCA root Capability Type all other TOSCA base Capability Types
    derive from.

tosca.capabilities.Node:
  derived_from: tosca.capabilities.Root

tosca.capabilities.Container:
  derived_from: tosca.capabilities.Root
  properties:
    num_cpus:
      required: no
      type: integer
      constraints:
        - greater_or_equal: 1
    cpu_frequency:
      required: no
      type: scalar-unit.frequency
      constraints:
        - greater_or_equal: 0.1 GHz
    disk_size:
      required: no
      type: scalar-unit.size
      constraints:
        - greater_or_equal: 0 MB
    mem_size:
      required: no
      type: scalar-unit.size
      constraints:
        - greater_or_equal: 0 MB

tosca.capabilities.Endpoint:
  derived_from: tosca.capabilities.Root
  properties:
    protocol:
      type: string
      default: tcp
    port:
      type: tosca.datatypes.network.PortDef
      required: false
    secure:
      type: boolean
      default: false
    url_path:
      type: string
      required: false
    port_name:
      type: string
      required: false
    network_name:
      type: string
      required: false
    initiator:
      type: string
      default: source
      constraints:
        - valid_values: [source, target, peer]
    ports:
      type: map
      required: false
      constraints:
        - min_length: 1
      entry_schema:
        type: tosca.datatypes.network.PortSpec
  attributes:
    ip_address:
      type: string

tosca.capabilities.Endpoint.Admin:
  derived_from: tosca.capabilities.Endpoint
  properties:
    secure: 
      type: boolean
      default: true
      constraints:
        - equal: true

tosca.capabilities.Endpoint.Public:
  derived_from: tosca.capabilities.Endpoint
  properties:
    # Change the default network_name to use the first public network found
    network_name:
      type: string
      default: PUBLIC
      constraints:
        - equal: PUBLIC
    floating:
      description: >
        Indicates that the public address should be allocated from a pool of
        floating IPs that are associated with the network.
      type: boolean
      default: false
      status: experimental
    dns_name:
      description: The optional name to register with DNS
      type: string
      required: false
      status: experimental

tosca.capabilities.Scalable:
  derived_from: tosca.capabilities.Root
  properties:
    min_instances:
      type: integer
      required: yes
      default: 1
      description: >
        This property is used to indicate the minimum number of instances
        that should be created for the associated TOSCA Node Template by
        a TOSCA orchestrator.
    max_instances:
      type: integer
      required: yes
      default: 1
      description: >
        This property is used to indicate the maximum number of instances
        that should be created for the associated TOSCA Node Template by
        a TOSCA orchestrator.
    default_instances:
      type: integer
      required: no
      description: >
        An optional property that indicates the requested default number
        of instances that should be the starting number of instances a
        TOSCA orchestrator should attempt to allocate.
        The value for this property MUST be in the range between the values
        set for min_instances and max_instances properties.

tosca.capabilities.Endpoint.Database:
  derived_from: tosca.capabilities.Endpoint

tosca.capabilities.Attachment:
  derived_from: tosca.capabilities.Root

tosca.capabilities.network.Linkable:
  derived_from: tosca.capabilities.Root
  description: >
    A node type that includes the Linkable capability indicates that it can
    be pointed by tosca.relationships.network.LinksTo relationship type, which
    represents an association relationship between Port and Network node types.

tosca.capabilities.network.Bindable:
  derived_from: tosca.capabilities.Root
  description: >
    A node type that includes the Bindable capability indicates that it can
    be pointed by tosca.relationships.network.BindsTo relationship type, which
    represents a network association relationship between Port and Compute node
    types.

tosca.capabilities.OperatingSystem:
  derived_from: tosca.capabilities.Root
  properties:
    architecture:
      required: false
      type: string
      description: >
        The host Operating System (OS) architecture.
    type:
      required: false
      type: string
      description: >
        The host Operating System (OS) type.
    distribution:
      required: false
      type: string
      description: >
        The host Operating System (OS) distribution. Examples of valid values
        for an “type” of “Linux” would include:
        debian, fedora, rhel and ubuntu.
    version:
      required: false
      type: version
      description: >
        The host Operating System version.

##########################################################################
 # Interfaces Type.
 # The Interfaces element describes a list of one or more interface
 # definitions for a modelable entity (e.g., a Node or Relationship Type)
 # as defined within the TOSCA Simple Profile specification.
##########################################################################
tosca.interfaces.node.lifecycle.Standard:
  create:
    description: Standard lifecycle create operation.
  configure:
    description: Standard lifecycle configure operation.
  start:
    description: Standard lifecycle start operation.
  stop:
    description: Standard lifecycle stop operation.
  delete:
    description: Standard lifecycle delete operation.

tosca.interfaces.relationship.Configure:
  pre_configure_source:
    description: Operation to pre-configure the source endpoint.
  pre_configure_target:
    description: Operation to pre-configure the target endpoint.
  post_configure_source:
    description: Operation to post-configure the source endpoint.
  post_configure_target:
    description: Operation to post-configure the target endpoint.
  add_target:
    description: Operation to add a target node.
  remove_target:
    description: Operation to remove a target node.
  add_source: >
    description: Operation to notify the target node of a source node which
    is now available via a relationship.
    description:
  target_changed: >
    description: Operation to notify source some property or attribute of the
    target changed

##########################################################################
 # Data Type.
 # A Datatype is a complex data type declaration which contains other
 # complex or simple data types.
##########################################################################
tosca.datatypes.Root:
  description: >
    The TOSCA root Data Type all other TOSCA base Data Types derive from

tosca.datatypes.network.NetworkInfo:
  derived_from: tosca.datatypes.Root
  properties:
    network_name:
      type: string
    network_id:
      type: string
    addresses:
      type: list
      entry_schema:
        type: string

tosca.datatypes.network.PortInfo:
  derived_from: tosca.datatypes.Root
  properties:
    port_name:
      type: string
    port_id:
      type: string
    network_id:
      type: string
    mac_address:
      type: string
    addresses:
      type: list
      entry_schema:
        type: string

tosca.datatypes.network.PortDef:
  derived_from: tosca.datatypes.Root
  type: integer
  constraints:
    - in_range: [ 1, 65535 ]

tosca.datatypes.network.PortSpec:
  derived_from: tosca.datatypes.Root
  properties:
    protocol:
      type: string
      required: true
      default: tcp
      constraints:
        - valid_values: [ udp, tcp, igmp ]
    target:
      type: PortDef
    target_range:
      type: range
      constraints:
        - in_range: [ 1, 65535 ]
    source:
      type: PortDef
    source_range:
      type: range
      constraints:
        - in_range: [ 1, 65535 ]

tosca.datatypes.Credential:
  derived_from: tosca.datatypes.Root
  properties:
    protocol:
      type: string
    token_type:
      type: string
    token:
      type: string
    keys:
      type: map
      entry_schema:
        type: string
    user:
      type: string
      required: false

##########################################################################
 # Artifact Type.
 # An Artifact Type is a reusable entity that defines the type of one or more
 # files which Node Types or Node Templates can have dependent relationships
 # and used during operations such as during installation or deployment.
##########################################################################
tosca.artifacts.Root:
  description: >
    The TOSCA Artifact Type all other TOSCA Artifact Types derive from
  properties:
    version: version

tosca.artifacts.File:
  derived_from: tosca.artifacts.Root

tosca.artifacts.Deployment:
  derived_from: tosca.artifacts.Root
  description: TOSCA base type for deployment artifacts

tosca.artifacts.Deployment.Image:
  derived_from: tosca.artifacts.Deployment

tosca.artifacts.Deployment.Image.VM:
  derived_from: tosca.artifacts.Deployment.Image

tosca.artifacts.Implementation:
  derived_from: tosca.artifacts.Root
  description: TOSCA base type for implementation artifacts

tosca.artifacts.Implementation.Bash:
  derived_from: tosca.artifacts.Implementation
  description: Script artifact for the Unix Bash shell
  mime_type: application/x-sh
  file_ext: [ sh ]

tosca.artifacts.Implementation.Python:
  derived_from: tosca.artifacts.Implementation
  description: Artifact for the interpreted Python language
  mime_type: application/x-python
  file_ext: [ py ]

tosca.artifacts.Deployment.Image.Container.Docker:
  derived_from: tosca.artifacts.Deployment.Image
  description: Docker container image

tosca.artifacts.Deployment.Image.VM.ISO:
  derived_from: tosca.artifacts.Deployment.Image
  description: Virtual Machine (VM) image in ISO disk format
  mime_type: application/octet-stream
  file_ext: [ iso ]

tosca.artifacts.Deployment.Image.VM.QCOW2:
  derived_from: tosca.artifacts.Deployment.Image
  description: Virtual Machine (VM) image in QCOW v2 standard disk format
  mime_type: application/octet-stream
  file_ext: [ qcow2 ]

##########################################################################
 # Policy Type.
 # TOSCA Policy Types represent logical grouping of TOSCA nodes that have
 # an implied relationship and need to be orchestrated or managed together
 # to achieve some result.
##########################################################################
tosca.policies.Root:
  description: The TOSCA Policy Type all other TOSCA Policy Types derive from.

tosca.policies.Placement:
  derived_from: tosca.policies.Root
  description: The TOSCA Policy Type definition that is used to govern
    placement of TOSCA nodes or groups of nodes.

tosca.policies.Scaling:
  derived_from: tosca.policies.Root
  description: The TOSCA Policy Type definition that is used to govern
    scaling of TOSCA nodes or groups of nodes.

tosca.policies.Update:
  derived_from: tosca.policies.Root
  description: The TOSCA Policy Type definition that is used to govern
    update of TOSCA nodes or groups of nodes.

tosca.policies.Performance:
  derived_from: tosca.policies.Root
  description: The TOSCA Policy Type definition that is used to declare
    performance requirements for TOSCA nodes or groups of nodes.