heat/doc/source/index.rst
Jason Dunsmore cf4ffd8215 Rename scaleout_apis.rst -> scale_deployment.rst
The multi-engine docs will be added to the file currently named
scaleout_apis.rst.  Renaming it to scale_deployment.rst to make the name
more generic.

blueprint multi-engine-docs
Change-Id: I038d775a065ccd22da9ec0dbc3d8fa5a806ca020
2013-12-27 09:25:33 -06:00

2.4 KiB

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/index templates/index template_guide/index glossary

Man Pages

man/index

Developers Documentation

architecture

Operations Documentation

scale_deployment

Code Documentation

sourcecode/autoindex

Indices and tables

  • genindex
  • modindex
  • search