1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
..
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
==================================
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 :term:`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
==============
.. toctree::
:maxdepth: 1
install/index
operating_guides/httpd
configuration/index
admin/index
operating_guides/scale_deployment
operating_guides/upgrades_guide
man/index
Using Heat
==========
.. toctree::
:maxdepth: 1
getting_started/create_a_stack
glossary
Working with Templates
----------------------
.. toctree::
:maxdepth: 1
template_guide/index
templates/index
Using the Heat Service
----------------------
- `OpenStack Orchestration API v1 Reference`_
- :python-heatclient-doc:`Python and CLI client <>`
.. _`OpenStack Orchestration API v1 Reference`: https://docs.openstack.org/api-ref/orchestration/v1/
Developing Heat
===============
.. toctree::
:maxdepth: 1
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/index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
