openstack/heat
Code Issues Proposed changes

Align the docs intro text with the old wiki page

Browse Source 
This landing page is now aimed at users, operators and developers
(instead of just developers).

This change rewrites the intro section to also cover points made
in the old wiki landing page [1] which needs to be deprecated with
a link to this page instead.

[1] https://wiki.openstack.org/wiki/Heat

Change-Id: I452807a2d9a8821c4a81d63eb8e824e04b344ef5
This commit is contained in:
Steve Baker 2015-10-05 10:43:25 +13:00
parent 80e909ca66
commit 3d440cd0dc
1 changed files with 25 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
doc/source/index.rst
View File

@ -11,20 +11,37 @@
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.
What is the purpose of the project and vision for it?
=====================================================
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.
* 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.
* 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 on how heat works and how to contribute to the project.
This documentation offers information aimed at end-users, operators and
developers of Heat.
Getting Started
===============