-

- -

-

`aria_extension_tosca.simple_v1_0`¶

-

Parser implementation of TOSCA Simple Profile v1.0 cos01.

- ---- - - - - - -

aria_extension_tosca.simple_v1_0.ToscaSimplePresenter1_0 ARIA presenter for the TOSCA Simple Profile v1.0 cos01.

-

Assignments¶

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

`aria_extension_tosca.simple_v1_0.PropertyAssignment`	This section defines the grammar for assigning values to named properties within TOSCA Node and Relationship templates that are defined in their corresponding named types.
`aria_extension_tosca.simple_v1_0.OperationAssignment`	An operation definition defines a named function or procedure that can be bound to an implementation artifact (e.g., a script).
`aria_extension_tosca.simple_v1_0.InterfaceAssignment`	An interface definition defines a named interface that can be associated with a Node or Relationship Type.
`aria_extension_tosca.simple_v1_0.RelationshipAssignment`	Relationship assignment.
`aria_extension_tosca.simple_v1_0.RequirementAssignment`	A Requirement assignment allows template authors to provide either concrete names of TOSCA templates or provide abstract selection criteria for providers to use to find matching TOSCA templates that are used to fulfill a named requirement’s declared TOSCA Node Type.
`aria_extension_tosca.simple_v1_0.AttributeAssignment`	This section defines the grammar for assigning values to named attributes within TOSCA Node and Relationship templates which are defined in their corresponding named types.
`aria_extension_tosca.simple_v1_0.CapabilityAssignment`	A capability assignment allows node template authors to assign values to properties and attributes for a named capability definition that is part of a Node Template’s type definition.
`aria_extension_tosca.simple_v1_0.ArtifactAssignment`	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.

-

Definitions¶

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

`aria_extension_tosca.simple_v1_0.PropertyDefinition`	A property definition defines a named, typed value and related data that can be associated with an entity defined in this specification (e.g., Node Types, Relationship Types, Capability Types, etc.).
`aria_extension_tosca.simple_v1_0.AttributeDefinition`	An attribute definition defines a named, typed value that can be associated with an entity defined in this specification (e.g., a Node, Relationship or Capability Type).
`aria_extension_tosca.simple_v1_0.ParameterDefinition`	A parameter definition is essentially a TOSCA property definition; however, it also allows a value to be assigned to it (as for a TOSCA property assignment).
`aria_extension_tosca.simple_v1_0.OperationDefinition`	An operation definition defines a named function or procedure that can be bound to an implementation artifact (e.g., a script).
`aria_extension_tosca.simple_v1_0.InterfaceDefinition`	An interface definition defines a named interface that can be associated with a Node or Relationship Type.
`aria_extension_tosca.simple_v1_0.RelationshipDefinition`	Relationship definition.
`aria_extension_tosca.simple_v1_0.RequirementDefinition`	The Requirement definition describes a named requirement (dependencies) of a TOSCA Node Type or Node template which needs to be fulfilled by a matching Capability definition declared by another TOSCA modelable entity.
`aria_extension_tosca.simple_v1_0.CapabilityDefinition`	A capability definition defines a named, typed set of data that can be associated with Node Type or Node Template to describe a transparent capability or feature of the software component the node describes.

-

Filters¶

- ---- - - - - - - - - -

`aria_extension_tosca.simple_v1_0.CapabilityFilter`	Capability filter.
`aria_extension_tosca.simple_v1_0.NodeFilter`	A node filter definition defines criteria for selection of a TOSCA Node Template based upon the template’s property values, capabilities and capability properties.

-

Miscellaneous¶

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

`aria_extension_tosca.simple_v1_0.Description`	Human-readable description.
`aria_extension_tosca.simple_v1_0.MetaData`	Meta data.
`aria_extension_tosca.simple_v1_0.Repository`	A repository definition defines a named external repository which contains deployment and implementation artifacts that are referenced within the TOSCA Service Template.
`aria_extension_tosca.simple_v1_0.Import`	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.
`aria_extension_tosca.simple_v1_0.ConstraintClause`	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.
`aria_extension_tosca.simple_v1_0.EntrySchema`	ARIA NOTE: The specification does not properly explain this type, however it is implied by examples.
`aria_extension_tosca.simple_v1_0.OperationImplementation`	Operation implementation.
`aria_extension_tosca.simple_v1_0.SubstitutionMappingsRequirement`	Substitution mapping for requirement.
`aria_extension_tosca.simple_v1_0.SubstitutionMappingsCapability`	Substitution mapping for capability.
`aria_extension_tosca.simple_v1_0.SubstitutionMappings`	Substitution mappings.

-

Templates¶

- ---- - - - - - - - - - - - - - - - - - - - - -

`aria_extension_tosca.simple_v1_0.NodeTemplate`	A Node Template specifies the occurrence of a manageable software component as part of an application’s topology model which is defined in a TOSCA Service Template.
`aria_extension_tosca.simple_v1_0.RelationshipTemplate`	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.
`aria_extension_tosca.simple_v1_0.GroupTemplate`	A group definition defines a logical grouping of node templates, typically for management purposes, but is separate from the application’s topology template.
`aria_extension_tosca.simple_v1_0.PolicyTemplate`	A policy definition defines a policy that can be associated with a TOSCA topology or top-level entity definition (e.g., group definition, node template, etc.).
`aria_extension_tosca.simple_v1_0.TopologyTemplate`	This section defines the topology template of a cloud application.
`aria_extension_tosca.simple_v1_0.ServiceTemplate`	Servicate template.

-

Types¶

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

`aria_extension_tosca.simple_v1_0.ArtifactType`	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 on their operations.
`aria_extension_tosca.simple_v1_0.DataType`	A Data Type definition defines the schema for new named datatypes in TOSCA.
`aria_extension_tosca.simple_v1_0.CapabilityType`	A Capability Type is a reusable entity that describes a kind of capability that a Node Type can declare to expose.
`aria_extension_tosca.simple_v1_0.InterfaceType`	An Interface Type is a reusable entity that describes a set of operations that can be used to interact with or manage a node or relationship in a TOSCA topology.
`aria_extension_tosca.simple_v1_0.RelationshipType`	A Relationship Type is a reusable entity that defines the type of one or more relationships between Node Types or Node Templates.
`aria_extension_tosca.simple_v1_0.NodeType`	A Node Type is a reusable entity that defines the type of one or more Node Templates.
`aria_extension_tosca.simple_v1_0.GroupType`	A Group Type defines logical grouping types for nodes, typically for different management purposes.
`aria_extension_tosca.simple_v1_0.PolicyType`	A Policy Type defines a type of requirement that affects or governs an application or service’s topology at some stage of its lifecycle, but is not explicitly part of the topology itself (i.e., it does not prevent the application or service from being deployed or run if it did not exist).

-

Data types¶

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

`aria_extension_tosca.simple_v1_0.Timestamp`	TOSCA timestamps follow the YAML specification, which in turn is a variant of ISO8601.
`aria_extension_tosca.simple_v1_0.Version`	TOSCA supports the concept of “reuse” of type definitions, as well as template definitions which could be version and change over time.
`aria_extension_tosca.simple_v1_0.Range`	The range type can be used to define numeric ranges with a lower and upper boundary.
`aria_extension_tosca.simple_v1_0.List`	The list type allows for specifying multiple values for a parameter of property.
`aria_extension_tosca.simple_v1_0.Map`	The map type allows for specifying multiple values for a parameter of property as a map.
`aria_extension_tosca.simple_v1_0.ScalarSize`	Integer scalar for counting bytes.
`aria_extension_tosca.simple_v1_0.ScalarTime`	Floating point scalar for counting seconds.
`aria_extension_tosca.simple_v1_0.ScalarFrequency`	Floating point scalar for counting cycles per second (Hz).

-

-class aria_extension_tosca.simple_v1_0.ToscaSimplePresenter1_0(name=None, raw=None, container=None)¶

Bases: aria.parser.presentation.presenter.Presenter

-

ARIA presenter for the TOSCA Simple Profile v1.0 cos01.

-

Supported tosca_definitions_version values:

-

tosca_simple_yaml_1_0

-

-ALLOWED_IMPORTED_DSL_VERSIONS = ('tosca_simple_yaml_1_0',)¶

- -

-DSL_VERSIONS = ('tosca_simple_yaml_1_0',)¶

- -

-SIMPLE_PROFILE_LOCATION = 'tosca-simple-1.0/tosca-simple-1.0.yaml'¶

- -

-SPECIAL_IMPORTS = {'aria-1.0': 'aria-1.0/aria-1.0.yaml'}¶

- -

-functions¶

- -

-service_template¶

- -

-class aria_extension_tosca.simple_v1_0.PropertyAssignment(name=None, raw=None, container=None, cls=None)¶

Bases: aria.parser.presentation.presentation.AsIsPresentation

-

This section defines the grammar for assigning values to named properties within TOSCA Node and -Relationship templates that are defined in their corresponding named types.

-

See the TOSCA Simple Profile v1.0 cos01 specification

-

- -

-class aria_extension_tosca.simple_v1_0.OperationAssignment(name=None, raw=None, container=None)¶

Bases: aria_extension_tosca.simple_v1_0.presentation.extensible.ExtensiblePresentation

-

An operation definition defines a named function or procedure that can be bound to an -implementation artifact (e.g., a script).

-

See the TOSCA Simple Profile v1.0 cos01 specification

-

-description¶

The optional description string for the associated named operation.

- --- - - - -

Type:	`Description`

-

- -

-implementation¶

The optional implementation artifact name (e.g., a script file name within a TOSCA CSAR -file).

- --- - - - -

Type:	`OperationImplementation`

-

- -

-inputs¶

The optional list of input property assignments (i.e., parameters assignments) for operation -definitions that are within TOSCA Node or Relationship Template definitions. This includes -when operation definitions are included as part of a Requirement assignment in a Node -Template.

- --- - - - -

Type:	{`basestring`: `PropertyAssignment`}

-

- -

-class aria_extension_tosca.simple_v1_0.InterfaceAssignment(name=None, raw=None, container=None)¶

Bases: aria_extension_tosca.simple_v1_0.presentation.extensible.ExtensiblePresentation

-

An interface definition defines a named interface that can be associated with a Node or -Relationship Type.

-

See the TOSCA Simple Profile v1.0 cos01 specification

-

-inputs¶

The optional list of input property assignments (i.e., parameters assignments) for interface -definitions that are within TOSCA Node or Relationship Template definitions. This includes -when interface definitions are referenced as part of a Requirement assignment in a Node -Template.

- --- - - - -

Type:	{`basestring`: `PropertyAssignment`}

-

- -

-operations¶

--- - - - -

Type:	{`basestring`: `OperationAssignment`}

-

- -

-class aria_extension_tosca.simple_v1_0.RelationshipAssignment(name=None, raw=None, container=None)¶

Bases: aria_extension_tosca.simple_v1_0.presentation.extensible.ExtensiblePresentation

-

Relationship assignment.

-

-interfaces¶

The optional reserved keyname used to reference declared (named) interface definitions of -the corresponding Relationship Type in order to provide Property assignments for these -interfaces or operations of these interfaces.

- --- - - - -

Type:	{`basestring`: `InterfaceAssignment`}

-

- -

-properties¶

ARIA NOTE: This field is not mentioned in the spec, but is implied.

- --- - - - -

Type:	{`basestring`: `PropertyAssignment`}

-

- -

-type¶

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

- --- - - - -

Type:	`basestring`

-

- -

-class aria_extension_tosca.simple_v1_0.RequirementAssignment(name=None, raw=None, container=None)¶

Bases: aria_extension_tosca.simple_v1_0.presentation.extensible.ExtensiblePresentation

-

A Requirement assignment allows template authors to provide either concrete names of TOSCA -templates or provide abstract selection criteria for providers to use to find matching TOSCA -templates that are used to fulfill a named requirement’s declared TOSCA Node Type.

-

See the TOSCA Simple Profile v1.0 cos01 specification

-

-capability¶

The optional reserved keyname used to provide the name of either a:

-

Capability definition within a target node template that can fulfill the requirement.
Capability Type that the provider will use to select a type-compatible target node -template to fulfill the requirement at runtime.

- --- - - - -

Type:	`basestring`

-

- -

-node¶

The optional reserved keyname used to identify the target node of a relationship. -Specifically, it is used to provide either a:

-

Node Template name that can fulfill the target node requirement.
Node Type name that the provider will use to select a type-compatible node template to -fulfill the requirement at runtime.

- --- - - - -

Type:	`basestring`

-

- -

-node_filter¶

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

- --- - - - -

Type:	`NodeFilter`

-

- -

-relationship¶

The optional reserved keyname used to provide the name of either a:

-

Relationship Template to use to relate the source node to the (capability in the) target -node when fulfilling the requirement.
Relationship Type that the provider will use to select a type-compatible relationship -template to relate the source node to the target node at runtime.

- --- - - - -

Type:	`RelationshipAssignment`

-

- -

-class aria_extension_tosca.simple_v1_0.AttributeAssignment(name=None, raw=None, container=None, cls=None)¶

Bases: aria.parser.presentation.presentation.AsIsPresentation

-

This section defines the grammar for assigning values to named attributes within TOSCA Node and -Relationship templates which are defined in their corresponding named types.

-

See the TOSCA Simple Profile v1.0 cos01 specification

-

- -

-class aria_extension_tosca.simple_v1_0.CapabilityAssignment(name=None, raw=None, container=None)¶

Bases: aria_extension_tosca.simple_v1_0.presentation.extensible.ExtensiblePresentation

-

A capability assignment allows node template authors to assign values to properties and -attributes for a named capability definition that is part of a Node Template’s type definition.

-

See the TOSCA Simple Profile v1.0 cos01 specification

-

-attributes¶

An optional list of attribute definitions for the Capability definition.

- --- - - - -

Type:	{`basestring`: `AttributeAssignment`}

-

- -

-properties¶

An optional list of property definitions for the Capability definition.

- --- - - - -

Type:	{`basestring`: `PropertyAssignment`}

-

- -

-class aria_extension_tosca.simple_v1_0.ArtifactAssignment(name=None, raw=None, container=None)¶

Bases: aria_extension_tosca.simple_v1_0.presentation.extensible.ExtensiblePresentation

-

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.

-

See the TOSCA Simple Profile v1.0 cos01 specification

-

-deploy_path¶

The file path the associated file would be deployed into within the target node’s container.

- --- - - - -

Type:	`basestring`

-

- -

-description¶

The optional description for the artifact definition.

- --- - - - -

Type:	`Description`

-

- -

-file¶

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

- --- - - - -

Type:	`basestring`

-

- -

-properties¶

ARIA NOTE: This field is not mentioned in the spec, but is implied.

- --- - - - -

Type:	{`basestring`: `PropertyAssignment`}

-

- -

-repository¶

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.

- --- - - - -

Type:	`basestring`

-

- -

-type¶

The required artifact type for the artifact definition.

- --- - - - -

Type:	`basestring`

-

- -

-class aria_extension_tosca.simple_v1_0.PropertyDefinition(name=None, raw=None, container=None)¶

Bases: aria_extension_tosca.simple_v1_0.presentation.extensible.ExtensiblePresentation

-

A property definition defines a named, typed value and related data that can be associated with -an entity defined in this specification (e.g., Node Types, Relationship Types, Capability Types, -etc.). Properties are used by template authors to provide input values to TOSCA entities which -indicate their “desired state” when they are instantiated. The value of a property can be -retrieved using the get_property function within TOSCA Service Templates.

-

See the TOSCA Simple Profile v1.0 cos01 specification

-

-constraints¶

The optional list of sequenced constraint clauses for the property.

- --- - - - -

Type:	list of (str, `ConstraintClause`)

-

- -

-default¶

An optional key that may provide a value to be used as a default if not provided by another -means.

- --- - - - -

Type:	`basestring`

-

- -

-description¶

The optional description for the property.

- --- - - - -

Type:	`Description`

-

- -

-entry_schema¶

The optional key that is used to declare the name of the Datatype definition for entries of -set types such as the TOSCA list or map.

- --- - - - -

Type:	`basestring`

-

- -

-required¶

An optional key that declares a property as required (true) or not (false).

- --- - - - -

Type:	bool

-

- -

-status¶

The optional status of the property relative to the specification or implementation.

- --- - - - -

Type:	`basestring`

-

- -

-type¶

The required data type for the property.

- --- - - - -

Type:	`basestring`

-

- -

-class aria_extension_tosca.simple_v1_0.AttributeDefinition(name=None, raw=None, container=None)¶

Bases: aria_extension_tosca.simple_v1_0.presentation.extensible.ExtensiblePresentation

-

An attribute definition defines a named, typed value that can be associated with an entity -defined in this specification (e.g., a Node, Relationship or Capability Type). Specifically, it -is used to expose the “actual state” of some property of a TOSCA entity after it has been -deployed and instantiated (as set by the TOSCA orchestrator). Attribute values can be retrieved -via the get_attribute function from the instance model and used as values to other -entities within TOSCA Service Templates.

-

See the TOSCA Simple Profile v1.0 cos01 specification

-

-default¶

An optional key that may provide a value to be used as a default if not provided by another -means.

-

This value SHALL be type compatible with the type declared by the property definition’s type -keyname.

- --- - - - -

Type:	`basestring`

-

- -

-description¶

The optional description for the attribute.

- --- - - - -

Type:	`Description`

-

- -

-entry_schema¶

The optional key that is used to declare the name of the Datatype definition for entries of -set types such as the TOSCA list or map.

- --- - - - -

Type:	`basestring`

-

- -

-status¶

The optional status of the attribute relative to the specification or implementation.

- --- - - - -

Type:	`basestring`

-

- -

-type¶

The required data type for the attribute.

- --- - - - -

Type:	`basestring`

-

- -

-class aria_extension_tosca.simple_v1_0.ParameterDefinition(name=None, raw=None, container=None)¶

Bases: aria_extension_tosca.simple_v1_0.definitions.PropertyDefinition

-

A parameter definition is essentially a TOSCA property definition; however, it also allows a -value to be assigned to it (as for a TOSCA property assignment). In addition, in the case of -output parameters, it can optionally inherit the data type of the value assigned to it rather -than have an explicit data type defined for it.

-

See the TOSCA Simple Profile v1.0 cos01 specification

-

-type¶

The required data type for the parameter.

-

Note: This keyname is required for a TOSCA Property definition, but is not for a TOSCA -Parameter definition.

- --- - - - -

Type:	`basestring`

-

- -

-value¶: The type-compatible value to assign to the named parameter. Parameter values may be provided -as the result from the evaluation of an expression or a function.
-

- -

-class aria_extension_tosca.simple_v1_0.OperationDefinition(name=None, raw=None, container=None)¶

Bases: aria_extension_tosca.simple_v1_0.presentation.extensible.ExtensiblePresentation

-

An operation definition defines a named function or procedure that can be bound to an -implementation artifact (e.g., a script).

-

See the TOSCA Simple Profile v1.0 cos01 specification

-

-description¶

The optional description string for the associated named operation.

- --- - - - -

Type:	`Description`

-

- -

-implementation¶

The optional implementation artifact name (e.g., a script file name within a TOSCA CSAR -file).

- --- - - - -

Type:	`OperationImplementation`

-

- -

-inputs¶

aria_extension_tosca.simple_v1_0¶

Assignments¶

Definitions¶

Filters¶

Miscellaneous¶

Templates¶

Types¶

Data types¶

`aria_extension_tosca.simple_v1_0`¶