Jump to: navigation, search

Difference between revisions of "Heat"

(Other Links)
(26 intermediate revisions by 14 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 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. 
 
 
 
Describe the relevance of the project to other [[OpenStack]] projects and the [[OpenStack]] mission to provide a ubiquitous cloud computing platform:
 
  
* 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.
+
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.
* 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]].
 
  
= Heat =
+
Why ‘Heat’? It makes the clouds rise!
  
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.
+
== How it works ==
  
Why heat?  It makes the clouds rise!
+
* 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 [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.
  
 
== 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 ==
 
== 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]
 +
* [https://storyboard.openstack.org/#!/project_group/82 Bug/Feature tracker]
 +
* [http://tarballs.openstack.org/heat/ Tarballs]
 
* [[Heat/Plugins|Heat Plugin Developer Guide]]
 
* [[Heat/Plugins|Heat Plugin Developer Guide]]
 
* [[Heat/DevelopmentProcess|Developer Process]]
 
* [[Heat/DevelopmentProcess|Developer Process]]
* [[Heat/BotoCompatibility|Boto Compatibility Matrix]]
+
* [[Heat/CoreTeam|Core Team]]
* [[Heat/VPC Resources Support|VPC Resources Support]]
+
* [https://review.openstack.org/#/dashboard/?foreach=%2528project%253Aopenstack%252Fheat+OR+project%253Aopenstack%252Fheat%252Dagents+OR%250Aproject%253Aopenstack%252Fheat%252Dtemplates+OR+project%253Aopenstack%252Fpython%252Dheatclient+OR%250Aproject%253Aopenstack%252Fheat%252Dcfntools+OR+project%253Aopenstack%252Fheat%252Dspecs+OR%250Aproject%253Aopenstack%252Fheat%252Ddashboard+OR+project%253Aopenstack%252Fheat%252Dtempest%252Dplugin%2529%250Astatus%253Aopen+NOT+owner%253Aself+NOT+label%253AWorkflow%253C%253D%252D1+label%253AVerified%253E%253D1%250ANOT+label%253ACode%252DReview%253C%253D%252D1%252Cself+NOT+label%253ACode%252DReview%253E%253D1%252Cself&title=Heat+Review+Inbox&Heat+Specs=project%253Aopenstack%252Fheat%252Dspecs&Stories+and+Bugs+Fixes=%2528intopic%253A+%255Estory%252F.%252A+OR+intopic%253A+%255Ebug%252F.%252A%2529&Blueprints=message%253A%2522Blueprint%2522&Needs+Feedback+%2528Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%2529=NOT+label%253ACode%252DReview%253E%253D1+NOT+label%253ACode%252DReview%253C%253D%252D1+age%253A5d&You+are+a+reviewer%252C+but+haven%2527t+voted+in+the+current+revision=reviewer%253Aself&Needs+final+%252B2=label%253ACode%252DReview%253E%253D2+limit%253A50&New+Contributors=reviewer%253A10068&Passed+Zuul%252C+No+Negative+Feedback=NOT+label%253ACode%252DReview%253E%253D2+NOT+label%253ACode%252DReview%253C%253D%252D1+limit%253A50 Code Review Dashboard]
  
 
== Getting Started Guides ==
 
== Getting Started Guides ==
 
There are getting started guides for several distributions in the [http://docs.openstack.org/developer/heat/getting_started/index.html Heat Documentation]
 
There are getting started guides for several distributions in the [http://docs.openstack.org/developer/heat/getting_started/index.html Heat Documentation]
 +
* The installation guides on http://docs.openstack.org
 
* [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_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_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/developer/heat/getting_started/on_devstack.html Heat and Devstack]
* [http://docs.openstack.org/cli/quick-start/content/heat_client.html Heat chapter] of the [http://docs.openstack.org/cli/quick-start/content/index.html OpenStack Clients Guide]
+
* [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 ==
 
* [[Heat/Using-the-metadata-server|Using Metadata Server]]
 
* [[Heat/Configuring-Floating-IPs|Using Floating IPs]]
 
* [[Heat/Using-HA|Using HA]]
 
* [[Heat/Using-CloudWatch|Using CloudWatch]]
 
* [[Heat/Using-Boto|Using Boto]]
 
* [[Heat/Running-openshift|Running Openshift on heat]]
 
* [[Heat/LocalPackageCacheMirror|Local package Cache/Mirror for faster instance builds]]
 
* [[Heat/TroubleShooting|Trouble Shooting]]
 
  
 
== Other Links ==
 
== Other Links ==
 +
* [http://docs.openstack.org/developer/heat/template_guide/hot_guide.html Heat Orchestration Template (HOT) Guide]
 
* [[Heat/ApplicationDeployment|How Heat uses CloudFormation and cloud-init for application deployment]]
 
* [[Heat/ApplicationDeployment|How Heat uses CloudFormation and cloud-init for application deployment]]
* [https://wiki.openstack.org/w/index.php?title=Special%3APrefixIndex&prefix=Heat&namespace=0|All topics in the Heat Wiki Namespace]
+
* [[Heat/BotoCompatibility|Boto Compatibility Matrix]]
 +
* [[Heat/VPC Resources Support|VPC Resources Support]]
 +
* [https://wiki.openstack.org/w/index.php?title=Special%3APrefixIndex&prefix=Heat&namespace=0 All topics in the Heat Wiki Namespace]
 +
* [https://wiki.openstack.org/wiki/Heat-Translator Heat Translator Project]
 +
 
 +
== [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]
 +
 
 +
= Get involved =
 +
== IRC ==
 +
 
 +
The developers use IRC in <code>#heat</code> on [http://freenode.net/ Freenode] for development discussion.
  
= IRC =
+
== Meetings ==
  
The developers use IRC in #heat on freenode for development discussion.
+
Meetings are held on IRC in <code>#heat</code> on [http://freenode.net/ Freenode] every Wednesday. See the [http://wiki.openstack.org/Meetings/HeatAgenda Heat agenda page] for times and details.
  
= Meetings =
+
== Mailing list ==
  
The [http://wiki.openstack.org/Meetings/HeatAgenda Heat IRC meeting] is held on Wednesday at 2000 UTC
+
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 04:33, 18 July 2018


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 #heat 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.