blob: e14d670eb90d5da26456be4b59e512a123f5c440 [file] [log] [blame]
Filip Pytloun923d8692015-10-06 16:28:32 +02001
2====
3Heat
4====
5
6Heat 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.
7
8Sample pillars
9==============
10
11Single Heat services on the controller node
12
13.. code-block:: yaml
14
15 heat:
16 server:
17 enabled: true
18 version: icehouse
19 bind:
20 metadata:
21 address: 10.0.106.10
22 port: 8000
23 waitcondition:
24 address: 10.0.106.10
25 port: 8000
26 watch:
27 address: 10.0.106.10
28 port: 8003
29 cloudwatch:
30 host: 10.0.106.20
31 api:
32 host: 10.0.106.20
33 api_cfn:
34 host: 10.0.106.20
35 database:
36 engine: mysql
37 host: 10.0.106.20
38 port: 3306
39 name: heat
40 user: heat
41 password: password
42 identity:
43 engine: keystone
44 host: 10.0.106.20
45 port: 35357
46 tenant: service
47 user: heat
48 password: password
49 message_queue:
50 engine: rabbitmq
51 host: 10.0.106.20
52 port: 5672
53 user: openstack
54 password: password
55 virtual_host: '/openstack'
56 ha_queues: True
57
58Heat client with specified git templates
59
60.. code-block:: yaml
61
62 heat:
63 client:
64 enabled: true
65 source:
66 engine: git
67 address: git@repo.domain.com/heat-templates.git
68 revision: master
69
70Heat system definition of several stacks/systems
71
72.. code-block:: yaml
73
74 heat:
75 control:
76 enabled: true
77 system:
78 web_production:
79 format: hot
80 template_file: /srv/heat/template/web_cluster.hot
81 environment: /srv/heat/env/web_cluster/prd.env
82 web_staging:
83 format: hot
84 template_file: /srv/heat/template/web_cluster.hot
85 environment: /srv/heat/env/web_cluster/stg.env
86
87Ceilometer notification
88
89.. code-block:: yaml
90
91 heat:
92 server:
93 enabled: true
94 version: icehouse
95 notification: true
96
97Usage
98=====
99
100Install Contrail Heat plugin for additional resources
101
102.. code-block:: bash
103
104 pip install git+https://github.com/Juniper/contrail-heat.git@R1.30
105
106Read more
107=========
108
109* http://docs.openstack.org/developer/heat/man/heat-keystone-setup.html
110* http://docwiki.cisco.com/wiki/OpenStack_Havana_Release:_High-Availability_Manual_Deployment_Guide
111
112
113Things to improve
114=================
115
116* IBM UrbanCode Deploy - has resources for AWS and VMWare
117 http://www.ibm.com/developerworks/rational/library/multi-platform-application-deployment-urbancode-deploy/
118