The heat.engine.environment ModuleΒΆ

class heat.engine.environment.ClassResourceInfo(registry, path, value)[source]

Bases: heat.engine.environment.ResourceInfo

Store the mapping of resource name to python class implementation.

ClassResourceInfo.description = 'Plugin'
ClassResourceInfo.get_class()[source]
class heat.engine.environment.Environment(env=None, user_env=True)[source]

Bases: object

Environment.get_class(resource_type, resource_name=None)[source]
Environment.get_constraint(name)[source]
Environment.get_resource_info(resource_type, resource_name=None, registry_type=None)[source]
Environment.get_stack_lifecycle_plugins()[source]
Environment.get_types(support_status=None)[source]
Environment.load(env_snippet)[source]
Environment.patch_previous_parameters(previous_env, clear_parameters=[])[source]

This instance of Environment is the new environment where we are reusing as default the previous parameter values.

Environment.register_class(resource_type, resource_class)[source]
Environment.register_constraint(constraint_name, constraint)[source]
Environment.register_stack_lifecycle_plugin(stack_lifecycle_name, stack_lifecycle_class)[source]
Environment.user_env_as_dict()[source]

Get the environment as a dict, ready for storing in the db.

class heat.engine.environment.GlobResourceInfo(registry, path, value)[source]

Bases: heat.engine.environment.MapResourceInfo

Store the mapping (with wild cards) of one resource type to another. like: OS::Networking::* -> OS::Neutron::*

GlobResourceInfo.description = 'Wildcard Mapping'
GlobResourceInfo.get_resource_info(resource_type=None, resource_name=None)[source]
GlobResourceInfo.matches(resource_type)[source]
class heat.engine.environment.MapResourceInfo(registry, path, value)[source]

Bases: heat.engine.environment.ResourceInfo

Store the mapping of one resource type to another. like: OS::Networking::FloatingIp -> OS::Neutron::FloatingIp

MapResourceInfo.description = 'Mapping'
MapResourceInfo.get_class()[source]
MapResourceInfo.get_resource_info(resource_type=None, resource_name=None)[source]
class heat.engine.environment.ResourceInfo(registry, path, value)[source]

Bases: object

Base mapping of resource type to implementation.

ResourceInfo.get_resource_info(resource_type=None, resource_name=None)[source]
ResourceInfo.matches(resource_type)[source]
class heat.engine.environment.ResourceRegistry(global_registry)[source]

Bases: object

By looking at the environment, find the resource implementation.

ResourceRegistry.as_dict()[source]

Return user resources in a dict format.

ResourceRegistry.get_class(resource_type, resource_name=None, accept_fn=None)[source]
ResourceRegistry.get_resource_info(resource_type, resource_name=None, registry_type=None, accept_fn=None)[source]

Find possible matches to the resource type and name. chain the results from the global and user registry to find a match.

ResourceRegistry.get_types(support_status)[source]

Return a list of valid resource types.

ResourceRegistry.iterable_by(resource_type, resource_name=None)[source]
ResourceRegistry.load(json_snippet)[source]
ResourceRegistry.register_class(resource_type, resource_class)[source]
class heat.engine.environment.TemplateResourceInfo(registry, path, value)[source]

Bases: heat.engine.environment.ResourceInfo

Store the info needed to start a TemplateResource.

TemplateResourceInfo.description = 'Template'
TemplateResourceInfo.get_class()[source]
heat.engine.environment.read_global_environment(env, env_dir=None)[source]

Previous topic

The heat.engine.event Module

Next topic

The heat.engine.stack Module

This Page