+
+ +
+

aria.modeling.models

+

Data models.

+
+

Service template models

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
aria.modeling.models.ServiceTemplateTemplate for creating Service instances.
aria.modeling.models.NodeTemplateTemplate for creating zero or more Node instances, which are typed vertices in the service topology.
aria.modeling.models.GroupTemplateTemplate for creating a Group instance, which is a typed logical container for zero or more Node instances.
aria.modeling.models.PolicyTemplateTemplate for creating a Policy instance, which is a typed set of orchestration hints applied to zero or more Node or Group instances.
aria.modeling.models.SubstitutionTemplateTemplate for creating a Substitution instance, which exposes an entire instantiated service as a single node.
aria.modeling.models.SubstitutionTemplateMappingUsed by SubstitutionTemplate to map a capability template or a requirement template to the exposed node.
aria.modeling.models.RequirementTemplateTemplate for creating Relationship instances, which are optionally-typed edges in the service topology, connecting a Node to a Capability of another node.
aria.modeling.models.RelationshipTemplateOptional addition to a RequirementTemplate.
aria.modeling.models.CapabilityTemplateTemplate for creating Capability instances, typed attachments which serve two purposes: to provide extra properties and attributes to Node instances, and to expose targets for Relationship instances from other nodes.
aria.modeling.models.InterfaceTemplateTemplate for creating Interface instances, which are typed bundles of Operation instances.
aria.modeling.models.OperationTemplateTemplate for creating Operation instances, which are entry points to Python functions called as part of a workflow execution.
aria.modeling.models.ArtifactTemplateTemplate for creating an Artifact instance, which is a typed file, either provided in a CSAR or downloaded from a repository.
aria.modeling.models.PluginSpecificationRequirement for a Plugin.
+
+
+

Service instance models

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
aria.modeling.models.ServiceUsually an instance of a ServiceTemplate and its many associated templates (node templates, group templates, policy templates, etc.).
aria.modeling.models.NodeTyped vertex in the service topology.
aria.modeling.models.GroupTyped logical container for zero or more Node instances.
aria.modeling.models.PolicyTyped set of orchestration hints applied to zero or more Node or Group instances.
aria.modeling.models.SubstitutionExposes the entire service as a single node.
aria.modeling.models.SubstitutionMappingUsed by Substitution to map a capability or a requirement to the exposed node.
aria.modeling.models.RelationshipOptionally-typed edge in the service topology, connecting a Node to a Capability of another node.
aria.modeling.models.CapabilityTyped attachment serving two purposes: to provide extra properties and attributes to a Node, and to expose targets for Relationship instances from other nodes.
aria.modeling.models.InterfaceTyped bundle of Operation instances.
aria.modeling.models.OperationEntry points to Python functions called as part of a workflow execution.
aria.modeling.models.ArtifactTyped file, either provided in a CSAR or downloaded from a repository.
+
+
+

Common models

+ ++++ + + + + + + + + + + + + + + + + + + + + + + + +
aria.modeling.models.OutputOutput parameter or declaration for an output parameter.
aria.modeling.models.InputInput parameter or declaration for an input parameter.
aria.modeling.models.ConfigurationConfiguration parameter.
aria.modeling.models.PropertyProperty parameter or declaration for a property parameter.
aria.modeling.models.AttributeAttribute parameter or declaration for an attribute parameter.
aria.modeling.models.TypeType and its children.
aria.modeling.models.MetadataCustom values associated with the service.
+
+
+

Orchestration models

+ ++++ + + + + + + + + + + + + + + + + + +
aria.modeling.models.ExecutionWorkflow execution.
aria.modeling.models.TaskRepresents the smallest unit of stateful execution in ARIA.
aria.modeling.models.LogSingle log message.
aria.modeling.models.PluginInstalled plugin.
aria.modeling.models.ArgumentPython function argument parameter.
+
+
+class aria.modeling.models.ServiceTemplate(*args, **kwargs)
+

Template for creating Service instances.

+

Usually created by various DSL parsers, such as ARIA’s TOSCA extension. However, it can also be +created programmatically.

+
+
+artifact_types
+

Base for the artifact type hierarchy,

+ +++ + + + +
Type:Type
+
+ +
+
+capability_types
+

Base for the capability type hierarchy,

+ +++ + + + +
Type:Type
+
+ +
+
+created_at
+

Creation timestamp.

+ +++ + + + +
Type:datetime
+
+ +
+
+description
+

Human-readable description.

+ +++ + + + +
Type:basestring
+
+ +
+
+group_templates
+

Templates for creating groups.

+ +++ + + + +
Type:{basestring, GroupTemplate}
+
+ +
+
+group_types
+

Base for the group type hierarchy,

+ +++ + + + +
Type:Type
+
+ +
+
+id
+

Unique ID.

+ +++ + + + +
Type:int
+
+ +
+
+inputs
+

Declarations for externally provided parameters.

+ +++ + + + +
Type:{basestring: Input}
+
+ +
+
+interface_types
+

Base for the interface type hierarchy,

+ +++ + + + +
Type:Type
+
+ +
+
+main_file_name
+

Filename of CSAR or YAML file from which this service template was parsed.

+ +++ + + + +
Type:basestring
+
+ +
+
+meta_data
+

Associated metadata.

+ +++ + + + +
Type:{basestring: Metadata}
+
+ +
+
+name
+
+ +
+
+node_templates
+

Templates for creating nodes.

+ +++ + + + +
Type:{basestring, NodeTemplate}
+
+ +
+
+node_types
+

Base for the node type hierarchy,

+ +++ + + + +
Type:Type
+
+ +
+
+outputs
+

Declarations for output parameters are filled in after service installation.

+ +++ + + + +
Type:{basestring: Output}
+
+ +
+
+plugin_specifications
+

Required plugins for instantiated services.

+ +++ + + + +
Type:{basestring: PluginSpecification}
+
+ +
+
+policy_templates
+

Templates for creating policies.

+ +++ + + + +
Type:{basestring, PolicyTemplate}
+
+ +
+
+policy_types
+

Base for the policy type hierarchy,

+ +++ + + + +
Type:Type
+
+ +
+
+relationship_types
+

Base for the relationship type hierarchy,

+ +++ + + + +
Type:Type
+
+ +
+
+services
+

Instantiated services.

+ +++ + + + +
Type:[Service]
+
+ +
+
+substitution_template
+

Exposes an entire service as a single node.

+ +++ + + + +
Type:SubstitutionTemplate
+
+ +
+
+updated_at
+

Update timestamp.

+ +++ + + + +
Type:datetime
+
+ +
+
+workflow_templates
+

Templates for creating workflows.

+ +++ + + + +
Type:{basestring, OperationTemplate}
+
+ +
+ +
+
+class aria.modeling.models.NodeTemplate(*args, **kwargs)
+

Template for creating zero or more Node instances, which are typed vertices in the +service topology.

+
+
+artifact_templates
+

Associated artifacts.

+ +++ + + + +
Type:{basestring: ArtifactTemplate}
+
+ +
+
+attributes
+

Declarations for associated mutable parameters.

+ +++ + + + +
Type:{basestring: Attribute}
+
+ +
+
+capability_templates
+

Associated exposed capability templates.

+ +++ + + + +
Type:{basestring: CapabilityTemplate}
+
+ +
+
+default_instances
+

Default number nodes that will appear in the service.

+ +++ + + + +
Type:int
+
+ +
+
+description
+

Human-readable description.

+ +++ + + + +
Type:basestring
+
+ +
+
+id
+

Unique ID.

+ +++ + + + +
Type:int
+
+ +
+
+interface_templates
+

Associated interface templates.

+ +++ + + + +
Type:{basestring: InterfaceTemplate}
+
+ +
+
+max_instances
+

Maximum number nodes that will appear in the service.

+ +++ + + + +
Type:int
+
+ +
+
+min_instances
+

Minimum number nodes that will appear in the service.

+ +++ + + + +
Type:int
+
+ +
+
+name
+

Model name.

+ +++ + + + +
Type:basestring
+
+ +
+
+nodes
+

Instantiated nodes.

+ +++ + + + +
Type:[Node]
+
+ +
+
+properties
+

Declarations for associated immutable parameters.

+ +++ + + + +
Type:{basestring: Property}
+
+ +
+
+requirement_templates
+

Associated potential relationships with other nodes.

+ +++ + + + +
Type:[RequirementTemplate]
+
+ +
+
+service_template
+

Containing service template.

+ +++ + + + +
Type:ServiceTemplate
+
+ +
+
+service_template_name
+

Internal. For use in SQLAlchemy queries.

+ +++ + + + +
Type:basestring
+
+ +
+
+target_node_template_constraints
+

Constraints for filtering relationship targets.

+ +++ + + + +
Type:[NodeTemplateConstraint]
+
+ +
+
+type
+

Node type.

+ +++ + + + +
Type:Type
+
+ +
+
+type_name
+

Internal. For use in SQLAlchemy queries.

+ +++ + + + +
Type:basestring
+
+ +
+ +
+
+class aria.modeling.models.GroupTemplate(*args, **kwargs)
+

Template for creating a Group instance, which is a typed logical container for zero or +more Node instances.

+
+
+description
+

Human-readable description.

+ +++ + + + +
Type:basestring
+
+ +
+
+groups
+

Instantiated groups.

+ +++ + + + +
Type:[Group]
+
+ +
+
+id
+

Unique ID.

+ +++ + + + +
Type:int
+
+ +
+
+interface_templates
+

Associated interface templates.

+ +++ + + + +
Type:{basestring: InterfaceTemplate}
+
+ +
+
+name
+

Model name.

+ +++ + + + +
Type:basestring
+
+ +
+
+node_templates
+

Nodes instantiated by these templates will be members of the group.

+ +++ + + + +
Type:[NodeTemplate]
+
+ +
+
+properties
+

Declarations for associated immutable parameters.

+ +++ + + + +
Type:{basestring: Property}
+
+ +
+
+service_template
+

Containing service template.

+ +++ + + + +
Type:ServiceTemplate
+
+ +
+
+type
+

Group type.

+ +++ + + + +
Type:Type
+
+ +
+ +
+
+class aria.modeling.models.PolicyTemplate(*args, **kwargs)
+

Template for creating a Policy instance, which is a typed set of orchestration hints +applied to zero or more Node or Group instances.

+
+
+description
+

Human-readable description.

+ +++ + + + +
Type:basestring
+
+ +
+
+group_templates
+

Policy will be enacted on all nodes in all groups instantiated by these templates.

+ +++ + + + +
Type:{basestring: GroupTemplate}
+
+ +
+
+id
+

Unique ID.

+ +++ + + + +
Type:int
+
+ +
+
+name
+

Model name.

+ +++ + + + +
Type:basestring
+
+ +
+
+node_templates
+

Policy will be enacted on all nodes instantiated by these templates.

+ +++ + + + +
Type:{basestring: NodeTemplate}
+
+ +
+
+policies
+

Instantiated policies.

+ +++ + + + +
Type:[Policy]
+
+ +
+
+properties
+

Declarations for associated immutable parameters.

+ +++ + + + +
Type:{basestring: Property}
+
+ +
+
+service_template
+

Containing service template.

+ +++ + + + +
Type:ServiceTemplate
+
+ +
+
+type
+

Policy type.

+ +++ + + + +
Type:Type
+
+ +
+ +
+
+class aria.modeling.models.SubstitutionTemplate(*args, **kwargs)
+

Template for creating a Substitution instance, which exposes an entire instantiated +service as a single node.

+
+
+id
+

Unique ID.

+ +++ + + + +
Type:int
+
+ +
+
+mappings
+

Map requirement and capabilities to exposed node.

+ +++ + + + +
Type:{basestring: SubstitutionTemplateMapping}
+
+ +
+
+name
+

Model name.

+ +++ + + + +
Type:basestring
+
+ +
+
+node_type
+

Exposed node type.

+ +++ + + + +
Type:Type
+
+ +
+
+substitutions
+

Instantiated substitutions.

+ +++ + + + +
Type:[Substitution]
+
+ +
+ +
+
+class aria.modeling.models.SubstitutionTemplateMapping(*args, **kwargs)
+

Used by SubstitutionTemplate to map a capability template or a requirement template to +the exposed node.

+

The name field should match the capability or requirement name on the exposed node’s +type.

+

Only one of capability_template and requirement_template can be set.

+
+
+capability_template
+

Capability template to expose (can be None).

+