Jump to: navigation, search

Difference between revisions of "Heat"

(Links: Fix internal links + add link to VPC Resources Support)
(Meetings)
(38 intermediate revisions by 18 users not shown)
Line 1: Line 1:
__TOC__
+
__NOTOC__
  
'''Summary''':
+
= OpenStack Orchestration =
  
Heat is a service to orchestrate multiple composite cloud applications using the [http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/Welcome.html?r=7078 AWS CloudFormation] template format, through both an [[OpenStack]]-native ReST API and a CloudFormation-compatible Query API.
+
The mission of the OpenStack Orchestration program is to create a human- and machine-accessible service for managing the entire
 +
lifecycle of infrastructure and applications within OpenStack clouds.
  
'''Detailed Description''':
+
= Heat =
  
What is the purpose of the project and vision for it?
+
Heat is the main project in the OpenStack Orchestration program. It implements an orchestration engine to launch multiple composite cloud applications based on templates in the form of text files that can be treated like code. A native Heat template format is evolving, but Heat also endeavours to provide compatibility with the [http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/Welcome.html?r=7078 AWS CloudFormation] template format, so that many existing CloudFormation templates can be launched on OpenStack. Heat provides both an [http://developer.openstack.org/api-ref-orchestration-v1.html OpenStack-native ReST API] and a CloudFormation-compatible Query API.
  
* Heat provides an AWS CloudFormation implementation for [[OpenStack]] that orchestrates an AWS CloudFormation template describing a cloud application by executing appropriate [[OpenStack]] API calls to generate running cloud applications. 
+
Why ‘Heat’? It makes the clouds rise!
  
Describe the relevance of the project to other [[OpenStack]] projects and the [[OpenStack]] mission to provide a ubiquitous cloud computing platform:
+
== How it works ==
  
* 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.
+
* A Heat template describes the infrastructure for a cloud application in a text file that is readable and writable by humans, and can be checked into version control, diffed, &c.
* Currently no other CloudFormation implementation exists for [[OpenStack]]. The developers believe cloud developers have a strong desire to move workloads from AWS to [[OpenStack]] deployments. Given the missing gap of a well-implemented and integrated CloudFormation API in [[OpenStack]], we provide a high quality implementation of this gap improving the ubiquity of [[OpenStack]].
+
* Infrastructure resources that can be described include: servers, floating ips, volumes, security groups, users, etc.
 
+
* Heat also provides an autoscaling service that integrates with [[Telemetry]], so you can include a scaling group as a resource in a template.
= Heat =
+
* Templates can also 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.
 
+
* Heat manages the whole lifecycle of the application - when you need to change your infrastructure, simply modify the template and use it to update your existing stack. Heat knows how to make the necessary changes. It will delete all of the resources when you are finished with the application, too.
Heat provides a REST API to orchestrate multiple composite cloud applications implementing the [http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/Welcome.html?r=7078 AWS CloudFormation] API.
+
* Heat primarily manages infrastructure, but the templates integrate well with software configuration management tools such as [https://s3.amazonaws.com/cloudformation-examples/IntegratingAWSCloudFormationWithPuppet.pdf Puppet] and [http://www.full360.com/2011/02/27/integrating-aws-cloudformation-and-chef.html Chef]. The Heat team is working on providing even better integration between infrastructure and software.
 
 
Why heat?  It makes the clouds rise!
 
  
 
== Architecture ==
 
== Architecture ==
  
The developers are focused on creating an [[OpenStack]] style project using [[OpenStack]] design tenets, implemented in Python.  We have started with full integration with Keystone.  We have a number of components.
+
Heat comprises a number of Python applications:
 
 
As the developers have only started development in March 2012, the architecture is evolving rapidly.
 
  
 
=== heat ===
 
=== heat ===
  
The heat tool is a CLI which communicates with the heat-api to execute AWS CloudFormation APIs. End developers could also use the heat REST API directly.
+
The heat tool is a CLI which communicates with the heat-api to execute AWS CloudFormation APIs. Of course this is not required—developers could also use the Heat APIs directly.
  
 
=== heat-api ===
 
=== heat-api ===
  
The heat-api component provides an [[OpenStack]]-native REST API that processes API requests by sending them to the heat-engine over RPC.
+
The heat-api component provides an [http://developer.openstack.org/api-ref-orchestration-v1.html OpenStack-native ReST API] that processes API requests by sending them to the heat-engine over RPC.
  
 
=== heat-api-cfn ===
 
=== heat-api-cfn ===
  
The heat-api-cfn component provides an AWS Query API that is compatible with AWS CloudFormation and processes API requests by sending them to the heat-engine over RPC.
+
The heat-api-cfn component provides an AWS-style Query API that is compatible with AWS CloudFormation and processes API requests by sending them to the heat-engine over RPC.
  
 
=== heat-engine ===
 
=== heat-engine ===
  
The heat engine's main responsibility is to orchestrate the launching of templates and provide events back to the API consumer.
+
The heat engine does the main work of orchestrating the launch of templates and providing events back to the API consumer.
 
 
The templates integrate well with [https://s3.amazonaws.com/cloudformation-examples/IntegratingAWSCloudFormationWithPuppet.pdf Puppet] and [http://www.full360.com/blogs/integrating-aws-cloudformation-and-chef Chef]
 
  
= Links =
+
== Development ==
* [[Heat/RoadMap|RoadMap]]
+
* [https://github.com/openstack/heat Source repository]
* [https://launchpad.net/heat LaunchPad]
+
* [https://github.com/openstack/python-heatclient Client source repository]
* [https://github.com/openstack/heat GitHub Repository]
+
* [https://github.com/openstack/heat-templates Example templates]
* [[Heat/TroubleShooting|Trouble Shooting]]
+
* [https://bugs.launchpad.net/heat Bug tracker]
 +
* [https://blueprints.launchpad.net/heat Feature tracker]
 +
* [http://tarballs.openstack.org/heat/ Tarballs]
 +
* [[Heat/Plugins|Heat Plugin Developer Guide]]
 
* [[Heat/DevelopmentProcess|Developer Process]]
 
* [[Heat/DevelopmentProcess|Developer Process]]
* [[Heat/ReleaseProcess|Release Process]]
+
* [[Heat/CoreTeam|Core Team]]
* [[Heat/BotoCompatibility|Boto Compatibility Matrix]]
+
* [https://review.openstack.org/#/dashboard/?foreach=%28project%3Aopenstack%2Ddev%2Fheat%2Dcfnclient+OR+project%3Aopenstack%2Fheat+OR+project%3Aopenstack%2Fheat%2Dcfntools+OR+project%3Aopenstack%2Fheat%2Dspecs+OR+project%3Aopenstack%2Fheat%2Dtemplates+OR+project%3Aopenstack%2Fpython%2Dheatclient+OR+project%3Aopenstack%2Ftripleo%2Dheat%2Dtemplates+OR+project%3Aopenstack%2Fheat%2Dtranslator+OR+project%3Aopenstack%2Fpuppet%2Dheat%29+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D%2D1+label%3AVerified%3E%3D1%2Cjenkins+NOT+label%3ACode%2DReview%3E%3D0%2Cself&title=Heat+Review+Inbox&Proposal+Bot+Proposals=owner%3A%22OpenStack+Proposal+Bot+%3Copenstack%2Dinfra%40lists.openstack.org%3E%22&Needs+final+%2B2=label%3ACode%2DReview%3E%3D2+NOT+label%3ACode%2DReview%3C%3D%2D1+limit%3A50&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%2DReview%3C%3D2+age%3A5d&You+are+a+reviewer%2C+but+haven%27t+voted+in+the+current+revision=NOT+label%3ACode%2DReview%3C%3D2%2Cself+reviewer%3Aself&Passed+Jenkins%2C+No+Negative+Feedback=NOT+label%3ACode%2DReview%3E%3D2+NOT+label%3ACode%2DReview%3C%3D%2D1+limit%3A50&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+label%3ACode%2DReview%3C%3D2+age%3A2d&Negative+Feedback=label%3ACode%2DReview%3C%3D%2D1+limit%3A10 Code Review Dashboard]
* [[Heat/VPC Resources Support|VPC Resources Support]]
 
  
 
== Getting Started Guides ==
 
== Getting Started Guides ==
* [https://github.com/openstack/heat/blob/master/docs/GettingStarted.rst#readme Getting started on Fedora 16+]
+
There are getting started guides for several distributions in the [http://docs.openstack.org/developer/heat/getting_started/index.html Heat Documentation]
* [http://wiki.openstack.org/Heat/GettingStartedUsingDevstack Getting started on Devstack].
+
* The installation guides on http://docs.openstack.org
* [http://wiki.openstack.org/Heat/GettingStartedUsingMasterOnUbuntu Getting started on Ubuntu Precise].
+
* [http://docs.openstack.org/developer/heat/getting_started/on_fedora.html Getting Started With Heat on Fedora]
 +
* [http://docs.openstack.org/developer/heat/getting_started/on_ubuntu.html Getting Started With Heat on Ubuntu]
 +
* [http://docs.openstack.org/developer/heat/getting_started/on_devstack.html Heat and Devstack]
 +
* [http://docs.openstack.org/user-guide/content/heat_client_commands.html Heat chapter] of the [http://docs.openstack.org/cli/quick-start/content/index.html OpenStack Clients Guide]
  
== HOWTO Guides ==
+
== Other Links ==
* [[Heat/Using-the-metadata-server|Using Metadata Server]]
+
* [http://docs.openstack.org/developer/heat/template_guide/hot_guide.html Heat Orchestration Template (HOT) Guide]
* [[Heat/Configuring-Floating-IPs|Using Floating IPs]]
+
* [[Heat/ApplicationDeployment|How Heat uses CloudFormation and cloud-init for application deployment]]
* [[Heat/Using-HA|Using HA]]
+
* [[Heat/BotoCompatibility|Boto Compatibility Matrix]]
* [[Heat/Using-CloudWatch|Using CloudWatch]]
+
* [[Heat/VPC Resources Support|VPC Resources Support]]
* [[Heat/Using-Boto|Using Boto]]
+
* [https://wiki.openstack.org/w/index.php?title=Special%3APrefixIndex&prefix=Heat&namespace=0 All topics in the Heat Wiki Namespace]
* [[Heat/Running-openshift|Running Openshift on heat]]
+
* [https://wiki.openstack.org/wiki/Heat-Translator Heat Translator Project]
* [[Heat/LocalPackageCacheMirror|Local package Cache/Mirror for faster instance builds]]
 
 
 
= IRC =
 
 
 
The developers use IRC in #heat on freenode for development discussion.
 
 
 
= Meetings =
 
 
 
The [http://wiki.openstack.org/Meetings/HeatAgenda Heat IRC meeting] is held on Wednesday at 2000 UTC
 
 
 
= Status of implementation =
 
 
 
November, 2012 - Heat has been incubated!
 
 
 
October 23, 2012 - [[OpenStack]]-native API support, authenticated metric collection via CloudWatch-compatible API [https://github.com/heat-api/heat/tarball/v7.release v7].
 
  
September 20, 2012 - Automated functional testing, many bug fixes, improved CloudWatch-compatible API, more templates [https://github.com/heat-api/heat/tarball/v6.release v6].
+
== [https://review.openstack.org/#/admin/groups/114,members heat-core] Blogs & Presentation Material ==
 +
* Steve Baker [http://blog.stevebaker.org/ Blog]
 +
* Zane Bitter [http://www.zerobanana.com/tags/OpenStack Blog] & [https://github.com/zaneb/presentations/releases Presentation Material]
 +
* Steve Dake [https://sdake.wordpress.com/ Blog] & [https://github.com/sdake/slides Presentation Material]
 +
* Steve Hardy [https://hardysteven.blogspot.co.uk/ Blog] & [https://github.com/hardys/presentations Presentation Material]
 +
* Angus Salkeld [http://ahsalkeld.wordpress.com/ Blog]
  
July 31, 2012 - Access scoping by tenant in Keystone, CloudWatch-compatible API for metrics, more templates [https://github.com/heat-api/heat/tarball/v5.release v5].
+
= Get involved =
 +
== IRC ==
  
June 27, 2012 - Ubuntu Support, High Availability improvements, more templates [https://github.com/heat-api/heat/tarball/v4.release v4].  See Heat's [https://github.com/heat-api/heat/wiki wiki] for documentation to get started.
+
The developers use IRC in <code>#heat</code> on [http://freenode.net/ Freenode] for development discussion.
  
May 14, 2012 - High Availability [https://github.com/heat-api/heat/tarball/v3.release v3].  See Heat's [https://github.com/heat-api/heat/wiki/Getting-Started-with-Heat-v3 getting started guide].
+
== Meetings ==
  
April 23, 2012 - Multiple Instance WordPress template [https://github.com/heat-api/heat/tarball/v2-M1.release v2-M1]. See Heat's [https://github.com/heat-api/heat/wiki/Getting-Started-with-Heat-v2-M1 getting started guide].
+
Meetings are held on IRC in <code>#openstack-meeting-5</code> on [http://freenode.net/ Freenode] every Wednesday. See the [http://wiki.openstack.org/Meetings/HeatAgenda Heat agenda page] for times and details.
  
April 4, 2012 - Launching a WordPress template with [https://github.com/heat-api/heat/tarball/v1-POC.release POC].  See Heat's [https://github.com/heat-api/heat/wiki/HeatGettingStartedPOC getting started guide]. 
+
== Mailing list ==
  
March 16, 2012 - Code base started.
+
Discussions about Heat happens on the [http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev openstack-dev] mailing list. Please use the tag <code>[Heat]</code> in the subject line for new threads.

Revision as of 13:00, 6 February 2017


OpenStack Orchestration

The mission of the OpenStack Orchestration program is to create a human- and machine-accessible service for managing the entire lifecycle of infrastructure and applications within OpenStack clouds.

Heat

Heat is the main project in the OpenStack Orchestration program. It implements an orchestration engine to launch multiple composite cloud applications based on templates in the form of text files that can be treated like code. A native Heat template format is evolving, but Heat also endeavours to provide compatibility with the AWS CloudFormation template format, so that many existing CloudFormation templates can be launched on OpenStack. Heat provides both an OpenStack-native ReST API and a CloudFormation-compatible Query API.

Why ‘Heat’? It makes the clouds rise!

How it works

  • A Heat template describes the infrastructure for a cloud application in a text file that is readable and writable by humans, and can be checked into version control, diffed, &c.
  • Infrastructure resources that can be described include: servers, floating ips, volumes, security groups, users, etc.
  • Heat also provides an autoscaling service that integrates with Telemetry, so you can include a scaling group as a resource in a template.
  • Templates can also 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.
  • Heat manages the whole lifecycle of the application - when you need to change your infrastructure, simply modify the template and use it to update your existing stack. Heat knows how to make the necessary changes. It will delete all of the resources when you are finished with the application, too.
  • Heat primarily manages infrastructure, but the templates integrate well with software configuration management tools such as Puppet and Chef. The Heat team is working on providing even better integration between infrastructure and software.

Architecture

Heat comprises a number of Python applications:

heat

The heat tool is a CLI which communicates with the heat-api to execute AWS CloudFormation APIs. Of course this is not required—developers could also use the Heat APIs directly.

heat-api

The heat-api component provides an OpenStack-native ReST API that processes API requests by sending them to the heat-engine over RPC.

heat-api-cfn

The heat-api-cfn component provides an AWS-style Query API that is compatible with AWS CloudFormation and processes API requests by sending them to the heat-engine over RPC.

heat-engine

The heat engine does the main work of orchestrating the launch of templates and providing events back to the API consumer.

Development

Getting Started Guides

There are getting started guides for several distributions in the Heat Documentation

Other Links

heat-core Blogs & Presentation Material

Get involved

IRC

The developers use IRC in #heat on Freenode for development discussion.

Meetings

Meetings are held on IRC in #openstack-meeting-5 on Freenode every Wednesday. See the Heat agenda page for times and details.

Mailing list

Discussions about Heat happens on the openstack-dev mailing list. Please use the tag [Heat] in the subject line for new threads.