openstack/heat
Code Issues Proposed changes
656e71c102
heat/doc/source/index.rst
Ghanshyam Mann 29573f8fbf [ussuri][goal] Update contributor documentation 
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38524
Change-Id: I41b6fa23569047c8ed877902989a5ebd20c0c189
2021-05-31 20:37:14 +00:00

3.2 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.

Operating Heat

install/index operating_guides/httpd configuration/index admin/index operating_guides/scale_deployment operating_guides/upgrades_guide man/index

Using Heat

getting_started/create_a_stack glossary

Working with Templates

template_guide/index templates/index

Using the Heat Service

Developing Heat

developing_guides/index

api/index

For Contributors

  • If you are a new contributor to Heat please refer: contributor/contributing

    contributor/index

Indices and tables

  • genindex
  • modindex
  • search