Welcome to the Heat developer documentation!

Heat is a service to orchestrate multiple composite cloud applications using the AWS CloudFormation template format, through both an OpenStack-native ReST API and a CloudFormation-compatible Query API.

What is the purpose of the project and vision for it?

• Heat provides a template based orchestration for describing a cloud application by executing appropriate OpenStack API calls to generate running cloud applications.
• The software integrates other core components of OpenStack into a one-file template system. 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. By providing very tight integration with other OpenStack core projects, all OpenStack core projects could receive a larger user base.
• Allow deployers to integrate with Heat directly or by adding custom plugins.

This documentation offers information on how heat works and how to contribute to the project.

Getting Started

• Getting Started Guides
• HOT Templates
• CFN Templates
• Template Guide
• Glossary

Man Pages

• Man pages for services and utilities
  • Heat services
  • Heat utilities

Developers Documentation

• Heat Architecture
• Heat Resource Plug-in Development Guide

API Documentation

• Heat REST API Reference (OpenStack API Complete Reference - Orchestration)

Operations Documentation

• Scaling a Deployment

Code Documentation

• Source Code Index
  • Heat
    • The heat Module
    • The heat.version Module
    • The heat.api Module
    • The heat.api.cloudwatch.versions Module
    • The heat.api.cloudwatch Module
    • The heat.api.cloudwatch.watch Module
    • The heat.api.openstack.versions Module
    • The heat.api.openstack Module
    • The heat.api.openstack.v1.build_info Module
    • The heat.api.openstack.v1.stacks Module
    • The heat.api.openstack.v1.software_configs Module
    • The heat.api.openstack.v1 Module
    • The heat.api.openstack.v1.software_deployments Module
    • The heat.api.openstack.v1.util Module
    • The heat.api.openstack.v1.events Module
    • The heat.api.openstack.v1.actions Module
    • The heat.api.openstack.v1.views Module
    • The heat.api.openstack.v1.views.stacks_view Module
    • The heat.api.openstack.v1.views.views_common Module
    • The heat.api.middleware.fault Module
    • The heat.api.middleware Module
    • The heat.api.middleware.ssl Module
    • The heat.api.middleware.version_negotiation Module
    • The heat.api.aws.exception Module
    • The heat.api.aws.utils Module
    • The heat.api.aws.ec2token Module
    • The heat.api.aws Module
    • The heat.api.cfn.versions Module
    • The heat.api.cfn Module
    • The heat.api.cfn.v1.stacks Module
    • The heat.api.cfn.v1 Module
    • The heat.api.cfn.v1.signal Module
    • The heat.scaling Module
    • The heat.scaling.template Module
    • The heat.rpc.client Module
    • The heat.rpc Module
    • The heat.rpc.api Module
    • The heat.engine.event Module
    • The heat.engine.stack_user Module
    • The heat.engine.service Module
    • The heat.engine.plugin_manager Module
    • The heat.engine.function Module
    • The heat.engine.stack_lock Module
    • The heat.engine.dependencies Module
    • The heat.engine.signal_responder Module
    • The heat.engine.support Module
    • The heat.engine.parser Module
    • The heat.engine.parameter_groups Module
    • The heat.engine.resource Module
    • The heat.engine.update Module
    • The heat.engine.constraints Module
    • The heat.engine.watchrule Module
    • The heat.engine.parameters Module
    • The heat.engine Module
    • The heat.engine.clients Module
    • The heat.engine.environment Module
    • The heat.engine.template Module
    • The heat.engine.api Module
    • The heat.engine.stack_resource Module
    • The heat.engine.scheduler Module
    • The heat.engine.properties Module
    • The heat.engine.timestamp Module
    • The heat.engine.attributes Module
    • The heat.engine.hot.parameters Module
    • The heat.engine.hot Module
    • The heat.engine.hot.template Module
    • The heat.engine.hot.functions Module
    • The heat.engine.notification.stack Module
    • The heat.engine.notification Module
    • The heat.engine.notification.autoscaling Module
    • The heat.engine.cfn Module
    • The heat.engine.cfn.template Module
    • The heat.engine.cfn.functions Module
  • Contrib/rackspace
    • The rackspace Module
    • The rackspace.clients Module
  • Contrib/heat_keystoneclient_v2
    • The heat_keystoneclient_v2.client Module
    • The heat_keystoneclient_v2 Module
  • Contrib/docker
    • The docker Module
  • Contrib/extraroute
    • The extraroute Module
  • Contrib/marconi
    • The marconi Module
    • The marconi.clients Module

Indices and tables

• Index
• Module Index
• Search Page