所选语种没有对应资源,请选择:

本站点使用Cookies,继续浏览表示您同意我们使用Cookies。Cookies和隐私政策>

提示

尊敬的用户,您的IE浏览器版本过低,为获取更好的浏览体验,请升级您的IE浏览器。

升级

FusionCloud 6.3.1 用户指南 (Region Type I) 10

评分并提供意见反馈 :
华为采用机器翻译与人工审校相结合的方式将此文档翻译成不同语言,希望能帮助您更容易理解此文档的内容。 请注意:即使是最好的机器翻译,其准确度也不及专业翻译人员的水平。 华为对于翻译的准确性不承担任何责任,并建议您参考英文文档(已提供链接)。
资源类型参考

资源类型参考

OS::Cinder::Volume

用于实现Cinder卷资源。

Cinder卷是块存储形式。例如,可以用于向实例提供存储。卷支持从快照、备份或镜像创建。此外,卷只能以大小形式进行创建。

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

availability_zone

待创建卷的可用分区。

string

-

backup_id

用于创建卷备份。

string

取值必须为cinder中已存在的卷备份。

description

用于描述卷。

string

-

image

用于创建卷的镜像名称或ID。

string

取值必须为glance中已存在的镜像。

metadata

与卷关联的键值对。

map

-

name

卷名称,用于区分不同卷。

string

-

size

卷的大小(以GB为单位)。 在更新时,仅支持增加卷大小。 除非指定了属性backup_id或source_volid或snapshot_id,否则此属性是必需的。

integer

最小值为1。

-

volume_type

如果指定,则使用的卷类型。

string

取值必须为cinder中已存在的卷类型。

属性

名称

说明

attachments

卷的附件列表。

availability_zone

卷所在可用分区。

bootable

卷是否能启动。

created_at

创建卷的时间戳。

display_description

卷说明。

display_name

卷名称。

metadata

用于关联卷的键值对。

metadata_values

以原始字典形式与卷相关联的键/值对。

multiattach

表示一个卷是否允许挂载多次。

size

卷大小以GB为单位。

snapshot_id

用于创建卷的快照(如果存在卷)。

source_volid

卷用作启动源(如果存在卷)。

status

卷的当前状态。

volume_type

卷与后端存储的映射类型(如果存在卷)。

HOT语法
heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Cinder::Volume
    properties:
      availability_zone: String
      backup_id: String
      description: String
      image: String
      metadata: {...}
      name: String
      size: Integer
      volume_type: String

OS::Cinder::VolumeAttachment

关联卷和实例的资源。

关联已有卷和实例。可指定卷在实例中的位置。

说明:

在模板中不能同时给一台虚拟机挂载多个卷。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

instance_uuid

挂载卷的服务器ID。

string

-

volume_id

待挂载卷的ID。

string

取值必须为cinder中已存在的volume。

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

mountpoint

卷在实例上的位置。该位置不指定,建议使用以下路 径:/dev/disk/by-id/virtio-<VolumeId>

string

-

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Cinder::VolumeAttachment
    properties:
      instance_uuid: String
      mountpoint: String
      volume_id: String

OS::Heat::AutoScalingGroup

可根据实际需求伸缩资源的自动伸缩组。

自动伸缩组允许创建相似资源所需的数量,这些资源由HOT格式的资源属性定义。如果需要创建很多相同的资源(例如一百套服务器、WaitCondition和WaitConditionHandle,甚至Neutron网络等),自动伸缩组就是方便而简单的方法。

说明:
  • 伸缩过程中,不能创建成员。否则,伸缩失败。
  • 不支持跨AZ自动伸缩。
必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

max_size

伸缩组中允许的最大资源数。

integer

取值至少为0。

-

min_size

伸缩组中允许的最小资源数。

integer

取值至少为0。

-

resource

伸缩组中的资源定义,HOT格式。模板中定义的该属性值。

map

-

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

cooldown

冷却时长,单位为秒。

integer

-

desired_capacity

资源的初始数量。

integer

-

rolling_updates

伸缩组更新策略。

map

默认为 “{max_batch_size: 1, min_in_service: 0, pause_time:

0}”。

映射属性说明请见参数映射属性

-

参数映射属性

可选参数rolling_updates映射属性说明

名称

说明

字段类型

内容变更引起资源重建

备注

max_batch_size

一次可替换的最大资源数。

integer

默认为1。

取值至少为1。

-

min_in_service

更新期间,运行的最小资源数。

integer

默认为0。

取值至少为0。

-

pause_time

各批次升级等待间隔,单位为秒。

number

默认为0。

取值至少为0。

-

属性

名称

说明

outputs

资源名称映射到属于自动伸缩组的每个单独资源的指定属性。此映射指定了自动伸缩组已被实例化后可用的输出参数。

outputs_list

属于自动伸缩组的每个单独资源的指定属性的列表。自动伸缩组实例化后,该属性列表可以作为输出使用,展示资源的详细信息。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Heat::AutoScalingGroup 
    properties:
      cooldown: Integer 
      desired_capacity: Integer 
      max_size: Integer 
      min_size: Integer 
      resource: {...}
      rolling_updates: {"max_batch_size": Integer, "pause_time": Number, "min_in_service": Integer}

OS::Heat::CloudConfig

表示cloud-init、cloud-config的配置资源。

该资源允许配置API定义和存储cloud-config YAML。存储结果之前,配置中调用的任何内部函数都将被解析。

该资源通常被OS::Nova::Server user_data或OS::Heat::MultipartMime部分配置引用。由于cloud-config是纯引导配置,所以对定义的任何更改都会导致所有引用它的服务器被替换。

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

cloud_config

表示将被格式化为YAML的cloud-config数据结构的映射。

map

-

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Heat::CloudConfig 
    properties:
      cloud_config: {...}

OS::Heat::MultipartMime

将多个软件配置集合为MultipartMime。

消息中的部分可以使用内联配置或对其他配置资源的引用进行填充。如果引用的资源本身是一个有效的MultipartMime消息,那么将被分解成附加在该消息上的多个部分。

所生成的MultipartMime消息将由configs API存储,并且可以在诸如OS::Nova::Server user_data的属性中引用。

此资源通常用于构建包含脚本和cloud-config在内的cloud-init配置元素的列表。由于cloud-init是引导配置,所以对定义的任何更改都将导致所有引用它的服务器被替换。

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

parts

属于该消息的所有部分。

list

默认为“[]”。

列表内容:

*

映射值。

更新导致替换。

映射属性说明请见参数映射属性

-

参数映射属性

可选参数parts映射属性说明

名称

说明

字段类型

内容变更引起资源重建

备注

config

要连接的部分的内容,要么内联,要么通过引用另一个软件配置资源的ID。

string

-

filename

关联消息部分的可选文件名。

string

-

subtype

用来指定类别的可选子类别。

string

-

Type

part内容是文本还是multipart。

string

默认为文本。

允许值:文本或multipart。

-

HOT语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Heat::MultipartMime 
    properties:
      parts: [{"filename": String, "subtype": String, "config": String, "type": String},
{"filename": String, "subtype": String, "config": String, "type": String}, ...]

OS::Heat::RandomString

生成随机字符串的资源。

该资源在服务上配置密码和密钥非常有用。可从指定的字符序列生成随机字符串。

这意味着所有字符将从指定的序列中随机选择,例如字母,这意味着所有字符都将随机地从ASCII字母和数字的组合中选出。输出字符串将随机生成具有指定长度的字符串(如果length属性未指定,则长度为32)。

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

character_classes

生成随机字符串的字符类的列表及其约束。

list

默认为“[{class: 字母数字、min: 1}]”。

列表内容:

*

map。

更新导致替换。

映射属性说明请见•可选参数character_classes映射...

-

character_sequences

字符序列列表及其生成随机字符串的约束。

list

列表内容:

*

map。

更新导致替换。

映射属性说明请见•可选参数character_sequences...

-

length

待生成字符串的长度。

integer

默认为“32”。

取值范围:1~512(含1、512)。

-

salt

可在堆栈更新时设置或更改的值,以触发用新的随机字符串替换的资源。随机生成器忽略了salt值本身。

string

-

sequence

生成随机字符串的字符序列。

string

允许值:英文字母(大小写)、数字(十六进制数字或八进制数字)。

-

参数映射属性
  • 可选参数character_classes映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    class

    生成随机字符串的字符列表及其相应最小值约束。

    string

    默认为“lettersdigits”。

    允许值:数字组合、字母、小写字母、大写字母、数字、十六进制数字、八进制数字。

    -

    min

    这个字符类中生成的字符串的最小字符数。

    integer

    默认为“1”。

    取值范围:1~512(含1、512)。

    -

  • 可选参数character_sequences映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    min

    生成字符串中该序列的最小字符数。

    integer

    默认为“1”。

    取值范围:1~512(含1、512)。

    -

    sequence

    一个字符序列及其对应的最小值约束来生成随机字符串。

    string

    -

属性

名称

说明

value

由该资源生成的随机字符串。该值也可以通过引用资源来获得。

HOT语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Heat::RandomString 
    properties:
      character_classes: [{"class": String, "min": Integer}, {"class": String, "min": Integer}, ...]
      character_sequences: [{"min": Integer, "sequence": String}, {"min": Integer, "sequence": String}, ...]
      length: Integer 
      salt: String 
      sequence: String

OS::Heat::ResourceGroup

创建一个或多个相同配置的嵌套资源。

除了refs属性外,该资源还实现了镜像组中资源的合成属性。但是,从该资源获取属性时,会返回组中每个资源的属性值列表。要获取组中单个资源的属性值,可以使用表单resource.{resource index}.{attribute name}的合成属性。组中特定资源的资源ID可以通过合成属性resource.{resource index}获取。请注意,如果您获取的是没有{resource index}的属性,例如[resource,{attribute_name}],您将获得组中所有资源的此属性值的列表。

虽然组中的每个资源都将进行相同的配置,但该资源允许对组中资源的属性进行一些基于索引的自定义。例如:

resources: 
  my_indexed_group:
    type: OS::Heat::ResourceGroup 
    properties:
      count: 3 
      resource_def:
        type: OS::Nova::Server 
        properties:
          # create a unique name for each server
          # using its index in the group 
          name: my_server_%index%
          image: CentOS 6.5 
          flavor: 4GB Performance

虽然该资源将生成具有相同镜像和规格的一组三台服务器,但服务器名称分别为my_server_0,my_server_1和my_server_2。用于替换的变量可以通过index_var属性来定制。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

resource_def

组中资源的资源定义。该属性的值即模板资源的定义值。

map

映射属性说明请见参数映射属性

-

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

count

待创建资源的数量。

integer

默认为“1”。

取值至少为0。

-

index_var

该资源将用于替换组中给定资源的当前索引的变量。例如,可用于自定义分组服务器的名称属性,以便在与Nova客户端列出时区分它们。

string。

默认为“%index%”。

长度至少为3。

-

参数映射属性
必选参数resource_def映射属性说明

名称

说明

字段类型

内容变更引起资源重建

备注

metadata

向组中资源提供的元数据。

map

-

properties

组中资源的属性值。

map

-

type

组中资源的类型。

string

-

属性

名称

说明

attributes

资源名称映射到每个单独资源的指定属性。 要求:heat_template_version: 2014-10-16。

refs

组中资源的ID列表。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Heat::ResourceGroup 
    properties:
      count: Integer 
      index_var: String

OS::Heat::ScalingPolicy

管理OS::Heat::AutoScalingGroup伸缩的资源,即定义要缩放的指标和缩放调整,设置冷却等。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

adjustment_type

调整类型(绝对值或百分比)。

string

允许值:change_in_capacity,exact_capacity,percent_change_in_capacity。

-

auto_scaling_group_id

策略适用的弹性伸缩组ID。

string

-

scaling_adjustment

调整大小。

number

-

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

cooldown

冷却时长,单位为“秒”。

number

-

min_adjustment_step

AutoScaling组向上或向下扩展时添加或删除的最小资源数。 仅在为adjustment_type属性指定percent_change_in_capacity时才能使用此选项。

integer

该值必须最少为0.

-

属性

名称

说明

alarm_url

处理告警的URL。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Heat::ScalingPolicy 
    properties:
      adjustment_type: String 
      auto_scaling_group_id: String 
      cooldown: Number 
      min_adjustment_step: Integer 
      scaling_adjustment: Number

OS::Heat::SoftwareComponent

用于描述和存储软件组件的资源。

该资源类似于OS::Heat::SoftwareConfig。与仅允许存储一个配置(例如一个脚本)的SoftwareConfig不同,SoftwareComponent允许存储多个配置,以便在一个地方处理软件组件的所有生命周期(CREATE,UPDATE,SUSPEND,RESUME,DELETE)。

该资源由SoftwareConfig资源的持久层和API支持,并且仅添加对附加配置和属性的处理。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

configs

表示软件组件的不同生命周期操作的配置列表。

list

长度至少为1。

列表内容:

*

map。

内容变更会引起资源重建。

映射属性说明请见•必选参数configs映射属性说明

Linux的脚本格式可能为.sh等。而Windows的脚本格式为.bat等,还有就是脚本的内容,根据各自脚本格式来变化。

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

inputs

代表该软件配置需输入的模式。

list

列表内容:

*

map。

内容变更会引起资源重建。

映射属性说明请见•可选参数inputs映射属性说明

-

options

包含该资源使用的配置管理工具特有选项的映射。

map

-

outputs

表示该软件配置将产生的输出模式。

list

列表内容:

*

映射值。

内容变更会引起资源重建。

映射属性说明请见•可选参数outputs映射属性说明

-

参数映射属性
  • 必选参数configs映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    actions

    配置适用的生命周期操作。为此属性提供的字符串值可以包括Heat支持的标准资源操作CREATE、SUSPEND、 RESUME、DELETE和UPDATE。

    list

    默认为“[CREATE, UPDATE]”。

    长度至少为1。

    列表内容:

    *

    string。

    内容变更会引起资源重建。

    -

    config

    配置脚本或清单,指定执行什么实际配置。

    string

    -

    tool

    用于在服务器上实际应用配置的配置工具,必须通过运行在部署服务器内部的实例工具来理解此字符串属性。

    string

    -

  • 可选参数inputs映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    default

    如未指定输入,则为默认值。

    string

    -

    description

    输入说明。

    string

    -

    name

    输入名称。

    string

    -

    replace_on_change

    输入值变化时,替换部署而非更新部署。

    boolean

    默认为“False”。

    -

    type

    输入值的类型。

    string

    默认为字符串。

    允许值:字符串、数字、CommaDelimitedList、Json、布尔值。

    -

  • 可选参数outputs映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    description

    输出说明。

    string

    -

    error_output

    如果此输出具有值,则表示部署处于错误状态。

    boolean

    默认为“False”。

    -

    name

    输出名称。

    string

    -

    type

    输出值类型。

    string

    默认为字符串。

    允许值:字符串、数字、CommaDelimitedList、Json、布尔值。

    -

属性

名称

说明

config

软件配置的配置值。

config一般是从某个脚本文件读取,并常常包含一些参数替换,该属性为真正在虚拟机中运行的脚本内容。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
...
  the_resource:
    type: OS::Heat::SoftwareComponent 
    properties:
      configs: [{"config": String, "tool": String, "actions": [String, String, ...]}, {"config": String, "tool": String, "actions": [String, String, ...]}, ...]
      inputs: [{"type": String, "default": String, "name": String, "replace_on_change": Boolean, "description": String}, {"type": String, "default": String, "name": String, "replace_on_change": Boolean, "description": String}, ...]
      options: {...}
      outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String},
{"type": String, "name": String, "error_output": Boolean, "description": String}, ...]

OS::Heat::SoftwareConfig

描述和存储软件配置的资源。

支持此资源的software_configs API会创建不可变的配置。因此对模板资源定义的任何更改,将创建新的配置,同时删除原配置。

配置可以在使用它们的同一模板中定义,也可以在一个堆栈中创建,并通过参数传递 给另一个堆栈。

可以在其他资源属性中引用配置资源。这包括OS::Nova::Server user_data和 OS::Heat::MultipartMime属性配置。

与配置脚本本身一起,此资源可以定义配置脚本应该使用和生成的输入和输出的模式。 输入和输出是可选的,并将映射到特定于所使用的配置工具的概念。

说明:

如果使用软件配置功能,则必须在镜像上安装cloud-init工具。

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

config

配置脚本或清单,指定执行什么实际配置。

string

linux的脚本格式可能为.sh等。而Windows的脚本格式为.bat等,还有就是脚本的内容,根据各自脚本格式来变化

group

命名空间将该软件配置按照传送到服务器的方式进行分组。

这可能意味着什么配置工具将执行配置。

string

默认为“Heat::Ungrouped”。

-

inputs

表示该软件配置所期望的输入模式。

list

列表内容:

*

map。

内容变更会引起资源重建。

映射属性说明请见•可选参数inputs映射属性说明

-

options

包含该资源使用的配置管理工具特有选项的映射。

map

-

outputs

表示该软件配置将产生的输出模式。

list

列表内容:

*

映射值。

内容变更会引起资源重建。

映射属性说明请见•可选参数outputs映射属性说明

-

参数映射属性
  • 可选参数inputs映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    default

    如未指定输入,则为默认值。

    string

    -

    description

    输入说明。

    string

    -

    name

    输入名称。

    string

    -

    replace_on_change

    输入值变化时,替换部署而非更新部署。

    boolean

    默认为“False”。

    -

    type

    输入值的类型。

    string

    默认为字符串。

    允许值:字符串、数字、CommaDelimitedList、Json、布尔值。

    -

  • 可选参数outputs映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    description

    输出说明。

    string

    -

    error_output

    如果此输出具有值,则表示部署处于错误状态。

    boolean

    默认为“False”。

    -

    name

    输出名称。

    string

    -

    type

    输出值类型。

    string

    默认为字符串。

    允许值:字符串、数字、CommaDelimitedList、Json、布尔值。

    -

属性

名称

说明

config

软件配置的配置值。

config一般是从某个脚本文件读取,并常常包含一些参数替换,该属性为真正在虚拟机中运行的脚本内容。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
...
  the_resource:
    type: OS::Heat::SoftwareConfig 
    properties:
      config: String 
      group: String
      inputs: [{"type": String, "default": String, "name": String, "replace_on_change": Boolean, "description": String}, {"type": String, "default": String, "name": String, "replace_on_change": Boolean, "description": String}, ...]
      options: {...}
      outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String},{"type": String, "name": String, "error_output": Boolean, "description": String}, ...]

OS::Heat::StructuredConfig

与OS::Heat::SoftwareConfig有相同逻辑的资源。

该资源类似于OS::Heat::SoftwareConfig,不过config属性由Map而不是String表示。

这对于使用YAML或JSON作为配置语法的配置工具非常有用,所生成的配置由解析的JSON通过software_configs API传输、存储和返回。

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

config

表示将被序列化为JSON格式的配置数据结构的映射。

map

-

group

命名空间将此软件配置分组传送到服务器时,配置工具将执行配置。

string

默认为“Heat::Ungrouped”。

-

inputs

表示该软件配置所期望的输入模式。

list

列表内容:

*

map。

内容变更会引起资源重建。

映射属性说明请见•可选参数inputs映射属性说明

-

options

包含该资源使用的配置管理工具特有选项的映射。

map

-

outputs

表示该软件配置将产生的输出模式。

list

列表内容:

*

映射值。

内容变更会引起资源重建。

映射属性说明请见•可选参数outputs映射属性说明

-

参数映射属性
  • 可选参数inputs映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    default

    如未指定输入,则为默认值。

    string

    -

    description

    输入说明。

    string

    -

    name

    输入名称。

    string

    -

    replace_on_change

    输入值变化时,替换部署而非更新部署。

    boolean

    默认为“False”。

    -

    type

    输入值的类型。

    string

    默认为字符串。

    允许值:字符串、数字、CommaDelimitedList、Json、布尔值。

    -

  • 可选参数outputs映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    description

    输出说明。

    string

    -

    error_output

    如果此输出具有值,则表示部署处于错误状态。

    boolean

    默认为“False”。

    -

    name

    输出名称。

    string

    -

    type

    输出值类型。

    string

    默认为字符串。

    允许值:字符串、数字、CommaDelimitedList、Json、布尔值。

    -

属性

名称

说明

config

软件配置的配置值。

config一般是从某个脚本文件读取,并常常包含一些参数替换,该属性为真正在虚拟机中运行的脚本内容。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Heat::StructuredConfig 
    properties:
      config: {...} group: String
      inputs: [{"type": String, "default": String, "name": String, "replace_on_change": Boolean, "description": String}, {"type": String, "default": String, "name": String, "replace_on_change": Boolean, "description": String}, ...]
      options: {...}
      outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]

OS::Heat::WaitCondition

处理WaitConditionHandle接收信息的资源。

资源需要WaitConditionHandle并开始创建。资源处于CREATE_IN_PROGRESS状态,直到WaitConditionHandle没有收到足够数量的成功信号(该数字可以用count属性指定),并在此之后成功创建,或由于超时而失败。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

handle

参考WaitConditionHandle来表示此等待条件。

string

-

timeout

等待正确数量的信号到达的秒数。

number

取值范围:1~43200(含1、43200)。

-

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

count

在堆栈创建过程继续前必须接收到的成功信号的数量。

integer

默认为“1”。

取值至少为1。

-

属性

名称

说明

data

包含发送到handle的与等待状态信号相关联的数据的JSON字符串。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Heat::WaitCondition 
    properties:
      count: Integer 
      handle: String 
      timeout: Number

OS::Heat::WaitConditionHandle

管理实例信息的资源。

该资源主要特点如下:

  • 无依赖关系(所以实例可以引用它)。
  • 创建证书以允许实例的信号。
  • 处理实例信号、验证并保存结果。
可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

signal_transport

客户端如何发出等待状态的信号。 CFN_SIGNAL将允许HTTP POST到CFN密钥对签名的URL。 TEMP_URL_SIGNAL将创建一个Swift TempURL,通过HTTP PUT发出信号。 HEAT_SIGNAL将允许使用提供的keystone凭证调用Heat API资源信号。 ZAQAR_SIGNAL将创建一个专用的zaqar队列,使用提供的keystone凭据进行信号通知。 TOKEN_SIGNAL将使用提供的keystone令牌允许和HTTP POST到Heat API端点。 NO_SIGNAL将导致资源进入信号状态而不等待任何信号。

string

默认为“TOKEN_SIGNAL”。

允许值:CFN_SIGNAL、TEMP_URL_SIGNAL、HEAT_SIGNAL、NO_SIGNAL、ZAQAR_SIGNAL、TOKEN_SIGNAL

-

属性

名称

说明

curl_cli

Convenience属性,提供curl CLI命令前缀,当signal_transport 设置为TOKEN_SIGNAL时,可用于表示信号传递处理完成或失败。您可以通过添加-data-binary {"status": "SUCCESS"} 来表示发送信号成功,或者通过添加-data-binary {"status": "FAILURE"}来表示发出信号失败。对于所有其他信号传输,此属性设置为“None”。

endpoint

signal_transport设置为TOKEN_SIGNAL时,通过Endpoint/url处理信号。其他信号传输,设置为“None”。

token

signal_transport设置为TOKEN_SIGNAL时,通过Token for stack-user 处理信号。其他信号传输,设置为“None”。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Heat::WaitConditionHandle 
    properties:
      signal_transport: String

OS::Neutron::FloatingIP

管理Neutron浮动IP地址的资源。

浮动IP地址可以通过用户的操作来改变路由器之间的关联。浮动IP地址最常见的使用场景之一是为私有云提供公共IP地址,其中可用的IP地址数量有限。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

floating_network

分配浮动IP的网络。

string

-

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

fixed_ip_address

如果端口有多个地址,则使用IP地址。

string

-

port_id

现有端口的ID,具有至少一个与此浮动IP关联的IP地址。端口必须与Nova实例关联。

string

取值必须为neutron中已存在的port。

value_specs

额外的参数包含在创建请求中的浮动IP对象中。参数通常特定于已安装的硬件或扩展。

map

默认为“{}”。

-

属性

名称

说明

fixed_ip_address

关联端口的IP地址(如果指定)。

floating_ip_address

该IP地址关联的地址。

floating_network_id

IP所分配的网络ID。

在浮动IP地址分配期间使用的网络ID是固定的外部网络ID。您可以使用GET /v2.0/networks?router:external=Trueneutron net-external-list来获取外部网络信息。

port_id

与此IP相关联的端口的ID。

router_id

用作网关的路由器ID,与端口关联时设置。

show

资源详细信息。

tenant_id

浮动IP所属租户。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Neutron::FloatingIP 
    properties:
      fixed_ip_address: String 
      floating_ip_address: String 
      floating_network: String 
      port_id: String
      value_specs: {...}

OS::Neutron::FloatingIPAssociation

关联浮动IP和端口的资源。

该资源允许将浮动IP与至少有一个IP地址的端口相关联。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

floatingip_id

要关联的浮动IP的ID。

string

-

port_id

一个至少有一个IP地址的现有端口的ID与这个浮动IP相关联,端口必须关联Nova实例。

string

-

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

fixed_ip_address

如果端口有多个地址,则使用IP地址。

string

-

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Neutron::FloatingIPAssociation 
    properties:
      fixed_ip_address: String 
      floatingip_id: String 
      port_id: String

OS::Neutron::LBaaS::HealthMonitor

操作负载均衡健康检查器的资源。

该资源用于创建或者管理监控负载均衡服务器的Neutron LBaaS v2健康检查器。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

delay

在成员常规连接之间的最小时间间隔为毫秒。

integer

取值范围:0~2147483647(包含0、2147483647)。

-

max_retries

设置重试多少次才将成员状态设置为离线。

integer

取值范围:0~10(包含0、10)。

-

pool

负载均衡成员池的ID或者名称。

string

取值必须为neutron中已存在的负载均衡成员池。

timeout

检查器等待建立连接超时最大值。

integer

最小值必须为0。

-

type

定义的健康检查器类型。

string

取值范围:PING、TCP、HTTP、HTTPS

-

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

admin_state_up

健康检查管理状态。

boolean

允许值:True。

-

expected_codes

期望HTTP响应状态码, 指定下列值:单值,例如200;列表,例如200, 202;区间,例如200-204。

string

默认值:200。

-

http_method

http方法用于http类型监视器的请求。

string

默认值:GET。

允许值:GET、HEAD、POST、PUT、DELETE、TRACE、OPTIONS、CONNECT、PATCH。

-

tenant_id

健康检查器所属租户的ID。

string

-

url_path

健康检查测试成员健康时发送的http请求路径。以斜杠(/)开头字符串值。

string

默认值:“/”。

-

属性

名称

说明

pools

该检查器关联的检查器列表。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Neutron::LBaaS::HealthMonitor
    properties:
      admin_state_up: Boolean
      delay: Integer
      expected_codes: String
      http_method: String
      max_retries: Integer
      pool: String
      tenant_id: String
      timeout: Integer
      type: String
      url_path: String

OS::Neutron::LBaaS::Listener

管理LBaaS v2监听器的资源。

该资源用于创建或者管理代表一个VIP的监听节点的Neutron LBaaS v2的监听器。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

loadbalancer

已关联监听器的load balancer的名称或ID。

string

取值必须为neutron中已存在的负载均衡器。

protocol

记录客户端通信协议。值必须与OS::Neutron::LBaaS::Pool的协议一致字符串值。

string

取值范围:TCP、HTTP、HTTPS、TERMINATED_HTTPS。

-

protocol_port

记录客户端TCP或者UDP端口通信。

integer

取值范围:1~65535(包含1、65535)。

-

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

admin_state_up

监听器管理状态。

boolean

允许值:True。

-

connection_limit

监听器最大连接数。默认值为-1。

interger

默认值为“-1”。

取值范围:-1~2147483647(包含-1、2147483647)。

-

description

监听器说明。

string

默认值:“”。

-

name

监听器名称。

string。

-

tenant_id

监听器所属租户的ID。

string

-

属性

名称

说明

default_pool_id

默认关联监听器的成员池的ID。

loadbalancers

默认关联监听器的负载均衡的ID。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Neutron::LBaaS::Listener
    properties:
      admin_state_up: Boolean
      connection_limit: Integer
      description: String
      loadbalancer: String
      name: String
      protocol: String
      protocol_port: Integer
      tenant_id: String

OS::Neutron::LBaaS::LoadBalancer

创建LBaaS v2负载均衡的资源。

该资源用于创建或者管理允许在服务器之间进行通讯的Neutron LBaaS v2负载均衡。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

vip_subnet

用于分配VIP地址的子网的名称或ID。

string

值必须为子网。

-

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

admin_state_up

负载均衡管理状态。

boolean

允许值:True。

-

description

负载均衡说明。

string

默认值:“”。

-

name

负载均衡名称。

string

-

provider

提供负载均衡。

string

允许值:vlb。

-

tenant_id

负载均衡所属租户的ID。仅管理用户可以指定自己以外的租户ID。

string

取值必须为keystone中已存在的project。

vip_address

VIP的IP地址

string

值类型限定:ip_addr。

-

属性

名称

说明

vip_address

负载均衡的VIP地址。

vip_port_id

负载均衡的VIP端口。

vip_subnet_id

负载均衡的VIP子网。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Neutron::LBaaS::LoadBalancer
    properties:
      admin_state_up: Boolean
      description: String
      name: String
      provider: String
      tenant_id: String
      vip_address: String
      vip_subnet: String

OS::Neutron::LBaaS::Pool

该资源不允许更新。

管理LBaaS v2成员池的资源。

该资源用于创建或者管理Neutron LBaaS v2成员池,该资源代表一组节点,成员池定义节点所在的子网,平衡算法,和自己的节点。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

lb_algorithm

分配策略类型,用于将负载分配在成员池各个成员中。

string

取值范围:ROUND_ROBIN、LEAST_CONNECTIONS、SOURCE_IP。

-

listener

关联该成员池的监听器的名称或者ID。

string

取值必须为neutron中已存在的负载均衡监听器。

protocol

成员池协议。值必须与OS::Neutron::LBaaS::Listener的协议一致。

string

取值范围:TCP、HTTP、HTTPS。

-

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

admin_state_up

成员池管理状态。

boolean

允许值:True。

-

description

成员池说明。

string

默认值:“”

-

name

成员池名称。

string

-

session_persistence

会话持久性。

map

映射属性说明请见参数映射属性

-

参数映射属性
可选参数session_persistence映射属性说明

名称

说明

字段类型

内容变更引起资源重建

备注

cookie_name

cookie的名称,APP_COOKIE类型下为必填。

string

-

type

保持会话持久性实现的方法。

string

取值范围:SOURCE_IP、HTTP_COOKIE、APP_COOKIE

-

属性

名称

说明

healthmonitor_id

关联该成员池的健康检查器的ID。

listeners

关联该成员池的监听器。

members

关联该成员池的成员。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Neutron::LBaaS::Pool
    properties:
      admin_state_up: Boolean
      description: String
      lb_algorithm: String
      listener: String
      name: String
      protocol: String
      session_persistence: {"type": String, "cookie_name": String}

OS::Neutron::LBaaS::PoolMember

管理LBaaS v2资源池成员的资源。一个资源池成员代表一个后端节点。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

address

在成员池网络中成员对应的IP地址。

string

取值类型:ip_addr。

-

pool

负载均衡成员池的名称或者ID。

string

取值必须为neutron中已存在的负载均衡成员池。

protocol_port

请求或者链接的后端端口号。值必须与OS::Neutron::LBaaS::Listener的协议一致。

interger

取值范围:1~65535(包含1、65535)。

-

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

admin_state_up

成员池成员管理状态。

boolean

允许值:True。

-

subnet

该成员的子网名称或者ID。

string

取值必须为neutron中已存在的子网。

weigh

资源池成员在资源池中的权重(默认值是1)。

interger

默认值:1。

取值范围:0~256(包含0、256)。

-

属性

名称

说明

address

成员的IP地址。

pool_id

该成员所属的成员池的ID。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Neutron::LBaaS::PoolMember
    properties:
      address: String
      admin_state_up: Boolean
      pool: String
      protocol_port: Integer
      subnet: String
      weight: Integer

OS::Neutron::Net

管理Neutron网络的资源。

网络是虚拟隔离的第2层广播域,通常为创建其租户保留,除非网络已被明确配置为共享。

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

admin_state_up

指定网络管理状态。

boolean

默认为“True”。

-

dhcp_agent_ids

用于调度网络的DHCP代理的ID。请注意,Neutron中的默认策略将该属性的用法限制为管理用户。

list

-

name

网络的名称,不需要是唯一的。

string

-

shared

网络是否在所有租户中共享。请注意,默认策略设置将此属性的用法限制为管理员用户。

boolean

默认为“False”。

-

tenant_id

该网络的租户ID。只有管理员用户可以设置租户标识符;不能使用授权策略更改。

string

-

value_specs

请求中包括的额外参数。参数通常特定于已安装的硬件或扩展。

map

默认为“{}”。

-

属性

名称

说明

admin_state_up

网络的管理状态。

name

网络名称。

show

资源详细信息。

status

网络状态。

subnets

网络子网。

tenant_id

网络所属租户。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Neutron::Net 
    properties:
      admin_state_up: Boolean 
      dhcp_agent_ids: [Value, Value, ...] 
      name: String
      shared: Boolean 
      tenant_id: String 
      value_specs: {...}

OS::Neutron::Port

管理Neutron端口的资源。

端口表示逻辑网络交换机上的虚拟交换机端口。虚拟实例将其接口连接到端口。逻辑端口还定义要分配给插入其中的接口的MAC地址和IP地址。当IP地址与端口关联时, 这也意味着端口与子网相关联,因为IP地址是从特定子网的分配池中获取的。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

network

该端口所属网络。如果您计划使用当前端口分配浮动IP, 则应使用子网指定fixed_ips。注意不同网络更新时该属性有变化,则端口将被替换。

string

取值必须为neutron中已存在的network。

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

admin_state_up

端口的管理状态。

boolean

默认为“True”。

-

allowed_address_pairs

允许通过端口的其他MAC/IP地址对。

list

列表内容:

*

map

内容变更不会引起资源重建。

映射属性说明请见•可选参数allowed_address_pai...

-

device_id

端口设备ID。

string

-

device_owner

端口所在网络的名称。该值通常为:network:floatingip、network:router_interface或network:dhcp。

string

-

fixed_ips

端口规定的IP地址。

list

列表内容:

*

map

内容变更不会引起资源重建。

映射属性说明请见•可选参数fixed_ips映射属性说明

-

mac_address

端口MAC地址。

string

-

name

端口的符号名称。

string

-

security_groups

端口关联的安全组ID。

list

-

value_specs

请求中包括的额外参数。

map

默认为“{}”。

-

replacement_policy

关于如何响应此资源的堆栈更新的策略。无论任何属性更改,REPLACE_ALWAYS都将替换端口。AUTO将更新现有端口以获取任何已更改的属性。

string

默认为“AUTO”。

允许值:AUTO、REPLACE_ALWAYS。

-

参数映射属性
  • 可选参数allowed_address_pairs映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    ip_address

    端口允许的IP地址。

    string

    值类型:net_cidr

    -

    mac_address

    端口允许的MAC地址。

    string

    值类型:mac_addr

    -

  • 可选参数fixed_ips映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    subnet

    要为该端口分配IP地址的子网。

    string

    取值必须为neutron中已存在的子网。

    ip_address

    此端口在子网中所需的IP地址。

    string

    值类型:ip_addr

    -

属性

名称

说明

admin_state_up

端口管理状态。

allowed_address_pairs

允许通过端口的其他MAC/IP地址对。

device_id

设备的唯一标识符。

device_owner

端口所在网络名称。

fixed_ips

固定IP地址。

mac_address

端口MAC地址。

name

端口名称。

network_id

端口所在网络唯一标识符。

security_groups

端口安全组列表。

show

资源详细信息。

status

端口状态。

subnets

端口子网属性列表。

tenant_id

端口所属租户。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
  type: OS::Neutron::Port 
    properties:
      admin_state_up: Boolean
      allowed_address_pairs: [{"mac_address": String, "ip_address": String}, {"mac_address": String, "ip_address": String}, ...]
      device_id: String 
      device_owner: String
      fixed_ips: [{"subnet_id": String, "ip_address": String, "subnet": String}, {"subnet_id": String, "ip_address": String, "subnet": String}, ...]
      mac_address: String 
      name: String network: String 
      security_groups: [Value, Value, ...] 
      value_specs: {...} 
      replacement_policy: String

OS::Neutron::Router

实现Neutron路由器的资源。

路由器是在不同网络之间传递网络流量的物理或虚拟网络设备。

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

admin_state_up

路由器管理状态。

boolean

默认为“True”。

-

external_gateway_info

路由器的外部网关配置。

您可以使用GET /v2.0/networks?router:external=Trueneutron net-external-list来查询网络信息。

map

映射属性说明请见参数映射属性

snat属性是在组织管理员角色可以被使用,而ManageOne角色一般都VDC相关,虽然名字可能为VDC管理员但是相对于底层来讲仍然是tenant。不具有使用该属性的权限。

l3_agent_ids

L3代理的ID列表。用户可以为高可用路由器指定多代理。

注意:

Neutron中的默认策略设置仅将该属性的用法限制为管理员用户。

list

列表内容:

*

string

-

name

路由器名称。

string

-

value_specs

创建请求中包括的额外参数。

map

默认为“{}”。

-

参数映射属性
可选参数external_gateway_info映射属性说明

名称

说明

字段类型

内容变更引起资源重建

备注

enable_snat

在路由器网关上启用源NAT。注意:Neutron中的默认策略设置仅将该属性的用法限制为管理员用户。

boolean

-

network

网关的外部网络ID或名称。

string

-

属性

名称

说明

admin_state_up

路由器管理状态。

external_gateway_info

路由器网关网络。

name

路由器名称。

show

资源详细信息。

status

路由器状态。

tenant_id

路由器所属租户。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Neutron::Router 
    properties:
      admin_state_up: Boolean
      external_gateway_info: {"network": String, "enable_snat": Boolean} 
      l3_agent_ids:[String,String,...]
      name: String 
      value_specs: {...}

OS::Neutron::RouterInterface

管理Neutron路由器接口的资源。

关联路由器与现有子网或端口的路由器接口。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

router_id

路由器ID。

string

-

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

port_id

端口ID。

string

-

subnet

子网。

string

取值必须为neutron中已存在的子网。

subnet_id

子网ID。

string

-

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Neutron::RouterInterface 
    properties:
      port_id: String 
      router_id: String 
      subnet: String 
      subnet_id: String

OS::Neutron::SecurityGroup

管理Neutron安全组的资源。

安全组是应用于实例网络的IP过滤规则集。它们是项目特定的,项目成员可以编辑其组的默认规则并添加新的规则集。所有项目都有一个“默认”安全组,适用于没有定义其他安全组的实例。

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

description

安全组说明。

string

-

name

安全组名称,不要求它是唯一的。

string

-

rules

安全组规则列表。

list

默认为“[]”。

列表内容:

*

map

内容变更不会引起资源重建。

映射属性说明请见参数映射属性

-

参数映射属性
可选参数rules映射属性说明

名称

说明

字段类型

内容变更引起资源重建

备注

direction

应用安全组规则的方向。对于计算实例,入口安全组规则匹配该实例的传入(入口)流量。出口规则应用于传出实例的流量。

string

默认为“ingress”。

允许值:ingress、egress。

-

ethertype

以太网类型的流量。

string

默认为“IPv4”。

允许值: IPv4、IPv6。

-

port_range_max

与安全组规则匹配的范围内的最大端口号。

port_range_min属性限制port_range_max属性。如果协议为ICMP,则该值必须为ICMP类型。

interger

取值范围:0~65535(含0、65535)。

-

port_range_min

与安全组规则匹配的范围内的最小端口号。如果协议是TCP或UDP,则此值必须小于或等于port_range_max属性的值。如果协议为ICMP,则该值必须为ICMP类型。

interger

取值范围:0~65535(含0、65535)。

-

protocol

与安全组规则匹配的协议。有效值包括TCP、UDP和ICMP。

string

-

remote_group_id

要与此安全组规则关联的远程安全组ID。如果没有指定值,则该规则将使用该安全组作为remote_group_id。远程模式参数必须设置为“remote_group_id”。

string

-

remote_ip_prefix

要与此安全组规则关联的CIDR。

string

-

remote_mode

是否指定远程安全组或CIDR。

string

默认为“remote_ip_prefix”。

允许值: remote_ip_prefix、remote_group_id。

-

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Neutron::SecurityGroup 
    properties:
      description: String 
      name: String
      rules: [{"remote_group_id": String, "port_range_max": Integer, "remote_ip_prefix": String, "protocol": String, "port_range_min": Integer, "ethertype": String, "direction": String, "remote_mode": String}, {"remote_group_id": String, "port_range_max": Integer, "remote_ip_prefix": String, "protocol": String, "port_range_min": Integer, "ethertype": String, "direction": String, "remote_mode": String}, ...]

OS::Neutron::Subnet

管理Neutron子网的资源。不允许更新该资源。

子网表示可用于为虚拟实例分配IP地址的IP地址块。每个子网必须具有CIDR,并且必须与网络相关联。可以从整个子网CIDR中选择IP地址,也可以从用户指定的“分配池”中选择。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

network

所依附网络的名称。

string

取值必须为neutron中已存在的network。

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

allocation_pools

分配池的开始和结束地址。

list

列表内容:

*

map。

内容变更不会引起资源重建。

映射属性说明请见•可选参数allocation_pools映射属...

-

cidr

CIDR

string

值类型:net_cidr。

  • 如果需要编排子网,模板中必须指定在底层交换机上已经放通的VLAN_ID。
  • 如果不需要编排子网,需要保证VM所关联的子网的网络对应的VLAN在底层环境上已经被放通。

dns_nameservers

一组待使用的DNS域名服务器。

list

默认为“[]”。

-

enable_dhcp

DHCP开启,则设为True。DHCP未开启,则设为False。

boolean

默认为“True”。

-

gateway_ip

网关IP地址。设置为[ null | ~ | "" ]创建/更新没有网关的子网。如果在创建时省略,自动将子网内的第一个空闲IP地址分配给网关。如果在更新时将其从模板中删除,旧的网关IP地址将被分离。

string

-

host_routes

子网的主机路由字典列表。

list

列表内容:

*

map

内容变更不会引起资源重建。

映射属性说明请见•可选参数host_routes映射属性说明

-

ip_version

IP 版本:4或6。

interger

默认为“4”。

允许值:4、6。

-

name

子网名称。

string

-

network_id

所依附网络的ID。

string

-

tenant_id

网络所属租户的ID。仅管理用户可以指定自己以外的租户ID。

string

不可更新此属性,否则网络更新会失败。

value_specs

请求中包括的额外参数。

map

默认为“{}”。

-

参数映射属性
  • 可选参数allocation_pools映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    end

    分配池的结束地址。

    string

    取值类型必须为:ip_addr。

    -

    start

    分配池的开始地址。

    string

    取值类型必须为:ip_addr。

    -

  • 可选参数host_routes映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    destination

    静态路由目的地址。

    string

    取值类型必须为:net_cidr

    -

    nexthop

    目的地址下一跳地址。

    string

    取值类型必须为:ip_addr

    -

属性

名称

说明

allocation_pools

IP地址分配池及其范围。

cidr

该子网的CIDR。

dns_nameservers

DNS名称服务器列表。

enable_dhcp

DHCP开启,则设为True;DHCP未开启,则设为False。

gateway_ip

子网网关IP地址。

host_routes

子网的主机路由字典列表。

ip_version

子网IP版本。

name

子网名称。

network_id

子网的父网络。

show

资源详细信息。

tenant_id

子网所属租户。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Neutron::Subnet 
    properties:
      allocation_pools: [{"start": String, "end": String}, {"start": String, "end": String}, ...] cidr: String
      dns_nameservers: [Value, Value, ...] enable_dhcp: Boolean
      gateway_ip: String
      host_routes: [{"destination": String, "nexthop": String}, {"destination": String, "nexthop": String}, ...]
      ip_version: Integer name: String network: String network_id: String tenant_id: String value_specs: {...}

OS::Nova::KeyPair

用于创建Nova密钥对的资源。 密钥对是在启动时可以注入服务器的SSH密钥。

请注意,如果生成新密钥,则将save_private_key设置为True,系统中将保存私钥,然后可以通过该资源的private_key属性来检索。

设置public_key属性意味着该资源的private_key属性将始终返回一个空字符串,而不管save_private_key设置,因为将不会保存私钥数据。

说明:

服务器模板不支持密钥对更新。如果更新了密钥对,则服务器将被重建。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

name

密钥对名称。

string

规定长度范围:1~255(含1、255)。

-

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

public_key

可选公钥。这允许用户从预先存在的密钥对提供公钥。 如果没有提供,将生成一个新的密钥对。

string

如果没有提供密钥对,在使用的模板的时候记得将生成的密钥对放在返回值里输出。

save_private_key

系统保留生成的私钥,则为True;反之,为False。

boolean

默认为“False”。

-

属性

名称

说明

private_key

私钥(如果保留)。

public_key

公钥。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
  type: OS::Nova::KeyPair 
    properties:
      name: String 
      public_key: String
      save_private_key: Boolean

OS::Nova::Server

用于管理Nova实例的资源。

Server资源管理OpenStack云中运行的虚拟机实例。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

flavor

要启动的规格ID或名称。

string

服务器规格不支持replace参数(更新堆栈时,资源需要删掉重建)。

取值必须为nova中已存在的flavor。

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

admin_pass

服务器管理员密码。

string

  • 当前版本,该参数无效。
  • 对于Linux弹性云服务器,如果需要注入密码,只能使用user_data进行注入;对于Windows弹性云服务器,如果需要注入密码,只能通过元数据admin_pass进行注入。

availability_zone

服务器所在可用分区名称。

string

不可更新该属性,否则虚拟机更新失败。

block_device_mapping

服务器映射的块设备。

list

列表内容:

*

map。

内容变更会引起资源重建。

映射属性说明请见•可选参数block_device_mappin...

  • 不可更新该属性,否则虚拟机更新失败。
  • 如果模板包含服务器挂载磁盘的信息,则不允许更新磁盘。否则将重建服务器。

block_device_mapping_v2

服务器的块设备映射(v2)。

list

列表内容:

*

map

内容变更会引起资源重建。

映射属性说明请见•可选参数block_device_mappin...

  • 不可更新该属性,否则虚拟机更新失败。
  • 如果模板包含服务器挂载磁盘的信息,则不允许更新磁盘。否则将重建服务器。

config_drive

设为True,开启服务器配置驱动。

boolean

不可更新该属性,否则虚拟机更新失败。

diskConfig

控制创建服务器时如何分区磁盘。

string

允许值:AUTO、MANUAL。

-

flavor_update_policy

关于如何应用规格更新的策略;通过请求服务器调整大小或通过替换整个服务器。

string

默认为“RESIZE”。

允许值:RESIZE,REPLACE。

不可更新该属性,否则虚拟机更新失败。

image

要引导的镜像ID或名称。

string

指定卷作为系统卷创建弹性云服务器时,不需要填写该参数;非卷创建弹性云服务器时需填写有效的UUID参数,否则API将返回400错误。

取值必须为glance中已存在的镜像。

image_update_policy

关于如何应用image-id更新的策略;通过请求服务器重建或替换整个服务器。

string

默认为“REBUILD”。

允许值:REBUILD、REPLACE、REBUILD_PRESERVE_EPHEMERAL。

-

key_name

要注入服务器的密钥对的名称。

string

不可更新该属性,否则虚拟机更新失败。

取值必须为nova中已存在的keypair。

metadata

用于存储此服务器的任意键/值元数据。键和值都必须为255个字符或更少。非字符串值将被序列化为JSON(序列化字符串必须为255个字符以内)。

map

-

name

服务器名称。

string

-

networks

要添加到此服务器的NIC的有序列表,其中包含有关连接网络、固定IP地址、端口等信息。

list

列表内容:

*

map

内容变更不会引起资源重建。

映射属性说明请见•可选参数networks映射属性说明

-

personality

启动时在服务器上创建/覆盖的文件映射。键是文件名,值是文件内容。

map

默认为“{}”。

不可更新该属性,否则虚拟机更新失败。

reservation_id

正在请求一组服务器的UUID。

string

不可更新该属性,否则虚拟机更新失败。

scheduler_hints

由客户端指定的任意键值对来帮助引导服务器。

map

不可更新该属性,否则虚拟机更新失败。

security_groups

安全组名称或ID列表。如果Neutron端口与此服务器相关联,则不能使用;将安全组分配给端口。

list

默认为“[]”。

不可更新该属性,否则虚拟机更新失败。

software_config_transport

服务器应该如何接收软件配置所需的元数据。

POLL_TEMP_URL将创建并填充带有用于轮询的元数据的Swift TempURL。

string

默认为“POLL_TEMP_URL”。

允许值: POLL_SERVER_CFN、POLL_SERVER_HEAT、POLL_TEMP_URL、ZAQAR_MESSAGE

-

tags

服务器标签。

list

列表内容:

*

string。

-

user_data

用户数据脚本由cloud-init执行。

string

默认为“”。

不建议您更新user_data,可能会重建虚拟机。

user_data_format

user_data应如何格式化为服务器。

  • 对于HEAT_CFNTOOLS,user_data作为heat-cfntools cloud-init引导配置数据的一部分进行捆绑。
  • 对于RAW,user_data未经修改传递给Nova。

string

默认为“HEAT_CFNTOOLS”。

允许值:HEAT_CFNTOOLS、RAW、SOFTWARE_CONFIG。

-

参数映射属性
  • 可选参数block_device_mapping映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    delete_on_termination

    服务器终止时是否删除卷。

    boolean

    -

    device_name

    在/dev/device_name系统中待挂载卷的设备名称。

    此值通常为vda。

    string

    -

    snapshot_id

    创建卷的快照ID。

    string

    取值必须为cinder中已存在的卷快照。

    volume_id

    引导卷的ID。只应提供volume_id或snapshot_id中的一个值。

    string

    取值必须为cinder中已存在的volume。

    volume_size

    卷大小,单位:GB。可为空,由计算服务推断大小。

    interger

    -

  • 可选参数block_device_mapping_v2映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    boot_index

    用于订购启动盘的整数。

    interger

    -

    delete_on_termination

    服务器终止时是否删除卷。

    boolean

    -

    device_name

    在/dev/device_name系统中将挂载的设备名称。此值通常为vda。

    string

    -

    device_type

    设备类型:目前只能在磁盘和光驱间做出区分。

    string

    允许值:cdrom、disk

    -

    disk_bus

    设备总线:如果缺省,hypervisor驱动程序选择合适的默认值。

    string

    允许值:ide、lame_bus、scsi、usb、virtio

    -

    snapshot_id

    创建卷的快照ID。

    string

    取值必须为cinder中已存在的卷快照。

    swap_size

    swap大小,单位为MB。

    interger

    -

    volume_id

    volume_id可设为服务器boot或non-boot设备。

    string

    取值必须为cinder中已存在的volume。

    volume_size

    块设备的大小,单位为GB。如缺省,由管理驱动程序计算大小。

    interger

    -

    image_id

    创建卷的镜像ID 。

    string

    取值必须为glance中已存在的镜像。

  • 可选参数networks映射属性说明

    名称

    说明

    字段类型

    内容变更引起资源重建

    备注

    fixed_ip

    固定IP地址,用来指定网络上创建的端口。

    string

    取值类型必须为:ip_addr

    保证绑定该IP的OS::Nova::Server资源所在的可用分区包含在该IP的网关所在OS::Neutron::Router资源的可用分区列表中,并且该IP的网关所在OS::Neutron::Router资源的外部网络类型必须是Intranet或Location;否则绑定该IP的OS::Nova::Server资源无法通过上层路由器进行通信。

    其中,OS::Neutron::Router资源的可用分区列表指OS::Neutron::Router资源所依赖的外部网络所属可用分区。

    port

    与此服务器关联的现有端口的ID。

    string

    保证绑定该port的OS::Nova::Server资源所在的可用分区包含在该port所依赖的OS::Neutron::Router资源的可用分区列表中,并且该port依赖的OS::Neutron::Router资源的外部网络类型必须是Intranet或Location;否则绑定该端口资源的OS::Nova::Server资源无法通过上层路由器进行通信。

    其中,OS::Neutron::Router资源的可用分区列表指OS::Neutron::Router资源所依赖的外部网络所属可用分区。

    取值必须为neutron中已存在的port。

    network

    创建端口的网络的名称或ID。

    string

    保证绑定该network的OS::Nova::Server资源所在的可用分区包含在该network所依赖的OS::Neutron::Router资源的可用分区列表中,并且该network所依赖的OS::Neutron::Router资源的外部网络类型必须是Intranet或Location。否则绑定该network的OS::Nova::Server资源无法通过上层路由器进行通信。

    其中,OS::Neutron::Router资源的可用分区列表指OS::Neutron::Router资源所依赖的外部网络所属可用分区。

    取值必须为neutron中已存在的network。

    uuid

    创建端口的网络的ID。

    string

    保证绑定该uuid对应网络的OS::Nova::Server资源所在的可用分区包含在该uuid对应网络所依赖的OS::Neutron::Router资源的可用分区列表中;并且该uuid对应网络所依赖的OS::Neutron::Router资源的外部网络类型必须是Intranet或Location。否则绑定该uuid对应网络的OS::Nova::Server资源无法通过上层路由器进行通信。

    其中,OS::Neutron::Router资源的可用分区列表指OS::Neutron::Router资源所依赖的外部网络所属可用分区。

    floating_ip

    弹性IP地址,用于为在请求的网络上创建的端口指定。

    string

    保证该弹性IP所依赖的外部网络的group与绑定该弹性IP的OS::Nova::Server所依赖的OS::Neutron::Router资源的group一致,并且该弹性IP所依赖的外部网络的网络类型为Internet;否则绑定该弹性IP的OS::Nova::Server资源通过该弹性IP通信。

    其中,OS::Neutron::Router资源的group指OS::Neutron::Router资源依赖的外部网络的group。

属性

名称

说明

accessIPv4

手动分配的服务器公共IPv4地址。

accessIPv6

手动分配的服务器公共IPv6地址。

addresses

所有具有相应port_id的网络地址。dict中的每个网络都有两个键,它们是网络名称和网络ID。可以通过以下表达 式获取端口ID:“{get_attr: [<server>, addresses, <network name_or_id>, 0, port]}”。

first_address

获取第一个分配的网络地址的Convenience属性,或者在此时未分配任何内容的空字符串。如果服务器具有来自多个网络的地址,结果可能是不可预测的。

instance_name

实例名称。

name

服务器名称。

networks

指定的网络地址形式如下:{"public": [ip1, ip2...], "private": [ip3, ip4], "public_uuid": [ip1, ip2...], "private_uuid": [ip3, ip4]}。dict中的每个网络都有两个键,它们是网络名称和网络ID。

show

资源详细信息。

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OS::Nova::Server 
    properties:
      admin_pass: String 
      availability_zone: String
      block_device_mapping: [{"snapshot_id": String, "volume_id": String, "delete_on_termination": Boolean, "volume_size": Integer, "device_name": String}, {"snapshot_id": String, "volume_id": String, "delete_on_termination": Boolean, "volume_size": Integer, "device_name": String}, ...]
      block_device_mapping_v2: [{"disk_bus": String, "swap_size": Integer, "device_name": String, "device_type": String, "delete_on_termination": Boolean, "volume_id": String, "snapshot_id": String, "boot_index": Integer, "image_id": String, "volume_size": Integer}, {"disk_bus": String, "swap_size": Integer, "device_name": String, "device_type": String, "delete_on_termination": Boolean, "volume_id": String, "snapshot_id": String, "boot_index": Integer, "image_id": String, "volume_size": Integer}, ...]
      config_drive: Boolean 
      diskConfig: String 
      flavor: String
      flavor_update_policy: String 
      image: String 
      image_update_policy: String 
      key_name: String
      metadata: {...} name: String
      networks: [{"network": String, "uuid": String, "fixed_ip": String, "port": String, "floating_ip": String, "subnet": String, "port_extra_properties": {"qos_policy": String,"mac_address": String, "binding:vnic_type": String, "admin_state_up": Boolean, "port_security_enabled": Boolean, "allowed_address_pairs": [{"mac_address": String, "ip_address": String}, {"mac_address": String, "ip_address": String}, ...], "value_specs": {...}}}, {"network": String, "uuid": String, "fixed_ip": String, "port": String, "floating_ip": String, "subnet": String, "port_extra_properties": {"qos_policy": String, "mac_address": String, "binding:vnic_type": String, "admin_state_up": Boolean, "port_security_enabled": Boolean, "allowed_address_pairs": [{"mac_address": String, "ip_address": String}, {"mac_address": String, "ip_address": String}, ...], "value_specs": {...}}}, ...
      personality: {...} 
      reservation_id: String 
      scheduler_hints: {...}
      security_groups: [Value, Value, ...] 
      software_config_transport: String 
      user_data: String
      user_data_format: String

OS::Nova::ServerGroup

管理Nova服务器组的资源。

服务器组允许您确保实例位于同一管理程序主机或其他主机上。

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

name

服务器组名称。

string

-

policies

所用字符串策略列表,默认为anti-affinity。

list

默认为“['anti-affinity']”。

允许值:anti-affinity、affinity。

列表内容:

*

string。

-

属性

名称

说明

字段类型

内容变更引起资源重建

备注

show

资源详细信息。

-

-

-

HOT 语法
heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Nova::ServerGroup 
    properties:
      name: String
      policies: [String, String, ...]

OSE::CES::Alarm

CES告警资源。

必选参数

名称

说明

字段类型

内容变更引起资源重建

备注

evaluation_periods

连续计数。

interger

允许值:1~5(含1、5)。

-

comparison_operator

用于比较指定统计量与阈值的运算符。

string

允许值:gt、lt、ge、le、eq。

-

meter_name

指标名称。

string

允许值:cpu_util、mem_util、 network_incoming_bytes_rate_inband和 network_outgoing_bytes_rate_inband。

  • cpu_util:CPU使用率。
  • mem_util:内存使用率。
  • network_incoming_bytes_rate_inband:带内网络流入速 率。
  • network_outgoing_bytes_rate_inband:带内网络流出速率。

-

period

到评估结束时的时长,单位为秒。

interger

允许值:300、1200、3600、14400、86400。

在与CES的告警互连期间,本机属性周期可以是任何值。但是,CES只支持前面的固定值。否则,告警资源创建失败。

-

resource_id

组ID。

string

CES过滤所需属性。

statistic

数据聚合方式。

string

允许值:avg、min、max、variance。

-

threshold

告警阈值。

interger

-

可选参数

名称

说明

字段类型

内容变更引起资源重建

备注

action_enabled

是否开启该告警的触发动作。

boolean

默认为“True”。

-

alarm_actions

当状态转换为告警时调用的URL(webhook)列表。

list

-

description

告警说明。

string

允许样式:^[^\&\"\'\(\)]{0,256}$

-

enabled

是否开启告警。

boolean。

默认为“True”。

-

name

告警名称。

string

允许以数字字母_-字符开头,允许包含数字字母_-字符,并且字符串长度为1~128

-

unit

数据单位。

string

允许由0~32个字符组成。

-

matching_metadata

Meter应将该资源元数据(key=value)与meter_name相匹配。

map

默认为“{}”。

当前版本,该参数无效。

resource_type

告警的资源类型。

string

默认为“RTS.Group”。

允许值:RTS.Group,AS.Group

-

HOT 语法
heat_template_version: 2014-10-16
...
resources:
  ...
  the_resource:
    type: OSE::CES::Alarm 
    properties:
      action_enabled: Boolean 
      alarm_actions: […] 
      comparison_operator: String 
      description: String
      enabled: Boolean 
      evaluation_periods: Integer 
      meter_name: String
      name: String 
      period: Integer
      resource_id: String 
      statistic: String 
      threshold: Integer 
      unit: String
翻译
下载文档
更新时间:2019-08-15

文档编号:EDOC1100043090

浏览量:12841

下载量:555

平均得分:
本文档适用于这些产品
相关文档
相关版本
Share
上一页 下一页