heat/install-guide/source/get_started.rst
Petr Kovar 3a93b123ac Add install-guide for heat
This adds heat-specific contents of the OpenStack Installation Guide
in the heat repo per [1]. A separate change will remove the heat
contents from the OpenStack Installation Guide for Newton per [2].

The heat install-guide structure is based on Install Guide
Cookiecutter [3].

Also adds tox.ini environment for install-guide and adds
openstackdocs-theme to test-requirements.txt.

[1] http://specs.openstack.org/openstack/docs-specs/specs/newton/project-specific-installguides.html
[2] http://specs.openstack.org/openstack/docs-specs/specs/newton/installguide.html
[3] https://review.openstack.org/#/c/314229/

Change-Id: I153b27dd17e5a22224bda473b19dbd76ca0cdc98
Partially-Implements: blueprint projectspecificinstallguides
2016-06-07 17:31:20 +00:00

38 lines
1.5 KiB
ReStructuredText

==============================
Orchestration service overview
==============================
The Orchestration service provides a template-based orchestration for
describing a cloud application by running 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 you to create most OpenStack resource types such as instances,
floating IPs, volumes, security groups, and users. It also provides
advanced functionality such as instance high availability, instance
auto-scaling, and nested stacks. This enables OpenStack core projects to
receive a larger user base.
The service allows deployers to integrate with the Orchestration service
directly or through custom plug-ins.
The Orchestration service consists of the following components:
``heat`` command-line client
A CLI that communicates with the ``heat-api`` to run AWS CloudFormation APIs.
End developers can directly use the Orchestration REST API.
``heat-api`` component
An OpenStack-native REST API that processes API requests by sending
them to the ``heat-engine`` over Remote Procedure Call (RPC).
``heat-api-cfn`` component
An AWS Query API that is compatible with AWS CloudFormation. It
processes API requests by sending them to the ``heat-engine`` over RPC.
``heat-api-cloudwatch`` component
A CloudWatch-like API service to the heat project.
``heat-engine``
Orchestrates the launching of templates and provides events back to
the API consumer.