Welcome to the Heat documentation!¶
Heat is a service to orchestrate composite cloud applications using a declarative template format through an OpenStack-native REST API.
Heat’s purpose and vision¶
- Heat provides a template based orchestration for describing a cloud application by executing appropriate OpenStack API calls to generate running cloud applications.
- A Heat template describes the infrastructure for a cloud application in text files which are readable and writable by humans, and can be managed by version control tools.
- Templates specify the relationships between resources (e.g. this volume is connected to this server). This enables Heat to call out to the OpenStack APIs to create all of your infrastructure in the correct order to completely launch your application.
- The software integrates other components of OpenStack. The templates allow creation of most OpenStack resource types (such as instances, floating ips, volumes, security groups, users, etc), as well as some more advanced functionality such as instance high availability, instance autoscaling, and nested stacks.
- Heat primarily manages infrastructure, but the templates integrate well with software configuration management tools such as Puppet and Ansible.
- Operators can customise the capabilities of Heat by installing plugins.
This documentation offers information aimed at end-users, operators and developers of Heat.
Using Heat¶
Operating Heat¶
Developing Heat¶
Code Documentation¶
- The
heat.api.aws.ec2token
Module - The
heat.api.aws.exception
Module - The
heat.api.aws.utils
Module - The
heat.api.cfn.v1.signal
Module - The
heat.api.cfn.v1.stacks
Module - The
heat.api.cfn.versions
Module - The
heat.api.cloudwatch.watch
Module - The
heat.api.middleware.fault
Module - The
heat.api.middleware.ssl
Module - The
heat.api.middleware.version_negotiation
Module - The
heat.api.openstack.v1.actions
Module - The
heat.api.openstack.v1.build_info
Module - The
heat.api.openstack.v1.events
Module - The
heat.api.openstack.v1.resources
Module - The
heat.api.openstack.v1.services
Module - The
heat.api.openstack.v1.software_configs
Module - The
heat.api.openstack.v1.software_deployments
Module - The
heat.api.openstack.v1.stacks
Module - The
heat.api.openstack.v1.util
Module - The
heat.api.openstack.v1.views.stacks_view
Module - The
heat.api.openstack.v1.views.views_common
Module - The
heat.api.openstack.versions
Module - The
heat.api.versions
Module - The
heat.engine.api
Module - The
heat.engine.attributes
Module - The
heat.engine.cfn.functions
Module - The
heat.engine.cfn.template
Module - The
heat.engine.clients.client_plugin
Module - The
heat.engine.clients.os.barbican
Module - The
heat.engine.clients.os.ceilometer
Module - The
heat.engine.clients.os.cinder
Module - The
heat.engine.clients.os.designate
Module - The
heat.engine.clients.os.glance
Module - The
heat.engine.clients.os.heat_plugin
Module - The
heat.engine.clients.os.keystone
Module - The
heat.engine.clients.os.magnum
Module - The
heat.engine.clients.os.manila
Module - The
heat.engine.clients.os.mistral
Module - The
heat.engine.clients.os.monasca
Module - The
heat.engine.clients.os.neutron.lbaas_constraints
Module - The
heat.engine.clients.os.neutron.neutron_constraints
Module - The
heat.engine.clients.os.nova
Module - The
heat.engine.clients.os.sahara
Module - The
heat.engine.clients.os.senlin
Module - The
heat.engine.clients.os.swift
Module - The
heat.engine.clients.os.trove
Module - The
heat.engine.clients.os.zaqar
Module - The
heat.engine.clients.progress
Module - The
heat.engine.constraint.common_constraints
Module - The
heat.engine.constraints
Module - The
heat.engine.dependencies
Module - The
heat.engine.environment
Module - The
heat.engine.event
Module - The
heat.engine.function
Module - The
heat.engine.hot.functions
Module - The
heat.engine.hot.parameters
Module - The
heat.engine.hot.template
Module - The
heat.engine.lifecycle_plugin
Module - The
heat.engine.notification.autoscaling
Module - The
heat.engine.notification.stack
Module - The
heat.engine.parameter_groups
Module - The
heat.engine.parameters
Module - The
heat.engine.plugin_manager
Module - The
heat.engine.properties
Module - The
heat.engine.resource
Module - The
heat.engine.rsrc_defn
Module - The
heat.engine.scheduler
Module - The
heat.engine.service
Module - The
heat.engine.service_software_config
Module - The
heat.engine.service_stack_watch
Module - The
heat.engine.stack
Module - The
heat.engine.stack_lock
Module - The
heat.engine.support
Module - The
heat.engine.sync_point
Module - The
heat.engine.template
Module - The
heat.engine.timestamp
Module - The
heat.engine.translation
Module - The
heat.engine.update
Module - The
heat.engine.watchrule
Module - The
heat.engine.worker
Module - The
heat.httpd.heat_api
Module - The
heat.httpd.heat_api_cfn
Module - The
heat.httpd.heat_api_cloudwatch
Module - The
heat.objects.base
Module - The
heat.objects.event
Module - The
heat.objects.fields
Module - The
heat.objects.raw_template
Module - The
heat.objects.resource
Module - The
heat.objects.resource_data
Module - The
heat.objects.service
Module - The
heat.objects.snapshot
Module - The
heat.objects.software_config
Module - The
heat.objects.software_deployment
Module - The
heat.objects.stack
Module - The
heat.objects.stack_lock
Module - The
heat.objects.stack_tag
Module - The
heat.objects.sync_point
Module - The
heat.objects.user_creds
Module - The
heat.objects.watch_data
Module - The
heat.objects.watch_rule
Module - The
heat.rpc.api
Module - The
heat.rpc.client
Module - The
heat.rpc.listener_client
Module - The
heat.rpc.worker_api
Module - The
heat.rpc.worker_client
Module - The
heat.scaling.cooldown
Module - The
heat.scaling.lbutils
Module - The
heat.scaling.rolling_update
Module - The
heat.scaling.scalingutil
Module - The
heat.scaling.template
Module - The
heat.version
Module