Openstack-Heat研究文档.docx

文件状态：
【√】 草稿
【 】 正式发布
【】 正在修改中
类 别
云计算
项目名称
Openstack Heat组件研究
版 本
日期
作者
备注说明
1.0
2015/08/31
程成
初稿

审 核

密 级
秘密
应用范围
陕西省信息化工程研究院软件研发部
版权所有
陕西省信息化工程研究院

Openstack Heat组件研究
目 录
OPENSTACK HEAT研究 3
1. Heat简介 3
2. Heat架构 3
2.1 Heat-engine 4
2.2 Heat Client 4
2.3 Heat-api 5
2.4 heat-api-cfn 5
2.5 Heat-cfntools 5
3. Heat模板 5
3.1 *formatversion字段介绍 6
3.2 heat_template_version字段介绍 7
4. Heat应用 15
4.1 命令行使用 15
4.2 界面Dashboard使用 16
4.3 实例：Wordpress应用部署 17
5. 参考文献： 21

Openstack Heat研究
1. Heat简介
heat简单来说就是用户可以预先定义一个规定格式的任务模版，任务模版中定义了一连串的相关任务（例如用某配置开几台虚拟机，然后在其中一台中安装一个mysql服务，设定相关数据库属性，然后再配置几台虚拟机安装web服务群集等等），然后将模版交由Heat执行，就会按一定的顺序执行heat模版中定义的一连串任务。
任务模板中的一连串任务就是用来指导openstack创建应用系统。在heat中，这个创建的应用系统称之为Stack。Nova是直接创建虚拟机，Heat则是直接创建应用系统。Heat作为相对独立的模块建立在Openstack其他模块之上。
2. Heat架构
基于预先定义的模板，Heat通过自身的orchestration Engine来实现复杂应用的创建启动。Heat原生的模板格式目前还在不停地演进中，但是对CloudFormation的格式具有良好的支持。存在的CloudFormation的模板可以在OpenStack平台通过heat来启动。从架构来看，Heat有一些重要的组件，下图为各组件之间的关系图。

2.1 Heat-engine
heat-engine是heat中的核心模块，主要的逻辑业务处理模块。此模块最终完成应用系统的创建和部署。整个heat的实现最为关键的代码在heat-engine，heat就是来操作stack，管理stack的整个生命周期: create，update，delete。
重点看create的过程，查看heat stack-create命令：
三个关键的optional arguments:
template-file: 模板文件
environment-file: 环境文件
parameters: 设置模板文件中的parameters
2.2 Heat Client
Heat client是Heat project 提供的CLI工具，类似于其他项目的client。对于heat tools的使用，可以通过安装后查看。
2.3 Heat-api
Heat-api 类似于nova-api，提供了原生的restful API对外使用。用户对API的调用，由heat-api处理之后，最终通过RPC传递给Heat-engine来进一步处理。
2.4 heat-api-cfn
heat-api-cfn组件则提供了Amazon style 的查询 API，因此可以完全兼容于
Amazon的CloudFormation，对于API的请求，同heat-api类似，处理之后，通过RPC传递给heat-engine进一步处理.
2.5 Heat-cfntools
这个工具是一个单独的工具，代码没在heat project里面，可以单独下载。这个工具主要用来完成虚拟机实例内部的操作配置任务。在创建虚拟机竟像时，需要在镜像中安装heat-cfntools工具。
3. Heat模板
Heat的目的之一就是致力于应用系统的自动化部署，那么若要自动化部署，则需要存在某个语言规范来描述应用系统，并且解决应用系统在不同场合下的配置适应问题。Heat模板文件则是用来对前者的支持。
模板文件的格式多种多样，例如， Amazon提供的cloudformation格式，Heat自有的格式HOT, Json等等，格式之间的差别在于表现形式。
template 中有三个formatversion，第一种是aws的格式，表示这是一个json
文件； 第二种是heat为了扩展aws并且更好的加入注释，引入的 yaml格式文件；第三种是openstack的heat特有的hot格式的头部，也是基于yaml格式的。
"AWSTemplateFormatVersion": "2010-09-09" 
"HeatTemplateFormatVersion": "2012-12-12"  
"heat_template_version": "2013-05-23 " 
3.1 *formatversion字段介绍
AWSTemplateFormatVersion和HeatTemplateFormatVersion支持的字段”AWSTemplateFormatVersio”格式版本，指定了编写模板时依据的AWS CloudFormation模板版本 ;
“HeatTemplateFormatVersion”格式版本,指定了编写模板时依据的HeatTemplateFormation模板版本 
“Description” 字段，可选描述，记录该模板的描述。 
“Mappings” 可选映像，通过映像部分，可以声明条件值，可在Resources和Outputs部分使用内建函数Fn::FindInMap将与键对应的值返回到 Mappings 部分声明的双层映射中。 
“Parameters”，  可选字段，可以定义用于控制是否创建某些资源或者是否在堆栈创建或更新过程中为某些资源属性分配值的条件。  
“Resources”,  资源部分将列出堆栈的成员资源。每项资源将予以分别列明，并指定创建此特定资源所必需的资源属性。可在资源和输出部分取消资源参考。
 “Outputs”，可选输出，在 Outputs 部分，您可以选择对响应 
aws cloudformation  describe-stacks 命令而返回的自定义 值进行定义。这些输出值将包括基于文本、资源、参数、虚拟参数和内部函数的信息。
3.2 heat_template_version字段介绍
这里具体介绍，openstack的hot模板格式，后边的应用实例也以基于hot格式。
Ø heat_template_version: 2013-05-23 
2013-05-23或者是在这个日期之后的日期表明YAML被定义为是HOT模板 
Ø description:  用来描述模板的一些信息，通常可以在创建完模板之后看到。
Ø parameter_groups:  用来表明一些参数应该被怎样分组以及提供参数的方式，这部分是可选的，当没有输出值时可以省略。
Ø Parameters:  用来对初始化模板时必须要提供的一些参数的说明，是可选的，当没有输出值时可以省略。 
Ø Resources:  这部分包含模板单一资源的声明，必须包含至少一个应该在HOT模板中被定义的资源，否则模板不会做任何实例化的事。
Ø Outputs:  这部分用于在模板被实例化后输出给用户可以使用参数信息，这部分是可选的，当没有输出值时可以省略
3.2.1 parameter_groups详细介绍
这些组被定义为一个列表，列表中每个组包含一个相关的参数列表。这些列表用于定义参数的期望顺序。每个参数应该跟只使用一次参数名称同时将这个参数绑定到parameters section中的参数定义部分的指定的组相关联。
下面看下parameter_groups具体内容： 
parameter_groups: 
- label: <human-readable label of parameter group> 
description: <description of the parameter group> 
parameters: - <param name> - <param name> 
label标签   一个定义与参数相关联的组的可读的标签。 
description   这个属性允许给参数组一个可读的描述。
Parameters   与参数组相关联的参数列表。 
Param name   在后面参数部分被定义的参数的名字。 
3.2.2 Parameters 详细介绍 
参数部分允许为在实例化模板的时候指定输入参数，这些参数通常被用于自定义每个部署或者应用，例如设定自定义的用户名和密码。每个参数会在一个单独的小模块（嵌套块）中被定义，模块中第一行是参数的名称，其他的属性比如类型或者默认值将作为模块中其他的的元素。
下面看下parameter的具体内容： 
parameters: 
<param name>:     
type: <string | number | json | comma_delimited_list | boolean>    
label: <human-readable name of the parameter>    
description: <description of the parameter>   
default: <default value for parameter>   
hidden: <true | false>   
constraints:         
 <parameter constraints>  param name 
每个参数模块中所定义的参数的名字。
Ø Type  这个属性是参数的类型。目前所支持的类型有tring、number、comma_delimited_list、json、 boolean。 Label  这个可选属性允许为参数提供一个可读的名字，通常省略。
Ø Description  这个可选属性允许为参数提供一个可读的描述。 
Ø Default  这个可选属性是为了在部署或者应用中没有指定参数的值 时定义一个默认的值。
Ø Hidden  这个可选属性允许当从模板运行时创建一个栈的时候隐藏参数的值，如果没有指明，默认值是false。
Ø Constraints  这个可选属性允许指明其他的参数限制条件，比如数字参数的最大值或者最小值。 
下面是一个关于两个参数定义的简单的例子，可以看出description和label实际上是可选的，但是为每个参数提供description和label是很好的做法。 
Parameters:
user_name:
type: string
label: User Name
description: User name to be configured for the app
port_number:
type: number       
label: Port Number        
description: Port number to be configured 
参数定义的限制模块允许定义额外的参数值的限制条件，在模板实例化的时候，用户所提供的参数值会被这些条件去验证以确保用户所提供的值是符合用户的期望的，限制条件被定义在一个列表中，如下所示： 
constraints:       
 - <constraint type>: <constraint definition>      
description:  <constraint description> 
Ø constraint type  限制条件的类型表明所定义的限制条件的种类 
Ø constraint definition  这个是根据限制类型所定义的具体的限制条件 
Ø description  这个可选属性允许指定当前限制条件的具体描述，例如，当所提供的输入值不符合限制条件，这个描述内容将会被呈现给用户（其实就是创建过程中如果出现错误，错误的具体描述），如果省略，一个默认的值将会呈现给用户。
下面的例子是定义了一个带有两个限制条件的一个字符串参数，表明当尽管每个限制条件的描述是可选的，为每个应用部署时提供限制条件的描述是非常重要的。 
Parameters: 
user_name:    
  type: string     
label: User Name     
description: User name to be configured for the application 
constraints: 
- length: { min: 6, max: 8 } 
description: User name must be between 6 and 8 
Ø 长度的限制适用于字符串类型的参数，允许定义字符串参数值的最大长度和最小长度，语法格式如下： 
length: { min: <lower limit>, max: <upper limit> }
Ø 范围的限制适用于数值类型的参数，允许定义数值类型的参数的最大值和最小值，语法格式如下： 
range: { min: 0, max: 10 }
Ø allowed_values限制条件适用于字符串或者数字类型的参数，指明一组可用的参数值，在部署的时候，用户提供的参数值必须在这一组参数值中。语法格式如下： 
allowed_values: [ <value>, <value>, ... ]
或者可以使用下面的格式：
allowed_values: - <value> - <value> - ...
Ø allowed_pattern 允许模式限制条件适用于字符串参数，定义一个具体的正则表达式，用于匹配用户提供的参数值，语法格式如下： 
allowed_pattern: <regular expression>
Ø custom_constraint限制条件提供一个额外的验证步骤，通常用于检验后台中资源是否存在，custom_constraint限制条件是通过插件的方式实现的，能够提供更高级的限制条件验证逻辑。语法格式如下： 
custom_constraint: <name>
Pseudo Parameters  模板中除了用户自定义的参数外，Heat也为每个stack创建了两个参数，一个是 “OS::stack_name”，是stack的名字，另一个是“OS::stack_id”，是stack的id，这两个值可以像用户自定义的参数一样通过“get_param”内建函数被访问。
3.2.3 Resources详细介绍 
在资源部分，实际资源的模板将从被定义的HOT模板中构成一个stack的部署，每个资源在资源部分被定义成一个单独的块，语法格式如下： 
resources:
<resource ID>:
type: <resource type>
properties:  
<property name>: <property value> 
metadata:     
<resource specific metadata> 
depends_on: <resource ID or list of ID> 
update_policy: <update policy> 
deletion_policy: <deletion policy>  
Ø resource ID一个资源块是由资源ID所标识，使模板中资源部分独一无二的。
Ø  type  这个属性表明资源的类型，比如OS::Nova::Server. 
Ø properties  这个可选部分包含一个资源指定属性的列表，属性值可以在适当的位置提供或者通过函数提供。
Ø  metadata  这个可选部分包含资源类型的特定metadata。
Ø depends_on  这个可选属性允许指明当前资源跟其他资源的依赖关系。 
Ø update_policy  该可选属性允许以嵌套字典的形式指明资源更新的策略，支持更新或者不更新策略，同时确切的语义依赖于当前的资源。
Ø  deletion_policy  该可选属性允许为资源指明删除策略，具体哪种删除策略依赖于当前资源的类型。根据资源的类型，资源块可以包含更多的资源具体数据，基本上能被用于CFN模板的所有资源类型同样可以被用于HOT模板中，适用于上文所述YMAL结构。
下面是一个简单的带有固定属性值的计算资源定义的例子： 
resources:     
my_instance:        
type: OS::Nova::Server      
properties:           
flavor: m1.small           
image: F18-x86_64-cfntools  
Resource Dependencies通过在一个属性部分的depends_on属性，能够定义资源与资源之间的依赖关系，如果一个资源仅仅依赖另外一个资源，那么另外一个资源的ID将作为depends_on属性的值，如下例所示： 
resources:    
server1:        
type: OS::Nova::Server       
depends_on: server2  
server2:  
type: OS::Nova::Server 
如果一个资源依赖的资源不止一个，depends_on属性值将以一个资源IDs列表的形式呈现，如下例所示： 
resources:
server1:       
 type: OS::Nova::Server        
depends_on: [ server2, server3 ]   
server2:        
type: OS::Nova::Server   
server3:       
 type: OS::Nova::Server 
3.2.4 Outputs 详细介绍
Outputs Section  在输出部分，任何向用户于提供可用输出参数将被定义，通常，参数可以是所部署的实例的IP地址或者所部署的栈的web应用实例的URLs，每个输出参数将在输出部分作为一个单独的块被定义，语法格式如下： 
outputs:    
 <parameter name>:        
description: <description>      
value: <parameter value> 
Ø parameter name  一个输出参数块中主要的是输出参数的名字，这个输出参数名字在模板中的输出部分是独一无二的。 
Ø Desceiption  这个元素提供一个关于输出参数的简短的描述。 
Ø Parameter value  这部分是输出参数的值，通常是通过一个函数来解析去获得值，例如去获得一个stack的资源属性值。下面的例子表明一个计算资源的IP地址是如何作为一个输出参数： 
outputs:     
instance_ip:        
description: IP address of the deployed compute instance              
value: { get_attr: [my_instance, first_address] }

以上只是介绍部分字段，各字段参数详情可参考：
http://docs.openstack.org/developer/heat/template_guide/index.html
http://docs.openstack.org/developer/heat/template_guide/hot_spec.html#heat-template-version
4. Heat应用
4.1 命令行使用
创建名为demo的Stack：
heat stack-create demo –f ./template1.yaml

观察stack启动的状态: heat stack-list

查看stack详情： heat resource-list demo

简单实例template1.yaml：
heat_template_version: 2013-05-23
description: Simple template to deploy a single compute instance
resources:
my_instance:
type: OS::Nova::Server
properties:
key_name: heat_key
image: 9a51863b-e58a-4bbe-bddc-920178c738a2
flavor: m1.small
networks:
- {network: 7e83541b-3bb9-4649-b307-9d3fbcd9e998}
4.2 界面Dashboard使用
在Dashboard上的操作：
Ø 进入“栈”菜单项，选择“启动栈”，支持三种方式（直接输入、url、文件）加载模板，这里选择直接输入，将模板写入的文本框中，如下图：

Ø 点击“下一步”，输入栈名和密码后，创建栈；

Ø 创建完成后

由于栈的资源为一台虚拟机，所以可以在“云主机”中查看创建的虚拟机：

4.3 实例：Wordpress应用部署
heat模板文件：
heat_template_version: 2013-05-23
description: >
Heat WordPress template deployment using a local MySQL database to store the data.
parameters:
key_name:
type: string
default: heat_key
description : Name of a KeyPair to enable SSH access to the instance
instance_type:
type: string
description: Instance type for WordPress server
default: m1.small
constraints:
- allowed_values: [m1.small, m1.medium, m1.large]
description: instance_type must be one of m1.small, m1.medium or m1.large
image_id:
type: string
description: ID of the image to use for the WordPress server
default: ubuntu12.04.final.img
db_name:
type: string
description: WordPress database name
default: wordpress
constraints:
- length: { min: 1, max: 64 }
description: db_name must be between 1 and 64 characters
- allowed_pattern: '[a-zA-Z][a-zA-Z0-9]*'
description: >
db_name must begin with a letter and contain only alphanumeric
characters
db_username:
type: string
description: The WordPress database admin account username
default: root
hidden: true
constraints:
- length: { min: 1, max: 16 }
description: db_username must be between 1 and 64 characters
- allowed_pattern: '[a-zA-Z][a-zA-Z0-9]*'
description: >
db_username must begin with a letter and contain only alphanumeric
characters
db_password:
type: string
description: The WordPress database admin account password
default: admin
hidden: true
constraints:
- length: { min: 1, max: 41 }
description: db_username must be between 1 and 64 characters
- allowed_pattern: '[a-zA-Z0-9]*'
description: db_password must contain only alphanumeric characters
db_root_password:
type: string
description: Root password for MySQL
default: admin
hidden: true
constraints:
- length: { min: 1, max: 41 }
description: db_username must be between 1 and 64 characters
- allowed_pattern: '[a-zA-Z0-9]*'
description: db_password must contain only alphanumeric characters
secgroup_id:
type: string
description : Id of the security groupe
default: default
public_net:
type: string
description: public network id
default: 004df4b2-3050-4646-958f-f0f2621df687
private_net:
type: string
description: private network id
default: 7e83541b-3bb9-4649-b307-9d3fbcd9e998
private_subnet:
type: string
description: private_subnet id
default: b20dfcde-55f0-40c6-b645-2eae7d116ee2

resources:
wordpress_port:
type: OS::Neutron::Port
properties:
network_id: { get_param: private_net }
security_groups: { get_param: secgroup_id }
fixed_ips:
- subnet_id: { get_param: private_subnet }

wordpress_floating_ip:
type: OS::Neutron::FloatingIP
properties:
floating_network_id: { get_param: public_net }
port_id: { get_resource: wordpress_port }

wordpress_instance:
type: OS::Nova::Server
properties:
image: { get_param: image_id }
flavor: { get_param: instance_type }
key_name: { get_param: key_name }
networks:
- port: { get_resource: wordpress_port }
user_data:
str_replace:
template: |
#!/bin/bash -v
apt-get install -y apache2 libapache2-mod-php5 php5 php5-mysql mysql-server-5.5 mysql-server mysql-client
wget -c http://wordpress.org/latest.tar.gz
tar xvzf wordpress.tar.gz
cp -rf wordpress /var/www
cp /var/www/wordpress/wp-config-sample.php
/var/www/wordpress/wp-config.php
# Setup MySQL root password and create a user
mysql -u root password db_root_password
cat << EOF | mysql -u root --password=db_rootpassword
CREATE DATABASE db_name;
FLUSH PRIVILEGES;
EXIT
EOF

sed -i s/database_name_here/db_name/ /var/www/wordpress/wp-config.php
sed -i s/username_here/db_user/ /var/www/wordpress/wp-config.php
sed -i s/password_here/db_password/ /var/www/wordpress/wp-config.php

params:
db_rootpassword: { get_param: db_root_password }
db_name: { get_param: db_name }
db_user: { get_param: db_username }
db_password: { get_param: db_password }

outputs:
WebsiteURL:
description: URL for Wordpress wiki
value:
str_replace:
template: http://host/wordpress
params:
host: { get_attr: [wordpress_floating_ip, floating_ip_address] }
执行模板后，会创建一台部署有Wordpress应用的云主机，stack中“概况”用访问的应用地址：

5. 参考文献：
(1) 陈沙克 （安装heat,包含实例）

(2) OpenStack Heat总结之：Icehouse中通过Heat+Ceilometer实现Autoscaling

(3) 臭蛋 Openstack Heat 学习

(4) OpenStack Heat模板学习二 之LBaaS(负载均衡即服务)

(5) 创建一个负载均衡 Apache 网站