openstack/heat
Code Issues Proposed changes
426aa3498b
heat/doc/source/index.rst
ricolin 222a8ac5e9 [policy in code] part 7 add sample and releasenote 
Since we're moving all policy into code and documenting it there we
should generate those docs automatically, so they are less likely to
be out-of-date.
Also add releasenote for ops to aware that Heat is now using
policies in code and their Orchestration service needs to avoid
depends on policy.json file if file not exist, since there is no
such file by default after this patch.
Partially-Implements: bp policy-in-code

Change-Id: I25fc5a110b1fe515918e042f220c23ac9a7e811f
2017-12-13 10:58:56 +08:00

3.5 KiB
Raw Blame History

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.

Installing Heat

install/index

Configuring Heat

configuration/index

Administering Heat

admin/index

Using Heat

getting_started/create_a_stack template_guide/index templates/index glossary

Operating Heat

getting_started/on_fedora getting_started/on_ubuntu operating_guides/scale_deployment operating_guides/httpd operating_guides/upgrades_guide man/index

Developing Heat

contributing/index getting_started/on_devstack developing_guides/architecture developing_guides/pluginguide developing_guides/schedulerhints developing_guides/gmr developing_guides/supportstatus developing_guides/rally_on_gates

API Documentation

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

Code Documentation

api/autoindex

Indices and tables

  • genindex
  • modindex
  • search