heat package

Subpackages

• heat.api package
  • Subpackages
    • heat.api.aws package
      • Submodules
      • Module contents
    • heat.api.cfn package
      • Subpackages
      • Submodules
      • Module contents
    • heat.api.middleware package
      • Submodules
      • Module contents
    • heat.api.openstack package
      • Subpackages
      • Submodules
      • Module contents
  • Submodules
    • heat.api.versions module
      • Controller
  • Module contents
    • pipeline_factory()
    • root_app_factory()
• heat.common package
  • Submodules
    • heat.common.auth_password module
      • KeystonePasswordAuthProtocol
      • filter_factory()
    • heat.common.auth_plugin module
      • get_keystone_plugin_loader()
      • parse_auth_credential_to_dict()
      • validate_auth_plugin()
    • heat.common.auth_url module
      • AuthUrlFilter
      • filter_factory()
    • heat.common.cache module
      • get_cache_region()
      • list_opts()
      • register_cache_configurations()
    • heat.common.config module
      • get_client_option()
      • get_ssl_options()
      • list_opts()
      • load_paste_app()
      • set_config_defaults()
      • startup_sanity_check()
    • heat.common.context module
      • ContextMiddleware
      • ContextMiddleware_filter_factory()
      • RequestContext
      • StoredContext
      • get_admin_context()
      • list_opts()
      • request_context()
    • heat.common.crypt module
      • SymmetricCrypto
      • cryptography_decrypt_v1()
      • decrypt()
      • decrypted_dict()
      • encrypt()
      • encrypted_dict()
      • get_valid_encryption_key()
      • heat_decrypt()
      • list_opts()
      • oslo_decrypt_v1()
    • heat.common.custom_backend_auth module
      • AuthProtocol
      • filter_factory()
    • heat.common.endpoint_utils module
      • get_auth_uri()
    • heat.common.environment_format module
      • default_for_missing()
      • parse()
      • validate()
    • heat.common.environment_util module
      • get_param_merge_strategy()
      • merge_environments()
      • merge_list()
      • merge_map()
      • merge_parameters()
      • parse_param()
    • heat.common.exception module
      • ActionInProgress
      • ActionNotComplete
      • AuthorizationFailure
      • CircularDependencyException
      • ClientNotAvailable
      • ConcurrentTransaction
      • ConflictingMergeStrategyForParam
      • DownloadLimitExceeded
      • EgressRuleNotAllowed
      • EntityNotFound
      • Error
      • EventSendFailed
      • Forbidden
      • HTTPExceptionDisguise
      • HeatException
      • HeatExceptionWithPath
      • ImmutableParameterModified
      • IncompatibleObjectVersion
      • InterfaceAttachFailed
      • InterfaceDetachFailed
      • Invalid
      • InvalidBreakPointHook
      • InvalidContentType
      • InvalidEncryptionKey
      • InvalidExternalResourceDependency
      • InvalidGlobalResource
      • InvalidMergeStrategyForParam
      • InvalidRestrictedAction
      • InvalidSchemaError
      • InvalidServiceVersion
      • InvalidTemplateAttribute
      • InvalidTemplateReference
      • InvalidTemplateSection
      • InvalidTemplateVersion
      • InvalidTemplateVersions
      • InvalidTenant
      • KeystoneServiceNameConflict
      • MissingCredentialError
      • NotAuthenticated
      • NotAuthorized
      • NotFound
      • NotSupported
      • ObjectActionError
      • ObjectFieldInvalid
      • OrphanedObjectError
      • PhysicalResourceExists
      • PhysicalResourceIDAmbiguity
      • PhysicalResourceNameAmbiguity
      • PropertyUnspecifiedError
      • ReadOnlyFieldError
      • RequestLimitExceeded
      • ResourceActionNotSupported
      • ResourceActionRestricted
      • ResourceFailure
      • ResourceInError
      • ResourceNotAvailable
      • ResourceNotFound
      • ResourcePropertyConflict
      • ResourcePropertyDependency
      • ResourcePropertyValueDependency
      • ResourceTypeUnavailable
      • ResourceUnknownStatus
      • SIGHUPInterrupt
      • SnapshotNotFound
      • StackExists
      • StackResourceLimitExceeded
      • StackValidationFailed
      • StopActionFailed
      • TemplateOutputError
      • UnableToAutoAllocateNetwork
      • UnknownUserParameter
      • UnsupportedObjectError
      • UpdateInProgress
      • UpdateReplace
      • UserParameterMissing
    • heat.common.grouputils module
      • GroupInspector
      • get_child_template_files()
      • get_member_definitions()
      • get_member_names()
      • get_member_refids()
      • get_members()
      • get_nested_attrs()
      • get_resource()
      • get_rsrc_attr()
      • get_rsrc_id()
      • get_size()
    • heat.common.i18n module
    • heat.common.identifier module
      • EventIdentifier
      • HeatIdentifier
      • ResourceIdentifier
    • heat.common.lifecycle_plugin_utils module
      • do_post_ops()
      • do_pre_ops()
      • get_plug_point_class_instances()
    • heat.common.messaging module
      • RequestContextSerializer
      • cleanup()
      • get_notifier()
      • get_rpc_client()
      • get_rpc_server()
      • get_specific_transport()
      • setup()
      • setup_transports()
    • heat.common.netutils module
      • is_prefix_subset()
      • validate_dns_format()
    • heat.common.noauth module
      • NoAuthProtocol
      • filter_factory()
    • heat.common.param_utils module
      • delim_string_to_list()
      • extract_bool()
      • extract_int()
      • extract_tags()
      • extract_template_type()
    • heat.common.password_gen module
      • CharClass
      • generate_openstack_password()
      • generate_password()
      • named_char_class()
      • special_char_class()
    • heat.common.plugin_loader module
      • create_subpackage()
      • load_modules()
    • heat.common.pluginutils module
      • log_fail_msg()
    • heat.common.policy module
      • Enforcer
      • ResourceEnforcer
      • get_enforcer()
      • get_policy_enforcer()
    • heat.common.profiler module
      • setup()
    • heat.common.serializers module
      • JSONResponseSerializer
      • XMLResponseSerializer
    • heat.common.service_utils module
      • engine_alive()
      • format_service()
      • generate_engine_id()
    • heat.common.short_id module
      • generate_id()
      • get_id()
    • heat.common.template_format module
      • convert_json_to_yaml()
      • parse()
      • simple_parse()
      • validate_template_limit()
      • yaml_dumper
      • yaml_loader
    • heat.common.timeutils module
      • Duration
      • isotime()
      • parse_isoduration()
      • retry_backoff_delay()
    • heat.common.urlfetch module
      • URLFetchError
      • get()
    • heat.common.wsgi module
      • AppFactory
      • BasePasteFactory
      • Debug
      • DefaultMethodController
      • FilterFactory
      • JSONRequestDeserializer
      • Middleware
      • Request
      • Resource
      • Router
      • Server
      • debug_filter()
      • get_bind_addr()
      • get_socket()
      • is_json_content_type()
      • list_opts()
      • log_exception()
      • paste_deploy_app()
      • setup_paste_factories()
      • teardown_paste_factories()
      • translate_exception()
  • Module contents
• heat.db package
  • Submodules
    • heat.db.api module
      • engine_get_all_locked_by_stack()
      • event_count_all_by_stack()
      • event_create()
      • event_get_all_by_stack()
      • event_get_all_by_tenant()
      • get_engine()
      • persist_state_and_release_lock()
      • purge_deleted()
      • raw_template_create()
      • raw_template_delete()
      • raw_template_files_create()
      • raw_template_files_get()
      • raw_template_get()
      • raw_template_update()
      • reset_stack_status()
      • resource_attr_data_delete()
      • resource_attr_id_set()
      • resource_create()
      • resource_create_replacement()
      • resource_data_delete()
      • resource_data_get()
      • resource_data_get_all()
      • resource_data_get_by_key()
      • resource_data_set()
      • resource_delete()
      • resource_exchange_stacks()
      • resource_get()
      • resource_get_all()
      • resource_get_all_active_by_stack()
      • resource_get_all_by_physical_resource_id()
      • resource_get_all_by_root_stack()
      • resource_get_all_by_stack()
      • resource_get_by_name_and_stack()
      • resource_get_by_physical_resource_id()
      • resource_prop_data_create()
      • resource_prop_data_create_or_update()
      • resource_prop_data_get()
      • resource_purge_deleted()
      • resource_update()
      • resource_update_and_save()
      • retry_on_db_error()
      • service_create()
      • service_delete()
      • service_get()
      • service_get_all()
      • service_get_all_by_args()
      • service_update()
      • snapshot_count_all_by_stack()
      • snapshot_create()
      • snapshot_delete()
      • snapshot_get()
      • snapshot_get_all_by_stack()
      • snapshot_get_by_stack()
      • snapshot_update()
      • software_config_count_all()
      • software_config_create()
      • software_config_delete()
      • software_config_get()
      • software_config_get_all()
      • software_deployment_count_all()
      • software_deployment_create()
      • software_deployment_delete()
      • software_deployment_get()
      • software_deployment_get_all()
      • software_deployment_update()
      • stack_count_all()
      • stack_count_total_resources()
      • stack_create()
      • stack_delete()
      • stack_get()
      • stack_get_all()
      • stack_get_all_by_owner_id()
      • stack_get_all_by_root_owner_id()
      • stack_get_by_name()
      • stack_get_by_name_and_owner_id()
      • stack_get_root_id()
      • stack_get_status()
      • stack_lock_create()
      • stack_lock_get_engine_id()
      • stack_lock_release()
      • stack_lock_steal()
      • stack_tags_delete()
      • stack_tags_get()
      • stack_tags_set()
      • stack_update()
      • sync_point_create()
      • sync_point_delete_all_by_stack_and_traversal()
      • sync_point_get()
      • sync_point_update_input_data()
      • user_creds_create()
      • user_creds_delete()
      • user_creds_get()
    • heat.db.filters module
      • exact_filter()
    • heat.db.migration module
      • db_sync()
      • db_version()
    • heat.db.models module
      • Event
      • HeatBase
      • RawTemplate
      • RawTemplateFiles
      • Resource
      • ResourceData
      • ResourcePropertiesData
      • Service
      • Snapshot
      • SoftDelete
      • SoftwareConfig
      • SoftwareDeployment
      • Stack
      • StackLock
      • StackTag
      • StateAware
      • SyncPoint
      • UserCreds
    • heat.db.types module
      • Json
      • List
      • LongText
    • heat.db.utils module
      • retry_on_stale_data_error()
  • Module contents
• heat.engine package
  • Subpackages
    • heat.engine.cfn package
      • Submodules
      • Module contents
    • heat.engine.clients package
      • Subpackages
      • Submodules
      • Module contents
    • heat.engine.constraint package
      • Submodules
      • Module contents
    • heat.engine.hot package
      • Submodules
      • Module contents
    • heat.engine.notification package
      • Submodules
      • Module contents
    • heat.engine.resources package
      • Submodules
      • Module contents
  • Submodules
    • heat.engine.api module
      • extract_args()
      • format_event()
      • format_notification_body()
      • format_resource_attributes()
      • format_resource_properties()
      • format_snapshot()
      • format_software_config()
      • format_software_deployment()
      • format_stack()
      • format_stack_db_object()
      • format_stack_output()
      • format_stack_outputs()
      • format_stack_preview()
      • format_stack_resource()
      • format_validate_parameter()
      • format_watch()
      • format_watch_data()
      • translate_filters()
    • heat.engine.attributes module
      • Attribute
      • Attributes
      • Schema
      • schemata()
      • select_from_attribute()
    • heat.engine.check_resource module
      • CancelOperation
      • CheckResource
      • check_resource_cleanup()
      • check_resource_update()
      • check_stack_complete()
      • load_resource()
      • propagate_check_resource()
    • heat.engine.conditions module
      • Conditions
    • heat.engine.constraints module
      • AllowedPattern
      • AllowedValues
      • AnyIndexDict
      • BaseCustomConstraint
      • Constraint
      • CustomConstraint
      • Length
      • Modulo
      • Range
      • Schema
    • heat.engine.dependencies module
      • Dependencies
      • Graph
      • Node
    • heat.engine.environment module
      • ClassResourceInfo
      • Environment
      • GlobResourceInfo
      • MapResourceInfo
      • ResourceInfo
      • ResourceRegistry
      • TemplateResourceInfo
      • get_child_environment()
      • is_hook_definition()
      • is_valid_restricted_action()
      • read_global_environment()
      • valid_hook_type()
      • valid_restricted_actions()
    • heat.engine.event module
      • Event
    • heat.engine.function module
      • Function
      • Invalid
      • Macro
      • all_dep_attrs()
      • dep_attrs()
      • dependencies()
      • resolve()
      • validate()
    • heat.engine.lifecycle_plugin module
      • LifecyclePlugin
    • heat.engine.node_data module
      • NodeData
      • load_resources_data()
    • heat.engine.output module
      • OutputDefinition
    • heat.engine.parameter_groups module
      • ParameterGroups
    • heat.engine.parameters module
      • BooleanParam
      • CommaDelimitedListParam
      • JsonParam
      • NumberParam
      • Parameter
      • Parameters
      • ParsedParameter
      • Schema
      • StringParam
    • heat.engine.parent_rsrc module
      • ParentResourceProxy
      • use_parent_stack()
    • heat.engine.plugin_manager module
      • PluginManager
      • PluginMapping
    • heat.engine.properties module
      • Properties
      • Property
      • Schema
      • schemata()
    • heat.engine.properties_group module
      • PropertiesGroup
    • heat.engine.resource module
      • NoActionRequired
      • PollDelay
      • Resource
    • heat.engine.rsrc_defn module
      • ResourceDefinition
    • heat.engine.scheduler module
      • DependencyTaskGroup
      • ExceptionGroup
      • TaskRunner
      • TimedCancel
      • Timeout
      • task_description()
    • heat.engine.service module
      • EngineListener
      • EngineService
      • NotifyEvent
      • ThreadGroupManager
    • heat.engine.service_software_config module
      • SoftwareConfigService
    • heat.engine.software_config_io module
      • IOConfig
      • InputConfig
      • OutputConfig
      • check_io_schema_list()
    • heat.engine.stack module
      • ConvergenceNode
      • ForcedCancel
      • Stack
      • reset_state_on_error()
    • heat.engine.stack_lock module
      • StackLock
    • heat.engine.status module
      • ResourceStatus
    • heat.engine.stk_defn module
      • ResourceProxy
      • StackDefinition
      • add_resource()
      • remove_resource()
      • update_resource_data()
    • heat.engine.support module
      • SupportStatus
      • is_valid_status()
    • heat.engine.sync_point module
      • create()
      • delete_all()
      • deserialize_input_data()
      • get()
      • make_key()
      • serialize_input_data()
      • str_pack_tuple()
      • sync()
      • update_input_data()
    • heat.engine.template module
      • Template
    • heat.engine.template_common module
      • CommonTemplate
    • heat.engine.template_files module
      • ReadOnlyDict
      • TemplateFiles
      • get_files_from_container()
    • heat.engine.timestamp module
      • Timestamp
    • heat.engine.translation module
      • Translation
      • TranslationRule
      • get_value()
      • resolve_and_find()
    • heat.engine.update module
      • StackUpdate
    • heat.engine.worker module
      • WorkerService
      • log_exceptions()
  • Module contents
• heat.objects package
  • Submodules
    • heat.objects.base module
      • HeatObject
      • HeatObjectRegistry
    • heat.objects.event module
      • Event
    • heat.objects.fields module
      • Json
      • JsonField
      • ListField
    • heat.objects.raw_template module
      • RawTemplate
    • heat.objects.raw_template_files module
      • RawTemplateFiles
    • heat.objects.resource module
      • Resource
      • ResourceCache
      • retry_on_conflict()
    • heat.objects.resource_data module
      • ResourceData
    • heat.objects.resource_properties_data module
      • ResourcePropertiesData
    • heat.objects.service module
      • Service
    • heat.objects.snapshot module
      • Snapshot
    • heat.objects.software_config module
      • SoftwareConfig
    • heat.objects.software_deployment module
      • SoftwareDeployment
    • heat.objects.stack module
      • Stack
    • heat.objects.stack_lock module
      • StackLock
    • heat.objects.stack_tag module
      • StackTag
      • StackTagList
    • heat.objects.sync_point module
      • SyncPoint
    • heat.objects.user_creds module
      • UserCreds
  • Module contents
• heat.policies package
  • Submodules
    • heat.policies.actions module
      • list_rules()
    • heat.policies.base module
      • list_rules()
    • heat.policies.build_info module
      • list_rules()
    • heat.policies.cloudformation module
      • list_rules()
    • heat.policies.events module
      • list_rules()
    • heat.policies.resource module
      • list_rules()
    • heat.policies.resource_types module
      • list_rules()
    • heat.policies.service module
      • list_rules()
    • heat.policies.software_configs module
      • list_rules()
    • heat.policies.software_deployments module
      • list_rules()
    • heat.policies.stacks module
      • list_rules()
  • Module contents
    • list_rules()
• heat.rpc package
  • Submodules
    • heat.rpc.api module
    • heat.rpc.client module
      • EngineClient
    • heat.rpc.listener_client module
      • EngineListenerClient
    • heat.rpc.worker_api module
    • heat.rpc.worker_client module
      • WorkerClient
  • Module contents
• heat.scaling package
  • Submodules
    • heat.scaling.cooldown module
      • CooldownMixin
    • heat.scaling.lbutils module
      • reconfigure_loadbalancers()
    • heat.scaling.rolling_update module
      • needs_update()
      • next_batch()
    • heat.scaling.scalingutil module
      • calculate_new_capacity()
    • heat.scaling.template module
      • make_template()
      • member_definitions()
  • Module contents

Module contents