TOSCA Version 2.0

Committee Specification Draft 02

25 June 2020

This version:

https://docs.oasis-open.org/tosca/TOSCA/v2.0/csd02/TOSCA-v2.0-csd02.docx (Authoritative)

https://docs.oasis-open.org/tosca/TOSCA/v2.0/csd02/TOSCA-v2.0-csd02.html

https://docs.oasis-open.org/tosca/TOSCA/v2.0/csd02/TOSCA-v2.0-csd02.pdf

Previous version:

https://docs.oasis-open.org/tosca/TOSCA/v2.0/csd01/TOSCA-v2.0-csd01.docx (Authoritative)

https://docs.oasis-open.org/tosca/TOSCA/v2.0/csd01/TOSCA-v2.0-csd01.html

https://docs.oasis-open.org/tosca/TOSCA/v2.0/csd01/TOSCA-v2.0-csd01.pdf

Latest version:

https://docs.oasis-open.org/tosca/TOSCA/v2.0/TOSCA-v2.0.docx (Authoritative)

https://docs.oasis-open.org/tosca/TOSCA/v2.0/TOSCA-v2.0.html

https://docs.oasis-open.org/tosca/TOSCA/v2.0/TOSCA-v2.0.pdf

Technical Committee:

OASIS Topology and Orchestration Specification for Cloud Applications (TOSCA) TC

Chairs:

Paul Lipton (paul.lipton@live.com), Individual Member

Chris Lauwers (lauwers@ubicity.com), Individual Member

Editors:

Chris Lauwers (lauwers@ubicity.com), Individual Member

Calin Curescu (calin.curescu@ericsson.com), Ericsson

Related work:

This specification replaces or supersedes:

·         Topology and Orchestration Specification for Cloud Applications Version 1.0. Edited by Derek Palma and Thomas Spatzier. OASIS Standard. Latest version: http://docs.oasis-open.org/tosca/TOSCA/v1.0/TOSCA-v1.0.html.

·         TOSCA Simple Profile in YAML Version 1.3. Edited by Matt Rutkowski, Chris Lauwers, Claude Noshpitz, and Calin Curescu. Latest version: https://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.3/TOSCA-Simple-Profile-YAML-v1.3.html.

This specification is related to:

·         Introduction to TOSCA Version 2.0. Edited by Chris Lauwers and Calin Curescu. Work in progress.

Declared XML namespaces:

·         http://docs.oasis-open.org/tosca/ns/2.0

Abstract:

The OASIS TOSCA TC works to enhance the portability of cloud applications and services across their entire lifecycle. TOSCA will enable the interoperable description of application and infrastructure cloud services, the relationships between parts of the service, and the operational behavior of these services (e.g., deploy, patch, shutdown) independent of the supplier creating the service or of any particular cloud provider or hosting technology. TOSCA will also make it possible for higher-level operational behavior to be associated with cloud infrastructure management.

By increasing service and application portability in a vendor-neutral ecosystem, TOSCA will enable:

·         Portable deployment to any compliant cloud

·         Smoother migration of existing applications to the cloud

·         Flexible bursting (consumer choice)

·         Dynamic, multi-cloud provider applications

Status:

This document was last revised or approved by the OASIS Topology and Orchestration Specification for Cloud Applications (TOSCA) TC on the above date. The level of approval is also listed above. Check the “Latest version” location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=tosca#technical.

TC members should send comments on this specification to the TC’s email list. Others should send comments to the TC’s public comment list, after subscribing to it by following the instructions at the “Send A Comment” button on the TC’s web page at https://www.oasis-open.org/committees/tosca/.

This specification is provided under the RF on Limited Terms Mode of the OASIS IPR Policy, the mode chosen when the Technical Committee was established. For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the TC’s web page (https://www.oasis-open.org/committees/tosca/ipr.php).

Note that any machine-readable content (Computer Language Definitions) declared Normative for this Work Product is provided in separate plain text files. In the event of a discrepancy between any such plain text file and display content in the Work Product's prose narrative document(s), the content in the separate plain text file prevails.

Citation format:

When referencing this specification, the following citation format should be used:

[TOSCA-v2.0]

TOSCA Version 2.0. Edited by Chris Lauwers and Calin Curescu. 25 June 2020. OASIS Committee Specification Draft 02. https://docs.oasis-open.org/tosca/TOSCA/v2.0/csd02/TOSCA-v2.0-csd02.html. Latest version: https://docs.oasis-open.org/tosca/TOSCA/v2.0/TOSCA-v2.0.html.

Notices

Copyright © OASIS Open 2020. All Rights Reserved.

All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

As stated in the OASIS IPR Policy, the following three paragraphs in brackets apply to OASIS Standards Final Deliverable documents (Committee Specification, Candidate OASIS Standard, OASIS Standard, or Approved Errata).

[OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Standards Final Deliverable, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this deliverable.]

[OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this OASIS Standards Final Deliverable by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this OASIS Standards Final Deliverable. OASIS may include such claims on its website, but disclaims any obligation to do so.]

[OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this OASIS Standards Final Deliverable or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Standards Final Deliverable, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.]

The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark for above guidance.

Table of Contents

1        Introduction. 17

1.1 IPR Policy. 17

1.2 Terminology. 17

1.3 Normative References. 17

1.4 Non-Normative References. 17

2        Overview. 19

2.1 Objective. 19

2.2 Application Domains. 19

2.3 Implementations. 19

2.4 Glossary. 20

3        TOSCA core concepts. 21

3.1 Topology Templates, Node Templates, and Relationships. 21

3.2 Interfaces, Operations, and Artifacts. 22

3.3 Workflows. 22

3.4 Requirements and Capabilities. 22

3.5 Decomposition of Service Templates. 23

3.6 Policies in TOSCA. 24

3.7 Archive Format for Cloud Applications. 24

4        TOSCA definitions in YAML. 26

4.1 TOSCA Metamodel 26

4.1.1 Modeling concepts and goals. 26

4.1.2 Modeling definitions and reuse. 26

4.1.3 Goal of the derivation and refinement rules. 26

4.1.4 Required Keynames. 27

4.2 TOSCA Service. 27

4.2.1 Service Template definition. 27

4.2.1.1 Keynames. 27

4.2.1.1.1 Metadata keynames. 28

4.2.1.2 Grammar 28

4.2.1.2.1 Requirements. 29

4.2.1.2.2 Notes. 29

4.2.1.3 Top-level keyname definitions. 30

4.2.1.3.1 tosca_definitions_version. 30

4.2.1.3.1.1     Keyname. 30

4.2.1.3.1.2     Grammar 30

4.2.1.3.1.3     Examples: 30

4.2.1.3.2 metadata. 30

4.2.1.3.2.1     Keyname. 30

4.2.1.3.2.2     Grammar 30

4.2.1.3.2.3     Example. 30

4.2.1.3.3 template_name. 30

4.2.1.3.3.1     Keyname. 31

4.2.1.3.3.2     Grammar 31

4.2.1.3.3.3     Example. 31

4.2.1.3.3.4     Notes. 31

4.2.1.3.4 template_author 31

4.2.1.3.4.1     Keyname. 31

4.2.1.3.4.2     Grammar 31

4.2.1.3.4.3     Example. 31

4.2.1.3.5 template_version. 31

4.2.1.3.5.1     Keyname. 31

4.2.1.3.5.2     Grammar 31

4.2.1.3.5.3     Example. 31

4.2.1.3.5.4     Notes: 32

4.2.1.3.6 description. 32

4.2.1.3.6.1     Keyname. 32

4.2.1.3.7 dsl_definitions. 32

4.2.1.3.7.1     Keyname. 32

4.2.1.3.7.2     Grammar 32

4.2.1.3.7.3     Example. 32

4.2.1.3.8 repositories. 32

4.2.1.3.8.1     Keyname. 32

4.2.1.3.8.2     Grammar 33

4.2.1.3.8.3     Example. 33

4.2.1.3.9 imports. 33

4.2.1.3.9.1     Keyname. 33

4.2.1.3.9.2     Grammar 33

4.2.1.3.9.3     Example. 33

4.2.1.3.10 artifact_types. 33

4.2.1.3.10.1     Keyname. 33

4.2.1.3.10.2     Grammar 33

4.2.1.3.10.3     Example. 34

4.2.1.3.11 data_types. 34

4.2.1.3.11.1     Keyname. 34

4.2.1.3.11.2     Grammar 34

4.2.1.3.11.3     Example. 34

4.2.1.3.12 capability_types. 34

4.2.1.3.12.1     Keyname. 34

4.2.1.3.12.2     Grammar 35

4.2.1.3.12.3     Example. 35

4.2.1.3.13 interface_types. 35

4.2.1.3.13.1     Keyname. 35

4.2.1.3.13.2     Grammar 35

4.2.1.3.13.3     Example. 35

4.2.1.3.14 relationship_types. 35

4.2.1.3.14.1     Keyname. 35

4.2.1.3.14.2     Grammar 36

4.2.1.3.14.3     Example. 36

4.2.1.3.15 node_types. 36

4.2.1.3.15.1     Keyname. 36

4.2.1.3.15.2     Grammar 36

4.2.1.3.15.3     Example. 36

4.2.1.3.15.4     Notes. 36

4.2.1.3.16 group_types. 36

4.2.1.3.16.1     Keyname. 37

4.2.1.3.16.2     Grammar 37

4.2.1.3.16.3     Example. 37

4.2.1.3.17 policy_types. 37

4.2.1.3.17.1     Keyname. 37

4.2.1.3.17.2     Grammar 37

4.2.1.3.17.3     Example. 37

4.2.2 Version and Namespace. 37

4.2.2.1 TOSCA Namespace URI and alias. 37

4.2.2.1.1 TOSCA Namespace prefix. 37

4.2.2.1.2 TOSCA Namespacing in TOSCA Service Templates. 38

4.2.2.1.3 Rules to avoid namespace collisions. 38

4.2.2.1.3.1     Additional Requirements. 38

4.2.2.2 Using Namespaces. 39

4.2.2.2.1 Example – Importing a Service Template and Namespaces. 39

4.2.2.2.1.1     Conceptual Global Namespace URI and Namespace Prefix tracking. 40

4.2.2.2.1.2     Conceptual Global Namespace and Type tracking. 41

4.2.3 Imports and References. 41

4.2.3.1 Import definition. 41

4.2.3.1.1 Keynames. 42

4.2.3.1.2 Grammar 42

4.2.3.1.2.1     Single-line grammar: 42

4.2.3.1.2.2     Multi-line grammar 42

4.2.3.1.2.3     Requirements. 42

4.2.3.1.2.4     Import URI processing requirements. 42

4.2.3.1.3 Example. 43

4.2.3.2 Repository definition. 43

4.2.3.2.1 Keynames. 43

4.2.3.2.2 Grammar 43

4.2.3.2.2.1     Single-line grammar: 43

4.2.3.2.2.2     Multi-line grammar 43

4.2.3.2.3 Example. 44

4.2.4 Additional information definitions. 44

4.2.4.1 Description definition. 44

4.2.4.1.1 Keyname. 44

4.2.4.1.2 Grammar 44

4.2.4.1.3 Examples. 44

4.2.4.1.4 Notes. 45

4.2.4.2 Metadata. 45

4.2.4.2.1 Keyname. 45

4.2.4.2.2 Grammar 45

4.2.4.2.3 Examples. 45

4.2.4.2.4 Notes. 45

4.2.4.3 DSL Definitions. 45

4.2.5 Type definitions. 45

4.2.5.1 General derivation and refinement rules. 46

4.2.5.2 Common keynames in type definitions. 46

4.2.5.2.1 Keynames. 46

4.2.5.2.2 Grammar 46

4.2.5.2.3 Derivation rules. 47

4.2.6 Topology Template definition. 47

4.2.6.1 Keynames. 47

4.2.6.2 Grammar 48

4.2.6.2.1 inputs. 49

4.2.6.2.1.1     Grammar 49

4.2.6.2.1.2     Examples. 49

4.2.6.2.2 node_templates. 49

4.2.6.2.2.1     grammar 49

4.2.6.2.2.2     Example. 50

4.2.6.2.3 relationship_templates. 50

4.2.6.2.3.1     Grammar 50

4.2.6.2.3.2     Example. 50

4.2.6.2.4 outputs. 50

4.2.6.2.4.1     Grammar 50

4.2.6.2.4.2     Example. 50

4.2.6.2.5 groups. 51

4.2.6.2.5.1     Grammar 51

4.2.6.2.5.2     Example. 51

4.2.6.2.6 policies. 51

4.2.6.2.6.1     Grammar 51

4.2.6.2.6.2     Example. 51

4.2.6.2.7 substitution_mapping. 52

4.2.6.2.7.1     requirement_mapping. 52

4.2.6.2.7.2     Example. 52

4.2.6.2.8 Notes. 53

4.3 Nodes and Relationships. 53

4.3.1 Node Type. 53

4.3.1.1 Keynames. 53

4.3.1.2 Grammar 54

4.3.1.3 Derivation rules. 54

4.3.1.4 Additional Requirements. 55

4.3.1.5 Example. 55

4.3.2 Node Template. 55

4.3.2.1 Keynames. 55

4.3.2.2 Grammar 56

4.3.2.3 Additional requirements. 57

4.3.2.4 Example. 57

4.3.3 Relationship Type. 57

4.3.3.1 Keynames. 57

4.3.3.2 Grammar 58

4.3.3.3 Derivation rules. 58

4.3.3.4 Examples. 59

4.3.4 Relationship Template. 59

4.3.4.1 Keynames. 59

4.3.4.2 Grammar 59

4.3.4.3 Additional requirements. 60

4.3.4.4 Example. 60

4.3.5 Capabilities and Requirements. 60

4.3.5.1 Capability Type. 60

4.3.5.1.1 Keynames. 60

4.3.5.1.2 Grammar 61

4.3.5.1.3 Derivation rules. 61

4.3.5.1.4 Example. 61

4.3.5.2 Capability definition. 62

4.3.5.2.1 Keynames. 62

4.3.5.2.2 Grammar 62

4.3.5.2.2.1     Short notation. 62

4.3.5.2.2.2     Extended notation. 63

4.3.5.2.3 Refinement rules. 63

4.3.5.2.4 Examples. 64

4.3.5.2.4.1     Simple notation example. 64

4.3.5.2.4.2     Full notation example. 64

4.3.5.2.5 Additional requirements. 64

4.3.5.3 Capability assignment 64

4.3.5.3.1 Keynames. 64

4.3.5.3.2 Grammar 65

4.3.5.3.3 Example. 65

4.3.5.3.3.1     Notation example. 65

4.3.5.4 Requirement Type. 65

4.3.5.5 Requirement definition. 66

4.3.5.5.1 Keynames. 66

4.3.5.5.1.1     Additional Keynames for multi-line relationship grammar 66

4.3.5.5.2 Grammar 66

4.3.5.5.2.1     Simple grammar (Capability Type only) 67

4.3.5.5.2.2     Extended grammar (with Node and Relationship Types) 67

4.3.5.5.2.3     Extended grammar for declaring Parameter Definitions on the relationship’s Interfaces. 67

4.3.5.5.3 Refinement rules. 68

4.3.5.5.4 Additional requirements. 68

4.3.5.5.5 Notes. 68

4.3.5.5.6 Requirement definition is a tuple with a filter 68

4.3.5.6 Requirement assignment 69

4.3.5.6.1 Keynames. 69

4.3.5.6.2 Grammar 70

4.3.5.6.2.1     Short notation: 70

4.3.5.6.2.2     Extended notation: 70

4.3.5.6.2.3     Extended grammar with Property Assignments and Interface Assignments for the relationship  70

4.3.5.6.3 Examples. 72

4.3.5.6.3.1     Example 1 – Hosting requirement on a Node Type. 72

4.3.5.6.3.2     Example 2 - Requirement with Node Template and a custom Relationship Type. 72

4.3.5.6.3.3     Example 3 - Requirement for a Compute node with additional selection criteria (filter) 72

4.3.5.6.3.4     Example 4 - Requirement assignment for definition with occurrences: [2,2] 73

4.3.5.7 Node Filter definition. 73

4.3.5.7.1 Keynames. 73

4.3.5.7.2 Additional filtering on capability properties. 74

4.3.5.7.3 Grammar 74

4.3.5.7.4 Additional requirements. 74

4.3.5.7.5 Example. 75

4.3.5.8 Property Filter definition. 75

4.3.5.8.1 Grammar 75

4.3.5.8.1.1     Short notation: 75

4.3.5.8.1.2     Extended notation: 75

4.3.5.8.2 Additional Requirements. 75

4.3.6 Interfaces. 76

4.3.6.1 Interface Type. 76

4.3.6.1.1 Keynames. 76

4.3.6.1.2 Grammar 76

4.3.6.1.3 Derivation rules. 76

4.3.6.1.4 Example. 77

4.3.6.1.5 Additional Requirements. 77

4.3.6.2 Interface definition. 77

4.3.6.2.1 Keynames. 77

4.3.6.2.2 Grammar 77

4.3.6.2.3 Refinement rules. 78

4.3.6.3 Interface assignment 78

4.3.6.3.1 Keynames. 78

4.3.6.3.2 Grammar 79

4.3.6.4 Operation definition. 79

4.3.6.4.1 Keynames. 79

4.3.6.4.2 Grammar 80

4.3.6.4.2.1     Short notation. 80

4.3.6.4.2.2     Extended notation. 80

4.3.6.4.3 Refinement rules. 80

4.3.6.4.4 Additional requirements. 81

4.3.6.4.5 Examples. 81

4.3.6.4.5.1     Single-line example. 81

4.3.6.4.5.2     Multi-line example with shorthand implementation definitions. 81

4.3.6.4.5.3     Multi-line example with extended implementation definitions. 81

4.3.6.5 Operation assignment 82

4.3.6.5.1 Keynames. 82

4.3.6.5.2 Grammar 82

4.3.6.5.2.1     Short notation. 82

4.3.6.5.2.2     Extended notation. 82

4.3.6.5.3 Additional requirements. 83

4.3.6.5.4 Examples. 83

4.3.6.6 Notification definition. 83

4.3.6.6.1 Keynames. 84

4.3.6.6.2 Grammar 84

4.3.6.6.2.1     Short notation. 84

4.3.6.6.2.2     Extended notation. 84

4.3.6.6.3 Refinement rules. 85

4.3.6.6.4 Additional requirements. 85

4.3.6.6.5 Examples. 85

4.3.6.7 Notification assignment 85

4.3.6.7.1 Keynames. 85

4.3.6.7.2 Grammar 86

4.3.6.7.2.1     Short notation. 86

4.3.6.7.2.2     Extended notation. 86

4.3.6.7.3 Additional requirements. 86

4.3.6.7.4 Examples. 86

4.3.6.8 Operation and notification implementation definition. 87

4.3.6.8.1 Keynames. 87

4.3.6.8.2 Grammar 87

4.3.6.8.2.1     Short notation for use with single artifact 87

4.3.6.8.2.2     Short notation for use with multiple artifacts. 87

4.3.6.8.2.3     Extended notation for use with single artifact 87

4.3.6.8.2.4     Extended notation for use with multiple artifacts. 88

4.3.7 Artifacts. 88

4.3.7.1 Artifact Type. 88

4.3.7.1.1 Keynames. 88

4.3.7.1.2 Grammar 89

4.3.7.1.3 Derivation rules. 89

4.3.7.1.4 Examples. 89

4.3.7.1.5 Additional Requirements. 89

4.3.7.1.6 Notes. 90

4.3.7.2 Artifact definition. 90

4.3.7.2.1 Keynames. 90

4.3.7.2.2 Grammar 90

4.3.7.2.2.1     Short notation. 91

4.3.7.2.2.2     Extended notation: 91

4.3.7.2.3 Refinement rules. 91

4.3.7.2.4 Examples. 91

4.4 Properties, Attributes, and Parameters. 92

4.4.1 Primitive types. 92

4.4.1.1 Referenced YAML Types. 92

4.4.1.1.1 Notes. 92

4.4.1.2 TOSCA version. 92

4.4.1.2.1 Grammar 93

4.4.1.2.2 Version Comparison. 93

4.4.1.2.3 Examples. 93

4.4.1.2.4 Notes. 93

4.4.1.2.5 Additional Requirements. 94

4.4.1.3 TOSCA range type. 94

4.4.1.3.1 Grammar 94

4.4.1.3.2 Keywords. 94

4.4.1.3.3 Examples. 94

4.4.1.4 TOSCA list type. 94

4.4.1.4.1 Grammar 95

4.4.1.4.1.1     Square bracket notation. 95

4.4.1.4.1.2     Bulleted list notation. 95

4.4.1.4.2 Declaration Examples. 95

4.4.1.4.2.1     List declaration using a simple type. 95

4.4.1.4.2.2     List declaration using a complex type. 95

4.4.1.4.3 Definition Examples. 95

4.4.1.4.3.1     Square bracket notation. 96

4.4.1.4.3.2     Bulleted list notation. 96

4.4.1.5 TOSCA map type. 96

4.4.1.5.1 Grammar 96

4.4.1.5.1.1     Single-line grammar 96

4.4.1.5.1.2     Multi-line grammar 96

4.4.1.5.2 Declaration Examples. 96

4.4.1.5.2.1     Map declaration using a simple type. 96

4.4.1.5.2.2     Map declaration using a complex type. 97

4.4.1.5.3 Definition Examples. 97

4.4.1.5.3.1     Single-line notation. 97

4.4.1.5.3.2     Multi-line notation. 97

4.4.1.6 TOSCA scalar-unit type. 97

4.4.1.6.1 Grammar 97

4.4.1.6.2 Additional requirements. 98

4.4.1.6.3 Concrete Types. 98

4.4.1.6.4 scalar-unit.size. 98

4.4.1.6.4.1     Recognized Units. 98

4.4.1.6.4.2     Examples. 99

4.4.1.6.4.3     Notes. 99

4.4.1.6.5 scalar-unit.time. 99

4.4.1.6.5.1     Recognized Units. 99

4.4.1.6.5.2     Examples. 99

4.4.1.6.5.3     Notes. 99

4.4.1.6.6 scalar-unit.frequency. 100

4.4.1.6.6.1     Recognized Units. 100

4.4.1.6.6.2     Examples. 100

4.4.1.6.6.3     Notes. 100

4.4.1.6.7 scalar-unit.bitrate. 100

4.4.1.6.7.1     Recognized Units. 100

4.4.1.6.7.2     Examples. 101

4.4.1.6.7.3     Notes. 101

4.4.2 Data Type. 101

4.4.2.1 Keynames. 101

4.4.2.2 Grammar 101

4.4.2.3 Derivation rules. 102

4.4.2.4 Additional Requirements. 102

4.4.2.5 Examples. 102

4.4.2.5.1 Defining a complex datatype. 103

4.4.2.5.2 Defining a datatype derived from an existing datatype. 103

4.4.3 Schema definition. 103

4.4.3.1 Keynames. 103

4.4.3.2 Grammar 104

4.4.3.3 Refinement rules. 104

4.4.4 Constraint clause definition. 104

4.4.4.1 Operator keynames. 104

4.4.4.1.1 Comparable value types. 105

4.4.4.2 Schema Constraint purpose. 105

4.4.4.3 Additional Requirements. 106

4.4.4.4 Grammar 106

4.4.4.5 Examples. 106

4.4.5 Property definition. 107

4.4.5.1 Attribute and Property reflection. 107

4.4.5.2 Keynames. 107

4.4.5.3 Status values. 108

4.4.5.4 Grammar 108

4.4.5.5 Refinement rules. 109

4.4.5.6 Additional Requirements. 110

4.4.5.7 Examples. 110

4.4.6 Property assignment 111

4.4.6.1 Keynames. 111

4.4.6.2 Grammar 111

4.4.6.2.1 Short notation: 111

4.4.6.3 Additional Requirements. 111

4.4.7 Attribute definition. 111

4.4.7.1 Attribute and Property reflection. 112

4.4.7.2 Keynames. 112

4.4.7.3 Grammar 112

4.4.7.4 Refinement rules. 113

4.4.7.5 Additional Requirements. 113

4.4.7.6 Notes. 114

4.4.7.7 Example. 114

4.4.8 Attribute assignment 114

4.4.8.1 Keynames. 114

4.4.8.2 Grammar 114

4.4.8.2.1 Short notation: 114

4.4.8.3 Additional requirements. 114

4.4.9 Parameter definition. 114

4.4.9.1 Keynames. 115

4.4.9.2 Grammar 115

4.4.9.3 Refinement rules. 117

4.4.9.4 Additional requirements. 117

4.4.9.5 Example. 117

4.4.10 Parameter value assignment 118

4.4.10.1 Keynames. 118

4.4.10.2 Grammar 118

4.4.10.3 Additional requirements. 118

4.4.11 Parameter mapping assignment 118

4.4.11.1 Keynames. 118

4.4.11.2 Grammar 119

4.4.11.3 Attribute selection format 119

4.4.11.4 Additional requirements. 120

4.5 Substitution. 120

4.5.1 Substitution mapping. 120

4.5.1.1 Keynames. 120

4.5.1.2 Grammar 120

4.5.1.3 Examples. 121

4.5.1.4 Additional requirements. 121

4.5.1.5 Notes. 121

4.5.2 Property mapping. 121

4.5.2.1 Keynames. 121

4.5.2.2 Grammar 121

4.5.2.3 Notes. 122

4.5.2.4 Additional constraints. 122

4.5.3 Attribute mapping. 122

4.5.3.1 Keynames. 122

4.5.3.2 Grammar 122

4.5.4 Capability mapping. 122

4.5.4.1 Keynames. 123

4.5.4.2 Grammar 123

4.5.4.3 Additional requirements. 123

4.5.5 Requirement mapping. 123

4.5.5.1 Keynames. 124

4.5.5.2 Grammar 124

4.5.5.3 Additional requirements. 124

4.5.6 Interface mapping. 124

4.5.6.1 Grammar 125

4.5.6.2 Notes. 125

4.6 Groups and Policies. 125

4.6.1 Group Type. 125

4.6.1.1 Keynames. 125

4.6.1.2 Grammar 125

4.6.1.3 Derivation rules. 126

4.6.1.4 Notes. 126

4.6.1.5 Additional Requirements. 126

4.6.1.6 Example. 126

4.6.2 Group definition. 127

4.6.2.1 Keynames. 127

4.6.2.2 Grammar 127

4.6.2.3 Notes. 128

4.6.2.4 Additional Requirements. 128

4.6.2.5 Example. 128

4.6.3 Policy Type. 128

4.6.3.1 Keynames. 128

4.6.3.2 Grammar 128

4.6.3.3 Derivation rules. 129

4.6.3.4 Example. 129

4.6.4 Policy definition. 129

4.6.4.1 Keynames. 129

4.6.4.2 Grammar 130

4.6.4.3 Example. 130

4.6.5 Trigger definition. 131

4.6.5.1 Keynames. 131

4.6.5.2 Additional keynames for the extended condition notation. 131

4.6.5.3 Grammar 131

4.6.5.3.1 Short notation. 131

4.6.5.3.2 Extended notation: 132

4.6.6 Event Filter definition. 132

4.6.6.1 Keynames. 132

4.6.6.2 Grammar 133

4.6.7 Condition clause definition. 133

4.6.7.1 Keynames. 133

4.6.7.2 Grammar 134

4.6.7.2.1 And clause. 134

4.6.7.2.2 Or clause. 134

4.6.7.2.3 Not clause. 134

4.6.7.3 Direct assertion definition. 134

4.6.7.4 Additional Requirement 134

4.6.7.5 Notes. 134

4.6.7.6 Example. 134

4.6.8 Assertion definition. 136

4.6.8.1 Keynames. 136

4.6.8.2 Grammar 136

4.6.8.3 Example. 136

4.6.9 Activity definitions. 136

4.6.9.1 Delegate workflow activity definition. 137

4.6.9.1.1 Keynames. 137

4.6.9.1.2 Grammar 137

4.6.9.1.2.1     Short notation. 137

4.6.9.1.2.2     Extended notation. 137

4.6.9.2 Set state activity definition. 137

4.6.9.2.1 Keynames. 137

4.6.9.2.2 Grammar 138

4.6.9.3 Call operation activity definition. 138

4.6.9.3.1 Keynames. 138

4.6.9.3.2 Grammar 138

4.6.9.3.2.1     Short notation. 138

4.6.9.3.2.2     Extended notation. 138

4.6.9.4 Inline workflow activity definition. 139

4.6.9.4.1 Keynames. 139

4.6.9.4.2 Grammar 139

4.6.9.4.2.1     Short notation. 139

4.6.9.4.2.2     Extended notation. 139

4.6.9.5 Example. 140

4.7 Workflows. 140

4.7.1 Imperative Workflow definition. 140

4.7.1.1 Keynames. 140

4.7.1.2 Grammar 140

4.7.2 Workflow precondition definition. 141

4.7.2.1 Keynames. 141

4.7.2.2 Grammar 141

4.7.3 Workflow step definition. 142

4.7.3.1 Keynames. 142

4.7.3.2 Grammar 142

4.8 Normative values. 143

4.8.1 Node States. 143

4.8.2 Relationship States. 143

4.8.2.1 Notes. 144

4.8.3 Directives. 144

4.8.4 Network Name aliases. 144

4.8.4.1 Usage. 144

5        TOSCA functions. 145

5.1 Reserved Function Keywords. 145

5.2 Environment Variable Conventions. 145

5.2.1 Reserved Environment Variable Names and Usage. 145

5.2.2 Prefixed vs. Unprefixed TARGET names. 147

5.2.2.1 Notes. 147

5.3 Intrinsic functions. 147

5.3.1 concat 147

5.3.1.1 Grammar 147

5.3.1.2 Parameters. 147

5.3.1.3 Examples. 148

5.3.2 join. 148

5.3.2.1 Grammar 148

5.3.2.2 Parameters. 148

5.3.2.3 Examples. 148

5.3.3 token. 148

5.3.3.1 Grammar 148

5.3.3.2 Parameters. 148

5.3.3.3 Examples. 149

5.4 Property functions. 149

5.4.1 get_input 149

5.4.1.1 Grammar 149

5.4.1.2 Parameters. 149

5.4.1.3 Examples. 150

5.4.2 get_property. 151

5.4.2.1 Grammar 151

5.4.2.2 Parameters. 151

5.4.2.3 Examples. 151

5.5 Attribute functions. 152

5.5.1 get_attribute. 152

5.5.1.1 Grammar 152

5.5.1.2 Parameters. 153

5.5.1.3 Examples: 153

5.5.1.4 Notes. 153

5.6 Operation functions. 153

5.6.1 get_operation_output 153

5.6.1.1 Grammar 153

5.6.1.2 Parameters. 154

5.6.1.3 Notes. 154

5.7 Navigation functions. 154

5.7.1 get_nodes_of_type. 154

5.7.1.1 Grammar 154

5.7.1.2 Parameters. 154

5.7.1.3 Returns. 154

5.8 Artifact functions. 155

5.8.1 get_artifact 155

5.8.1.1 Grammar 155

5.8.1.2 Parameters. 155

5.8.1.3 Examples. 155

5.8.1.3.1 Example: Retrieving artifact without specified location. 155

5.8.1.3.2 Example: Retrieving artifact as a local path. 156

5.8.1.3.3 Example: Retrieving artifact in a specified location. 156

5.9 Context-based Entity names (global) 157

5.9.1.1 Goals. 157

6        TOSCA Cloud Service Archive (CSAR) format 158

6.1 Overall Structure of a CSAR. 158

6.2 TOSCA Meta File. 158

6.2.1 Custom keynames in the TOSCA.meta file. 159

6.2.2 Example. 159

6.3 Archive without TOSCA-Metadata. 159

6.3.1 Example. 159

7        Security Considerations. 161

8        Conformance. 162

8.1 Conformance Targets. 162

8.2 Conformance Clause 1: TOSCA YAML service template. 162

8.3 Conformance Clause 2: TOSCA processor 162

8.4 Conformance Clause 3: TOSCA orchestrator 162

8.5 Conformance Clause 4: TOSCA generator 163

8.6 Conformance Clause 5: TOSCA archive. 163

Appendix A. Acknowledgments. 164

Appendix B. Example Title. 165

B.1 Subsidiary section. 165

B.1.1 Sub-subsidiary section. 165

B.1.1.1 Sub-sub-subsidiary section. 165

B.1.1.1.1 Sub-sub-sub-subsidiary section. 165

Appendix C. Revision History. 166

 

 


1      Introduction

[All text is normative unless otherwise labeled]

1.1 IPR Policy

This specification is provided under the RF on Limited Terms Mode of the OASIS IPR Policy, the mode chosen when the Technical Committee was established. For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the TC’s web page (https://www.oasis-open.org/committees/tosca/ipr.php).

1.2 Terminology

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] and [RFC8174] when, and only when, they appear in all capitals, as shown here.

1.3 Normative References

[RFC2119]               Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, <http://www.rfc-editor.org/info/rfc2119>.

[RFC8174]               Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, <http://www.rfc-editor.org/info/rfc8174>.

[YAML-1.2]              YAML, Version 1.2, 3rd Edition, Patched at 2009-10-01, Oren Ben-Kiki, Clark Evans, Ingy döt Net http://www.yaml.org/spec/1.2/spec.html

[YAML-TS-1.1]         Timestamp Language-Independent Type for YAML Version 1.1, Working Draft 2005-01-18, http://yaml.org/type/timestamp.html

[ISO-IEC-21320-1]    ISO/IEC 21320-1 "Document Container File — Part 1: Core", https://www.iso.org/standard/60101.html

 

1.4 Non-Normative References

[Apache]                 Apache Server, https://httpd.apache.org/

[Chef]                     Chef, https://wiki.opscode.com/display/chef/Home

[NodeJS]                Node.js, https://nodejs.org/

[Puppet]                 Puppet, http://puppetlabs.com/

[WordPress]            WordPress, https://wordpress.org/

[Maven-Version]      Apache Maven version policy draft: https://cwiki.apache.org/confluence/display/MAVEN/Version+number+policy

[JSON-Spec]           The JSON Data Interchange Format (ECMA and IETF versions):

·         http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf

·         https://tools.ietf.org/html/rfc7158

[JSON-Schema]      JSON Schema specification:

·         http://json-schema.org/documentation.html

[XMLSpec]              XML Specification, W3C Recommendation, February 1998, http://www.w3.org/TR/1998/REC-xml-19980210

[XML Schema Part 1]     XML Schema Part 1: Structures, W3C Recommendation, October 2004, http://www.w3.org/TR/xmlschema-1/

[XML Schema Part 2]     XML Schema Part 2: Datatypes, W3C Recommendation, October 2004, http://www.w3.org/TR/xmlschema-2/

[IANA register for Hash Function Textual Names]            https://www.iana.org/assignments/hash-function-text-names/hash-function-text-names.xhtml

[Jinja2]                    Jinja2, jinja.pocoo.org/

[Twig]                     Twig, https://twig.symfony.com

 

2      Overview

2.1 Objective

Cloud computing can become more valuable if the creation and lifecycle management of application, infrastructure, and network services can be fully automated and supported across a variety of deployment environments. The core TOSCA specification provides a language for describing service components and their relationships using a service topology, and it provides for specifying the lifecycle management procedures that allow for creation or modification of services using orchestration processes. The combination of topology and orchestration in a Service Template describes what is needed in different environments to enable automated deployment of services and their management throughout the complete service lifecycle (e.g. scaling, patching, monitoring, etc.).

2.2 Application Domains

TOSCA can be used to specify automated lifecycle management of the following:

·         Infrastructure-as-a-Service Clouds: automate the deployment and management of workloads in IaaS clouds such as OpenStack, Amazon Web Services, Microsoft Azure, and others.

·         Cloud-native applications: deploy containerized applications and micro-services, for example by interfacing to orchestration platforms such as Kubernetes.

·         Network Functions Virtualization: define the management of Virtual Network Functions and their composition into complex network services.

·         Software Defined Networking: support on-demand creation of network services (for example SD-WAN).

·         Functions-as-a-Service: define abstract software applications without any deployment or operational considerations.

·         IoT and Edge computing: deploy services at the network edge with the goal of minimizing latency.

·         Process automation: support open and interoperable process control architectures.

This list is by no means intended to be exhaustive and only serves to demonstrate the breadth of application domains that can benefit from TOSCA’s automated lifecycle management capabilities.

2.3 Implementations

Different kinds of processors and artifacts qualify as implementations of TOSCA. Those that this specification is explicitly mentioning or referring to fall into the following categories:

·         TOSCA YAML service template (or “service template”): A YAML document artifact containing a (TOSCA) topology template (see sections 3.9 “Service template definition”) that represents a Cloud application. (see sections 3.8 “Topology template definition”)

·         TOSCA processor (or “processor”): An engine or tool that is capable of parsing and interpreting a TOSCA service template for a particular purpose. For example, the purpose could be validation, translation or visual rendering.

·         TOSCA orchestrator (also called orchestration engine): A TOSCA processor that interprets a TOSCA service template or a TOSCA CSAR in order to instantiate, deploy, and manage the described application in a Cloud.

·         TOSCA translator: A tool that translates TOSCA service templates into documents that use another language, such as Kubernetes Helm charts or Amazon CloudFormation templates.

·         TOSCA template generator: A tool that generates a TOSCA service template. An example of generator is a modeling tool capable of generating or editing a TOSCA service template (often such a tool would also be a TOSCA processor).

·         TOSCA archive (or TOSCA Cloud Service Archive, or “CSAR”): a package artifact that contains a TOSCA service template and other artifacts usable by a TOSCA orchestrator to deploy an application.

The above list is not exclusive. The above definitions should be understood as referring to and implementing TOSCA as described in this document.

2.4 Glossary

The following terms are used throughout this specification and have the following definitions when used in context of this document.

Term

Definition

Instance Model

A deployed service is a running instance of a Service Template. More precisely, the instance is derived by instantiating the Topology Template of its Service Template, most often by running a declarative workflow that is automatically generated based on the node templates and relationship templates defined in the Topology Template.

Node Template

A Node Template specifies the occurrence of a component node as part of a Topology Template. Each Node Template refers to a Node Type that defines the semantics of the node (e.g., properties, attributes, requirements, capabilities, interfaces). Node Types are defined separately for reuse purposes.

Relationship Template

A Relationship Template specifies the occurrence of a relationship between nodes in a Topology Template. Each Relationship Template refers to a Relationship Type that defines the semantics relationship (e.g., properties, attributes, interfaces, etc.). Relationship Types are defined separately for reuse purposes.

Service Template

A Service Template is typically used to specify the “topology” (or structure) and “orchestration” (or invocation of management behavior) of IT services so that they can be provisioned and managed in accordance with constraints and policies.

Specifically, TOSCA Service Templates optionally allow definitions of a TOSCA Topology Template, TOSCA types (e.g., Node, Relationship, Capability, Artifact, etc.), groupings, policies and constraints along with any input or output declarations.

Topology Model

The term Topology Model is often used synonymously with the term Topology Template with the use of “model” being prevalent when considering a Service Template’s topology definition as an abstract representation of an application or service to facilitate understanding of its functional components and by eliminating unnecessary details.

Topology Template

A Topology Template defines the structure of a service in the context of a Service Template. A Topology Template consists of a set of Node Template and Relationship Template definitions that together define the topology model of a service as a (not necessarily connected) directed graph.The term Topology Template is often used synonymously with the term Topology Model.  The distinction is that a topology template can be used to instantiate and orchestrate the model as a reusable pattern and includes all details necessary to accomplish it.

Abstract Node Template

An abstract node template is a node template that doesn’t define any implementations for the TOSCA lifecycle management operations. Service designers explicitly mark node templates as abstract using the substitute directive. TOSCA orchestrators provide implementations for abstract node templates by finding substituting templates for those node templates.

3      TOSCA core concepts

The TOSCA language introduces a YAML-based grammar for creating service templates that define the lifecycle management of application, infrastructure, and network services. The language defines a metamodel for specifying both the structure of a service as well as its management aspects. Within a service template, a Topology Template defines the structure of a service. Interfaces, Operations, and Workflows define how service elements can be created and terminated as well as how they can be managed during their whole lifetimes. Policies specify operational behavior of the service such as quality-of-service objectives, performance objectives, and security constraints, and allow for closed-loop automation. The major elements defining a service are depicted in Figure 1.

3.1 Topology Templates, Node Templates, and Relationships

Within a Service Template, a Topology Template defines the topology model of a service as a directed graph. Each node in this graph is represented by a Node Template. A Node Template specifies the presence of an entity of a specific Node Type as a component of a service. A Node Type defines the properties of such a component (via Node Type Properties) and the operations (via Interfaces) available to manipulate the component. Node Types are defined separately for reuse purposes. In a Topology template a Node Template assigns values to the properties defined in the Node Type.

Figure 1: Structural Elements of a Service Template and their Relations

For example, consider a service that consists of an application server, a process engine, and a process model. A Topology Template defining that service would include one Node Template of Node Type “application server”, another Node Template of Node Type “process engine”, and a third Node Template of Node Type “process model”. The application server Node Type defines properties like the IP address of an instance of this type, an operation for installing the application server with the corresponding IP address, and an operation for shutting down an instance of this application server. A constraint in the Node Template can specify a range of IP addresses available when making a concrete application server available.

Node templates may include one or more relationships to other node templates in the Topology Template. Relationships represent the edges in the service topology graph. The node template that includes the relationship definition is implicitly defined as the source node of the relationship and the target node is explicitly specified as part of the relationship definition.  Each relationship definition refers to a Relationship Type that defines the semantics and any properties of the relationship. Relationship Types are defined separately for reuse purposes.

In the example above, a relationship can be established from the process engine Node Template to the application server Node Template with the meaning “hosted by”, and from the process model Node Template to the process engine Node Template with meaning “deployed on”.

3.2 Interfaces, Operations, and Artifacts

Both node and relationship types may define lifecycle operations that implement the behavior an orchestration engine can invoke when instantiating a service template. For example, a node type for some software product might provide a ‘create’ operation to handle the creation of an instance of a component at runtime, or a ‘start’ or ‘stop’ operation to handle a start or stop event triggered by an orchestration engine.

Operations that are related to the same management mission (e.g. lifecycle management) are grouped together in Interfaces that are defined by node and relationship types. Just like other TOSCA entities, interfaces refer to their corresponding Interface Type that defines the group of operations that are part of the interface. Interface Types can also define notifications that represent external events that are generated by the outside world and received by the orchestrator.

The implementations of interface operations can be provided as TOSCA artifacts. An artifact represents the content needed to provide an implementation for an interface operation. A TOSCA artifact could be an executable (e.g. a script, an executable program, an image), a configuration file or data file, or something that might be needed so that another executable can run (e.g. a library). Artifacts can be of different types, for example EJBs or python scripts. The content of an artifact depends on its type. Typically, descriptive metadata (such as properties) will also be provided along with the artifact. This metadata might be needed to properly process the artifact, for example by describing the appropriate execution environment.

3.3 Workflows

A deployed service is an instance of a Service Template. More precisely, the instance is created by instantiating the Topology Template of its Service Template by running workflows that are most often automatically created by the orchestrator and that invoke the interface operations of the Node Types or the Node Templates. Orchestrators can automatically generate workflows by using the relationship between components to derive the order of component instantiation. For example, during the instantiation of a two-tier application that includes a web application that depends on a database, an orchestration engine would first invoke the ‘create’ operation on the database component to install and configure the database, and it would then invoke the ‘create’ operation of the web application to install and configure the application (which includes configuration of the database connection).

Interface operations invoked by workflows must use actual values for the various properties of the various Node Templates and Relationship Templates of the Topology Template. These values can come from input passed in by users as triggered by human interactions with the orchestrator or the templates can specify default values for some properties. For example, the application server Node Template will be instantiated by installing an actual application server at a concrete IP address considering the specified range of IP addresses. Next, the process engine Node Template will be instantiated by installing a concrete process engine on that application server (as indicated by the “hosted by” relationship template). Finally, the process model Node Template will be instantiated by deploying the process model on that process engine (as indicated by the “deployed on” relationship template).

3.4 Requirements and Capabilities

We discussed earlier how relationships are used to link node templates together into a service topology graph. However, it may not always be possible to define all node templates for a given service topology within a single service template. For example, modular design practices may dictate that different service subcomponents be modeled using separate service templates. This may result in relationships that need to be established across multiple service templates. Additionally, relationships may need to target components that already exists and do not need to be instantiated by an orchestrator. For example, relationships may reference physical resources that are managed in a resource inventory. Service topology templates may not include node templates for these resources.

TOSCA accommodates these scenarios using requirements and capabilities of node templates. A requirement expresses that one component depends on (requires) a feature provided by another component, or that a component has certain requirements against the hosting environment such as for the allocation of certain resources or the enablement of a specific mode of operation. Capabilities represent features exposed by components that can be used to fulfill requirements of other components.

Relationships are the result of fulfilling a requirement in one node template using a capability of a different node template. If both source and target node templates are defined in the same service template, service designers typically define the relationship between these node templates explicitly. Requirements that do not explicitly specify a target node must be fulfilled by the orchestrator at service deployment time. Orchestrators can take multiple service templates into account when fulfilling requirements, or they can attempt to use resources managed in an inventory, which will result in relationships that are established across service template boundaries.

Requirements and capabilities are modeled by annotating Node Types with Requirement Definitions and Capability Definitions. Capability Types are defined as reusable entities so that those definitions can be used in the context of several Node Types. Requirement definitions can specify the relationship type that will be used when creating the relationship that fulfills the requirement.

Figure 2: Requirements and Capabilities

 

Node Templates which have corresponding Node Types with Requirement Definitions or Capability Definitions will include representations of the respective Requirements and Capabilities with content specific to the respective Node Template..

Requirements can be matched in two ways as briefly indicated above: (1) requirements of a Node Template can be matched by capabilities of another Node Template in the same Service Template by connecting the respective requirement-capability-pairs via relationships; (2) requirements of a Node Template can be matched by the orchestrator, for example by allocating needed resources for a Node Template during instantiation.

3.5 Decomposition of Service Templates

TOSCA provides support for decomposing service components using the Substitution Mapping feature. For example, a Service Template for a business application that is hosted on an application server tier might focus on defining the structure and manageability behavior of the business application itself. The structure of the application server tier hosting the application can be provided in a separate Service Template built by another vendor specialized in deploying and managing application servers. This approach enables separation of concerns and re-use of common infrastructure templates.

Figure 3: Service Template Decomposition

From the point of view of a Service Template (e.g. the business application Service Template from the example above) that uses another Service Template, the other Service Template (e.g. the application server tier) “looks” like just a Node Template. During deployment, however, this Node Template can be substituted by the second Service Template if it exposes the same external façade (i.e. properties, capabilities, etc.) as the Node Template. Thus, a substitution with any Service Template that has the same facade as a certain Node Template in one Service Template becomes possible, allowing for a flexible composition of different Service Templates. This concept also allows for providing substitutable alternatives in the form of Service Templates. For example, a Service Template for a single node application server tier and a Service Template for a clustered application server tier might exist, and the appropriate option can be selected per deployment.

3.6 Policies in TOSCA

Non-functional behavior or quality-of-services are defined in TOSCA by means of policies. A Policy can express such diverse things like monitoring behavior, payment conditions, scalability, or continuous availability, for example.

A Node Template can be associated with a set of Policies collectively expressing the non-functional behavior or quality-of-services that each instance of the Node Template will expose. Each Policy specifies the actual properties of the non-functional behavior, like the concrete payment information (payment period, currency, amount etc.) about the individual instances of the Node Template.

These properties are defined by a Policy Type. Policy Types might be defined in hierarchies to properly reflect the structure of non-functional behavior or quality-of-services in particular domains. Furthermore, a Policy Type might be associated with a set of Node Types the non-functional behavior or quality-of-service it describes.

Policy Templates provide actual values of properties of the types defined by Policy Types. For example, a Policy Template for monthly payments for US customers will set the “payment period” property to “monthly” and the “currency” property to “US$”, leaving the “amount” property open. The “amount” property will be set when the corresponding Policy Template is used for a Policy within a Node Template. Thus, a Policy Template defines the invariant properties of a Policy, while the Policy sets the variant properties resulting from the actual usage of a Policy Template in a Node Template.

3.7 Archive Format for Cloud Applications

In order to support in a certain environment the execution and management of the lifecycle of a cloud application, all corresponding artifacts have to be available in that environment. This means that beside the service template of the cloud application, the deployment artifacts and implementation artifacts have to be available in that environment. To ease the task of ensuring the availability of all of these, this specification defines a corresponding archive format called CSAR (Cloud Service ARchive).

A CSAR is a container file, i.e. it contains multiple files of possibly different file types. These files are typically organized in several subdirectories, each of which contains related files (and possibly other subdirectories etc). The organization into subdirectories and their content is specific for a particular cloud application. CSARs are zip files, typically compressed.

Each CSAR MUST contain a file called TOSCA.meta (either in the top-level directory of the archive or in a subdirectory called TOSCA-Metadata). The TOSCA meta file contains metadata of the other files in the CSAR.

4      TOSCA definitions in YAML

Except for the examples, this section is normative and describes all of the YAML grammar, definitions and block structure for all keys and mappings that are defined for the TOSCA Version 2.0 specification that are needed to describe a TOSCA Service Template (in YAML).

4.1 TOSCA Metamodel

This section defines the models and the modeling goals that comprise the TOSCA Version 2.0 specification.

4.1.1 Modeling concepts and goals

TBD. Here we should have selected core concepts of TOSCA 1.0 from section “3        Core Concepts and Usage Pattern” and this section should be a more in-depth section than section 2.1 in this document.

 

4.1.2 Modeling definitions and reuse

The TOSCA metamodel includes complex definitions used in types and templates. Reuse concepts simplify the design of TOSCA templates by allowing relevant TOSCA entities to use and/or modify definitions already specified during entity type design. The following four concepts are clarified next:

·         Definition:

·         The TOSCA specification is based on defining modeling entities.

·         Entity definitions are based on different sets of keynames (with specific syntax and semantics) that are associated with values (of a specific format).

·         Derivation:

·         Specific TOSCA entities support a type definition.

·         When defining a type, it can be derived from a parent type.

·         The derivation rules describe what (keyname) definitions are inherited from the parent type and further if and how they can be expanded or modified.

·         Refinement:

·         Definitions within a type definition consist of the definition of keynames and other TOSCA entities (e.g. properties, requirements, capabilities, etc.).

·         The refinement rules pertaining to an entity describe how such entity definitions that are inherited from the parent type during a type derivation can be expanded or modified.

·         Assignment:

·         When creating a topology template, we specify several entities that are part of the template (e.g. nodes, relationships, groups, etc.).

·         When adding such an entity in the topology template, for some definitions that appear in the corresponding entity type (e.g. properties, operations, requirements, etc.) we may (or must) assign a certain specification (or value).

4.1.3 Goal of the derivation and refinement rules

The main reason for derivation and refinement rules is to create a framework useful for a consistent TOSCA type profile creation. The intuitive idea is that a derived type follows to a large extent the structure and behavior of a parent type, otherwise it would be better to define a new "not derived" type.

The guideline regarding the derivation rules is that a node of a derived type should be usable instead of a node of the parent type during the selection and substitution mechanisms. These two mechanisms are used by TOSCA templates to connect to TOSCA nodes and services defined by other TOSCA templates:

·         The selection mechanism allows a node instance created a-priori by another service template to be selected for usage (i.e. building relationships) to the current TOSCA template.

·         The substitution mechanism allows a node instance to be represented by a service created simultaneously via a substitution template.

It is relevant to emphasize the cross-template usage, as only in this case we deal with templates defined at different design time-points, with potentially different editing and maintenance restrictions.

4.1.4 Required Keynames

The TOSCA metamodel includes complex definitions used in types (e.g., Node Types, Relationship Types, Capability Types, Data Types, etc.) and templates (e.g. Service Template, Topology Template, Node Template, etc.) each of which include their own list of reserved keynames that are sometimes marked as required. If a keyname is marked as required it MUST be defined in that particular definition context. Note that in the context of type definitions, types may be used to derive other types, and keyname definitions MAY be inherited from parent types (according to the derivation rules of that type entity). If a keyname definition is inherited, the derived type does not have to provide such definition.

4.2 TOSCA Service

A TOSCA Service is specified by a TOSCA Service Template.

4.2.1 Service Template definition

A TOSCA Service Template (YAML) document contains element definitions of building blocks for cloud application, or complete models of cloud applications. This section describes the top-level structural elements (TOSCA keynames) along with their grammars, which are allowed to appear in a TOSCA Service Template document.

4.2.1.1 Keynames

The following is the list of recognized keynames for a TOSCA Service Template definition:

Keyname

Required

Type

Description

tosca_definitions_version

yes

string

Defines the version of the TOSCA specification the template (grammar) complies with.

namespace

no

URI

The default (target) namespace for all unqualified Types defined within the Service Template.

 

metadata

no

map of string

Defines a section used to declare additional metadata information.  Domain-specific TOSCA profile specifications may define keynames that are required for their implementations.

description

no

string

Declares a description for this Service Template and its contents.

dsl_definitions

no

N/A

Declares optional DSL-specific definitions and conventions.  For example, in YAML, this allows defining reusable YAML macros (i.e., YAML alias anchors) for use throughout the TOSCA Service Template.

repositories

no

map of

Repository definitions

Declares the map of external repositories which contain artifacts that are referenced in the service template along with their addresses used to connect to them in order to retrieve the artifacts.

imports

no

list of

Import Definitions

Declares a list import statements pointing to external TOSCA Definitions documents. For example, these may be file location or URIs relative to the service template file within the same TOSCA CSAR file.

artifact_types

no

map of

Artifact Types

This section contains an optional map of artifact type definitions for use in the service template

data_types

no

map of

Data Types

Declares a map of optional TOSCA Data Type definitions.

capability_types

no

map of

Capability Types

This section contains an optional map of capability type definitions for use in the service template.

interface_types

no

map of

Interface Types

This section contains an optional map of interface type definitions for use in the service template.

relationship_types

no

map of

Relationship Types

This section contains a map of relationship type definitions for use in the service template.

node_types

no

map of

Node Types

This section contains a map of node type definitions for use in the service template.

group_types

no

map of

Group Types

This section contains a map of group type definitions for use in the service template.

policy_types

no

list of

Policy Types

This section contains a list of policy type definitions for use in the service template.

topology_template

no

Topology Template definition

Defines the topology template of an application or service, consisting of node templates that represent the application’s or service’s components, as well as relationship templates representing relations between the components.

4.2.1.1.1 Metadata keynames

The following is the list of recognized metadata keynames for a TOSCA Service Template definition:

Keyname

Required

Type

Description

template_name

no

string

Declares a descriptive name for the template. 

template_author

no

string

Declares the author(s) or owner of the template.

template_version

no

string

Declares the version string for the template.

4.2.1.2 Grammar

The overall structure of a TOSCA Service Template and its top-level key collations using TOSCA is shown below:

# Required TOSCA Definitions version string

tosca_definitions_version: <value>  # Required, see section 3.1 for usage

namespace: <URI>                    # Optional, see section 3.2 for usage

 

# Optional metadata keyname: value pairs

metadata:

  template_name: <value>            # Optional, name of this service template

  template_author: <value>          # Optional, author of this service template

  template_version: <value>         # Optional, version of this service template

  #  More optional entries of domain or profile specific metadata keynames

 

# Optional description of the definitions inside the file.

description: <template_type_description>

 

dsl_definitions:

  # map of YAML alias anchors (or macros)

 

repositories:

  # map of external repository definitions which host TOSCA artifacts

 

imports:

  # ordered list of import definitions

 

artifact_types:

  # map of artifact type definitions

 

data_types:

  # map of datatype definitions

 

capability_types:

  # map of capability type definitions

 

interface_types

  # map of interface type definitions

 

relationship_types:

  # map of relationship type definitions

 

node_types:

  # map of node type definitions

 

group_types:

  # map of group type definitions

 

policy_types:

  # map of policy type definitions

 

topology_template:

  # topology template definition of the cloud application or service

4.2.1.2.1 Requirements

·         The URI value “http://docs.oasis-open.org/tosca”, as well as all (path) extensions to it, SHALL be reserved for TOSCA approved specifications and work.  That means Service Templates that do not originate from a TOSCA approved work product MUST NOT use it, in any form, when declaring a (default) Namespace.

·         The key “tosca_definitions_version” SHOULD be the first line of each Service Template.

4.2.1.2.2 Notes

·         TOSCA Service Templates do not have to contain a topology_template and MAY contain simply type definitions (e.g., Artifact, Interface, Capability, Node, Relationship Types, etc.) and be imported for use as type definitions in other TOSCA Service Templates.

4.2.1.3 Top-level keyname definitions

4.2.1.3.1 tosca_definitions_version

This required element provides a means to include a reference to the TOSCA specification within the TOSCA Definitions YAML file.  It is an indicator for the version of the TOSCA grammar that should be used to parse the remainder of the document.

4.2.1.3.1.1     Keyname

tosca_definitions_version

4.2.1.3.1.2     Grammar

Single-line form:

tosca_definitions_version: <tosca_simple_profile_version>

4.2.1.3.1.3     Examples:

TOSCA Version 2.0 specification using the defined namespace alias (see Section 4.2.2.1 TOSCA Namespace URI and alias):

tosca_definitions_version: tosca_2_0

TOSCA Version 2.0 specification using the fully defined (target) namespace (see Section 4.2.2.1 TOSCA Namespace URI and alias):

tosca_definitions_version: http://docs.oasis-open.org/tosca/ns/2.0

4.2.1.3.2 metadata

This keyname is used to associate domain-specific metadata with the Service Template.  The metadata keyname allows a declaration of a map of keynames with string values.

4.2.1.3.2.1     Keyname

metadata

4.2.1.3.2.2     Grammar

metadata:

  <map_of_string_values>

4.2.1.3.2.3     Example

metadata:

  creation_date: 2015-04-14

  date_updated: 2015-05-01

  status: developmental 

4.2.1.3.3 template_name

This optional metadata keyname can be used to declare the name of service template as a single-line string value.

4.2.1.3.3.1     Keyname

template_name

4.2.1.3.3.2     Grammar

template_name: <name string>

4.2.1.3.3.3     Example

template_name: My service template

4.2.1.3.3.4     Notes

·         Some service templates are designed to be referenced and reused by other service templates.  Therefore, in these cases, the template_name value SHOULD be designed to be used as a unique identifier through the use of namespacing techniques. 

4.2.1.3.4 template_author

This optional metadata keyname can be used to declare the author(s) of the service template as a single-line string value.

4.2.1.3.4.1     Keyname

template_author

4.2.1.3.4.2     Grammar

template_author: <author string>

4.2.1.3.4.3     Example

template_author: My service template

4.2.1.3.5 template_version

This optional metadata keyname can be used to declare a domain specific version of the service template as a single-line string value.

4.2.1.3.5.1     Keyname

template_version

4.2.1.3.5.2     Grammar

template_version: <version>

4.2.1.3.5.3     Example

template_version: 2.0.17

4.2.1.3.5.4     Notes:

·         Some service templates are designed to be referenced and reused by other service templates and have a lifecycle of their own.  Therefore, in these cases, a template_version value SHOULD be included and used in conjunction with a unique template_name value to enable lifecycle management of the service template and its contents. 

4.2.1.3.6 description

This optional keyname provides a means to include single or multiline descriptions within a TOSCA template as a scalar string value.

4.2.1.3.6.1     Keyname

description

4.2.1.3.7 dsl_definitions

This optional keyname provides a section to define macros (e.g., YAML-style macros when using the TOSCA specification).

4.2.1.3.7.1     Keyname

dsl_definitions

4.2.1.3.7.2     Grammar

dsl_definitions:

   <dsl_definition_1>

   ...

   <dsl_definition_n>

4.2.1.3.7.3     Example

dsl_definitions:

    ubuntu_image_props: &ubuntu_image_props

      architecture: x86_64

      type: linux

      distribution: ubuntu

      os_version: 14.04

 

    redhat_image_props: &redhat_image_props

      architecture: x86_64

      type: linux

      distribution: rhel

      os_version: 6.6

4.2.1.3.8 repositories

This optional keyname provides a section to define external repositories which may contain artifacts or other TOSCA Service Templates which might be referenced or imported by the TOSCA Service Template definition.

4.2.1.3.8.1     Keyname

repositories

4.2.1.3.8.2     Grammar

repositories:

   <repository_definition_1>

   ...

   <repository_definition_n>

4.2.1.3.8.3     Example

repositories:

  my_project_artifact_repo:

    description: development repository for TAR archives and Bash scripts

    url: http://mycompany.com/repository/myproject/

4.2.1.3.9 imports

This optional keyname provides a way to import a block sequence of one or more TOSCA Definitions documents.  TOSCA Definitions documents can contain reusable TOSCA type definitions (e.g., Node Types, Relationship Types, Artifact Types, etc.) defined by other authors.  This mechanism provides an effective way for companies and organizations to define normative types and/or describe their software applications for reuse in other TOSCA Service Templates.

4.2.1.3.9.1     Keyname

imports

4.2.1.3.9.2     Grammar

imports:

   - <import_definition_1>

   - ...

   - <import_definition_n>

4.2.1.3.9.3     Example

# An example import of definitions files from a location relative to the

# file location of the service template declaring the import.

imports:

  - some_definitions: relative_path/my_defns/my_typesdefs_1.yaml

  - file: my_defns/my_typesdefs_n.yaml   

    repository: my_company_repo

    namespace_prefix: mycompany

4.2.1.3.10 artifact_types

This optional keyname lists the Artifact Types that are defined by this Service Template.

4.2.1.3.10.1   Keyname

artifact_types

4.2.1.3.10.2   Grammar

artifact_types:

  <artifact_type_defn_1>

  ...

  <artifact type_defn_n>

4.2.1.3.10.3   Example

artifact_types:

  mycompany.artifacttypes.myFileType:

    derived_from: tosca.artifacts.File

4.2.1.3.11 data_types

This optional keyname provides a section to define new data types in TOSCA.

4.2.1.3.11.1   Keyname

data_types

4.2.1.3.11.2   Grammar

data_types:

   <tosca_datatype_def_1>

   ...

   <tosca_datatype_def_n>

4.2.1.3.11.3   Example

data_types:

  # A complex datatype definition

  simple_contactinfo_type:

    properties:

      name:

        type: string

      email:

        type: string

      phone:

        type: string

 

  # datatype definition derived from an existing type

  full_contact_info:

    derived_from: simple_contact_info

    properties:

      street_address:

        type: string

      city:

        type: string

      state:

        type: string

      postalcode:

        type: string

4.2.1.3.12 capability_types

This optional keyname lists the Capability Types that provide the reusable type definitions that can be used to describe features Node Templates or Node Types can declare they support.

4.2.1.3.12.1   Keyname

capability_types

4.2.1.3.12.2   Grammar

capability_types:

  <capability_type_defn_1>

  ...

  <capability type_defn_n>

4.2.1.3.12.3   Example

capability_types:

  mycompany.mytypes.myCustomEndpoint:

    derived_from: tosca.capabilities.Endpoint

    properties:

      # more details ...

 

  mycompany.mytypes.myCustomFeature:

    derived_from: tosca.capabilities.Feature

    properties:

      # more details ...

4.2.1.3.13 interface_types

This optional keyname lists the Interface Types that provide the reusable type definitions that can be used to describe operations for on TOSCA entities such as Relationship Types and Node Types.

4.2.1.3.13.1   Keyname

interface_types

4.2.1.3.13.2   Grammar

interface_types:

  <interface_type_defn_1>

  ...

  <interface type_defn_n>

4.2.1.3.13.3   Example

interface_types:

  mycompany.interfaces.service.Signal:

    signal_begin_receive:

      description: Operation to signal start of some message processing.

    signal_end_receive:

      description: Operation to signal end of some message processed.

4.2.1.3.14 relationship_types

This optional keyname lists the Relationship Types that provide the reusable type definitions that can be used to describe dependent relationships between Node Templates or Node Types.

4.2.1.3.14.1   Keyname

relationship_types

4.2.1.3.14.2   Grammar

relationship_types:

  <relationship_type_defn_1>

  ...

  <relationship type_defn_n>

4.2.1.3.14.3   Example

relationship_types:

  mycompany.mytypes.myCustomClientServerType:

    derived_from: tosca.relationships.HostedOn

    properties:

      # more details ...

  mycompany.mytypes.myCustomConnectionType:

    derived_from: tosca.relationships.ConnectsTo

    properties:

      # more details ...

4.2.1.3.15 node_types

This optional keyname lists the Node Types that provide the reusable type definitions for software components that Node Templates can be based upon.

4.2.1.3.15.1   Keyname

node_types

4.2.1.3.15.2   Grammar

node_types:

  <node_type_defn_1>

  ...

  <node_type_defn_n>

4.2.1.3.15.3   Example

node_types:

  my_webapp_node_type:

    derived_from: WebApplication

    properties:

      my_port:

        type: integer

 

  my_database_node_type:

    derived_from: Database

    capabilities:

      mytypes.myfeatures.transactSQL

4.2.1.3.15.4   Notes

·         The node types that are part of the node_types block can be mapped to the NodeType definitions as described by the TOSCA v1.0 specification. 

4.2.1.3.16 group_types

This optional keyname lists the Group Types that are defined by this Service Template.

4.2.1.3.16.1   Keyname

group_types

4.2.1.3.16.2   Grammar

group_types:

  <group_type_defn_1>

  ...

  <group type_defn_n>

4.2.1.3.16.3   Example

group_types:

  mycompany.mytypes.myScalingGroup:

    derived_from: tosca.groups.Root

4.2.1.3.17 policy_types

This optional keyname lists the Policy Types that are defined by this Service Template.

4.2.1.3.17.1   Keyname

policy_types

4.2.1.3.17.2   Grammar

policy_types:

  <policy_type_defn_1>

  ...

  <policy type_defn_n>

4.2.1.3.17.3   Example

policy_types:

  mycompany.mytypes.myScalingPolicy:

    derived_from: tosca.policies.Scaling

4.2.2 Version and Namespace

4.2.2.1 TOSCA Namespace URI and alias

The following TOSCA Namespace URI alias and TOSCA Namespace Alias are reserved values which SHALL be used when identifying the TOSCA Version 2.0 specification.

Namespace Alias

Namespace URI

Specification Description

tosca_2_0

http://docs.oasis-open.org/tosca/ns/2.0

The TOSCA v2.0 (YAML) target namespace and namespace alias.

4.2.2.1.1 TOSCA Namespace prefix

The following TOSCA Namespace prefix is a reserved value and SHALL be used to reference the default TOSCA Namespace URI as declared in TOSCA Service Templates.

Namespace Prefix

Specification Description

tosca

The reserved TOSCA Specification prefix that can be associated with the default TOSCA Namespace URI

4.2.2.1.2 TOSCA Namespacing in TOSCA Service Templates

In the TOSCA , TOSCA Service Templates MUST always have, as the first line of YAML, the keyname “tosca_definitions_version” with an associated TOSCA Namespace Alias value.  This single line accomplishes the following:

Establishes the TOSCA Specification version whose grammar MUST be used to parse and interpret the contents for the remainder of the TOSCA Service Template.

Establishes the default TOSCA Namespace URI and Namespace Prefix for all types found in the document that are not explicitly namespaced.

Automatically imports (without the use of an explicit import statement) the normative type definitions (e.g., Node, Relationship, Capability, Artifact, etc.) that are associated with the TOSCA Specification the TOSCA Namespace Alias value identifies.

Associates the TOSCA Namespace URI and Namespace Prefix to the automatically imported TOSCA type definitions.

4.2.2.1.3 Rules to avoid namespace collisions

TOSCA s allows template authors to declare their own types and templates and assign them simple names with no apparent namespaces .  Since TOSCA Service Templates can import other service templates to introduce new types and topologies of templates that can be used to provide concrete implementations (or substitute) for abstract nodes.  Rules are needed so that TOSCA Orchestrators know how to avoid collisions and apply their own namespaces when import and nesting occur.

4.2.2.1.3.1     Additional Requirements

·         The URI value “http://docs.oasis-open.org/tosca”, as well as all (path) extensions to it, SHALL be reserved for TOSCA approved specifications and work.  That means Service Templates that do not originate from a TOSCA approved work product MUST NOT use it, in any form, when declaring a (default) Namespace.

·         Since TOSCA Service Templates can import (or substitute in) other Service Templates, TOSCA Orchestrators and tooling will encounter the “tosca_definitions_version” statement for each imported template.  In these cases, the following additional requirements apply:

      Imported type definitions with the same Namespace URI, local name and version SHALL be equivalent.

      If different values of the “tosca_definitions_version” are encountered, their corresponding type definitions MUST be uniquely identifiable using their corresponding Namespace URI using a different Namespace prefix.

·         Duplicate local names (i.e., within the same Service Template SHALL be considered an error.  These include, but are not limited to duplicate names found for the following definitions:

      Repositories (repositories)

      Data Types (data_types)

      Node Types (node_types)

      Relationship Types (relationship_types)

      Capability Types (capability_types)

      Artifact Types (artifact_types)

      Interface Types (interface_types)

·         Duplicate Template names within a Service Template’s Topology Template SHALL be considered an error.  These include, but are not limited to duplicate names found for the following template types:

      Node Templates (node_templates)

      Relationship Templates (relationship_templates)

      Inputs (inputs)

      Outputs (outputs)

·         Duplicate names for the following keynames within Types or Templates SHALL be considered an error.  These include, but are not limited to duplicate names found for the following keynames:

      Properties (properties)

      Attributes (attributes)

      Artifacts (artifacts)

      Requirements (requirements)

      Capabilities (capabilities)

      Interfaces (interfaces)

      Policies (policies)

      Groups (groups)

4.2.2.2 Using Namespaces

As of TOSCA version 1.2, Service template authors may declare a namespace within a Service Template that will be used as the default namespace for any types (e.g., Node Type, Relationship Type, Data Type, etc.) defined within the same Service template.  

Specifically, a Service Template’s namespace declaration’s URI will be used to form a unique, fully qualified Type name when combined with the locally defined, unqualified name of any Type in the same Service Template.  The resulting, fully qualified Type name will be used by TOSCA Orchestrators, Processors and tooling when that Service Template was imported into another Service Template to avoid Type name collision.

If a default namespace for the Service Template is declared, then it should be declared immediately after the “tosca_definitions_version” declaration, to ensure that the namespace is clearly visible.

4.2.2.2.1 Example – Importing a Service Template and Namespaces

For example, let say we have two Service Templates, A and B, both of which define Types and a Namespace.  Service Template B contains a Node Type definition for “MyNode” and declares its (default) Namespace to be “http://companyB.com/service/namespace/”:

Service Template B

tosca_definitions_version: tosca_simple_yaml_1_2

description: Service Template B

namespace: http://companyB.com/service/namespace/ 

 

node_types:

  MyNode:

    derived_from: SoftwareComponent

    properties:

      # omitted here for brevity

    capabilities:

      # omitted here for brevity

Service Template A has its own, completely different, Node Type definition also named “MyNode“. 

Service Template A

tosca_definitions_version: tosca_simple_yaml_1_2

description: Service Template A

namespace: http://companyA.com/product/ns/ 

 

imports:

  - file: csar/templates/ServiceTemplateB.yaml

    namespace_prefix: templateB

 

node_types:

  MyNode:

    derived_from: Root

    properties:

      # omitted here for brevity

    capabilities:

      # omitted here for brevity

As you can see, Service Template A also “imports“ Service Template B (i.e., “ServiceTemplateB.yaml“) bringing in its Type defintions to the global namespace using the Namespace URI declared in Service Template B to fully qualify all of its imported types. 

In addition, the import includes a “namespace_prefix“ value (i.e., “templateB“ ), that can be used to qualify and disambiguate any Type reference from from Service Template B within Service Template A.  This prefix is effectively the local alias for the corresponding Namespace URI declared within Service Template B (i.e., “http://companyB.com/service/namespace/“).

To illustrate conceptually what a TOSCA Orchestrator, for example, would track for their global namespace upon processing Service Template A (and by import Service Template B) would be a list of global Namespace URIs and their associated Namespace prefixes, as well as a list of fully qualified Type names that comprises the overall global namespace.

4.2.2.2.1.1     Conceptual Global Namespace URI and Namespace Prefix tracking

 

Entry#

Namespace URI

Namespace Prefix

Added by Key (Source file)

1

http://docs.oasis-open.org/tosca/ns/2.0

tosca

· tosca_definitions_version:

-    from Service Template A

2

http://companyA.com/product/ns/ 

<None>

·  namespace:

-    from Service Template A

3

http://companyB.com/service/namespace/ 

templateB

·  namespace:

-    from Service Template B

·  namespace_prefix:

-   from Service Template A, during import

In the above table,

·         Entry 1: is an entry for the default TOSCA namespace, which is required to exist for it to be a valid Service template.  It is established by the “tosca_definitions_version” key’s value.  By default, it also gets assigned the “tosca” Namespace prefix.

·         Entry 2: is the entry for the local default namespace for Service Template A as declared by the “namespace” key. 

      Note that no Namespace prefix is needed; any locally defined types that are not qualified (i.e., not a full URI or using a Namespace Prefix) will default to this namespace if not found first in the TOSCA namespace.

·         Entry 3: is the entry for default Namespace URI for any type imported from Service Template B.  The author of Service Template A has assigned the local Namespace Prefix “templateB” that can be used to qualify reference to any Type from Service Template B.

As per TOSCA specification, any Type, that is not qualified with the ‘tosca’ prefix or full URI name, should be first resolved by its unqualified name within the TOSCA namespace.  If it not found there, then it may be resolved within the local Service Template’s default namespace.

4.2.2.2.1.2     Conceptual Global Namespace and Type tracking

 

Entry#

Namespace URI

Unqualified Full Name

 

Unqualified Short Name

Type Classification

1

http://docs.oasis-open.org/tosca/ns/2.0

tosca.nodes.Compute

Compute

node

2

http://docs.oasis-open.org/tosca/ns/2.0

tosca.nodes.SoftwareComponent

 

SoftwareComponent

 

3

http://docs.oasis-open.org/tosca/ns/2.0

tosca.relationships.ConnectsTo

ConnectsTo

relationship

...

...

 

 

 

100

http://companyA.com/product/ns/ 

N/A

MyNode

node

...

...

 

 

 

200

http://companyB.com/service/namespace/ 

N/A

MyNode

node

...

...

 

 

 

 

In the above table,

·         Entry 1: is an example of one of the TOSCA standard Node Types (i.e., “Compute”) that is brought into the global namespace via the “tosca_definitions_version” key.

      It also has two forms, full and short that are unique to TOSCA types for historical reasons.  Reference to a TOSCA type by either its unqualified short or full names is viewed as equivalent as a reference to the same fully qualified Type name (i.e., its full URI).

      In this example, use of either “tosca.nodes.Compute” or “Compute” (i.e., an unqualified full and short name Type) in a Service Template will be treated as its fully qualified URI equivalent of:

·         “http://docs.oasis-open.org/tosca/ns/2.0/tosca.nodes.Compute”.

·         Entry 2: is an example of a standard TOSCA Relationship Type

·         Entry 100: contains the unique Type identifer for the Node Type “MyNode” from Service Template A.

·         Entry 200: contains the unique Type identifer for the Node Type “MyNode” from Service Template B.

As you can see, although both templates defined a NodeType with an unqualified name of “MyNode”, the TOSCA Orchestrator, processor or tool tracks them by their unique fully qualified Type Name (URI).

The classification column is included as an example on how to logically differentiate a “Compute” Node Type and “Compute” capability type if the table will be used to “search” for a match based upon context in a Service Template.  

For example, if the short name “Compute” were used in a template on a Requirements clause, then the matching type will not be the Compute Node Type, but instead the Compute Capability Type based upon the Requirement clause being the context for Type reference.

4.2.3 Imports and References

4.2.3.1 Import definition

An import definition is used within a TOSCA Service Template to locate and uniquely name another TOSCA Service Template file which has type and template definitions to be imported (included) and referenced within another Service Template.

4.2.3.1.1 Keynames

The following is the list of recognized keynames for a TOSCA import definition:

Keyname

Required

Type

Constraints

Description

file

yes

string

None

The required symbolic name for the imported file.

repository

no

string

None

The optional symbolic name of the repository definition where the imported file can be found as a string.

namespace_prefix

no

string

None

The optional namespace prefix (alias) that will be used to indicate the namespace_uri when forming a qualified name (i.e., qname) when referencing type definitions from the imported file.

4.2.3.1.2 Grammar

Import definitions have one the following grammars:

4.2.3.1.2.1     Single-line grammar:

imports:

  - <URI_1>

  - <URI_2>

4.2.3.1.2.2     Multi-line grammar

imports: 

  - file: <file_URI>  

    repository: <repository_name>

    namespace_prefix: <definition_namespace_prefix>

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         file_uri: contains the required name (i.e., URI) of the file to be imported as a string.

·         repository_name: represents the optional symbolic name of the repository definition where the imported file can be found as a string.

·         namespace_prefix: represents the optional namespace prefix (alias) that will be used to indicate the default namespace as declared in the imported Service Template when forming a qualified name (i.e., qname) when referencing type definitions from the imported file as a string.

4.2.3.1.2.3     Requirements

·         The “file” keyname’s vlue MAY be an approved TOSCA Namespace alias.

·         The namespace prefix “tosca” Is reserved and SHALL NOT be used to as a value for “namespace_prefix” on import.

4.2.3.1.2.4     Import URI processing requirements

TOSCA Orchestrators, Processors and tooling SHOULD treat the <file_URI> of an import as follows:

·         URI: If the <file_URI> is a known namespace URI (identifier), such as a well-known URI defined by a TOSCA specification, then it SHOULD cause the corresponding Type defintions to be imported.

      This implies that there may or may not be an actual Service Template, perhaps it is a known set Types identified by the well-known URI.

      This also implies that internet access is NOT needed to import.

·         Alias – If the <file_URI> is a reserved TOSCA Namespace alias, then it SHOULD cause the corresponding Type defintions to be imported, using the associated full, Namespace URI to uniquely identify the imported types.

·         URL - If the <file_URI> is a valid URL (i.e., network accessible as a remote resource) and the location contains a valid TOSCA Service Template, then it SHOULD cause the remote Service Template to be imported.

·         Relative path - If the <file_URI> is a relative path URL, perhaps pointing to a Service Template located in the same CSAR file, then it SHOULD cause the locally accessible Service Template to be imported.

      If the “repository” key is supplied, this could also mean relative to the repository’s URL in a remote file system;

      If the importing file located in a CSAR file, it should be treated as relative to the current document’s location within a CSAR file’s directory structure.

·         Otherwise, the import SHOULD be considered a failure.

4.2.3.1.3 Example

The following represents how import definitions will be used for the imports keyname within a TOSCA Service Template:

imports:

  - path1/path2/some_defs.yaml

  - file: path1/path2/file2.yaml

    repository: my_service_catalog

    namespace_uri: http://mycompany.com/tosca/1.0/platform

    namespace_prefix: mycompany

 

4.2.3.2 Repository definition

A repository definition defines an external repository which contains deployment and implementation artifacts that are referenced within the TOSCA Service Template.

4.2.3.2.1 Keynames

The following is the list of recognized keynames for a TOSCA repository definition:

Keyname

Required

Type

Constraints

Description

description

no

string

None

The optional description for the repository.

url

yes

string

None

The required URL or network address used to access the repository.

4.2.3.2.2 Grammar

Repository definitions have one the following grammars:

4.2.3.2.2.1     Single-line grammar:

<repository_name>: <repository_address>

4.2.3.2.2.2     Multi-line grammar

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         repository_name: represents the required symbolic name of the repository as a string.

·         repository_description: contains an optional description of the repository.

·         repository_address: represents the required URL of the repository as a string.

4.2.3.2.3 Example

The following represents a repository definition:

repositories:

  my_code_repo:

    description: My project’s code repository in GitHub

    url: https://github.com/my-project/

 

4.2.4 Additional information definitions

4.2.4.1 Description definition

This optional element provides a means include single or multiline descriptions within a TOSCA template as a scalar string value.

4.2.4.1.1 Keyname

The following keyname is used to provide a description within the TOSCA specification:

description

4.2.4.1.2 Grammar

Description definitions have the following grammar:

description: <description_string>

4.2.4.1.3 Examples

Simple descriptions are treated as a single literal that includes the entire contents of the line that immediately follows the description key:

description: This is an example of a single line description (no folding).

The YAML “folded” style may also be used for multi-line descriptions which “folds” line breaks as space characters.

description: >

  This is an example of a multi-line description using YAML. It permits for line       

  breaks for easier readability...

 

  if needed.  However, (multiple) line breaks are folded into a single space  

  character when processed into a single string value.

4.2.4.1.4 Notes

·         Use of “folded” style is discouraged for the YAML string type apart from when used with the description keyname.

4.2.4.2 Metadata

This optional element provides a means to include optional metadata as a map of strings.

4.2.4.2.1 Keyname

The following keyname is used to provide metadata within the TOSCA specification:

metadata

4.2.4.2.2 Grammar

Metadata definitions have the following grammar:

metadata:

  map of <string>

4.2.4.2.3 Examples

metadata:

  foo1: bar1

  foo2: bar2

  ...

4.2.4.2.4 Notes

·         Data provided within metadata, wherever it appears, MAY be ignored by TOSCA Orchestrators and SHOULD NOT affect runtime behavior.

4.2.4.3 DSL Definitions

TBD.

4.2.5 Type definitions

TOSCA provides a type system to describe possible building blocks to construct a topology template (i.e. for the nodes, relationship, group and policy templates, and the data, capabilities, interfaces, and artifacts used in the node and relationship templates). TOSCA types are reusable TOSCA entities and are defined in their specific sections in the service template, see Section 4.2.1 Service Template definition.

Next, in Section 4.2.5.2 Common keynames in type definitions we present the definitions of common keynames that are used by all TOSCA types. Type-specific definitions for the different TOSCA type entities are presented further in the document:

·         Node Type in Section 4.3.1 Node Type.

·         Relationship Type in Section 4.3.3 Relationship Type.

·         Interface Type in Section 4.3.6.1 Interface Type.

·         Capability Type in Section 4.3.5.1 Capability Type.

·         Requirement Type in Section 4.3.5.4 Requirement Type.

·         Data Type in Section 4.4.2 Data Type.

·         Artifact Type in Section 4.3.7.1 Artifact Type.

·         Group Type in Section 4.6.1 Group Type.

·         Policy Type in Section 4.6.3 Policy Type.

4.2.5.1 General derivation and refinement rules

To simplify type creation and to promote type extensibility TOSCA allows the definition of a new type (the derived type) based on another type (the parent type). The derivation process can be applied recursively, where a type may be derived from a long list of ancestor types (the parent, the parent of the parent, etc).

Unless specifically stated in the derivation rules, when deriving new types from parent types the keyname definitions are inherited from the parent type. Moreover, the inherited definitions may be refined according to the derivation rules of that particular type entity.

For definitions that are not inherited, a new definition MUST be provided (if the keyname is required) or MAY be provided (if the keyname is not required). If not provided, the keyname remains undefined. For definitions that are inherited, a refinement of the inherited definition is not mandatory even for required keynames (since it has been inherited). A definition refinement that is exactly the same as the definition in the parent type does not change in any way the inherited definition. While unnecessary, it is not wrong.

The following are some generic derivation rules used during type derivation (the specific rules of each TOSCA type entity are presented in their respective sections):

·         If not refined, usually a keyname/entity definition, is inherited unchanged from the parent type, unless explicitly specified in the rules that it is “not inherited”.

·         New entities (such as properties, attributes, capabilities, requirements, interfaces, operations, notification, parameters) may be added during derivation.

·         Already defined entities that have a type may be redefined to have a type derived from the original type.

·         New constraints are added to already defined keynames/entities (i.e. the defined constraints do not replace the constraints defined in the parent type but are added to them).

·         Some definitions must be totally flexible, so they will overwrite the definition in the parent type.

·         Some definitions must not be changed at all once defined (i.e. they represent some sort of “signature”).

4.2.5.2 Common keynames in type definitions

The following keynames are used by all TOSCA type entities in the same way. This section serves to define them at once.

4.2.5.2.1 Keynames

The following is the list of recognized keynames used by all TOSCA type definitions:

Keyname

Required

Type

Description

derived_from

no

string

An optional parent type name from which this type derives.

version

no

version

An optional version for the type definition.

metadata

no

map of string

Defines a section used to declare additional metadata information.

description

no

string

An optional description for the type.

4.2.5.2.2 Grammar

The common keynames in type definitions have the following grammar:

<type_name>:

  derived_from: <parent_type_name>

  version: <version_number>

  metadata:

    <metadata_map>

  description: <type_description>

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         parent_type_name: represents the optional parent type name.

·         version_number: represents the optional TOSCA version number for the type.

·         entity_description: represents the optional description string for the type.

·         metadata_map: represents the optional metadata map of string.

4.2.5.2.3 Derivation rules

During type derivation the common keyname definitions use the following rules:

·         derived_from: obviously, the definition is not inherited from the parent type. If not defined, it remains undefined and this type does not derive from another type. If defined, then this type derives from another type, and all its keyname definitions must respect the derivation rules of the type entity.

·         version: the definition is not inherited from the parent type. If undefined, it remains undefined.

·         metadata: the definition is not inherited from the parent type. If undefined, it remains undefined.

·         description: the definition is not inherited from the parent type. If undefined, it remains undefined.

4.2.6 Topology Template definition

This section defines the topology template of a cloud application. The main ingredients of the topology template are node templates representing components of the application and relationship templates representing links between the components. These elements are defined in the nested node_templates section and the nested relationship_templates sections, respectively.  Furthermore, a topology template allows for defining input parameters, output parameters as well as grouping of node templates.

4.2.6.1 Keynames

The following is the list of recognized keynames for a TOSCA Topology Template:

Keyname

Required

Type

Description

description

no

string

The optional description for the Topology Template.

inputs

no

map of

parameter definitions

An optional map of input parameters (i.e., as parameter definitions) for the Topology Template.

node_templates

yes

map of

node templates

An optional map of node template definitions for the Topology Template.

relationship_templates

no

map of

relationship templates

An optional map of relationship templates for the Topology Template.

groups

no

map of

group definitions

An optional map of Group definitions whose members are node templates defined within this same Topology Template.

policies

no

list of

policy definitions

An optional list of Policy definitions for the Topology Template.

outputs

no

map of

parameter definitions

An optional map of output parameters (i.e., as parameter definitions) for the Topology Template.

substitution_mappings

no

substitution_mapping

An optional declaration that exports the topology template as an implementation of a Node type.

 

This also includes the mappings between the external Node Types capabilities and requirements to existing implementations of those capabilities and requirements on Node templates declared within the topology template.

workflows

no

map of imperative workflow definitions

An optional map of imperative workflow definition for the Topology Template.

4.2.6.2 Grammar

The overall grammar of the topology_template section is shown below.–Detailed grammar definitions of the each sub-sections are provided in subsequent subsections.

topology_template:

  description: <template_description>

  inputs: <input_parameters>

  outputs: <output_parameters>

  node_templates: <node_templates>

  relationship_templates: <relationship_templates>

  groups: <group_definitions>

  policies:

    - <policy_definition_list>

  workflows: <workflows>

  # Optional declaration that exports the Topology Template

  # as an implementation of a Node Type.

  substitution_mappings:

    <substitution_mappings>

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         template_description: represents the optional description string for Topology Template.

·         input_parameters: represents the optional map of input parameter definitions for the Topology Template.

·         output_parameters: represents the optional map of output parameter definitions for the Topology Template.

·         group_definitions: represents the optional map of group definitions whose members are node templates that also are defined within this Topology Template.

·         policy_definition_list: represents the optional list of sequenced policy definitions for the Topology Template.

·         workflows: represents the optional map of imperative workflow definitions for the Topology Template.

·         node_templates: represents the optional map of node template definitions for the Topology Template.

·         relationship_templates: represents the optional map of relationship templates for the Topology Template.

·         node_type_name: represents the optional name of a Node Type that the Topology Template implements as part of the substitution_mappings.

·         map_of_capability_mappings_to_expose: represents the mappings that expose internal capabilities from node templates (within the topology template) as capabilities of the Node Type definition that is declared as part of the substitution_mappings.

·         map_of_requirement_mappings_to_expose: represents the mappings of link requirements of the Node Type definition that is declared as part of the substitution_mappings to internal requirements implementations within node templates (declared within the topology template).

More detailed explanations for each of the Topology Template grammar’s keynames appears in the sections below.

4.2.6.2.1 inputs

The inputs section provides a means to define parameters using TOSCA parameter definitions, their allowed values via constraints and default values within a TOSCA template. Input parameters defined in the inputs section of a topology template can be mapped to properties of node templates or relationship templates within the same topology template and can thus be used for parameterizing the instantiation of the topology template.

When deploying a service from the service template, values must be provided for all required input parameters that have no default value defined. If no input is provided, then the default value is used.

4.2.6.2.1.1     Grammar

The grammar of the inputs section is as follows:

inputs:

  <parameter_definitions>

4.2.6.2.1.2     Examples

This section provides a set of examples for the single elements of a topology template.

Simple inputs example without any constraints:

inputs:

  fooName:

    type: string

    description: Simple string typed parameter definition with no constraints.

    default: bar

Example of inputs with constraints:

inputs:

  SiteName:

    type: string

    description: string typed parameter definition with constraints

    default: My Site

    constraints:

      - min_length: 9

4.2.6.2.2 node_templates

The node_templates section lists the Node Templates that describe the (software) components that are used to compose cloud applications.

4.2.6.2.2.1     grammar

The grammar of the node_templates section is a follows:

node_templates:

  <node_template_defn_1>

  ...

  <node_template_defn_n>

4.2.6.2.2.2     Example

Example of node_templates section:

node_templates:

  my_webapp_node_template:

    type: WebApplication

 

  my_database_node_template:

    type: Database

4.2.6.2.3 relationship_templates

The relationship_templates section lists the Relationship Templates that describe the relations between components that are used to compose cloud applications.

Note that in TOSCA, the explicit definition of relationship templates as it was required in TOSCA v1.0 is optional, since relationships between nodes get implicitly defined by referencing other node templates in the requirements sections of node templates.

4.2.6.2.3.1     Grammar

The grammar of the relationship_templates section is as follows:

relationship_templates:

  <relationship_template_defn_1>

  ...

  <relationship_template_defn_n>

4.2.6.2.3.2     Example

Example of relationship_templates section:

relationship_templates:

  my_connectsto_relationship:

    type: tosca.relationships.ConnectsTo

    interfaces:

      Configure:

        inputs:

          speed: { get_attribute: [ SOURCE, connect_speed ] }     

4.2.6.2.4 outputs

The outputs section provides a means to define the output parameters that are available from a TOSCA service template. It allows for exposing attributes of node templates or relationship templates within the containing topology_template to users of a service.

4.2.6.2.4.1     Grammar

The grammar of the outputs section is as follows:

outputs:

  <parameter_definitions>

4.2.6.2.4.2     Example

Example of the outputs section:

outputs:

  server_address:

    description: The first private IP address for the provisioned server.

    value: { get_attribute: [ node5, networks, private, addresses, 0 ] }

4.2.6.2.5 groups

The groups section allows for grouping one or more node templates within a TOSCA Service Template and for assigning special attributes like policies to the group.

4.2.6.2.5.1     Grammar

The grammar of the groups section is as follows:

groups:

  <group_defn_1>

  ...

  <group_defn_n>

4.2.6.2.5.2     Example

The following example shows the definition of three Compute nodes in the node_templates section of a topology_template as well as the grouping of two of the Compute nodes in a group server_group_1.

node_templates:

  server1:

    type: tosca.nodes.Compute

    # more details ...

 

  server2:

    type: tosca.nodes.Compute

    # more details ...

 

  server3:

    type: tosca.nodes.Compute

    # more details ...

 

groups:

  # server2 and server3 are part of the same group

  server_group_1:

    type: tosca.groups.Root

    members: [ server2, server3 ]

4.2.6.2.6 policies

The policies section allows for declaring policies that can be applied to entities in the topology template.

4.2.6.2.6.1     Grammar

The grammar of the policies section is as follows:

policies:

  - <policy_defn_1>

  - ...

  - <policy_defn_n>

4.2.6.2.6.2     Example

The following example shows the definition of a placement policy.

policies:

  - my_placement_policy:

      type: mycompany.mytypes.policy.placement

4.2.6.2.7 substitution_mapping
4.2.6.2.7.1     requirement_mapping

The grammar of a requirement_mapping is as follows:

<requirement_name>: [ <node_template_name>, <node_template_requirement_name> ]

The multi-line grammar is as follows :

<requirement_name>:

  mapping: [ <node_template_name>, <node_template_capability_name> ]

  properties:

    <property_name>: <property_value>

·         requirement_name: represents the name of the requirement as it appears in the Node Type definition for the Node Type (name) that is declared as the value for on the substitution_mappings’ “node_type” key.

·         node_template_name: represents a valid name of a Node Template definition (within the same topology_template declaration as the substitution_mapping is declared).

·         node_template_requirement_name: represents a valid name of a requirement definition within the <node_template_name> declared in this mapping.

4.2.6.2.7.2     Example

The following example shows the definition of a placement policy.

topology_template:

 

inputs:

   cpus:

     type: integer

     constraints:

       less_than: 2 # OR use “defaults” key

 

substitution_mappings:

    node_type: MyService

    properties:  # Do not care if running or matching (e.g., Compute node)

      # get from outside?  Get from contsraint?

      num_cpus: cpus # Implied “PUSH”

      # get from some node in the topology…

      num_cpus: [ <node>, <cap>, <property> ]

      # 1) Running

      architecture:

        # a) Explicit

        value: { get_property: [some_service, architecture] }

        # b) implicit

        value: [ some_service, <req | cap name>, <property name> architecture ]

        default: “amd”

        # c) INPUT mapping?

        ???

      # 2) Catalog (Matching)

      architecture:

         contraints: equals: “x86”

 

    capabilities:

      bar: [ some_service, bar ]

    requirements:

      foo: [ some_service, foo ]

 

  node_templates:

    some_service:

      type: MyService

      properties:

        rate: 100

      capabilities:

        bar:

          ...

      requirements:

        - foo:

            ...

 

 

4.2.6.2.8 Notes

·         The parameters (properties) that are part of the inputs block can be mapped to PropertyMappings provided as part of BoundaryDefinitions as described by the TOSCA v1.0 specification.

·         The node templates that are part of the node_templates block can be mapped to the NodeTemplate definitions provided as part of TopologyTemplate of a ServiceTemplate as described by the TOSCA v1.0 specification.

·         The relationship templates that are part of the relationship_templates block can be mapped to the RelationshipTemplate definitions provided as part of TopologyTemplate of a ServiceTemplate as described by the TOSCA v1.0 specification.

·         The output parameters that are part of the outputs section of a topology template can be mapped to PropertyMappings provided as part of BoundaryDefinitions as described by the TOSCA v1.0 specification.

      Note, however, that TOSCA v1.0 does not define a direction (input vs. output) for those mappings, i.e. TOSCA v1.0 PropertyMappings are underspecified in that respect and TOSCA ’s inputs and outputs provide a more concrete definition of input and output parameters.

4.3 Nodes and Relationships

4.3.1 Node Type

A Node Type is a reusable entity that defines the type of one or more Node Templates. As such, a Node Type defines the structure of observable properties and attributes, the capabilities and requirements of the node as well as its supported interfaces and the artifacts it uses.

4.3.1.1 Keynames

The Node Type is a TOSCA type entity and has the common keynames listed Section 4.2.5.2 Common keynames in type definitions. In addition, the Node Type has the following recognized keynames:

Keyname

Required

Type

Description

properties

no

map of

property definitions

An optional map of property definitions for the Node Type.

attributes

no

map of

attribute definitions

An optional map of attribute definitions for the Node Type.

capabilities

no

map of

capability definitions

An optional map of capability definitions for the Node Type.

requirements

no

list of

requirement definitions

An optional list of requirement definitions for the Node Type.

interfaces

no

map of

interface definitions

An optional map of interface definitions supported by the Node Type.

artifacts

no

map of

artifact definitions

An optional map of artifact definitions for the Node Type.

4.3.1.2 Grammar

Node Types have following grammar:

<node_type_name>: 

  derived_from: <parent_node_type_name>

  version: <version_number>

  metadata:

    <map of string>

  description: <node_type_description>

  properties:

    <property_definitions>

  attributes:

    <attribute_definitions>

  capabilities:

    <capability_definitions>

  requirements:

    - <requirement_definitions>

  interfaces:

    <interface_definitions>

  artifacts:

    <artifact_definitions>

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         node_type_name: represents the required symbolic name of the Node Type being declared.

·         parent_node_type_name: represents the name (string) of the Node Type this Node Type definition derives from (i.e. its parent type).

·         version_number: represents the optional TOSCA version number for the Node Type.

·         node_type_description: represents the optional description string for the corresponding node_type_name.

·         property_definitions: represents the optional map of property definitions for the Node Type.

·         attribute_definitions: represents the optional map of attribute definitions for the Node Type.

·         capability_definitions: represents the optional map of capability definitions for the Node Type.

·         requirement_definitions: represents the optional list of requirement definitions for the Node Type.

·         interface_definitions: represents the optional map of one or more interface definitions supported by the Node Type.

·         artifact_definitions: represents the optional map of artifact definitions for the Node Type

4.3.1.3 Derivation rules

During Node Type derivation the keyname definitions follow these rules:

·         properties: existing property definitions may be refined; new property definitions may be added.

·         attributes: existing attribute definitions may be refined; new attribute definitions may be added.

·         capabilities: existing capability definitions may be refined; new capability definitions may be added.

·         requirements: existing requirement definitions may be refined; new requirement definitions may be added.

·         interfaces: existing interface definitions may be refined; new interface definitions may be added.

·         artifacts: existing artifact definitions (identified by their symbolic name) may be redefined; new artifact definitions may be added.

o    note that an artifact is created for a specific purpose and corresponds to a specific file (with e.g. a path name and checksum); if it cannot meet its purpose in a derived type then a new artifact should be defined and used.

o    thus, if an artifact defined in a parent node type does not correspond anymore with the needs in the child node type, its definition may be completely redefined; thus, an existing artifact definition is not refined, but completely overwritten.

4.3.1.4 Additional Requirements

·         Requirements are intentionally expressed as a list of TOSCA Requirement definitions which SHOULD be resolved (processed) in sequence by TOSCA Orchestrators.

4.3.1.5 Example

my_company.my_types.my_app_node_type:

  derived_from: tosca.nodes.SoftwareComponent

  description: My company’s custom applicaton

  properties:

    my_app_password:

      type: string

      description: application password

      constraints:

        - min_length: 6

        - max_length: 10

  attributes:

    my_app_port:

      type: integer

      description: application port number

  requirements:

    - some_database:

        capability: EndPoint.Database

        node: Database   

        relationship: ConnectsTo

 

4.3.2 Node Template

A Node Template specifies the occurrence of a manageable component as part of an application’s topology model which is defined in a TOSCA Service Template.  A Node Template is an instance of a specified Node Type and can provide customized properties, constraints, relationships or interfaces which complement and change the defaults provided by its Node Type.

4.3.2.1 Keynames

The following is the list of recognized keynames for a TOSCA Node Template definition:

Keyname

Required

Type

Description

type

yes

string

The required name of the Node Type the Node Template is based upon.

description

no

string

An optional description for the Node Template.

metadata

no

map of string

Defines a section used to declare additional metadata information.

directives

no

list of string

An optional list of directive values to provide processing instructions to orchestrators and tooling.

properties

no

map of

property assignments

An optional map of property value assignments for the Node Template.

attributes

no

map of

attribute assignments

An optional map of attribute value assignments for the Node Template.

requirements

no

list of

requirement assignments

An optional list of requirement assignments for the Node Template.

capabilities

no

map of

capability assignments

An optional map of capability assignments for the Node Template.

interfaces

no

map of

interface assignments

An optional map of interface assignments for the Node Template.

artifacts

no

map of

artifact definitions

 

An optional map of artifact definitions for the Node Template.

node_filter

no

node filter

The optional filter definition that TOSCA orchestrators will use to select the correct target node. 

copy

no

string

The optional (symbolic) name of another node template to copy into (all keynames and values) and use as a basis for this node template.

4.3.2.2 Grammar

<node_template_name>:

  type: <node_type_name>

  description: <node_template_description>

  directives: [<directives>]

  metadata:

    <map of string>

  properties:

    <property_assignments>

  attributes:

    <attribute_assignments>

  requirements:

    - <requirement_assignments>

  capabilities:

    <capability_assignments>

  interfaces:

    <interface_assignments>

  artifacts:

    <artifact_definitions>

  node_filter:

    <node_filter_definition>

  copy: <source_node_template_name>

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         node_template_name: represents the required symbolic name of the Node Template being declared.

·         node_type_name: represents the name of the Node Type the Node Template is based upon.

·         node_template_description: represents the optional description string for Node Template.

·         directives: represents the optional list of processing instruction keywords (as strings) for use by tooling and orchestrators.

·         property_assignments: represents the optional map of property assignments for the Node Template that provide values for properties defined in its declared Node Type.

·         attribute_assignments: represents the optional map of attribute assignments for the Node Template that provide values for attributes defined in its declared Node Type.

·         requirement_assignments: represents the optional list of requirement assignments for the Node Template for requirement definitions provided in its declared Node Type.

·         capability_assignments: represents the optional map of capability assignments for the Node Template for capability definitions provided in its declared Node Type.

·         interface_assignments: represents the optional map of interface assignments for the Node Template interface definitions provided in its declared Node Type.

·         artifact_definitions: represents the optional map of artifact definitions for the Node Template that augment those provided by its declared Node Type.

·         node_filter_definition: represents the optional node filter TOSCA orchestrators will use for selecting a matching node template.

·         source_node_template_name: represents the optional (symbolic) name of another node template to copy into (all keynames and values) and use as a basis for this node template.

4.3.2.3 Additional requirements

·         The source node template provided as a value on the copy keyname MUST NOT itself use the copy keyname (i.e., it must itself be a complete node template description and not copied from another node template).

4.3.2.4 Example

node_templates:

  mysql:

    type: tosca.nodes.DBMS.MySQL

    properties:

      root_password: { get_input: my_mysql_rootpw }

      port: { get_input: my_mysql_port }

    requirements:

      - host: db_server

    interfaces:

      Standard:

        operations:

          configure: scripts/my_own_configure.sh

 

4.3.3 Relationship Type

A Relationship Type is a reusable entity that defines the type of one or more relationships between Node Types or Node Templates.

4.3.3.1 Keynames

The Relationship Type is a TOSCA type entity and has the common keynames listed in Section 4.2.5.2 Common keynames in type definitions. In addition, the Relationship Type has the following recognized keynames:

Keyname

Required

Definition/Type

Description

properties

no

map of

property definitions

An optional map of property definitions for the Relationship Type.

attributes

no

map of

attribute definitions

An optional map of attribute definitions for the Relationship Type.

interfaces

no

map of

interface definitions

An optional map of interface definitions supported by the Relationship Type.

valid_target_types

no

list of string

An optional list of one or more names of Capability Types that are valid targets for this relationship. If undefined, all Capability Types are valid target targets.

4.3.3.2 Grammar

Relationship Types have following grammar:

<relationship_type_name>:

  derived_from: <parent_relationship_type_name>

  version: <version_number>

  metadata:

    <map of string>

  description: <relationship_description>

  properties:

    <property_definitions>

  attributes:

    <attribute_definitions>

  interfaces:

    <interface_definitions>

  valid_target_types: [ <capability_type_names> ]

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         relationship_type_name: represents the required symbolic name of the Relationship Type being declared as a string.

·         parent_relationship_type_name: represents the name (string) of the Relationship Type this Relationship Type definition derives from (i.e., its “parent” type).

·         relationship_description: represents the optional description string for the corresponding relationship_type_name.

·         version_number: represents the optional TOSCA version number for the Relationship Type.

·         property_definitions: represents the optional map of property definitions for the Relationship Type.

·         attribute_definitions: represents the optional map of attribute definitions for the Relationship Type.

·         interface_definitions: represents the optional map of interface definitions supported by the Relationship Type.

·         capability_type_names: represents the optional list of valid target Capability Types for the relationship; if undefined, the valid target types are not restricted at all (i.e. all Capability Types are valid).

4.3.3.3 Derivation rules

During Relationship Type derivation the keyname definitions follow these rules:

·         properties: existing property definitions may be refined; new property definitions may be added.

·         attributes: existing attribute definitions may be refined; new attribute definitions may be added.

·         interfaces: existing interface definitions may be refined; new interface definitions may be added.

·         valid_target_types: if valid_target_types is defined in the parent type, each element in this list must either be in the parent type list or derived from an element in the parent type list; if valid_target_types is not defined in the parent type then no restrictions are applied.

4.3.3.4 Examples

mycompanytypes.myrelationships.AppDependency:

  derived_from: tosca.relationships.DependsOn

  valid_target_types: [ mycompanytypes.mycapabilities.SomeAppCapability ]

 

4.3.4 Relationship Template

A Relationship Template specifies the occurrence of a manageable relationship between node templates as part of an application’s topology model that is defined in a TOSCA Service Template.  A Relationship template is an instance of a specified Relationship Type and can provide customized properties, constraints or operations which complement and change the defaults provided by its Relationship Type and its implementations.

4.3.4.1 Keynames

The following is the list of recognized keynames for a TOSCA Relationship Template definition:

Keyname

Required

Type

Description

type

yes

string

The required name of the Relationship Type the Relationship Template is based upon.

description

no

string

An optional description for the Relationship Template.

metadata

no

map of string

Defines a section used to declare additional metadata information.

properties

no

map of

property assignments

An optional map of property assignments for the Relationship Template.

attributes

no

map of

attribute assignments

An optional map of attribute assignments for the Relationship Template.

interfaces

no

map of

interface assignments

An optional map of interface assignments for the relationship template.

copy

no

string

The optional (symbolic) name of another relationship template to copy into (all keynames and values) and use as a basis for this relationship template.

4.3.4.2 Grammar

<relationship_template_name>:

  type: <relationship_type_name>

  description: <relationship_type_description>

  metadata:

    <map of string>

  properties:

    <property_assignments>

  attributes:

    <attribute_assignments>

  interfaces:

    <interface_assignments>

  copy:

    <source_relationship_template_name>

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         relationship_template_name: represents the required symbolic name of the Relationship Template being declared.

·         relationship_type_name: represents the name of the Relationship Type the Relationship Template is based upon.

·         relationship_template_description: represents the optional description string for the Relationship Template.

·         property_assignments: represents the optional map of property assignments for the Relationship Template that provide values for properties defined in its declared Relationship Type.

·         attribute_assignments: represents the optional map of attribute assignments for the Relationship Template that provide values for attributes defined in its declared Relationship Type.

·         interface_assignments: represents the optional map of interface assignments for the Relationship Template for interface definitions provided by its declared Relationship Type.

·         source_relationship_template_name: represents the optional (symbolic) name of another relationship template to copy into (all keynames and values) and use as a basis for this relationship template.

4.3.4.3 Additional requirements

·         The source relationship template provided as a value on the copy keyname MUST NOT itself use the copy keyname (i.e., it must itself be a complete relationship template description and not copied from another relationship template).

4.3.4.4 Example

relationship_templates:

  storage_attachment:

    type: AttachesTo

    properties:

      location: /my_mount_point

 

4.3.5 Capabilities and Requirements

4.3.5.1 Capability Type

A Capability Type is a reusable entity that describes a kind of capability that a Node Type can declare to expose.  Requirements (implicit or explicit) that are declared as part of one node can be matched to (i.e., fulfilled by) the Capabilities declared by another node.

4.3.5.1.1 Keynames

The Capability Type is a TOSCA type entity and has the common keynames listed in Section 4.2.5.2 Common keynames in type definitions. In addition, the Capability Type has the following recognized keynames:

Keyname

Required

Type

Description

properties

no

map of
property definitions

An optional map of property definitions for the Capability Type.

attributes

no

map of

attribute definitions

An optional map of attribute definitions for the Capability Type.

valid_source_types

no

list of string

An optional list of one or more valid names of Node Types that are supported as valid sources of any relationship established to the declared Capability Type. If undefined, all Node Types are valid sources.

4.3.5.1.2 Grammar

Capability Types have following grammar:

<capability_type_name>:

  derived_from: <parent_capability_type_name>

  version: <version_number>

  description: <capability_description>

  properties:

    <property_definitions>

  attributes:

    <attribute_definitions>

  valid_source_types: [ <node type_names> ]

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         capability_type_name: represents the required name of the Capability Type being declared as a string.

·         parent_capability_type_name: represents the name of the Capability Type this Capability Type definition derives from (i.e., its “parent” type).

·         version_number: represents the optional TOSCA version number for the Capability Type.

·         capability_description: represents the optional description string for the Capability Type.

·         property_definitions: represents the optional map of property definitions for the Capability Type.

·         attribute_definitions: represents the optional map of attribute definitions for the Capability Type.

·         node_type_names: represents the optional list of one or more names of Node Types that the Capability Type supports as valid sources for a successful relationship to be established to itself; if undefined, the valid source types are not restricted at all (i.e. all Node Types are valid).

4.3.5.1.3 Derivation rules

During Capability Type derivation the keyname definitions follow these rules:

·         properties: existing property definitions may be refined; new property definitions may be added.

·         attributes: existing attribute definitions may be refined; new attribute definitions may be added.

·         valid_source_types: if valid_source_types is defined in the parent type, each element in this list must either be in the parent type list or derived from an element in the parent type list; if valid_source_types is not defined in the parent type then no restrictions are applied.

4.3.5.1.4 Example

mycompany.mytypes.myapplication.MyFeature:

  derived_from: tosca.capabilities.Root

  description: a custom feature of my company’s application

  properties:

    my_feature_setting:

      type: string

    my_feature_value:

      type: integer

 

4.3.5.2 Capability definition

A Capability definition defines a typed set of data that a node can expose and is used to describe a relevant feature of the component described by the node. A Capability is defined part of a Node Type definition and may be refined during Node Type derivation.

4.3.5.2.1 Keynames

The following is the list of recognized keynames for a TOSCA capability definition:

Keyname

Required

Type

Constraints

Description

type

yes

string

N/A

The required name of the Capability Type this capability definition is based upon.

description

no

string

N/A

The optional description of the Capability definition.

properties

no

map of

property refinements

- refinements apply to the definitions in the Capability Type

- new properties may not be added

An optional map of property refinements for the Capability definition. The referred properties must have been defined in the Capability Type definition referred by the type keyword.

attributes

no

map of

attribute refinements

- refinements apply to the definitions in the Capability Type

- new attributes may not be added

An optional map of attribute refinements for the Capability definition. The referred attributes must have been defined in the Capability Type definition referred by the type keyword.

valid_source_types

no

list of string

if valid_source_types is defined in the Capability Type, each element in this list must either be in or derived from an element in the list defined in the type

An optional list of one or more valid names of Node Types that are supported as valid sources of any relationship established to the declared Capability Type. If undefined, all node types are valid sources.

occurrences

no

range of integer

if not defined the implied default is [1,UNBOUNDED]

The optional minimum and maximum of occurrences for the capability. The occurrence represents the maximum number of relationships that are allowed by the Capability. By default, an exported Capability should allow minimum one relationship to be formed with it and maximum a UNBOUNDED number of relationships.

 

4.3.5.2.2 Grammar

Capability definitions have one of the following grammars:

4.3.5.2.2.1     Short notation

The following single-line grammar may be used when only the capability type needs to be declared, without further refinement of the definitions in the capability type:

4.3.5.2.2.2     Extended notation

The following multi-line grammar may be used when additional information on the capability definition is needed:

<capability_definition_name>:

  type: <capability_type>

  description: <capability_description>

  properties:

    <property_refinements>

  attributes:

    <attribute_refinements>

  valid_source_types: [ <node type_names> ]

  occurrences: <range_of_occurrences>

In the above grammars, the pseudo values that appear in angle brackets have the following meaning:

·         capability_definition_name: represents the symbolic name of the capability as a string.

·         capability_type: represents the required name of a capability type the capability definition is based upon.

·         capability_description: represents the optional description of the capability definition.

·         property_refinements: represents the optional map of property definitions refinements for properties already defined in the capability type; new properties may not be added.

·         attribute_refinements: represents the optional map of attribute definitions refinements for attributes already defined in the capability type; new attributes may not be added.

·         node_type_names: represents the optional list of one or more names of Node Types that the Capability definition supports as valid sources for a successful relationship to be established to itself

·         if valid_source_types is defined in the capability type, each element in this list MUST either be in the capability type list or derived from an element in the capability type list; if valid_source_types is not defined in the capability type then no restrictions are applied.

·         range_of_occurrences: represents he optional minimum and maximum occurrences for the capability

·         the occurrence represents the maximum number of relationships that are allowed by the capability; however, it does not restrict a lower number of relationships than the occurrence to be established.

·         in a node template, the occurrences keyname may be assigned to any number within the range_of_occurrences defined here.

·         if the occurrences is not assigned in the node template the TOSCA orchestrator may automatically set the occurrences to a number in the defined range (e.g. the maximum in the range).

·         the minimum in the range prevents the occurrences (during subsequent refinements or during assignment) to be set below this minimum.

·         by default (i.e. if occurrences is undefined here), a capability should allow at least one (1), and at most an unrestricted number (UNBOUNDED) of relationships to be formed to it.

4.3.5.2.3 Refinement rules

A capability definition within a node type uses the following definition refinement rules when the containing node type is derived:

·         type: must be derived from (or the same as) the type in the capability definition in the parent node type definition.

·         description: a new definition is unrestricted and will overwrite the one inherited from the capability definition in the parent node type definition.

·         occurrences: the new range MUST be within the range defined in the capability definition in the parent node type definition.

·         properties: not applicable to the definitions in the parent node type but to the definitions in the capability type referred by the type keyname (see grammar above for the rules).

·         attributes: not applicable to the definitions in the parent node type but to the definitions in the capability type referred by the type keyname (see grammar above for the rules).

·         valid_source_types: not applicable to the definitions in the parent node type but to the definitions in the capability type referred by the type keyname (see grammar above for the rules).

4.3.5.2.4 Examples

The following examples show capability definitions in both simple and full forms:

4.3.5.2.4.1     Simple notation example

# Simple notation, no properties need to be refined

some_capability: mytypes.mycapabilities.MyCapabilityTypeName

4.3.5.2.4.2     Full notation example

# Full notation, refining properties

some_capability:

  type: mytypes.mycapabilities.MyCapabilityTypeName

  properties:

    limit:

      default: 100

4.3.5.2.5 Additional requirements

·         Capability symbolic names SHALL be unique; it is an error if a capability name is found to occur more than once.

·         If the occurrences keyname is not present, then a default declaration as follows will be assumed: occurrences: [1, UNBOUNDED]

4.3.5.3 Capability assignment

A capability assignment allows node template authors to assign values to properties and attributes for a capability definition that is part of a the node templates’ respective type definition, and also to set the capability occurrences.

4.3.5.3.1 Keynames

The following is the list of recognized keynames for a TOSCA capability assignment:

Keyname

Required

Type

Description

properties

no

map of

property assignments

An optional map of property assignments for the Capability definition.

attributes

no

map of

attribute assignments

An optional map of attribute assignments for the Capability definition.

occurrences

no

integer

An optional integer that sets the number of occurrences. It defines the maximum number of allowed relationships to this capability. Must be within the range specified in the corresponding capability definition. If not defined, the orchestrator uses a suitable value from the range defined in the corresponding capability definition (e.g. the maximum in the range).

4.3.5.3.2 Grammar

Capability assignments have one of the following grammars:

<capability_definition_name>:

  properties:

    <property_assignments>

  attributes:

    <attribute_assignments>

  occurrences: <occurrences_value>

In the above grammars, the pseudo values that appear in angle brackets have the following meaning:

·         capability_definition_name: represents the symbolic name of the capability as a string.

·         property_assignments: represents the optional map of property assignments that provide values for properties defined in the Capability definition.

·         attribute_assignments: represents the optional map of attribute assignments that provide values for attributes defined in the Capability definition.

·         occurrences_value: represents the optional integer that sets the number of occurrences

·         it represents the maximum number of relationships that are allowed by the capability; note that it does not restrict a lower number of relationships to be established.

·         must be within the range specified in the corresponding capability definition.

·         if not defined, the orchestrator uses a suitable value from the range defined in the corresponding capability definition (e.g. the maximum in the range).

4.3.5.3.3 Example

The following example shows a capability assignment:

4.3.5.3.3.1     Notation example

node_templates:

  some_node_template:

    capabilities:

      some_capability:

        properties:

          limit: 100

 

4.3.5.4 Requirement Type

Requirement types are not defined in TOSCA. TOSCA seeks to simplify the modeling by not declaring specific Requirement Types with nodes declaring their features sets using TOSCA Capability Types. So, it suffices that capabilites are advertised a-priory by Capability Types, while requirement definitions can be directly created during Node Type design.

 

4.3.5.5 Requirement definition

The Requirement definition describes a requirement (dependency) of a TOSCA node which needs to be fulfilled by a matching Capability definition declared by another TOSCA node. A Requirement is defined as part of a Node Type definition and may be refined during Node Type derivation.

4.3.5.5.1 Keynames

The following is the list of recognized keynames for a TOSCA requirement definition:

Keyname

Required

Type

Constraints

Description

description

no

string

N/A

The optional description of the Requirement definition.

capability

yes

string

N/A

The required keyname used to provide either the:

·         symbolic name of a Capability definition within a target Node Type that can fulfill the requirement.

·         name of a Capability Type that the TOSCA orchestrator will use to select a type-compatible target node to fulfill the requirement at runtime.

node

no

string

N/A

The optional keyname used to provide the name of a valid Node Type that contains the capability definition that can be used to fulfill the requirement.

If a symbolic name of a Capability definition has been used for the capability keyname, then the node keyname is mandatory.

relationship

no

string

N/A

The optional keyname used to provide the name of a valid Relationship Type to construct a relationship when fulfilling the requirement.

node_filter

no

node filter

N/A

The optional filter definition that TOSCA orchestrators will use to select a type-compatible target node that can fulfill the associated abstract requirement at runtime.

occurrences

no

range of integer

implied default of [1,1]

The optional minimum and maximum occurrences for the requirement.

Note: the keyword UNBOUNDED is also supported to represent any positive integer.

4.3.5.5.1.1     Additional Keynames for multi-line relationship grammar

The Requirement definition contains the Relationship Type information needed by TOSCA Orchestrators to construct relationships to other TOSCA nodes with matching capabilities; however, it is sometimes recognized that additional parameters may need to be passed to the relationship (perhaps for configuration). In these cases, additional grammar is provided so that the requirement definition may declare interface refinements  (e.g. changing the implementation definition or declaring additional parameter definitions to be used as inputs/outputs). 

Keyname

Required

Type

Constraints

Description

type

yes

string

N/A

The optional keyname used to provide the name of the Relationship Type as part of the relationship keyname definition.

interfaces

no

map of interface refinements

N/A

The optional keyname used to reference declared interface definitions on the corresponding Relationship Type for refinement.

4.3.5.5.2 Grammar

Requirement definitions have one of the following grammars:

4.3.5.5.2.1     Simple grammar (Capability Type only)
4.3.5.5.2.2     Extended grammar (with Node and Relationship Types)

<requirement_definition_name>:

  description: <requirement_description>

  capability: <capability_symbolic_name> | <capability_type_name>

  node: <node_type_name>

  relationship: <relationship_type_name>

  node_filter: <node_filter_definition>

  occurrences: [ <min_occurrences>, <max_occurrences> ]

4.3.5.5.2.3     Extended grammar for declaring Parameter Definitions on the relationship’s Interfaces

The following additional multi-line grammar is provided for the relationship keyname in order to declare new parameter definitions for inputs/outputs of known Interface definitions of the declared Relationship Type. 

<requirement_definition_name>:

  # Other keynames omitted for brevity

  relationship:

    type: <relationship_type_name>

    interfaces: <interface_refinements>

In the above grammars, the pseudo values that appear in angle brackets have the following meaning:

·         requirement_definition_name: represents the required symbolic name of the requirement definition as a string.

·         requirement_description: represents the optional description of the requirement definition.

·         capability_symbolic_name: represents the required symbolic name of the Capability definition within the target Node Type.

·         capability_type_name: represents the required name of a Capability Type that can be used to fulfill the requirement.

·         node_type_name: represents the name of a Node Type that contains either the Capability Type or the Capability definition the requirement can be fulfilled by; the node_type_name is required if the capability_symbolic_name was used, and is optional if the capability_type_name was used.

·         relationship_type_name: represents the optional name of a Relationship Type to be used to construct a relationship between this requirement definition (i.e. in the source node) to a matching capability definition (in a target node).

·         node_filter_definition: represents the optional node filter TOSCA orchestrators will use to fulfill the requirement when selecting a target node, or to verify that the specified node template fulfills the requirement (if a node template was specified during requirement assignment).

·         min_occurrences, max_occurrences: represents the optional minimum and maximum range for the occurrences of the requirement (i.e. its cardinality)

·         the requirement occurrences define how many relationships are created from this requirement towards target capabilities, and its value is set during requirement assignment time to an integer in the range specified here.

·         by default (i.e. if occurrences is undefined here), a requirement shall form exactly one relationship (i.e. at least one, and at most one).

·         interface_refinements: represents refinements for one or more already declared interface definitions in the Relationship Type (as declared on the type keyname)

·         allowing for the declaration of new parameter definitions for these interfaces or for specific operation or notification definitions of these interfaces or for the change of the description or implementation definitions.

4.3.5.5.3 Refinement rules

A requirement definition within a node type uses the following definition refinement rules when the containing node type is derived:

·         description: a new definition is unrestricted and will overwrite the one inherited from the requirement definition in the parent node type definition.

·         capability: the type of the capability must be derived from (or the same as) the capability type in the requirement definition in the parent node type definition;

·         if the capability was specified using the symbolic name of a capability definition in the target node type, then the capability keyname definition MUST remain unchanged in any subsequent refinements or during assignment.

·         node: must be derived from (or the same as) the node type in the requirement definition in the parent node type definition; if node is not defined in the parent type then no restrictions are applied;

·         the node type specified by the node keyname must also contain a capability definition that fulfills the requirement set via the capability keyname above.

·         relationship: must be derived from (or the same as) the relationship type in the requirement definition in the parent node type definition; if relationship is not defined in the parent type then no restrictions are applied.

·         node_filter: a new definition is unrestricted and will be considered in addition (i.e. logical and) to the node_filter definition in the parent node type definition; further refinements may add further node filters.

·         occurrences: the new range MUST be within the range defined in the requirement definition in the parent node type definition.

4.3.5.5.4 Additional requirements

·         Requirement symbolic names SHALL be unique; it is an error if a requirement name is found to occur more than once.

·         If the occurrences keyname is not present, then a default declaration as follows will be assumed: 

- occurrences: [1,1]

4.3.5.5.5 Notes

·         The requirement symbolic name is used for identification of the requirement definition only and not relied upon for establishing any relationships in the topology.

4.3.5.5.6 Requirement definition is a tuple with a filter

A requirement definition allows type designers to govern which types are allowed (valid) for fulfillment using three levels of specificity with only the Capability definition or Capability Type being required.

1.     Node Type (required/optional)

2.     Relationship Type (optional)

3.     Capability definition or Capability Type (required)

The first level allows selection, as shown in both the simple or complex grammar, simply providing the node’s type using the node keyname. The second level allows specification of the relationship type to use when connecting the requirement to the capability using the relationship keyname.  Finally, the specific Capability definition or Capability Type on the target node is provided using the capability keyname. Note that if a Capability definition is used, the Node Type definition is required (as it refers to a Capability definition in that Node Type).

In addition to the node, relationship and capability types, a filter, with the keyname node_filter, may be provided to constrain the allowed set of potential target nodes based upon their properties and their capabilities’ properties.  This allows TOSCA orchestrators to help find the “best fit” when selecting among multiple potential target nodes for the expressed requirements. Also, if a Node Template was specified during requirement assignment it allows TOSCA orchestrators to verify that the specified node template fulfills the requirement.

 

4.3.5.6 Requirement assignment

A Requirement assignment allows Node Template authors to provide assignments for individual and/or subsets of occurrences of the corresponding Requirement definition (i.e. having the same symbolic name) in the Node Type definition.

A Requirement assignment provides either names of Node Templates or selection criteria for TOSCA orchestrators to find matching TOSCA nodes that are used to fulfill the requirement’s declared Capability Type and/or Node Type. A Requirement assignment also provides either names of Relationship Templates (to use) or the name of Relationship Types (to create relationships) for relating the source node (containing the Requirement) to the target node (containing the Capability).

Note that several Requirement assignments in the Node Template definition can have the same symbolic name, each referring to different occurrences of the Requirement definition. To how many occurrences a particular assignment refers to is set via the occurrences keyname. Nevertheless, the sum of the occurrences’ values for all of the Requirement assignments with the same symbolic name MUST be within the range of occurrences specified by the corresponding Requirement definition.

4.3.5.6.1 Keynames

The following is the list of recognized keynames for a TOSCA requirement assignment:

Keyname

Required

Type

Description

capability

no

string

The optional keyname used to provide either the:

·         symbolic name of a Capability definition within a target node that can fulfill the requirement.

·         name of a Capability Type that the TOSCA orchestrator will use to select a type-compatible target node to fulfill the requirement at runtime.

node

no

string

The optional keyname used to identify the target node of a relationship; specifically, it is used to provide either the:

·         name of a Node Template that can fulfill the target node requirement.

·         name of a Node Type that the TOSCA orchestrator will use to select a type-compatible target node to fulfill the requirement at runtime.

relationship

no

string

The optional keyname used to provide either the:

·         name of a Relationship Template to use to relate this node to the target node when fulfilling the requirement.

·         name of a Relationship Type that the TOSCA orchestrator will use to create a relationship to relate this node to the target node when fulfilling the requirement.

node_filter

no

node filter

The optional filter definition that TOSCA orchestrators will use to select a type-compatible target node that can fulfill the requirement at runtime.

occurrences

no

integer

An optional keyname that sets the occurrences for this requirement. The sum of all occurrences’ values for all Requirement assignments with the same symbolic name must be within the range specified in the corresponding Requirement definition. If not defined, the assumed occurrences for an assignment is one (1).

The following is the list of recognized keynames for a TOSCA requirement assignment’s relationship keyname which is used when property assignments or interface assignments (for e.g. changing the implementation keyname or declare additional parameter definitions to be used as inputs/outputs) need to be provided: 

Keyname

Required

Type

Description

type

no

string

The optional keyname used to provide the name of the Relationship Type for the Requirement assignment’s relationship.

properties

no

map of

property assignments

An optional keyname providing property assignments for the relationship.

interfaces

no

map of

interface assignments

The optional keyname providing Interface assignments for the corresponding Interface definitions in the Relationship Type.

4.3.5.6.2 Grammar

Requirement assignments have one of the following grammars:

4.3.5.6.2.1     Short notation:

The following single-line grammar may be used if only a concrete Node Template for the target node needs to be declared in the requirement:

4.3.5.6.2.2     Extended notation:

The following grammar should be used if the requirement assignment needs to provide more information than just the Node Template name:

4.3.5.6.2.3     Extended grammar with Property Assignments and Interface Assignments for the relationship

The following additional multi-line grammar is provided for the relationship keyname in order to provide new Property assignments and Interface assignments for the created relationship of the declared Relationship.   

<requirement_name>:

  # Other keynames omitted for brevity

  relationship:

    type: <relationship_template_name> | <relationship_type_name>

    properties: <property_assignments>

    interfaces: <interface_assignments>

 

In the above grammars, the pseudo values that appear in angle brackets have the following meaning:

·         requirement_name: represents the symbolic name of a requirement assignment as a string.

·         capability_symbolic_name: represents the optional name of the Capability definition within the target Node Type or Node Template;

·         if the capability in the Requirement definition was specified using the symbolic name of a capability definition in a target node type, then the capability keyname definition MUST remain unchanged in any subsequent refinements or during assignment.

·         if the capability in the Requirement definition was specified using the name of a Capability Type, then the Capability definition referred here by the capability_symbolic_name must be of a type that is the same as or derived from the said Capability Type in the Requirement definition.

·         capability_type_name: represents the optional name of a Capability Type definition within the target Node Type or Node Template this requirement needs to form a relationship with;

·         may not be used if the capability in the Requirement definition was specified using the symbolic name of a capability definition in a target node type.

·         otherwise the capability_type_name must be of a type that is the same as or derived from the type defined by the capability keyname in the Requirement definition.

·         node_template_name: represents the optional name of a Node Template that contains the capability this requirement will be fulfilled by;

·         in addition, the Node Type of the Node Template must be of a type that is the same as or derived from the type defined by the node keyname (if the node keyname is defined) in the Requirement definition,

·         in addition, the Node Template must fulfill the node filter requirements of the node_filter (if a node_filter is defined) in the Requirement definition.

·         node_type_name: represents the optional name of a Node Type that contains the capability this Requirement will be fulfilled by;

·         in addition, the node_type_name must be of a type that is the same as or derived from the type defined by the node keyname (if the node keyname is defined) in the Requirement definition.

·         relationship_template_name: represents the optional name of a Relationship Template to be used when relating the Requirement to the Capability in the target node.

·         in addition, the Relationship Type of the Relationship Template must be of a type that is the same as or derived from the type defined by the relationship keyname (if the relationship keyname is defined) in the Requirement definition.

·         relationship_type_name: represents the optional name of a Relationship Type that is compatible with the Capability Type in the target node; the TOSCA orchestrator will create a relationship of the  Relationship Type when relating the Requirement to the Capability in the target node.

·         in addition, the relationship_type_name must be of a type that is the same as or derived from the type defined by the relationship keyname (if the relationship keyname is defined) in the Requirement definition.

·         property_assignments: represents the optional map of property assignments for the declared relationship.

·         interface_assignments: represents the optional map of interface assignments for the declared relationship used to provide parameter assignments on inputs and outputs of interfaces, operations and notifications or changing the implementation definition.

·         node_filter_definition: represents the optional node filter TOSCA orchestrators will use to fulfill the requirement for selecting a target node; if a node template was specified during requirement assignment, the TOSCA orchestrator verifies that the specified node template fulfills the node filter.

·         this node_filter does not replace the node_filter definition in the Requirement definition, it is applied in addition to that.

·         occurrences_value: represents the optional occurrences number that specifies to how many occurrences within the Requirement definition this particular assignment refers to.

·         in addition, the sum of all occurrences_value for all Requirement assignments with the same symbolic name must be within the range specified in the Requirement definition.

·         if not defined, the assumed occurrences_value for an assignment is one; i.e. the following default declaration will be assumed:

- occurrences: 1

4.3.5.6.3 Examples

Examples of uses for the extended requirement assignment grammar include:

·         The need to allow runtime selection of the target node a Node Type rather than a Node Template.  This may include use of the node_filter keyname to provide node and capability filtering information to find the “best match” of a node at runtime.

·         The need to further specify the Relationship Template or Relationship Type to use when relating the source node’s requirement to the target node’s capability.

·         The need to further specify the capability (symbolic) name or Capability Type in the target node to form a relationship between.

·         The need to specify the number of occurrences the requirement assigns (when greater than 1).

4.3.5.6.3.1     Example 1 – Hosting requirement on a Node Type

A web application node template named ‘my_application_node_template’ of type WebApplication declares a requirement named ‘host’ that needs to be fulfilled by any node that derives from the node type WebServer. 

# Example of a requirement fulfilled by a specific web server node template

node_templates:

  my_application_node_template:

    type: tosca.nodes.WebApplication

    ...

    requirements:

      - host:

          node: tosca.nodes.WebServer

In this case, the node template’s type is WebApplication which already declares the Relationship Type HostedOn to use to relate to the target node and the Capability Type of Container to be the specific target of the requirement in the target node.

4.3.5.6.3.2     Example 2 - Requirement with Node Template and a custom Relationship Type

This example is similar to the previous example; however, the requirement named ‘database’ describes a requirement for a connection to a database endpoint (Endpoint.Database) Capability Type in a node template (my_database). However, the connection requires a custom Relationship Type (my.types.CustomDbConnection’) declared on the keyname ‘relationship’.

# Example of a (database) requirement that is fulfilled by a node template named

# “my_database”, but also requires a custom database connection relationship

my_application_node_template:

  requirements:

    - database:

        node: my_database

        capability: Endpoint.Database

        relationship: my.types.CustomDbConnection

4.3.5.6.3.3     Example 3 - Requirement for a Compute node with additional selection criteria (filter)

This example shows how to extend an abstract ‘host’ requirement for a Compute node with a filter definition that further constrains TOSCA orchestrators to include additional properties and capabilities on the target node when fulfilling the requirement.

node_templates:

  mysql:

   type: tosca.nodes.DBMS.MySQL

    properties:

      # omitted here for brevity

    requirements:

      - host:

          node: tosca.nodes.Compute

          node_filter:

            capabilities:

              - host:

                  properties:

                    - num_cpus: { in_range: [ 1, 4 ] }

                    - mem_size: { greater_or_equal: 512 MB }

              - os:

                  properties:

                    - architecture: { equal: x86_64 }

                    - type: { equal: linux }

                    - distribution: { equal: ubuntu }

              - mytypes.capabilities.compute.encryption:

                  properties:

                    - algorithm: { equal: aes }

                    - keylength: { valid_values: [ 128, 256 ] }

4.3.5.6.3.4     Example 4 - Requirement assignment for definition with occurrences: [2,2]

This example shows how the assignments can look if the Requirement definition has the occurrences range different from the default [1,1]. In this case the redundant_database requirement has occurrences: [2,2]. The Requirement definition is not presented here for brevity. In the Requirement assignment we use the short notation. Note that the occurrences keyname for each assignment is not declared (i.e. the default value of 1 is used) and that the sum of the occurrences values of both assignments is 2 which is in the range of [2,2] as specified in the Requirement definition.

# Example of a (redundant_database) requirement that is fulfilled by

# two node templates named “database1” and “database1

my_critical_application_node_template:

  requirements:

    - redundant_database: database1

    - redundant_database: database2

 

4.3.5.7 Node Filter definition

A node filter defines criteria for selection of a target node based upon its property values, capabilities and capability properties.

4.3.5.7.1 Keynames

The following is the list of recognized keynames for a TOSCA node filter definition:

Keyname

Required

Type

Description

properties

no

list of

property filter definition

An optional list of property filters that will be used to select (filter) matching TOSCA entities (e.g., Node Template, Node Type, Capability Types, etc.) based upon their property definitions’ values.

capabilities

no

list of capability names or capability type names

An optional list of capability names or types that will be used to select (filter) matching TOSCA entities based upon their existence.

4.3.5.7.2 Additional filtering on capability properties

Capabilities used as filters often have their own sets of properties which also can be used to construct a filter.

Keyname

Required

Type

Description

  properties

 

(within a capability   name or type name)

no

list of

property filter definitions

An optional list of property filters that will be used to select (filter) matching TOSCA entities (e.g., Node Template, Node Type, Capability Types, etc.) based upon their capabilities’ property definitions’ values.

4.3.5.7.3 Grammar

Node filter definitions have following grammar:

node_filter:

  properties:

    - <property_filter_def_1>

    - ...

    - <property_filter_def_n>

  capabilities:

    - <capability_name_or_type_1>:

        properties:

          - <cap_1_property_filter_def_1>

          - ...

          - <cap_1_property_filter_def_n>

    -  ...

    - <capability_name_or_type_m>:

        properties:

          - <cap_m_property_filter_def_1>

          - ...

          - <cap_m_property_filter_def_n>

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         property_filter_def_*: represents a property filter definition that will be used to select (filter) matching TOSCA entities (e.g., Node Template, Node Type, Capability Types, etc.) based upon their property definitions’ values. 

·         capability_name_or_type_*: represents the type or name of a capability that will be used to select (filter) matching TOSCA entities based upon their existence.

·         cap_*_property_def_*: represents a property filter definition that will be used to select (filter) matching TOSCA entities (e.g., Node Template, Node Type, Capability Types, etc.) based upon their capabilities’ property definitions’ values.

4.3.5.7.4 Additional requirements

·         TOSCA orchestrators SHALL search for matching capabilities listed on a target filter by assuming the capability name is first a symbolic name and secondly it is a type name (in order to avoid namespace collisions).

4.3.5.7.5 Example

The following example is a filter that will be used to select a Compute node based upon the values of its defined capabilities. Specifically, this filter will select Compute nodes that support a specific range of CPUs (i.e., num_cpus value between 1 and 4) and memory size (i.e., mem_size of 2 or greater) from its declared “host” capability. 

                                                                                                     

my_node_template:

  # other details omitted for brevity

  requirements:

    - host:

        node_filter:

          capabilities:

            # My “host” Compute node needs these properties:     

            - host:

                properties:

                  - num_cpus: { in_range: [ 1, 4 ] }

                  - mem_size: { greater_or_equal: 512 MB }

 

4.3.5.8 Property Filter definition

A property filter definition defines criteria, using constraint clauses, for selection of a TOSCA entity based on its property values. Constraint clauses are further defined in Section Error! Reference source not found. Error! Reference source not found..

4.3.5.8.1 Grammar

Property filter definitions have one of the following grammars:

4.3.5.8.1.1     Short notation:

The following single-line grammar may be used when only a single constraint is needed on a property:

<property_name>: <property_constraint_clause>

4.3.5.8.1.2     Extended notation:

The following multi-line grammar may be used when multiple constraints are needed on a property:

<property_name>:

  - <property_constraint_clause_1>

  - ...

  - <property_constraint_clause_n>

In the above grammars, the pseudo values that appear in angle brackets have the following meaning:

·         property_name: represents the name of property that will be used to select a property definition with the same name (property_name) on a TOSCA entity (e.g., a Node Type, Node Template, Capability Type, etc.). 

·         property_constraint_clause_*: represents constraint clause(s) that will be used to filter entities based upon the named property’s value(s).

4.3.5.8.2 Additional Requirements

·         Property constraint clauses must be type compatible with the property definitions (of the same name) as defined on the target TOSCA entity that the clause will be applied against.

4.3.6 Interfaces

4.3.6.1 Interface Type

An Interface Type is a reusable entity that describes a set of operations that can be used to interact with or to manage a node or relationship in a TOSCA topology.

4.3.6.1.1 Keynames

The Interface Type is a TOSCA type entity and has the common keynames listed in Section 4.2.5.2 Common keynames in type definitions. In addition, the Interface Type has the following recognized keynames:

Keyname

Required

Type

Description

inputs

no

map of parameter definitions

The optional map of input parameter definitions available to all operations defined for this interface.

operations

no

map of operation definitions

The optional map of operations defined for this interface.

notifications

no

map of notification definitions

The optional map of notifications defined for this interface.

4.3.6.1.2 Grammar

Interface Types have following grammar:

<interface_type_name>:

  derived_from: <parent_interface_type_name>

  version: <version_number>

  metadata:

    <map of string>

  description: <interface_description>

  inputs:

    <parameter_definitions>

  operations:

    <operation_definitions>

  notifications:

    <Error! Reference source not found.Error! Reference source not found.notification_definitions>

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         interface_type_name: represents the required name of the interface as a string.

·         parent_interface_type_name: represents the name of the Interface Type this Interface Type definition derives from (i.e. its “parent” type).

·         version_number: represents the optional TOSCA version number for the Interface Type.

·         interface_description: represents the optional description for the Interface Type.

·         parameter_definitions: represents the optional map of parameter definitions which the TOSCA orchestrator will make available (i.e., or pass) to all implementation artifacts for operations declared on the interface during their execution.

·         operation_definitions: represents the optional map of one or more operation definitions.

·         notification_definitions: represents the optional map of one or more notification definitions.

4.3.6.1.3 Derivation rules

During Interface Type derivation the keyname definitions follow these rules:

·         inputs: existing parameter definitions may be refined; new parameter definitions may be added.

·         operations: existing operation definitions may be refined; new operation definitions may be added.

·         notifications: existing notification definitions may be refined; new notification definitions may be added.

4.3.6.1.4 Example

The following example shows a custom interface used to define multiple configure operations.

mycompany.mytypes.myinterfaces.MyConfigure:

  derived_from: tosca.interfaces.relationship.Root

  description: My custom configure Interface Type

  inputs:

    mode:

      type: string

  operations:

    pre_configure_service:

      description: pre-configure operation for my service

    post_configure_service:

      description: post-configure operation for my service

4.3.6.1.5 Additional Requirements

·         Interface Types MUST NOT include any implementations for defined operations or notifications; that is, the implementation keyname is invalid in this context.

4.3.6.2 Interface definition

An Interface definition defines an interface (containing operations and notifications definitions) that can be associated with (i.e. defined within) a Node or Relationship Type definition (including Interface definitions in Requirements definitions). An Interface definition may be refined in subsequent Node or Relationship Type derivations.

4.3.6.2.1 Keynames

The following is the list of recognized keynames for a TOSCA interface definition:

Keyname

Required

Type

Description

type

yes

string

The required name of the Interface Type this interface definition is based upon.

description

no

string

The optional description for this interface definition.

inputs

no

map of

parameter definitions and refinements

The optional map of input parameter refinements and new input parameter definitions available to all operations defined for this interface (the input parameters to be refined have been defined in the Interface Type definition).

operations

no

map of operation refinements

The optional map of operations refinements for this interface. The referred operations must have been defined in the Interface Type definition.

notifications

no

map of notification refinements

The optional map of notifications refinements for this interface. The referred operations must have been defined in the Interface Type definition.

4.3.6.2.2 Grammar

Interface definitions in Node or Relationship Type definitions have the following grammar:

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         interface_definition_name: represents the required symbolic name of the interface as a string.

·         interface_type_name: represents the required name of the Interface Type for the interface definition.

·         interface_description: represents the optional description string for the interface.

·         parameter_definitions_and_refinements: represents the optional map of input parameters which the TOSCA orchestrator will make available (i.e. pass) to all defined operations. This means these parameters and their values will be accessible to the implementation artifacts (e.g., scripts) associated to each operation during their execution

·         the map represents a mix of parameter refinements (for parameters already defined in the Interface Type) and new parameter definitions.

·         with the new parameter definitions, we can flexibly add new parameters when changing the implementation of operations and notifications during refinements or assignments.

·         operation_refinements: represents the optional map of operation definition refinements for this interface; the referred operations must have been previously defined in the Interface Type.

·         notification_refinements: represents the optional map of notification definition refinements for this interface; the referred notifications must have been previously defined in the Interface Type.

4.3.6.2.3 Refinement rules

An interface definition within a node or relationship type (including interface definitions in requirements definitions) uses the following definition refinement rules when the containing entity type is derived:

·         type: must be derived from (or the same as) the type in the interface definition in the parent entity type definition.

·         description: a new definition is unrestricted and will overwrite the one inherited from the interface definition in the parent entity type definition.

 

·         inputs: not applicable to the definitions in the parent entity type but to the definitions in the interface type referred by the type keyname (see grammar above for the rules).

·         operations: not applicable to the definitions in the parent entity type but to the definitions in the interface type referred by the type keyname (see grammar above for the rules).

·         notifications: not applicable to the definitions in the parent entity type but to the definitions in the interface type referred by the type keyname (see grammar above for the rules).

4.3.6.3 Interface assignment

An Interface assignment is used to specify assignments for the inputs, operations and notifications defined in the Interface. Interface assignments may be used within a Node or Relationship Template definition (including when Interface assignments are referenced as part of a Requirement assignment in a Node Template).

4.3.6.3.1 Keynames

The following is the list of recognized keynames for a TOSCA interface definition:

Keyname

Required

Type

Description

inputs

no

map of parameter value assignments

The optional map of input parameter assignments. Template authors MAY provide parameter assignments for interface inputs that are not defined in their corresponding Interface Type.

operations

no

map of operation assignments

The optional map of operations assignments specified for this interface.

notifications

no

map of notification assignments

The optional map of notifications assignments specified for this interface.

4.3.6.3.2 Grammar

Interface assignments have the following grammar:

<interface_definition_name>:

  inputs:

    <parameter_value_assignments>

  operations:

    <operation_assignments>

  notifications:

    <notification_assignments>

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         interface_definition_name: represents the required symbolic name of the interface as a string.

·         parameter_value_assignments: represents the optional map of parameter value assignments for passing input parameter values to all interface operations

·         template authors MAY provide new parameter assignments for interface inputs that are not defined in the Interface definition.

·         operation_assignments: represents the optional map of operation assignments for operations defined in the Interface definition.

·         notification_assignments: represents the optional map of notification assignments for notifications defined in the Interface definition.

4.3.6.4 Operation definition

An operation definition defines a function or procedure to which an operation implementation can be bound.

A new operation definition may be declared only inside interface type definitions (this is the only place where new operations can be defined). In interface type, node type, or relationship type definitions (including operation definitions as part of a requirement definition) we may further refine operations already defined in an interface type.

An operation definition or refinement inside an interface type definition may not contain an operation implementation definition and it may not contain an attribute mapping as part of its output definition (as both these keynames are node/relationship specific).

4.3.6.4.1 Keynames

The following is the list of recognized keynames for a TOSCA operation definition (including definition refinement)

Keyname

Required

Type

Description

description

no

string

The optional description string for the associated operation.

implementation

no

operation implementation definition

The optional definition of the operation implementation. May not be used in an interface type definition (i.e. where an operation is initially defined), but only during refinements.

inputs

no

map of

parameter definitions

The optional map of parameter definitions for operation input values.

outputs

no

map of

parameter definitions

The optional map of parameter definitions for operation output values.

Only as part of node and relationship type definitions, the output definitions may include mappings onto attributes of the node or relationship type that contains the definition.

4.3.6.4.2 Grammar

Operation definitions have the following grammar:

4.3.6.4.2.1     Short notation

The following single-line grammar may be used when the operation’s implementation definition is the only keyname that is needed, and when the operation implementation definition itself can be specified using a single line grammar:

4.3.6.4.2.2     Extended notation

The following multi-line grammar may be used when additional information about the operation is needed:

<operation_name>:

   description: <operation_description>

   implementation: <operation_implementation_definition>

   inputs:

     <parameter_definitions>

   outputs:

     <parameter_definitions>

In the above grammars, the pseudo values that appear in angle brackets have the following meaning:

·         operation_name: represents the required symbolic name of the operation as a string.

·         operation_description: represents the optional description string for the operation.

·         operation_implementation_definition: represents the optional specification of the operation’s implementation).

·         parameter_definitions: represents the optional map of parameter definitions which the TOSCA orchestrator will make available as inputs to or receive as outputs from the corresponding implementation artifact during its execution.

4.3.6.4.3 Refinement rules

An operation definition within an interface, node, or relationship type (including interface definitions in requirements definitions) uses the following refinement rules when the containing entity type is derived:

·         description: a new definition is unrestricted and will overwrite the one inherited from the operation definition in the parent entity type definition.

·         implementation: a new definition is unrestricted and will overwrite the one inherited from the operation definition in the parent entity type definition.

·         inputs: parameter definitions inherited from the parent entity type may be refined; new parameter definitions may be added.

·         outputs: parameter definitions inherited from the parent entity type may be refined; new parameter definitions may be added.

4.3.6.4.4 Additional requirements

·         The definition of implementation is not allowed in interface type definitions (as a node or node type context is missing at that point). Thus, it can be part only of an operation refinement and not of the original operation definition.

·         The default refinement behavior for implementations SHALL be overwrite. That is, implementation definitions in a derived type overwrite any defined in its parent type.

·         Defining a fixed value for an input parameter (as part of its definition) may only use a parameter_value_expression that is meaningful in the scope of the context. For example, within the context of an Interface Type definition functions such as get_propery or get_attribute cannot be used. Within the context of Node or Relationship Type definitions, these functions may only reference properties and attributes of the same node (i.e. SELF), respectively same relationship or its target (i.e. SELF or TARGET). For example, value: { get_property: [SELF, property1] }

·         Defining attribute mapping as part of the output parameter definition is not allowed in interface type definitions (i.e. as part of operation definitions). It is allowed only in node and relationship type definitions (as part of operation refinements) and has to be meaningful in the scope of the context (i.e. SELF in node types and SELF or TARGET in relationship types).

·         Implementation artifact file names (e.g., script filenames) may include file directory path names that are relative to the TOSCA service template file itself when packaged within a TOSCA Cloud Service Archive (CSAR) file.

4.3.6.4.5 Examples
4.3.6.4.5.1     Single-line example

interfaces:

  Standard:

    start: scripts/start_server.sh

4.3.6.4.5.2     Multi-line example with shorthand implementation definitions

interfaces:

  Configure:

    pre_configure_source:

      implementation:

        primary: scripts/pre_configure_source.sh

        dependencies:

          - scripts/setup.sh

          - binaries/library.rpm

          - scripts/register.py

4.3.6.4.5.3     Multi-line example with extended implementation definitions

interfaces:

  Configure:

    pre_configure_source:

      implementation:

        primary:

          file: scripts/pre_configure_source.sh

          type: tosca.artifacts.Implementation.Bash

          repository: my_service_catalog

        dependencies:

           - file : scripts/setup.sh

             type : tosca.artifacts.Implementation.Bash

             repository : my_service_catalog

 

4.3.6.5 Operation assignment

An operation assignment may be used to assign values for input parameters, specify attribute mappings for output parameters, and define/redefine the implementation definition of an already defined operation in the interface definition. An operation assignment may be used inside interface assignments inside node template or relationship template definitions (this includes when operation assignments are part of a requirement assignment in a node template).

An operation assignment may add or change the implementation and description definition of the operation. Assigning a value to an input parameter that had a fixed value specified during operation definition or refinement is not allowed. Providing an attribute mapping for an output parameter that was mapped during an operation refinement is also not allowed.

Note also that in the operation assignment we can use inputs and outputs that have not been previously defined in the operation definition. This is equivalent to an ad-hoc definition of a parameter, where the type is inferred from the assigned value (for input parameters) or from the attribute to map to (for output parameters).

4.3.6.5.1 Keynames

The following is the list of recognized keynames for an operation assignment:

Keyname

Required

Type

Description

implementation

no

operation implementation definition

The optional definition of the operation implementation. Overrides implementation provided at operation definition.

inputs

no

map of parameter value assignments

The optional map of parameter value assignments for assigning values to operation inputs.

outputs

no

map of parameter

mapping assignments

The optional map of parameter mapping assignments that specify how operation outputs are mapped onto attributes of the node or relationship that contains the operation definition.

4.3.6.5.2 Grammar

Operation assignments have the following grammar:

4.3.6.5.2.1     Short notation

The following single-line grammar may be used when the operation’s implementation definition is the only keyname that is needed, and when the operation implementation definition itself can be specified using a single line grammar:

4.3.6.5.2.2     Extended notation

The following multi-line grammar may be used in Node or Relationship Template definitions when additional information about the operation is needed:

<operation_name>:

   implementation: <operation_implementation_definition>

   inputs:

     <parameter_value_assignments>

   outputs:

     <parameter_mapping_assignments>

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         operation_name: represents the required symbolic name of the operation as a string.

·         operation_implementation_definition: represents the optional specification of the operation’s implementation

·         the implementation declared here overrides the implementation provided at operation definition.

·         parameter_value_assignments: represents the optional map of parameter value assignments for passing input parameter values to operations.

·         assignments for operation inputs that are not defined in the operation definition may be provided

·         parameter_mapping_assignments: represents the optional map of parameter mapping assignments that consists of named output values returned by operation implementations (i.e. artifacts) and associated attributes into which this output value must be stored

·         assignments for operation outputs that are not defined in the operation definition may be provided.

4.3.6.5.3 Additional requirements

·         The behavior for implementation of operations SHALL be override. That is, implementation definitions assigned in an operation assignment override any defined in the operation definition.

·         Template authors MAY provide parameter assignments for operation inputs that are not defined in the operation definition.

·         Template authors MAY provide attribute mappings for operation outputs that are not defined in the operation definition.

·         Implementation artifact file names (e.g., script filenames) may include file directory path names that are relative to the TOSCA service template file itself when packaged within a TOSCA Cloud Service Archive (CSAR) file.

4.3.6.5.4 Examples

TBD

4.3.6.6 Notification definition

A notification definition defines an asynchronous notification or incoming message that can be associated with an interface. The notification is a way for an external event to be transmitted to the TOSCA orchestrator. Values can be sent with a notification as notification outputs and we can map them to node/relationship attributes similarly to the way operation outputs are mapped to attributes. The artifact that the orchestrator is registering with in order to receive the notification is specified using the implementation keyname in a similar way to operations. As opposed to an operation definition, a notification definition does not include an inputs keyname since notifications are not invoked from the orchestrator.

When the notification is received an event is generated within the orchestrator that can be associated to triggers in policies to call other internal operations and workflows. The notification name (the unqualified full name) itself identifies the event type that is generated and can be textually used when defining the associated triggers.

A notification definition may be used only inside interface type definitions (this is the only place where new notifications can be defined). Inside interface type, node type, or relationship type definitions (including notifications definitions as part of a requirement definition) we may further refine a notification already defined in the interface type.

A notification definition or refinement inside an interface type definition may not contain a notification implementation definition and it may not contain an attribute mapping as part of its output definition (as both these keynames are node/relationship specific).

4.3.6.6.1 Keynames

The following is the list of recognized keynames for a TOSCA notification definition:

Keyname

Required

Type

Description

description

no

string

The optional description string for the associated notification.

implementation

no

notification implementation definition

The optional definition of the notification implementation.

outputs

no

map of parameter definitions

The optional map of parameter definitions that specify notification output values.

Only as part of node and relationship type definitions, the output definitions may include their mappings onto attributes of the node type or relationship type that contains the definition.

4.3.6.6.2 Grammar

Notification definitions have the following grammar:

4.3.6.6.2.1     Short notation

The following single-line grammar may be used when the notification’s implementation definition is the only keyname that is needed and when the notification implementation definition itself can be specified using a single line grammar:

4.3.6.6.2.2     Extended notation

The following multi-line grammar may be used when additional information about the notification is needed:

<notification_name>:

  description: <notification_description>

  implementation: <notification_implementation_definition>

  outputs:

    <parameter_definitions>

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         notification_name: represents the required symbolic name of the notification as a string.

·         notification_description: represents the optional description string for the notification.

·         notification_implementation_definition: represents the optional specification of the notification implementation (i.e. the external artifact that may send notifications)

·         parameter_definitions: represents the optional map of parameter definitions for parameters that the orchestrator will receive as outputs from the corresponding implementation artifact during its execution.

4.3.6.6.3 Refinement rules

A notification definition within an interface, node, or relationship type (including interface definitions in requirements definitions) uses the following refinement rules when the containing entity type is derived:

·         description: a new definition is unrestricted and will overwrite the one inherited from the notification definition in the parent entity type definition.

·         implementation: a new definition is unrestricted and will overwrite the one inherited from the notification definition in the parent entity type definition.

·         outputs: parameter definitions inherited from the parent entity type may be refined; new parameter definitions may be added.

4.3.6.6.4 Additional requirements

·         The definition of implementation is not allowed in interface type definitions (as a node or node type context is missing at that point). Thus, it can be part only of a notification refinement and not of the original notification definition.

·         The default sub-classing (i.e. refinement) behavior for implementations of notifications SHALL be overwrite.  That is, implementation artifacts definitions in a derived type overwrite any defined in its parent type.

·         Defining attribute mapping as part of the output parameter definition is not allowed in interface type definitions (i.e. as part of operation definitions). It is allowed only in node and relationship type definitions (as part of operation refinements).

·         Defining a mapping in an output parameter definition may use an attribute target that is meaningful in the scope of the context. Within the context of Node Type definitions these functions may only reference attributes of the same node (i.e. SELF). Within the context of Relationship Type definitions, they may reference attributes of the relationship itself or its target node (i.e. SELF or TARGET).

·         Implementation artifact file names (e.g., script filenames) may include file directory path names that are relative to the TOSCA service template file itself when packaged within a TOSCA Cloud Service Archive (CSAR) file.

4.3.6.6.5 Examples

TBD

4.3.6.7 Notification assignment

A notification assignment may be used to specify attribute mappings for output parameters and to define/redefine the implementation definition and description definition of an already defined notification in the interface definition. A notification assignment may be used inside interface assignments inside node or relationship template definitions (this includes when notification assignments are part of a requirement assignment in a node template).

Providing an attribute mapping for an output parameter that was mapped during a previous refinement is not allowed. Note also that in the notification assignment we can use outputs that have not been previously defined in the operation definition. This is equivalent to an ad-hoc definition of an output parameter, where the type is inferred from the attribute to map to.

4.3.6.7.1 Keynames

The following is the list of recognized keynames for a TOSCA notification assignment:

Keyname

Required

Type

Description

implementation

no

notification implementation definition

The optional definition of the notification implementation. Overrides implementation provided at notification definition.

outputs

no

map of parameter

mapping assignments

The optional map of parameter mapping assignments that specify how notification outputs values are mapped onto attributes of the node or relationship type that contains the notification definition.

4.3.6.7.2 Grammar

Notification assignments have the following grammar:

4.3.6.7.2.1     Short notation

The following single-line grammar may be used when the notification’s implementation definition is the only keyname that is needed, and when the notification implementation definition itself can be specified using a single line grammar:

4.3.6.7.2.2     Extended notation

The following multi-line grammar may be used in Node or Relationship Template definitions when additional information about the notification is needed:

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         notification_name: represents the required symbolic name of the notification as a string.

·         notification_implementation_definition: represents the optional specification of the notification implementation (i.e. the external artifact that is may send notifications)

·         the implementation declared here overrides the implementation provided at notification definition.

·         parameter_mapping_assignments: represents the optional map of parameter_mapping_assignments that consists of named output values returned by operation implementations (i.e. artifacts) and associated attributes into which this output value must be stored

·         assignments for notification outputs that are not defined in the operation definition may be provided.

4.3.6.7.3 Additional requirements

·         The behavior for implementation of notifications SHALL be override. That is, implementation definitions assigned in a notification assignment override any defined in the notification definition.

·         Template authors MAY provide attribute mappings for notification outputs that are not defined in the corresponding notification definition.

·         Implementation artifact file names (e.g., script filenames) may include file directory path names that are relative to the TOSCA service template file itself when packaged within a TOSCA Cloud Service Archive (CSAR) file.

4.3.6.7.4 Examples

TBD

4.3.6.8 Operation and notification implementation definition

An operation implementation definition specifies one or more artifacts (e.g. scripts) to be used as the implementation for an operation in an interface.

A notification implementation definition specifies one or more artifacts to be used by the orchestrator to subscribe and receive a particular notification (i.e. the artifact implements the notification).

The operation implementation definition and the notification implementation definition share the same keynames and grammar, with the exception of the timeout keyname that has no meaning in the context of a notification implementation definition and should not be used in such.

4.3.6.8.1 Keynames

The following is the list of recognized keynames for an operation implementation definition or a notification implementation definition:

Keyname

Required

Type

Description

primary

no

artifact definition

The optional implementation artifact (i.e., the primary script file within a TOSCA CSAR file). 

dependencies

no

list of

artifact definition

The optional list of one or more dependent or secondary implementation artifacts which are referenced by the primary implementation artifact (e.g., a library the script installs or a

secondary script). 

timeout

no

integer

Timeout value in seconds. Has no meaning and should not be used within a notification implementation definition.

4.3.6.8.2 Grammar

Operation implementation definitions and notification implementation definitions have the following grammar:

4.3.6.8.2.1     Short notation for use with single artifact

The following single-line grammar may be used when only a primary implementation artifact name is needed:

This notation can be used when the primary artifact name uniquely identifies the artifact, either because it refers to an artifact specified in the artifacts section of a type or template, or because it represents the name of a script in the CSAR file that contains the definition.

4.3.6.8.2.2     Short notation for use with multiple artifacts

The following multi-line short-hand grammar may be used when multiple artifacts are needed, but each of the artifacts can be uniquely identified by name as before:

implementation:

  primary: <primary_artifact_name>

  dependencies:

    - <list_of_dependent_artifact_names>

  timeout: 60

4.3.6.8.2.3     Extended notation for use with single artifact

The following multi-line grammar may be used in Node or Relationship Type or Template definitions when only a single artifact is used but additional information about the primary artifact is needed (e.g. to specify the repository from which to obtain the artifact, or to specify the artifact type when it cannot be derived from the artifact file extension):

implementation:

  primary:

    <primary_artifact_definition>

  timeout: 100

4.3.6.8.2.4     Extended notation for use with multiple artifacts

The following multi-line grammar may be used in Node or Relationship Type or Template definitions when there are multiple artifacts that may be needed for the operation to be implemented and additional information about each of the artifacts is required:

implementation:

  primary:

    <primary_artifact_definition>  

  dependencies:

    - <list_of_dependent_artifact definitions>

  timeout: 120

In the above grammars, the pseudo values that appear in angle brackets have the following meaning:

·         primary_artifact_name: represents the optional name (string) of an implementation artifact definition (defined elsewhere), or the direct name of an implementation artifact’s relative filename (e.g., a service template-relative, path-inclusive filename or absolute file location using a URL).

·         primary_artifact_definition: represents a full inline definition of an implementation artifact.

·         list_of_dependent_artifact_names: represents the optional ordered list of one or more dependent or secondary implementation artifact names (as strings) which are referenced by the primary implementation artifact.  TOSCA orchestrators will copy these files to the same location as the primary artifact on the target node so as to make them accessible to the primary implementation artifact when it is executed.

·         list_of_dependent_artifact_definitions: represents the ordered list of one or more inline definitions of dependent or secondary implementation artifacts. TOSCA orchestrators will copy these artifacts to the same location as the primary artifact on the target node so as to make them accessible to the primary implementation artifact when it is executed.

4.3.7 Artifacts

4.3.7.1 Artifact Type

An Artifact Type is a reusable entity that defines the type of one or more files that are used to define implementation or deployment artifacts that are referenced by nodes or relationships.

4.3.7.1.1 Keynames

The Artifact Type is a TOSCA type entity and has the common keynames listed in Section 4.2.5.2 Common keynames in type definitions. In addition, the Artifact Type has the following recognized keynames:

Keyname

Required

Type

Constraints

Description

mime_type

no

string

None

The required mime type property for the Artifact Type.

file_ext

no

list of string

None

The required file extension property for the Artifact Type.

properties

no

map of

property definitions

No

An optional map of property definitions for the Artifact Type.

4.3.7.1.2 Grammar

Artifact Types have following grammar:

<artifact_type_name>:

  derived_from: <parent_artifact_type_name>

  version: <version_number>

  metadata:

    <map of string>

  description: <artifact_description>

  mime_type: <mime_type_string>

  file_ext: [ <file_extensions> ]

  properties:    

    <property_definitions>

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         artifact_type_name: represents the name of the Artifact Type being declared as a string.

·         parent_artifact_type_name: represents the name of the Artifact Type this Artifact Type definition derives from (i.e., its “parent” type).

·         version_number: represents the optional TOSCA version number for the Artifact Type.

·         artifact_description: represents the optional description string for the Artifact Type.

·         mime_type_string: represents the optional Multipurpose Internet Mail Extensions (MIME) standard string value that describes the file contents for this type of Artifact Type as a string.

·         file_extensions: represents the optional list of one or more recognized file extensions for this type of artifact type as strings.

·         property_definitions: represents the optional map of property definitions for the artifact type.

4.3.7.1.3 Derivation rules

During Artifact Type derivation the keyname definitions follow these rules:

·         mime_type: a new definition is unrestricted and will overwrite the one inherited from the parent type.

·         file_ext: a new definition is unrestricted and will overwrite the one inherited from the parent type.

·         properties: existing property definitions may be refined; new property definitions may be added.

4.3.7.1.4 Examples

my_artifact_type:

  description: Java Archive artifact type

  derived_from: tosca.artifact.Root

  mime_type: application/java-archive

  file_ext: [ jar ]

  properties:

    id:

      description: Identifier of the jar

      type: string

      required: true

    creator:

      description: Vendor of the java implementation on which the jar is based

      type: string

      required: false

4.3.7.1.5 Additional Requirements

·         The ‘mime_type’ keyname  is meant to have values that are Apache mime types such as those defined here: http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types

4.3.7.1.6 Notes

Information about artifacts can be broadly classified in two categories that serve different purposes:

·         Selection of artifact processor. This category includes informational elements such as artifact version, checksum, checksum algorithm etc. and s used by TOSCA Orchestrator to select the correct artifact processor for the artifact. These informational elements are captured in TOSCA as keywords for the artifact.

·         Properties processed by artifact processor. Some properties are not processed by the Orchestrator but passed on to the artifact processor to assist with proper processing of the artifact. These informational elements are described through artifact properties.

4.3.7.2 Artifact definition

An artifact definition defines a named, typed file that can be associated with Node Type or Node Template and used by orchestration engine to facilitate deployment and implementation of interface operations.

4.3.7.2.1 Keynames

The following is the list of recognized keynames for a TOSCA artifact definition when using the extended notation:

Keyname

Required

Type

Description

type

yes

string

The required artifact type for the artifact definition.

file

yes

string

The required URI string (relative or absolute) which can be used to locate the artifact’s file.

repository

no

string

The optional name of the repository definition which contains the location of the external repository that contains the artifact.  The artifact is expected to be referenceable by its file URI within the repository.

description

no

string

The optional description for the artifact definition.

deploy_path

no

string

The file path the associated file will be deployed on within the target node’s container.

artifact_version

no

string

The version of this artifact. One use of this artifact_version is to declare the particular version of this artifact type, in addition to its mime_type (that is declared in the artifact type definition). Together with the mime_type it may be used to select a particular artifact processor for this artifact. For example, a python interpreter that can interpret python version 2.7.0.

checksum

no

string

The checksum used to validate the integrity of the artifact.

checksum_algorithm

no

string

Algorithm used to calculate the artifact checksum (e.g. MD5, SHA [Ref]). Shall be specified if checksum is specified for an artifact.

 

properties

no

map of

property

assignments

The optional map of property assignments associated with the artifact.

4.3.7.2.2 Grammar

Artifact definitions have one of the following grammars:

4.3.7.2.2.1     Short notation

The following single-line grammar may be used when the artifact’s type and mime type can be inferred from the file URI:

4.3.7.2.2.2     Extended notation:

The following multi-line grammar may be used when the artifact’s definition’s type and mime type need to be explicitly declared:

<artifact_name>:

  description: <artifact_description>

  type: <artifact_type_name>

  file: <artifact_file_URI>

  repository: <artifact_repository_name>

  deploy_path: <file_deployment_path>

  version: <artifact _version>

  checksum: <artifact_checksum>

  checksum_algorithm: <artifact_checksum_algorithm>

  properties: <property assignments>

In the above grammars, the pseudo values that appear in angle brackets have the following meaning:

·         artifact_name: represents the required symbolic name of the artifact as a string.

·         artifact_description: represents the optional description for the artifact.

·         artifact_type_name: represents the required artifact type the artifact definition is based upon.

·         artifact_file_URI: represents the required URI string (relative or absolute) which can be used to locate the artifact’s file.

·         artifact_repository_name: represents the optional name of the repository definition to use to retrieve the associated artifact (file) from.

·         file_deployement_path: represents the optional path the artifact_file_URI will be copied into within the target node’s container.

·         artifact_version: represents the version of artifact

·         artifact_checksum: represents the checksum of the Artifact

·         artifact_checksum_algorithm:represents the algorithm for verifying the checksum. Shall be specified if checksum is specified

·         properties: represents an optional map of property assignments associated with the artifact

4.3.7.2.3 Refinement rules

Artifact definitions represent specific external entities. If a certain artifact definition cannot be reused as is, then it may be completely redefined.

·         If an artifact is redefined, the symbolic name from the definition in the parent node type is reused, but no keyname definitions are inherited from the definition in the parent node type, and the new definition completely overwrites the definition in the parent.

·         If the artifact is not redefined the complete definition is inherited from the parent node type.

4.3.7.2.4 Examples

The following represents an artifact definition:

my_file_artifact: ../my_apps_files/operation_artifact.txt

The following example represents an artifact definition with property assignments:

artifacts:

  sw_image:

    description: Image for virtual machine

    type: tosca.artifacts.Deployment.Image.VM

    file: http://10.10.86.141/images/Juniper_vSRX_15.1x49_D80_preconfigured.qcow2

    checksum: ba411cafee2f0f702572369da0b765e2

    version: 3.2

    checksum_algorithm: MD5

    properties:

      name: vSRX

      container_format: BARE

      disk_format: QCOW2

      min_disk: 1 GB

      size: 649 MB

 

4.4 Properties, Attributes, and Parameters

This section presents data handling in TOSCA via properties, attributes and parameters. The type of the values they contain can be divided in primitive types (either referenced from YAML or defined in TOSCA) or complex data types that can be defined themselves in the TOSCA service template.

4.4.1 Primitive types

This clause describes the primitive types that are used for declaring normative properties, parameters and grammar elements throughout this specification.

4.4.1.1 Referenced YAML Types

Many of the types we use in this profile are built-in types from the YAML 1.2 specification (i.e., those identified by the “tag:yaml.org,2002” version tag) [YAML-1.2].

The following table declares the valid YAML type URIs and aliases that SHALL be used when possible when defining parameters or properties within TOSCA Service Templates using this specification:

Valid aliases

Type URI

string

tag:yaml.org,2002:str (default)

integer

tag:yaml.org,2002:int

float

tag:yaml.org,2002:float

boolean

tag:yaml.org,2002:bool (i.e., a value either ‘true’ or ‘false’)

timestamp

tag:yaml.org,2002:timestamp  [YAML-TS-1.1]

null

tag:yaml.org,2002:null

4.4.1.1.1 Notes

·         The “string” type is the default type when not specified on a parameter or property declaration.

·         While YAML supports further type aliases, such as “str” for “string”, the TOSCA specification promotes the fully expressed alias name for clarity.

 

4.4.1.2 TOSCA version

TOSCA supports the concept of “reuse” of type definitions, as well as template definitions which could be version and change over time.  It is important to provide a reliable, normative means to represent a version string which enables the comparison and management of types and templates over time. Therefore, the TOSCA TC intends to provide a normative version type (string) for this purpose in future Working Drafts of this specification.

Shorthand Name

version

Type Qualified Name

tosca:version

4.4.1.2.1 Grammar

TOSCA version strings have the following grammar:

<major_version>.<minor_version>[.<fix_version>[.<qualifier>[-<build_version] ] ]

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         major_version: is a required integer value greater than or equal to 0 (zero)

·         minor_version: is a required integer value greater than or equal to 0 (zero).

·         fix_version: is an optional integer value greater than or equal to 0 (zero).

·         qualifier: is an optional string that indicates a named, pre-release version of the associated code that has been derived from the version of the code identified by the combination major_version, minor_version and fix_version numbers.

·         build_version: is an optional integer value greater than or equal to 0 (zero) that can be used to further qualify different build versions of the code that has the same qualifer_string.

4.4.1.2.2 Version Comparison

·         When comparing TOSCA versions, all component versions (i.e., major, minor and fix) are compared in sequence from left to right.

·         TOSCA versions that include the optional qualifier are considered older than those without a qualifier.

·         TOSCA versions with the same major, minor, and fix versions and have the same qualifier string, but with different build versions can be compared based upon the build version.

·         Qualifier strings are considered domain-specific. Therefore, this specification makes no recommendation on how to compare TOSCA versions with the same major, minor and fix versions, but with different qualifiers strings and simply considers them different branches derived from the same code.

4.4.1.2.3 Examples

Examples of valid TOSCA version strings:

# basic version strings

6.1

2.0.1

 

# version string with optional qualifier

3.1.0.beta

 

# version string with optional qualifier and build version

1.0.0.alpha-10

4.4.1.2.4 Notes

·         [Maven-Version] The TOSCA version type is compatible with the Apache Maven versioning policy.

4.4.1.2.5 Additional Requirements

·         A version value of zero (i.e., ‘0’, ‘0.0’, or ‘0.0.0’) SHALL indicate there no version provided.

·         A version value of zero used with any qualifiers SHALL NOT be valid.

4.4.1.3 TOSCA range type

The range type can be used to define numeric ranges with a lower and upper boundary. For example, this allows for specifying a range of ports to be opened in a firewall.

Shorthand Name

range

Type Qualified Name

tosca:range

4.4.1.3.1 Grammar

TOSCA range values have the following grammar:

[<lower_bound>, <upper_bound>]  

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         lower_bound: is a required integer value that denotes the lower boundary of the range.

·         upper_bound: is a required integer value that denotes the upper boundary of the range. This value MUST be greater than or equal to lower_bound.

4.4.1.3.2 Keywords

The following Keywords may be used in the TOSCA range type:

Keyword

Applicable Types

Description

UNBOUNDED

scalar

Used to represent an unbounded upper bounds (positive) value in a set for a scalar type.

4.4.1.3.3 Examples

Example of a node template property with a range value:

# numeric range between 1 and 100

a_range_property: [ 1, 100 ]

 

# a property that has allows any number 0 or greater

num_connections: [ 0, UNBOUNDED ]

 

4.4.1.4 TOSCA list type

The list type allows for specifying multiple values for a parameter of property. For example, if an application allows for being configured to listen on multiple ports, a list of ports could be configured using the list data type.

Note that entries in a list for one property or parameter must be of the same type. The type (for simple entries) or schema (for complex entries) is defined by the entry_schema attribute of the respective property definition, attribute definitions, or input or output parameter definitions.

Shorthand Name

list

Type Qualified Name

tosca:list

4.4.1.4.1 Grammar

TOSCA lists are essentially normal YAML lists with the following grammars:

4.4.1.4.1.1      Square bracket notation

 [ <list_entry_1>, <list_entry_2>, ... ]

4.4.1.4.1.2     Bulleted list notation

- <list_entry_1>

- ...

- <list_entry_n>

In the above grammars, the pseudo values that appear in angle brackets have the following meaning:

·         <list_entry_*>: represents one entry of the list.

4.4.1.4.2 Declaration Examples
4.4.1.4.2.1     List declaration using a simple type

The following example shows a list declaration with an entry schema based upon a simple integer type (which has additional constraints):

<some_entity>:

  ...

  properties: 

    listen_ports:

      type: list

      entry_schema:

        description: listen port entry (simple integer type)

        type: integer

        constraints:

          - max_length: 128

4.4.1.4.2.2     List declaration using a complex type

The following example shows a list declaration with an entry schema based upon a complex type:

<some_entity>:

  ...

  properties: 

    products:

      type: list

      entry_schema:

        description: Product information entry (complex type) defined elsewhere

        type: ProductInfo

4.4.1.4.3 Definition Examples

These examples show two notation options for defining lists:

·         A single-line option which is useful for only short lists with simple entries.

·         A multi-line option where each list entry is on a separate line; this option is typically useful or more readable if there is a large number of entries, or if the entries are complex.

4.4.1.4.3.1     Square bracket notation

listen_ports: [ 80, 8080 ]

4.4.1.4.3.2     Bulleted list notation

listen_ports:

  - 80

  - 8080

4.4.1.5 TOSCA map type

The map type allows for specifying multiple values for a parameter of property as a map. In contrast to the list type, where each entry can only be addressed by its index in the list, entries in a map are named elements that can be addressed by their keys.

Note that entries in a map for one property or parameter must be of the same type. The type (for simple entries) or schema (for complex entries) is defined by the entry_schema attribute of the respective property definition, attribute definition, or input or output parameter definition. In addition, the keys that identify entries in a map must be of the same type as well. The type of these keys is defined by the key_schema attribute of the respective property_definition, attribute_definition, or input or output parameter_definition. If the key_schema is not specified, keys are assumed to be of type string.

Shorthand Name

map

Type Qualified Name

tosca:map

4.4.1.5.1 Grammar

TOSCA maps are normal YAML dictionaries with following grammar:

4.4.1.5.1.1     Single-line grammar

{ <entry_key_1>: <entry_value_1>, ..., <entry_key_n>: <entry_value_n> }

4.4.1.5.1.2     Multi-line grammar

<entry_key_1>: <entry_value_1>

...

<entry_key_n>: <entry_value_n>

In the above grammars, the pseudo values that appear in angle brackets have the following meaning:

·         entry_key_*: is the required key for an entry in the map

·         entry_value_*: is the value of the respective entry in the map

4.4.1.5.2 Declaration Examples
4.4.1.5.2.1     Map declaration using a simple type

The following example shows a map with an entry schema definition based upon an existing string type (which has additional constraints):

<some_entity>:

  ...

  properties: 

    emails:

      type: map

      entry_schema:

        description: basic email address

        type: string

        constraints:

          - max_length: 128

4.4.1.5.2.2     Map declaration using a complex type

The following example shows a map with an entry schema definition for contact information:

<some_entity>:

  ...

  properties: 

    contacts:

      type: map

      entry_schema:

        description: simple contact information

        type: ContactInfo

4.4.1.5.3 Definition Examples

These examples show two notation options for defining maps:

·         A single-line option which is useful for only short maps with simple entries.

·         A multi-line option where each map entry is on a separate line; this option is typically useful or more readable if there is a large number of entries, or if the entries are complex.

4.4.1.5.3.1     Single-line notation

# notation option for shorter maps

user_name_to_id_map: { user1: 1001, user2: 1002 }

4.4.1.5.3.2     Multi-line notation

# notation for longer maps

user_name_to_id_map:

  user1: 1001

  user2: 1002

4.4.1.6 TOSCA scalar-unit type

The scalar-unit type can be used to define scalar values along with a unit from the list of recognized units provided below.

4.4.1.6.1 Grammar

TOSCA scalar-unit typed values have the following grammar:

<scalar> <unit>  

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         scalar: is a required scalar value.

·         unit: is a required unit value. The unit value MUST be type-compatible with the scalar.

4.4.1.6.2 Additional requirements

·         Whitespace: any number of spaces (including zero or none) SHALL be allowed between the scalar value and the unit value.

·         It SHALL be considered an error if either the scalar or unit portion is missing on a property or attribute declaration derived from any scalar-unit type.

·         When performing constraint clause evaluation on values of the scalar-unit type, both the scalar value portion and unit value portion SHALL be compared together (i.e., both are treated as a single value). For example, if we have a property called storage_size (which is of type scalar-unit) a valid range constraint would appear as follows:

      storage_size: in_range [ 4 GB, 20 GB ]

where storage_size’s range will be evaluated using both the numeric and unit values (combined together), in this case ‘4 GB’ and ’20 GB’.

4.4.1.6.3 Concrete Types

Shorthand Names

scalar-unit.size, scalar-unit.time, scalar-unit.frequency, scalar-unit.bitrate

Type Qualified Names

tosca:scalar-unit.size, tosca:scalar-unit.time

 

The scalar-unit type grammar is abstract and has four recognized concrete types in TOSCA:

·         scalar-unit.size – used to define properties that have scalar values measured in size units.

·         scalar-unit.time – used to define properties that have scalar values measured in size units.

·         scalar-unit.frequency – used to define properties that have scalar values measured in units per second.

·         scalar-unit.bitrate – used to define properties that have scalar values measured in bits or bytes per second

These types and their allowed unit values are defined below.

4.4.1.6.4 scalar-unit.size
4.4.1.6.4.1     Recognized Units

Unit

Usage

Description

B

size

byte

kB

size

kilobyte (1000 bytes)

KiB

size

kibibytes (1024 bytes)

MB

size

megabyte (1000000 bytes)

MiB

size

mebibyte (1048576 bytes)

GB

size

gigabyte (1000000000 bytes)

GiB

size

gibibytes (1073741824 bytes)

TB

size

terabyte (1000000000000 bytes)

TiB

size

tebibyte (1099511627776 bytes)

4.4.1.6.4.2     Examples

# Storage size in Gigabytes

properties:

  storage_size: 10 GB

4.4.1.6.4.3     Notes

·         The unit values recognized by TOSCA for size-type units are based upon a subset of those defined by GNU at http://www.gnu.org/software/parted/manual/html_node/unit.html, which is a non-normative reference to this specification.

·         TOSCA treats these unit values as case-insensitive (e.g., a value of ‘kB’, ‘KB’ or ‘kb’ is equivalent), but it is considered best practice to use the case of these units as prescribed by GNU.

·         Some cloud providers may not support byte-level granularity for storage size allocations. In those cases, these values could be treated as desired sizes and actual allocations will be based upon individual provider capabilities.

4.4.1.6.5 scalar-unit.time
4.4.1.6.5.1     Recognized Units

Unit

Usage

Description

d

time

days

h

time

hours

m

time

minutes

s

time

seconds

ms

time

milliseconds

us

time

microseconds

ns

time

nanoseconds

4.4.1.6.5.2     Examples

# Response time in milliseconds

properties:

  respone_time: 10 ms

4.4.1.6.5.3     Notes

·         The unit values recognized by TOSCA for time-type units are based upon a subset of those defined by International System of Units whose recognized abbreviations are defined within the following reference: 

      http://www.ewh.ieee.org/soc/ias/pub-dept/abbreviation.pdf

      This document is a non-normative reference to this specification and intended for publications or grammars enabled for Latin characters which are not accessible in typical programming languages

4.4.1.6.6 scalar-unit.frequency
4.4.1.6.6.1     Recognized Units

Unit

Usage

Description

Hz

frequency

Hertz, or Hz. equals one cycle per second.

kHz

frequency

Kilohertz, or kHz, equals to 1,000 Hertz

MHz

frequency

Megahertz, or MHz, equals to 1,000,000 Hertz or 1,000 kHz

GHz

frequency

Gigahertz, or GHz, equals to 1,000,000,000 Hertz, or 1,000,000 kHz, or 1,000 MHz.

4.4.1.6.6.2     Examples

# Processor raw clock rate

properties:

  clock_rate: 2.4 GHz

4.4.1.6.6.3     Notes

·         The value for Hertz (Hz) is the International Standard Unit (ISU) as described by the Bureau International des Poids et Mesures (BIPM) in the “SI Brochure: The International System of Units (SI) [8th edition, 2006; updated in 2014]”, http://www.bipm.org/en/publications/si-brochure/

4.4.1.6.7 scalar-unit.bitrate
4.4.1.6.7.1     Recognized Units

Unit

Usage

Description

bps

bitrate

bit per second

Kbps

bitrate

kilobit (1000 bits) per second

Kibps

bitrate

kibibits (1024 bits) per second

Mbps

bitrate

megabit (1000000 bits) per second

Mibps

bitrate

mebibit (1048576 bits) per second

Gbps

bitrate

gigabit (1000000000 bits) per second

Gibps

bitrate

gibibits (1073741824 bits) per second

Tbps

bitrate

terabit (1000000000000 bits) per second

Tibps

bitrate

tebibits (1099511627776 bits) per second

Bps

bitrate

byte per second

KBps

bitrate

kilobyte (1000 bytes) per second

KiBps

bitrate

kibibytes (1024 bytes) per second

MBps

bitrate

megabyte (1000000 bytes) per second

MiBps

bitrate

mebibyte (1048576 bytes) per second

GBps

bitrate

gigabyte (1000000000 bytes) per second

GiBps

bitrate

gibibytes (1073741824 bytes) per second

TBps

bitrate

terabytes (1000000000000 bits) per second

TiBps

bitrate

tebibytes (1099511627776 bits) per second

4.4.1.6.7.2     Examples

# Somewhere in a node template definition

requirements:

    - link:

        node_filter:

          capabilities:

            - myLinkable

                properties:

                  bitrate:

                   - greater_or_equal: 10 Kbps # 10 * 1000 bits per second at least

4.4.1.6.7.3     Notes

·         Unlike with the scalar-unit.size type, TOSCA treats scalar-unit.bitrate values as case-sensitive (e.g., a value of ‘KBs’ means kilobyte per second, whereas ‘Kb’ means kilobit per second).

·         For comparison purposes, 1 byte is the same as 8 bits.

4.4.2 Data Type

A Data Type definition defines the schema for new datatypes in TOSCA. 

4.4.2.1 Keynames

The Data Type is a TOSCA type entity and has the common keynames listed in Section 4.2.5.2 Common keynames in type definitions. In addition, the Data Type has the following recognized keynames:

Keyname

Required

Type

Description

constraints

no

list of

constraint clauses

The optional list of sequenced constraint clauses for the Data Type. 

properties

no

map of property definitions

The optional map property definitions that comprise the schema for a complex Data Type in TOSCA.

key_schema

no

schema definition

For data types that derive from the TOSCA map data type, the optional schema definition for the keys used to identify entries in properties of this data type.

entry_schema

no

schema definition

For data types that derive from the TOSCA map or list data types, the optional schema definition for the entries in properties of this data type.

4.4.2.2 Grammar

Data Types have the following grammar:

<data_type_name>:

  derived_from: <existing_type_name>

  version: <version_number>

  metadata:

    <map of string>

  description: <datatype_description>

  constraints:

    - <type_constraints>

  properties:

    <property_definitions>

  key_schema: <key_schema_definition>

  entry_schema: <entry_schema_definition>

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         data_type_name: represents the required symbolic name of the data type as a string.

·         version_number: represents the optional TOSCA version number for the data type.

·         datatype_description: represents the optional description for the data type.

·         existing_type_name: represents the optional name of a valid TOSCA primitive type or data type this new data type derives from.

·         type_constraints: represents the optional list of one or more type-compatible constraint clauses that restrict the data type.

·         property_definitions: represents the optional map of one or more property definitions that provide the schema for the data type

·         property_definitions may not be added to data types derived_from TOSCA primitive types.

·         key_schema_definition: if the data type derives from the TOSCA map type (i.e existing_type_name is a map or derives from a map), it represents the optional schema definition for the keys used to identify entry properties of this type.

·         entry_schema_definition: if the data type derives from the TOSCA map or list types (i.e. existing_type name is a map or list or derives from a map or list), it represents the optional schema definition for the entries in properties of this type.

4.4.2.3 Derivation rules

During data type derivation the keyname definitions follow these rules:

·         constraints: new constraints may be defined; these constraints do not replace the constraints defined in the parent type but are considered in addition to them.

·         properties: existing property definitions may be refined; new property definitions may be added.

·         key_schema: the key_schema definition may be refined according to schema refinement rules.

·         entry_schema: the entry_schema definition may be refined according to schema refinement rules.

4.4.2.4 Additional Requirements

·         A valid datatype definition MUST have either a valid derived_from declaration or at least one valid property definition.

·         Any constraint clauses SHALL be type-compatible with the type declared by the derived_from keyname.

·         If a properties keyname is provided, it SHALL contain one or more valid property definitions.

·         Property definitions may not be added to data types derived from TOSCA primitive types.

4.4.2.5 Examples

The following example represents a Data Type definition based upon an existing string type:

4.4.2.5.1 Defining a complex datatype

# define a new complex datatype

mytypes.phonenumber:

  description: my phone number datatype

  properties:

    countrycode:

      type: integer

    areacode:

      type: integer

    number:

      type: integer

4.4.2.5.2 Defining a datatype derived from an existing datatype

# define a new datatype that derives from existing type and extends it

mytypes.phonenumber.extended:

  derived_from: mytypes.phonenumber

  description: custom phone number type that extends the basic phonenumber type

  properties:

    phone_description:

      type: string

      constraints:

        - max_length: 128

 

4.4.3 Schema definition

All entries in a map or list for one property or parameter must be of the same type. Similarly, all keys for map entries for one property or parameter must be of the same type as well.  A TOSCA schema definition specifies the type (for simple entries) or schema (for complex entries) for keys and entries in TOSCA set types such as the TOSCA list or map.

If the schema definition specifies a map key, then the type of the schema must be derived originally from the string type (which basically ensures that the schema type is a string with additional constraints). As there is little need for complex keys this caters to more straight-forward and clear specifications.

Schema definitions appear in data type definitions when derived_from a map or list type or in parameter, property, or attribute definitions of a map or list type.

4.4.3.1 Keynames

The following is the list of recognized keynames for a TOSCA schema definition:

Keyname

Required

Type

Description

type

yes

string

The required data type for the key or entry.

If this schema definition is for a map key, then the referred type must be derived originally from string.

description

no

string

The optional description for the schema.

constraints

no

list of

constraint clauses

The optional list of sequenced constraint clauses for the property.

key_schema

no

schema definition

When the schema itself is of type map, the optional schema definition that is used to specify the type of the keys of that map’s entries.

entry_schema

no

schema definition

When the schema itself is of type map or list, the optional schema definition that is used to specify the type of the entries in that map or list

4.4.3.2 Grammar

Schema definitions have the following grammar:

<schema_definition>:

  type: <schema_type>

  description: <schema_description>

  constraints:

    - <schema_constraints>

  key_schema: <key_schema_definition>

  entry_schema: <entry_schema_definition>

In the above grammar, the pseudo values that appear in angle brackets have the following meaning:

·         schema_type: represents the required type name for entries of the specified schema

·         if this schema definition is for a map key, then the schema_type must be derived originally from string.

·         schema_description: represents the optional description of the schema definition

·         schema_constraints: represents the optional list of one or more constraint clauses on entries of the specified schema.

·         key_schema_definition: if the schema_type is map, it represents the optional schema definition for the keys of that map’s entries.

·         entry_schema_definition: if the schema_type is map or list, it represents the optional schema definition for the entries in that map or list.

4.4.3.3 Refinement rules

A schema definition uses the following definition refinement rules when the containing entity type is derived:

·         type: must be derived from (or the same as) the type in the schema definition in the parent entity type definition.

·         description: a new definition is unrestricted and will overwrite the one inherited from the schema definition in the parent entity type definition.

·         constraints: a new definition is unrestricted; these constraints do not replace the constraints defined in the schema definition in the parent entity type but are considered in addition to them.

·         key_schema: may be refined (recursively) according to schema refinement rules.

·         entry_schema: may be refined (recursively) according to schema refinement rules.

4.4.4 Constraint clause definition

A constraint clause defines an operation along with one or more compatible values that can be used to define a constraint on a property or parameter’s allowed values when it is defined in a TOSCA Service Template or one of its entities.

4.4.4.1 Operator keynames

The following is the list of recognized operators (keynames) when defining constraint clauses:

Operator

Type

Value Type

Description

equal

scalar

any

Constrains a property or parameter to a value equal to (‘=’) the value declared.

greater_than

scalar

comparable

Constrains a property or parameter to a value greater than (‘>’) the value declared.

greater_or_equal

scalar

comparable

Constrains a property or parameter to a value greater than or equal to (‘>=’) the value declared.

less_than

scalar

comparable

Constrains a property or parameter to a value less than (‘<’) the value declared.

less_or_equal

scalar

comparable

Constrains a property or parameter to a value less than or equal to (‘<=’) the value declared.

in_range

dual scalar

comparable, range

Constrains a property or parameter to a value in range of (inclusive) the two values declared.

 

Note: subclasses or templates of types that declare a property with the in_range constraint MAY only further restrict the range specified by the parent type.

valid_values

list

any

Constrains a property or parameter to a value that is in the list of declared values.

length

scalar

string, list, map

Constrains the property or parameter to a value of a given length.

min_length

scalar

string, list, map

Constrains the property or parameter to a value to a minimum length.

max_length

scalar

string, list, map

Constrains the property or parameter to a value to a maximum length.

pattern

regex