OpenStack 资源类型¶
OS::Aodh::CompositeAlarm¶
实现 Aodh 复合告警的资源。
允许在创建复合告警时指定多个规则，并使用逻辑运算符（and、or）组合规则。
必需属性¶
可选属性¶
- alarm_actions¶
- 状态变为告警时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- alarm_queues¶
-
状态变为告警时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- description¶
- 告警描述。期望字符串值。可以在不替换的情况下更新。
- enabled¶
- 如果告警评估/操作已启用，则为 True。期望布尔值。可以在不替换的情况下更新。默认为
"true" - insufficient_data_actions¶
- 状态变为 insufficient-data 时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- insufficient_data_queues¶
-
状态变为 insufficient-data 时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- ok_actions¶
- 状态变为 ok 时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- ok_queues¶
-
状态变为 ok 时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- repeat_actions¶
- 如果达到阈值且告警状态已更改，则为 False 以触发操作。默认情况下，每次达到阈值时都会调用操作。期望布尔值。可以在不替换的情况下更新。默认为
"true" - severity¶
-
告警级别。期望字符串值。可以在不替换的情况下更新。默认为
"low"允许的值：“low”、“moderate”、“critical” - time_constraints¶
-
描述告警的时间约束。仅当评估时间在时间约束内时才评估告警。约束的开始点（s）使用 cron 表达式指定，而持续时间以秒为单位。期望列表值。更新会导致替换。默认为
[]列表内容- 期望 Map 值。更新会导致替换。Map 属性
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Aodh::CompositeAlarm
properties:
alarm_actions: [Value, Value, ...]
alarm_queues: [String, String, ...]
composite_rule: {"operator": String, "rules": [Value, Value, ...]}
description: String
enabled: Boolean
insufficient_data_actions: [Value, Value, ...]
insufficient_data_queues: [String, String, ...]
ok_actions: [Value, Value, ...]
ok_queues: [String, String, ...]
repeat_actions: Boolean
severity: String
time_constraints: [{"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, {"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, ...]
OS::Aodh::EventAlarm¶
实现事件告警的资源。
允许用户定义基于其他 OpenStack 服务传入的事件进行评估的告警。当其他 OpenStack 服务的资源已更新、创建或删除时，可以发出事件，例如“compute.instance.reboot.end”、“scheduler.select_destinations.end”。
可选属性¶
- alarm_actions¶
- 状态变为告警时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- alarm_queues¶
-
状态变为告警时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- description¶
- 告警描述。期望字符串值。可以在不替换的情况下更新。
- enabled¶
- 如果告警评估/操作已启用，则为 True。期望布尔值。可以在不替换的情况下更新。默认为
"true" - event_type¶
- 要评估的事件类型。如果未指定，将匹配所有事件。期望字符串值。可以在不替换的情况下更新。默认为
"*" - insufficient_data_actions¶
- 状态变为 insufficient-data 时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- insufficient_data_queues¶
-
状态变为 insufficient-data 时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- ok_actions¶
- 状态变为 ok 时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- ok_queues¶
-
状态变为 ok 时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- query¶
- 用于过滤事件的列表。查询条件用于在评估告警时过滤特定事件。期望列表值。可以在不替换的情况下更新。列表内容
- repeat_actions¶
- 如果达到阈值且告警状态已更改，则为 False 以触发操作。默认情况下，每次达到阈值时都会调用操作。期望布尔值。可以在不替换的情况下更新。默认为
"true" - severity¶
-
告警级别。期望字符串值。可以在不替换的情况下更新。默认为
"low"允许的值：“low”、“moderate”、“critical” - time_constraints¶
-
描述告警的时间约束。仅当评估时间在时间约束内时才评估告警。约束的开始点（s）使用 cron 表达式指定，而持续时间以秒为单位。期望列表值。更新会导致替换。默认为
[]列表内容- 期望 Map 值。更新会导致替换。Map 属性
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Aodh::EventAlarm
properties:
alarm_actions: [Value, Value, ...]
alarm_queues: [String, String, ...]
description: String
enabled: Boolean
event_type: String
insufficient_data_actions: [Value, Value, ...]
insufficient_data_queues: [String, String, ...]
ok_actions: [Value, Value, ...]
ok_queues: [String, String, ...]
query: [{"field": String, "type": String, "op": String, "value": String}, {"field": String, "type": String, "op": String, "value": String}, ...]
repeat_actions: Boolean
severity: String
time_constraints: [{"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, {"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, ...]
OS::Aodh::GnocchiAggregationByMetricsAlarm¶
实现指定指标的告警的资源。
实现允许使用指标列表中用户指定的指标的告警的资源。
必需属性¶
可选属性¶
- aggregation_method¶
- 用于与阈值进行比较的聚合方法。期望字符串值。可以在不替换的情况下更新。
- alarm_actions¶
- 状态变为告警时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- alarm_queues¶
-
状态变为告警时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- comparison_operator¶
- 用于将指定统计数据与阈值进行比较的运算符。期望字符串值。可以在不替换的情况下更新。允许的值：“le”、“ge”、“eq”、“lt”、“gt”、“ne”
- description¶
- 告警描述。期望字符串值。可以在不替换的情况下更新。
- enabled¶
- 如果告警评估/操作已启用，则为 True。期望布尔值。可以在不替换的情况下更新。默认为
"true" - evaluation_periods¶
- 要评估的周期数。期望整数值。可以在不替换的情况下更新。
- granularity¶
- 时间范围（秒）。期望整数值。可以在不替换的情况下更新。
- insufficient_data_actions¶
- 状态变为 insufficient-data 时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- insufficient_data_queues¶
-
状态变为 insufficient-data 时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- ok_actions¶
- 状态变为 ok 时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- ok_queues¶
-
状态变为 ok 时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- repeat_actions¶
- 如果达到阈值且告警状态已更改，则为 False 以触发操作。默认情况下，每次达到阈值时都会调用操作。期望布尔值。可以在不替换的情况下更新。默认为
"true" - severity¶
-
告警级别。期望字符串值。可以在不替换的情况下更新。默认为
"low"允许的值：“low”、“moderate”、“critical” - time_constraints¶
-
描述告警的时间约束。仅当评估时间在时间约束内时才评估告警。约束的开始点（s）使用 cron 表达式指定，而持续时间以秒为单位。期望列表值。更新会导致替换。默认为
[]列表内容- 期望 Map 值。更新会导致替换。Map 属性
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Aodh::GnocchiAggregationByMetricsAlarm
properties:
aggregation_method: String
alarm_actions: [Value, Value, ...]
alarm_queues: [String, String, ...]
comparison_operator: String
description: String
enabled: Boolean
evaluation_periods: Integer
granularity: Integer
insufficient_data_actions: [Value, Value, ...]
insufficient_data_queues: [String, String, ...]
metrics: [Value, Value, ...]
ok_actions: [Value, Value, ...]
ok_queues: [String, String, ...]
repeat_actions: Boolean
severity: String
threshold: Number
time_constraints: [{"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, {"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, ...]
OS::Aodh::GnocchiAggregationByResourcesAlarm¶
实现资源告警聚合的告警的资源。
实现使用具有某些条件的资源告警聚合的告警的资源。如果系统状态满足告警条件，则激活告警。
必需属性¶
可选属性¶
- aggregation_method¶
- 用于与阈值进行比较的聚合方法。期望字符串值。可以在不替换的情况下更新。
- alarm_actions¶
- 状态变为告警时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- alarm_queues¶
-
状态变为告警时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- comparison_operator¶
- 用于将指定统计数据与阈值进行比较的运算符。期望字符串值。可以在不替换的情况下更新。允许的值：“le”、“ge”、“eq”、“lt”、“gt”、“ne”
- description¶
- 告警描述。期望字符串值。可以在不替换的情况下更新。
- enabled¶
- 如果告警评估/操作已启用，则为 True。期望布尔值。可以在不替换的情况下更新。默认为
"true" - evaluation_periods¶
- 要评估的周期数。期望整数值。可以在不替换的情况下更新。
- granularity¶
- 时间范围（秒）。期望整数值。可以在不替换的情况下更新。
- insufficient_data_actions¶
- 状态变为 insufficient-data 时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- insufficient_data_queues¶
-
状态变为 insufficient-data 时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- ok_actions¶
- 状态变为 ok 时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- ok_queues¶
-
状态变为 ok 时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- repeat_actions¶
- 如果达到阈值且告警状态已更改，则为 False 以触发操作。默认情况下，每次达到阈值时都会调用操作。期望布尔值。可以在不替换的情况下更新。默认为
"true" - severity¶
-
告警级别。期望字符串值。可以在不替换的情况下更新。默认为
"low"允许的值：“low”、“moderate”、“critical” - time_constraints¶
-
描述告警的时间约束。仅当评估时间在时间约束内时才评估告警。约束的开始点（s）使用 cron 表达式指定，而持续时间以秒为单位。期望列表值。更新会导致替换。默认为
[]列表内容- 期望 Map 值。更新会导致替换。Map 属性
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Aodh::GnocchiAggregationByResourcesAlarm
properties:
aggregation_method: String
alarm_actions: [Value, Value, ...]
alarm_queues: [String, String, ...]
comparison_operator: String
description: String
enabled: Boolean
evaluation_periods: Integer
granularity: Integer
insufficient_data_actions: [Value, Value, ...]
insufficient_data_queues: [String, String, ...]
metric: String
ok_actions: [Value, Value, ...]
ok_queues: [String, String, ...]
query: String
repeat_actions: Boolean
resource_type: String
severity: String
threshold: Number
time_constraints: [{"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, {"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, ...]
OS::Aodh::GnocchiResourcesAlarm¶
允许监视某些指定资源的资源。
根据指定资源的某些指标评估阈值的告警。
必需属性¶
可选属性¶
- aggregation_method¶
- 用于与阈值进行比较的聚合方法。期望字符串值。可以在不替换的情况下更新。
- alarm_actions¶
- 状态变为告警时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- alarm_queues¶
-
状态变为告警时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- comparison_operator¶
- 用于将指定统计数据与阈值进行比较的运算符。期望字符串值。可以在不替换的情况下更新。允许的值：“le”、“ge”、“eq”、“lt”、“gt”、“ne”
- description¶
- 告警描述。期望字符串值。可以在不替换的情况下更新。
- enabled¶
- 如果告警评估/操作已启用，则为 True。期望布尔值。可以在不替换的情况下更新。默认为
"true" - evaluation_periods¶
- 要评估的周期数。期望整数值。可以在不替换的情况下更新。
- granularity¶
- 时间范围（秒）。期望整数值。可以在不替换的情况下更新。
- insufficient_data_actions¶
- 状态变为 insufficient-data 时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- insufficient_data_queues¶
-
状态变为 insufficient-data 时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- ok_actions¶
- 状态变为 ok 时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- ok_queues¶
-
状态变为 ok 时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- repeat_actions¶
- 如果达到阈值且告警状态已更改，则为 False 以触发操作。默认情况下，每次达到阈值时都会调用操作。期望布尔值。可以在不替换的情况下更新。默认为
"true" - severity¶
-
告警级别。期望字符串值。可以在不替换的情况下更新。默认为
"low"允许的值：“low”、“moderate”、“critical” - time_constraints¶
-
描述告警的时间约束。仅当评估时间在时间约束内时才评估告警。约束的开始点（s）使用 cron 表达式指定，而持续时间以秒为单位。期望列表值。更新会导致替换。默认为
[]列表内容- 期望 Map 值。更新会导致替换。Map 属性
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Aodh::GnocchiResourcesAlarm
properties:
aggregation_method: String
alarm_actions: [Value, Value, ...]
alarm_queues: [String, String, ...]
comparison_operator: String
description: String
enabled: Boolean
evaluation_periods: Integer
granularity: Integer
insufficient_data_actions: [Value, Value, ...]
insufficient_data_queues: [String, String, ...]
metric: String
ok_actions: [Value, Value, ...]
ok_queues: [String, String, ...]
repeat_actions: Boolean
resource_id: String
resource_type: String
severity: String
threshold: Number
time_constraints: [{"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, {"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, ...]
OS::Aodh::LBMemberHealthAlarm¶
实现负载均衡器成员健康告警的资源。
允许基于负载均衡器池成员的健康状况设置告警，其中成员的健康状况由成员在创建后的初始宽限期（默认为 120 秒）后报告 operating_status 为 ERROR 来确定。
必需属性¶
可选属性¶
- alarm_actions¶
- 状态变为告警时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- alarm_queues¶
-
状态变为告警时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- description¶
- 告警描述。期望字符串值。可以在不替换的情况下更新。
- enabled¶
- 如果告警评估/操作已启用，则为 True。期望布尔值。可以在不替换的情况下更新。默认为
"true" - insufficient_data_actions¶
- 状态变为 insufficient-data 时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- insufficient_data_queues¶
-
状态变为 insufficient-data 时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- ok_actions¶
- 状态变为 ok 时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- ok_queues¶
-
状态变为 ok 时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- repeat_actions¶
- 如果达到阈值且告警状态已更改，则为 False 以触发操作。默认情况下，每次达到阈值时都会调用操作。期望布尔值。可以在不替换的情况下更新。默认为
"true" - severity¶
-
告警级别。期望字符串值。可以在不替换的情况下更新。默认为
"low"允许的值：“low”、“moderate”、“critical” - time_constraints¶
-
描述告警的时间约束。仅当评估时间在时间约束内时才评估告警。约束的开始点（s）使用 cron 表达式指定，而持续时间以秒为单位。期望列表值。更新会导致替换。默认为
[]列表内容- 期望 Map 值。更新会导致替换。Map 属性
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Aodh::LBMemberHealthAlarm
properties:
alarm_actions: [Value, Value, ...]
alarm_queues: [String, String, ...]
autoscaling_group_id: String
description: String
enabled: Boolean
insufficient_data_actions: [Value, Value, ...]
insufficient_data_queues: [String, String, ...]
ok_actions: [Value, Value, ...]
ok_queues: [String, String, ...]
pool: String
repeat_actions: Boolean
severity: String
stack: String
time_constraints: [{"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, {"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, ...]
OS::Aodh::PrometheusAlarm¶
实现 prometheus 类型 Aodh 告警的资源。
从 Prometheus 获取指标数据并评估阈值的告警。
必需属性¶
可选属性¶
- alarm_actions¶
- 状态变为告警时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- alarm_queues¶
-
状态变为告警时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- comparison_operator¶
- 用于将指定统计数据与阈值进行比较的运算符。期望字符串值。可以在不替换的情况下更新。允许的值：“le”、“ge”、“eq”、“lt”、“gt”、“ne”
- description¶
- 告警描述。期望字符串值。可以在不替换的情况下更新。
- enabled¶
- 如果告警评估/操作已启用，则为 True。期望布尔值。可以在不替换的情况下更新。默认为
"true" - insufficient_data_actions¶
- 状态变为 insufficient-data 时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- insufficient_data_queues¶
-
状态变为 insufficient-data 时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- ok_actions¶
- 状态变为 ok 时调用的 URL（Webhook）列表。期望列表值。可以在不替换的情况下更新。
- ok_queues¶
-
状态变为 ok 时发布到的 Zaqar 队列列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 zaqar.queue 类型
- repeat_actions¶
- 如果达到阈值且告警状态已更改，则为 False 以触发操作。默认情况下，每次达到阈值时都会调用操作。期望布尔值。可以在不替换的情况下更新。默认为
"true" - severity¶
-
告警级别。期望字符串值。可以在不替换的情况下更新。默认为
"low"允许的值：“low”、“moderate”、“critical” - time_constraints¶
-
描述告警的时间约束。仅当评估时间在时间约束内时才评估告警。约束的开始点（s）使用 cron 表达式指定，而持续时间以秒为单位。期望列表值。更新会导致替换。默认为
[]列表内容- 期望 Map 值。更新会导致替换。Map 属性
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Aodh::PrometheusAlarm
properties:
alarm_actions: [Value, Value, ...]
alarm_queues: [String, String, ...]
comparison_operator: String
description: String
enabled: Boolean
insufficient_data_actions: [Value, Value, ...]
insufficient_data_queues: [String, String, ...]
ok_actions: [Value, Value, ...]
ok_queues: [String, String, ...]
query: String
repeat_actions: Boolean
severity: String
threshold: Number
time_constraints: [{"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, {"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, ...]
OS::Barbican::CertificateContainer¶
用于创建 barbican 证书容器的资源。
证书容器用于存储与证书相关的密钥。
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Barbican::CertificateContainer
properties:
certificate_ref: String
intermediates_ref: String
name: String
private_key_passphrase_ref: String
private_key_ref: String
OS::Barbican::GenericContainer¶
用于创建 Barbican 通用容器的资源。
通用容器用于用户希望聚合的任何类型的密钥。此容器中可以容纳的密钥数量没有限制。
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Barbican::GenericContainer
properties:
name: String
secrets: [{"name": String, "ref": String}, {"name": String, "ref": String}, ...]
OS::Barbican::Order¶
允许 Barbican 生成密钥材料的资源。
该资源允许生成一些密钥材料。例如，可以是某个密钥或证书。订单封装了创建密钥的工作流程和历史记录。生成密钥的时间可能因密钥类型而异。
必需属性¶
- type¶
-
订单的类型。期望字符串值。更新会导致替换。允许的值：“key”、“asymmetric”、“certificate”
可选属性¶
- algorithm¶
- 用于生成密钥的算法类型。对于 key 和 asymmetric 类型的订单是必需的。期望字符串值。更新会导致替换。
- bit_length¶
- 密钥的位长度。对于 key 和 asymmetric 类型的订单是必需的。期望整数值。更新会导致替换。
- ca_id¶
-
要使用的 CA 的标识符。期望字符串值。更新会导致替换。
- expiration¶
- 密钥的到期日期，ISO-8601 格式。期望字符串值。更新会导致替换。值必须为 expiration 类型
- mode¶
- 与密钥信息相关的算法的类型/模式。期望字符串值。更新会导致替换。
- name¶
- 密钥的可读名称。期望字符串值。更新会导致替换。
- pass_phrase¶
-
创建的密钥的密码。只能为 asymmetric 类型的订单设置。期望字符串值。更新会导致替换。
- payload_content_type¶
- 提供密钥数据的类型/格式。期望字符串值。更新会导致替换。
- profile¶
-
要使用的证书配置文件。期望字符串值。更新会导致替换。
- request_data¶
-
CSR 的内容。仅适用于证书订单。期望字符串值。更新会导致替换。
- request_type¶
-
证书请求的类型。期望字符串值。更新会导致替换。允许的值：“stored-key”、“simple-cmc”、“custom”
- source_container_ref¶
-
证书请求的源。期望字符串值。更新会导致替换。值必须为 barbican.container 类型
- subject_dn¶
-
证书请求的主题。期望字符串值。更新会导致替换。
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Barbican::Order
properties:
algorithm: String
bit_length: Integer
ca_id: String
expiration: String
mode: String
name: String
pass_phrase: String
payload_content_type: String
profile: String
request_data: String
request_type: String
source_container_ref: String
subject_dn: String
type: String
OS::Barbican::RSAContainer¶
用于创建 barbican RSA 容器的资源。
RSA 容器用于存储 RSA 公钥、私钥和私钥密码。
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Barbican::RSAContainer
properties:
name: String
private_key_passphrase_ref: String
private_key_ref: String
public_key_ref: String
OS::Barbican::Secret¶
该资源提供对存储的密钥/密钥材料的访问。
密钥是存储在 Barbican 中的单个项目。密钥可以是您希望的任何内容；然而，正式的用例是您希望隐藏的密钥。密钥可以包括私钥、密码等。
可选属性¶
- algorithm¶
- 用于生成密钥的算法类型。期望字符串值。更新会导致替换。
- bit_length¶
- 密钥的位长度。期望整数值。更新会导致替换。该值必须至少为 0。
- expiration¶
- 密钥的到期日期，ISO-8601 格式。期望字符串值。更新会导致替换。值必须为 expiration 类型
- mode¶
- 与密钥信息相关的算法的类型/模式。期望字符串值。更新会导致替换。
- name¶
- 密钥的可读名称。期望字符串值。更新会导致替换。
- payload¶
- 密钥的未加密明文。期望字符串值。更新会导致替换。
- payload_content_encoding¶
- 提供有效负载数据所使用的编码格式。期望字符串值。更新会导致替换。允许的值：“base64”
- payload_content_type¶
- 提供密钥数据的类型/格式。期望字符串值。更新会导致替换。允许的值：“text/plain”、“application/octet-stream”
- secret_type¶
-
密钥的类型。期望字符串值。更新会导致替换。默认为
"opaque"允许的值：“symmetric”、“public”、“private”、“certificate”、“passphrase”、“opaque”
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Barbican::Secret
properties:
algorithm: String
bit_length: Integer
expiration: String
mode: String
name: String
payload: String
payload_content_encoding: String
payload_content_type: String
secret_type: String
OS::Blazar::Host¶
管理 Blazar 主机的资源。
Host 资源管理 OpenStack 中的 lease/reservation 的物理主机。
# TODO(asmita): 根据与 Blazar 团队的协议，此资源类不支持更新主机资源，因为 Blazar 目前不支持在更新主机时删除现有的 extra_capability 键。此外，在不久的将来，当 Blazar 团队提供新的替代 API 来解决此问题时，我们将需要修改此类。
必需属性¶
- name¶
- 主机的名称。期望字符串值。更新会导致替换。
可选属性¶
- extra_capability¶
- 主机的额外功能。期望 Map 值。更新会导致替换。
属性¶
- cpu_info¶
主机的 CPU 信息。
- created_at¶
创建主机的日期和时间。日期和时间格式必须是“CCYY-MM-DD hh:mm”。
- extra_capability¶
主机的额外功能。
- hypervisor_hostname¶
主机的虚拟机管理程序名称。
- hypervisor_type¶
主机的虚拟机管理程序类型。
- hypervisor_version¶
主机的虚拟机管理程序版本。
- local_gb¶
主机的本地磁盘 GB。
- memory_mb¶
主机的内存 MB。
- reservable¶
表示主机是否可预订的标志。
- service_name¶
主机的计算服务名称。
- show¶
资源的详细信息。
- status¶
主机的状态。
- trust_id¶
主机运营商信任的 UUID。
- updated_at¶
更新主机的日期和时间。日期和时间格式必须是“CCYY-MM-DD hh:mm”。
- vcpus¶
主机的 VCPU 数量。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Blazar::Host
properties:
extra_capability: {...}
name: String
OS::Blazar::Lease¶
管理 Blazar 租约的资源。
Lease 资源管理 OpenStack 中特定类型/数量的云资源的预订。
注意：根据与 Blazar 团队的协议，此类不支持更新，因为当前的 Blazar 租约方案不适合 Heat。如果您想更新租约，您需要指定 reservation 的 ID，该 ID 是 lease 的一个属性。
必需属性¶
- end_date¶
- 租约的结束日期和时间。日期和时间格式必须是“CCYY-MM-DD hh:mm”。期望字符串值。更新会导致替换。值必须匹配模式：\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}
- name¶
- 租约的名称。期望字符串值。更新会导致替换。
- reservations¶
- 预订列表。期望列表值。更新会导致替换。列表内容
- 期望 Map 值。更新会导致替换。Map 属性
- affinity¶
- 可选。要预订的实例的亲和性。期望布尔值。更新会导致替换。默认为
false - amount¶
- 可选。要预订的实例数量。期望整数值。更新会导致替换。值必须在 0 到 2147483647 的范围内。
- before_end¶
- 可选。预订的 before-end-action。期望字符串值。更新会导致替换。默认为
"default"允许的值：“default”、“snapshot” - disk_gb¶
- 可选。每个实例的本地磁盘 GB。期望整数值。更新会导致替换。值必须在 0 到 2147483647 的范围内。
- hypervisor_properties¶
- 可选。要预订的虚拟机管理程序的属性。期望字符串值。更新会导致替换。
- max¶
- 可选。要预订的主机最大数量。期望整数值。更新会导致替换。值必须至少为 1。
- memory_mb¶
- 可选。每个实例的内存 MB。期望整数值。更新会导致替换。值必须在 0 到 2147483647 的范围内。
- min¶
- 可选。要预订的主机最小数量。期望整数值。更新会导致替换。值必须至少为 1。
- resource_properties¶
- 可选。要预订的资源的属性。期望字符串值。更新会导致替换。
- resource_type¶
- 必需。要预订的资源的类型。期望字符串值。更新会导致替换。允许的值：“virtual:instance”、“physical:host”
- vcpus¶
- 可选。每个实例的 VCPU 数量。期望整数值。更新会导致替换。值必须在 0 到 2147483647 的范围内。
- start_date¶
- 租约的开始日期和时间。日期和时间格式必须是“CCYY-MM-DD hh:mm”。期望字符串值。更新会导致替换。值必须匹配模式：\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}
可选属性¶
属性¶
- created_at¶
创建租约的日期和时间。日期和时间格式是“CCYY-MM-DD hh:mm”。
- degraded¶
表示租约预留资源状况的标志。如果为 true，则预留资源的数量少于请求的量或预留的资源已被更改。
- end_date¶
租约的结束日期和时间。日期和时间格式是“CCYY-MM-DD hh:mm”。
- events¶
租约的事件信息。
- name¶
租约的名称。
- project_id¶
拥有租约的项目 UUID。
- reservations¶
预订对象列表。
- show¶
资源的详细信息。
- start_date¶
租约的开始日期和时间。日期和时间格式是“CCYY-MM-DD hh:mm”。
- status¶
租约的状态。
- trust_id¶
租约所有者信任的 UUID。
- updated_at¶
更新租约的日期和时间。日期和时间格式是“CCYY-MM-DD hh:mm”。
- user_id¶
租约所有者的 UUID。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Blazar::Lease
properties:
before_end_date: String
end_date: String
events: [{"event_type": String, "time": String}, {"event_type": String, "time": String}, ...]
name: String
reservations: [{"resource_type": String, "min": Integer, "max": Integer, "hypervisor_properties": String, "resource_properties": String, "before_end": String, "amount": Integer, "vcpus": Integer, "memory_mb": Integer, "disk_gb": Integer, "affinity": Boolean}, {"resource_type": String, "min": Integer, "max": Integer, "hypervisor_properties": String, "resource_properties": String, "before_end": String, "amount": Integer, "vcpus": Integer, "memory_mb": Integer, "disk_gb": Integer, "affinity": Boolean}, ...]
start_date: String
OS::Cinder::EncryptedVolumeType¶
加密 Cinder 卷类型的资源。
卷加密类型是用于对特定卷类型执行加密的设置集合。
请注意，默认 Cinder 安全策略使用此资源仅限于管理员。
必需属性¶
可选属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Cinder::EncryptedVolumeType
properties:
cipher: String
control_location: String
key_size: Integer
provider: String
volume_type: String
OS::Cinder::QoSAssociation¶
将 Cinder QoS 策略与卷类型关联的资源。
默认策略限制了此资源的用法，仅限管理员。
必需属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Cinder::QoSAssociation
properties:
qos_specs: String
volume_types: [String, String, ...]
OS::Cinder::QoSSpecs¶
创建 Cinder QoS 策略的资源。
用户可以请求特定的卷类型。该卷类型的一部分是一个定义卷 IO (fast, normal, or slow) QoS 的字符串。能够满足卷类型所有需求的后端将成为调度候选。默认策略限制了此资源的用法，仅限管理员。
必需属性¶
- specs¶
- QoS 的 specs 键值对。期望 Map 值。可以在不替换的情况下更新。
可选属性¶
- name¶
- QoS 名称。期望字符串值。更新会导致替换。
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Cinder::QoSSpecs
properties:
name: String
specs: {...}
OS::Cinder::Quota¶
创建 Cinder 配额的资源。
Cinder 配额用于管理项目的操作限制。目前，此资源可以管理 Cinder 的 GB、快照和卷配额。
请注意，默认 Cinder 安全策略使用此资源仅限于管理员。管理员应小心，每个项目只创建一个 Cinder 配额资源，否则将难以正确管理配额。
必需属性¶
- project¶
- OpenStack Keystone 项目。期望字符串值。更新会导致替换。值必须为 keystone.project 类型
可选属性¶
- backup_gigabytes¶
-
备份磁盘空间总量（GB）的配额。将值设置为 -1 可移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- backups¶
-
备份数量配额。将值设置为 -1 可移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- gigabytes¶
- 磁盘空间总量（GB）的配额。将值设置为 -1 可移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- snapshots¶
- 快照数量配额。将值设置为 -1 可移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- volumes¶
- 卷数量配额。将值设置为 -1 可移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Cinder::Quota
properties:
backup_gigabytes: Integer
backups: Integer
gigabytes: Integer
project: String
snapshots: Integer
volumes: Integer
OS::Cinder::Volume¶
实现 Cinder 卷的资源。
Cinder 卷是块设备形式的存储。例如，可用于为实例提供存储。卷支持从快照、备份或镜像创建。卷也可以仅按大小创建。
可选属性¶
- availability_zone¶
- 将创建卷的可用区。期望字符串值。更新会导致替换。
- backup_id¶
- 如果指定，则为从中创建卷的备份。期望字符串值。可以在不替换的情况下更新。值必须为 cinder.backup 类型
- description¶
- 卷的描述。期望字符串值。可以在不替换的情况下更新。
- image¶
- 如果指定，则为从中创建卷的镜像的名称或 ID。期望字符串值。更新会导致替换。值必须为 glance.image 类型
- metadata¶
- 要与卷关联的键/值对。期望 Map 值。可以在不替换的情况下更新。默认为
{} - name¶
- 用于区分卷的名称。期望字符串值。可以在不替换的情况下更新。
- read_only¶
-
启用或禁用卷的只读访问模式。期望布尔值。可以在不替换的情况下更新。
- scheduler_hints¶
-
客户端指定的任意键值对，以帮助 Cinder 调度器创建卷。期望 Map 值。更新会导致替换。
- size¶
- 卷的大小（GB）。更新时仅支持增大。除非指定了 property backup_id、source_volid 或 snapshot_id，否则此属性是必需的。期望整数值。可以在不替换的情况下更新。值必须至少为 1。
- snapshot_id¶
- 如果指定，则为从中创建卷的快照。期望字符串值。更新会导致替换。值必须为 cinder.snapshot 类型
- source_volid¶
- 如果指定，则为用作源的卷。期望字符串值。更新会导致替换。值必须为 cinder.volume 类型
- volume_type¶
- 如果指定，则为要使用的卷类型，映射到特定后端。期望字符串值。可以在不替换的情况下更新。值必须为 cinder.vtype 类型
属性¶
- attachments¶
-
卷附件列表的字符串表示。
- attachments_list¶
-
卷附件列表。
- availability_zone¶
卷所在的可用区。
- bootable¶
布尔值，指示卷是否可启动。
- created_at¶
指示卷创建的时间戳。
- display_description¶
卷的描述。
- display_name¶
卷的名称。
- encrypted¶
布尔值，指示卷是否已加密。
- metadata¶
与卷关联的键/值对。
- metadata_values¶
与卷关联的键/值对（原始字典形式）。
- multiattach¶
-
布尔值，指示是否允许卷被多次附加。
- show¶
资源的详细信息。
- 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
read_only: Boolean
scheduler_hints: {...}
size: Integer
snapshot_id: String
source_volid: String
volume_type: String
OS::Cinder::VolumeAttachment¶
将卷与实例关联的资源。
将现有卷与实例关联的资源。另外，可以指定卷在实例上的暴露位置。
必需属性¶
可选属性¶
- mountpoint¶
- 卷在实例上暴露的位置。此分配可能不会被遵守，建议使用路径/dev/disk/by-id/virtio-<VolumeId>。期望字符串值。可以在不替换的情况下更新。
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Cinder::VolumeAttachment
properties:
instance_uuid: String
mountpoint: String
volume_id: String
OS::Cinder::VolumeType¶
创建 Cinder 卷类型的资源。
卷类型资源允许定义使用此类型的卷是否为公共卷，以及允许哪些项目使用它。此外，还可以定义一些用户自定义元数据。
请注意，默认 Cinder 安全策略使用此资源仅限于管理员。
必需属性¶
- name¶
- 卷类型的名称。期望字符串值。可以在不替换的情况下更新。
可选属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Cinder::VolumeType
properties:
description: String
is_public: Boolean
metadata: {...}
name: String
projects: [String, String, ...]
OS::Designate::RecordSet¶
Designate 的 Heat 模板资源。
Designate 提供 OpenStack 的 DNS 即服务。RecordSet 有助于添加多个记录。
必需属性¶
- records¶
- 此 RecordSet 的数据列表。每项都将成为 Designate 中的一个单独记录。这些项应符合记录类型的 DNS 规范 - 例如，A 记录必须是 IPv4 地址，CNAME 记录必须是主机名。DNS 记录数据因记录类型而异。有关更多详细信息，请参阅 rfc 1035。期望列表值。可以在不替换的情况下更新。
- type¶
- DNS RecordSet 类型。期望字符串值。更新会导致替换。允许的值：“A”、“AAAA”、“CNAME”、“MX”、“SRV”、“TXT”、“SPF”、“NS”、“PTR”、“SSHFP”、“SOA”、“CAA”、“CERT”、“NAPTR”
- zone¶
- DNS 区域 ID 或名称。期望字符串值。更新会导致替换。值必须为 designate.zone 类型
可选属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Designate::RecordSet
properties:
description: String
name: String
records: [Value, Value, ...]
ttl: Integer
type: String
zone: String
OS::Designate::Zone¶
Designate 的 Heat 模板资源。
Designate 提供 OpenStack 的 DNS 即服务。因此，域的一部分区域是具有唯一标识符的区域，在 DNS 中是唯一的。
必需属性¶
- name¶
- 区域的 DNS 名称。期望字符串值。更新会导致替换。长度不能超过 255。
可选属性¶
- attributes¶
-
有关此区域以及用户希望放置区域的池的信息的键：值对。这些信息可供调度程序用于将区域放置在正确的池上。期望 Map 值。更新会导致替换。
- description¶
- 区域描述。期望字符串值。可以在不替换的情况下更新。长度不能超过 160。
- email¶
- 区域的电子邮件。用于区域的 SOA 记录。PRIMARY 类型需要，否则被忽略。期望字符串值。可以在不替换的情况下更新。
- primaries¶
- 用于传输 DNS 区域信息的服务器。SECONDARY区域类型必需，否则被忽略。期望列表值。可以在不替换的情况下更新。
- ttl¶
- 区域的生存时间（秒）。期望整数值。可以在不替换的情况下更新。值必须在 1 到 2147483647 的范围内。
- 类型¶
- 区域类型。PRIMARY 由 Designate 控制，SECONDARY 区域则从另一个 DNS 服务器传输。期望字符串值。更新会导致替换。默认值为
"PRIMARY"允许值：“PRIMARY”、“SECONDARY” - 主服务器¶
-
用于传输 DNS 区域信息的服务器。SECONDARY区域类型必需，否则被忽略。期望列表值。可以在不替换的情况下更新。
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Designate::Zone
properties:
attributes: {...}
description: String
email: String
name: String
primaries: [Value, Value, ...]
ttl: Integer
type: String
OS::Glance::WebImage¶
一种通过 Web 下载导入来管理 Glance 中镜像的资源。
这为最近的 Glance 安装提供了镜像支持。
必需属性¶
- container_format¶
- 镜像的容器格式。期望字符串值。更新会导致替换。允许值：“ami”、“ari”、“aki”、“bare”、“ovf”、“ova”、“docker”
- disk_format¶
- 镜像的磁盘格式。期望字符串值。更新会导致替换。允许值：“ami”、“ari”、“aki”、“vhd”、“vhdx”、“vmdk”、“raw”、“qcow2”、“vdi”、“iso”、“ploop”
- location¶
- 镜像数据已驻留的 URL。例如，如果镜像数据存储在 swift 中，您可以指定“swift://example.com/container/obj”。期望字符串值。更新会导致替换。
可选属性¶
- active¶
-
激活或停用镜像。需要管理员访问权限。期望布尔值。可以在不替换的情况下更新。默认为
true - architecture¶
- 操作系统架构。期望字符串值。可以在不替换的情况下更新。
- extra_properties¶
-
与镜像关联的任意属性。期望 Map 值。可以在不替换的情况下更新。默认为
{} - id¶
- 镜像 ID。如果未指定，Glance 将生成一个 UUID。期望字符串值。更新会导致替换。
- kernel_id¶
- 存储在 Glance 中的镜像的 ID，该镜像应在启动 AMI 风格的镜像时用作内核。期望字符串值。可以在不替换的情况下更新。值必须匹配模式：^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$
- members¶
-
允许读取该镜像的附加成员列表。根据所使用的 Glance 配置，这可以是 Keystone 项目 ID 或用户 ID。期望列表值。可以在不替换的情况下更新。列表内容
- 可选。成员 ID。根据所使用的 Glance 配置，这可以是 Keystone 项目 ID 或用户 ID。期望字符串值。可以在不替换的情况下更新。
- min_disk¶
- 启动镜像所需的磁盘空间量（GB）。如果未指定，则默认为 0，表示磁盘大小无限制。期望整数值。更新会导致替换。默认值为
0该值必须至少为 0。 - min_ram¶
- 启动镜像所需的 RAM 量（MB）。如果未指定，则默认为 0，表示 RAM 大小无限制。期望整数值。更新会导致替换。默认值为
0该值必须至少为 0。 - name¶
- 镜像的名称。镜像的名称在镜像服务节点上不唯一。期望字符串值。更新会导致替换。
- os_distro¶
- 操作系统发行版的通用名称（小写）。期望字符串值。可以在不替换的情况下更新。
- os_version¶
- 分发商指定的操作系统版本。期望字符串值。可以在不替换的情况下更新。
- owner¶
- 镜像的所有者。期望字符串值。可以在不替换的情况下更新。
- protected¶
- 镜像是否可以被删除。如果值为 True，则镜像受到保护，无法被删除。期望布尔值。可以在不替换的情况下更新。默认为
false - ramdisk_id¶
- 存储在 Glance 中的镜像的 ID，该镜像应在启动 AMI 风格的镜像时用作 ramdisk。期望字符串值。可以在不替换的情况下更新。值必须匹配模式：^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$
- visibility¶
- 镜像可访问范围。期望字符串值。可以在不替换的情况下更新。默认值为
"private"允许值：“public”、“private”、“community”、“shared”
属性¶
- 显示¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Glance::WebImage
properties:
active: Boolean
architecture: String
container_format: String
disk_format: String
extra_properties: {...}
id: String
kernel_id: String
location: String
members: [String, String, ...]
min_disk: Integer
min_ram: Integer
name: String
os_distro: String
os_version: String
owner: String
protected: Boolean
ramdisk_id: String
tags: [Value, Value, ...]
visibility: String
OS::Heat::AccessPolicy¶
定义哪些资源可以被用户访问的资源。
注意：此资源当前与 AWS 用户资源相关联，而不是与任何 OS:: 资源相关联，尽管它在下面的 OS 命名空间下注册。
定义用户可以通过 DescribeStackResource API 访问的资源。
必需属性¶
- AllowedResources¶
- 用户可以通过 DescribeStackResource API 访问的资源。期望列表值。更新会导致替换。
属性¶
- 显示¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::AccessPolicy
properties:
AllowedResources: [Value, Value, ...]
OS::Heat::AutoScalingGroup¶
一个可以扩展任意资源的自动伸缩组。
自动伸缩组允许创建指定数量的相似资源，这些资源以 HOT 格式定义。如果您需要创建许多相同的资源（例如，一百套服务器、WaitCondition 和 WaitConditionHandle，甚至 Neutron 网络），AutoScalingGroup 是一个便捷易用的方法。
必需属性¶
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::AutoScalingGroup
properties:
cooldown: Integer
desired_capacity: Integer
max_size: Integer
min_size: Integer
resource: {...}
rolling_updates: {"min_in_service": Integer, "max_batch_size": Integer, "pause_time": Number}
OS::Heat::CloudConfig¶
表示 cloud-init cloud-config 的配置资源。
此资源允许 cloud-config YAML 被定义并由 config API 存储。在存储结果之前，任何在 config 中调用的内在函数都将被解析。
此资源通常由 OS::Nova::Server user_data 或 OS::Heat::MultipartMime parts config 引用。由于 cloud-config 是启动时配置，因此对定义所做的任何更改都将导致替换所有引用它的服务器。
可选属性¶
- cloud_config¶
- 表示 cloud-config 数据结构的映射，该结构将被格式化为 YAML。期望 Map 值。更新会导致替换。
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::CloudConfig
properties:
cloud_config: {...}
OS::Heat::Delay¶
一种暂停可配置延迟的资源。
通过操作模板中资源之间的依赖关系，可以在堆栈创建或删除等任意点插入延迟。在 CREATE 或 SUSPEND 期间，延迟会发生在它所依赖的任何资源之后，在 DELETE 或 RESUME 期间，延迟会发生在它所依赖的任何资源之前。同样，在 CREATE 或 SUSPEND 期间，延迟会发生在它所依赖的任何资源之前，在 DELETE 或 RESUME 期间，延迟会发生在依赖于它的任何资源之后。
如果指定了非零的最大抖动，则会向最小延迟时间添加一个抖动量（以均匀概率选择，范围从 0 到最大抖动值与抖动乘数（默认为 1 秒）的乘积）。这可以用于例如大型伸缩组的伸缩单元，以防止“惊群”效应。
可选属性¶
- actions¶
- 延迟将发生的动作。期望列表值。可以在不替换的情况下更新。默认为
["CREATE"]允许值：“CREATE”、“DELETE”、“SUSPEND”、“RESUME” - jitter_multiplier¶
- 用于乘以最大抖动值的秒数。预期的数字值。可以在不替换的情况下更新。默认值为
1.0该值必须至少为 0。 - max_jitter¶
- 添加到最小等待时间的最大抖动量。预期的数字值。可以在不替换的情况下更新。默认值为
0该值必须至少为 0。 - min_wait¶
- 在指定动作期间等待的最小时间（秒）。预期的数字值。可以在不替换的情况下更新。默认值为
0该值必须至少为 0。
属性¶
- 显示¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::Delay
properties:
actions: [Value, Value, ...]
jitter_multiplier: Number
max_jitter: Number
min_wait: Number
OS::Heat::DeployedServer¶
用于管理已部署服务器的资源。
DeployedServer 资源管理在 OpenStack 外部已部署的服务器的资源。这些服务器可以与 SoftwareDeployments 关联，以便通过 Heat 进行进一步的编排。
可选属性¶
- deployment_swift_data¶
-
用于存储服务器资源的部署数据的 Swift 容器和对象。该参数是一个映射值，具有“container”和“object”键，值为相应的容器和对象名称。software_config_transport 参数必须设置为 POLL_TEMP_URL 才能使用 swift。如果未指定且 software_config_transport 设置为 POLL_TEMP_URL，则将根据资源名称自动创建一个容器，对象名称将是生成的 uuid。期望 Map 值。可以在不替换的情况下更新。默认为
{}Map 属性 - name¶
- 服务器名称。期望字符串值。可以在不替换的情况下更新。
- software_config_transport¶
- 服务器应如何接收软件配置所需的元数据。POLL_SERVER_CFN 允许调用 cfn API 操作 DescribeStackResource，并使用提供的密钥对进行身份验证。POLL_SERVER_HEAT 允许使用提供的 keystone 凭证调用 Heat API 资源显示。POLL_TEMP_URL 将创建一个 TempURL 并填充元数据以供轮询。ZAQAR_MESSAGE 将创建一个专用的 zaqar 队列并发布元数据以供轮询。期望字符串值。可以在不替换的情况下更新。默认值为
"POLL_SERVER_CFN"允许值：“POLL_SERVER_CFN”、“POLL_SERVER_HEAT”、“POLL_TEMP_URL”、“ZAQAR_MESSAGE” - metadata¶
-
要与此服务器关联的任意键/值元数据。键和值都必须小于或等于 255 个字符。非字符串值将被序列化为 JSON（序列化后的字符串必须小于或等于 255 个字符）。期望 Map 值。可以在不替换的情况下更新。
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::DeployedServer
properties:
deployment_swift_data: {"container": String, "object": String}
name: String
software_config_transport: String
OS::Heat::InstanceGroup¶
一个可以扩展任意实例的实例组。
一种资源，允许创建与 AWS::AutoScaling::LaunchConfiguration 实例数量相同的实例。允许将伸缩资源与负载均衡器资源关联。
必需属性¶
可选属性¶
属性¶
update_policy¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::InstanceGroup
properties:
AvailabilityZones: [Value, Value, ...]
LaunchConfigurationName: String
LoadBalancerNames: [Value, Value, ...]
Size: Integer
Tags: [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]
OS::Heat::MultipartMime¶
将一组软件配置组装成一个多部分 MIME 消息。
消息中的部分可以填充内联配置或对其他配置资源的引用。如果引用的资源本身是有效多部分 MIME 消息，则该消息将被分解为部分，并将这些部分附加到当前消息中。
生成的 MIME 多部分消息将由 configs API 存储，并可在 OS::Nova::Server user_data 等属性中引用。
此资源通常用于构建 cloud-init 配置元素列表，包括脚本和 cloud-config。由于 cloud-init 是启动时配置，因此对定义所做的任何更改都将导致替换所有引用它的服务器。
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::MultipartMime
properties:
group: String
parts: [{"config": String, "filename": String, "type": String, "subtype": String}, {"config": String, "filename": String, "type": String, "subtype": String}, ...]
OS::Heat::None¶
允许通过 resource_registry 轻松禁用某些资源。
它什么也不做，但可以通过接受任何属性并返回任何属性（作为 None）来有效地模拟任何其他资源。请注意，此资源在更新时始终什么也不做（例如，即使对被模拟资源的属性的更改会导致替换，它也不会被替换）。
属性¶
- 显示¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::None
OS::Heat::RandomString¶
一种生成随机字符串的资源。
这对于配置服务上的密码和密钥很有用。随机字符串可以从指定的字符序列生成，这意味着所有字符都将从指定的序列中随机选择，或者使用某些类，例如 letterdigits，这意味着所有字符都将从 ASCII 字母和数字的并集中随机选择。输出字符串将是指定长度（如果未指定 length 属性，则为 32）的随机生成的字符串。
可选属性¶
- character_classes¶
- 一个字符类及其约束列表，用于生成随机字符串。期望列表值。更新会导致替换。默认为
[{"class": "lettersdigits", "min": 1}]列表内容 - character_sequences¶
- 一系列字符序列及其约束，用于生成随机字符串。期望列表值。更新会导致替换。列表内容
- length¶
- 要生成的字符串的长度。期望整数值。更新会导致替换。默认为
32值必须在 1 到 512 的范围内。 - salt¶
- 在堆栈更新时可以设置或更改的值，以触发资源替换为新的随机字符串。随机生成器会忽略 salt 值本身。期望字符串值。更新会导致替换。
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::RandomString
properties:
character_classes: [{"class": String, "min": Integer}, {"class": String, "min": Integer}, ...]
character_sequences: [{"sequence": String, "min": Integer}, {"sequence": String, "min": Integer}, ...]
length: Integer
salt: String
OS::Heat::ResourceChain¶
创建具有相同配置的一个或多个资源。
要创建的资源类型通过 resources 属性传入链中。将为列出的每种类型创建一个资源。每个资源都将获得 resource_properties 下指定的配置。
concurrent 属性控制资源是否并发创建。如果省略或设置为 false，则每个资源将被视为依赖于列表中的前一个资源。
必需属性¶
- resources¶
- 要创建的资源类型列表。此列表可能包含资源注册表中定义的类型名称或别名。不支持特定的模板名称。期望列表值。可以在不替换的情况下更新。
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::ResourceChain
properties:
concurrent: Boolean
resource_properties: {...}
resources: [Value, Value, ...]
OS::Heat::ResourceGroup¶
创建具有相同配置的一个或多个嵌套资源。
除了 refs 属性外，此资源还实现了镜像组内资源属性的合成属性。但是，在获取此资源的属性时，将返回组内每个资源的属性值列表。要获取组中单个资源的属性值，可以使用形式为 resource.{resource index}.{attribute name} 的合成属性。可以通过合成属性 resource.{resource index} 获取组中特定资源的资源 ID。请注意，如果您在不带 {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 属性进行自定义。
必需属性¶
可选属性¶
- count¶
- 要创建的资源数量。期望整数值。可以在不替换的情况下更新。默认值为
1该值必须至少为 0。 - index_var¶
-
此资源将用于替换组内给定资源的当前索引的变量。例如，可用于自定义组服务器的名称属性，以便在通过 nova 客户端列出它们时区分它们。期望字符串值。更新会导致替换。默认为
"%index%"长度必须至少为 3。 - removal_policies¶
-
更新时资源移除策略。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 执行需要移除特定资源的更新时要处理的策略。期望 Map 值。可以在不替换的情况下更新。Map 属性
- resource_list¶
- 在执行需要移除特定资源的更新时要移除的资源列表。资源可以通过几种方式指定：（1）资源名称，如嵌套堆栈中；（2）模板中 get_resource 返回的资源引用，可通过“refs”属性访问。请注意，这在更新时是破坏性的，即使计数未减少，并且一旦移除资源名称，在后续更新中就不会再使用其名称。期望列表值。可以在不替换的情况下更新。默认为
[]
- removal_policies_mode¶
-
如何处理更新时 removal_policies 的更改。默认的“append”模式会追加到内部列表，“update”模式会在更新时替换它。期望字符串值。可以在不替换的情况下更新。默认为
"append"允许值：“append”、“update”
属性¶
update_policy¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::ResourceGroup
properties:
count: Integer
index_var: String
removal_policies: [{"resource_list": [Value, Value, ...]}, {"resource_list": [Value, Value, ...]}, ...]
removal_policies_mode: String
resource_def: {"type": String, "properties": {...}, "metadata": {...}}
OS::Heat::ScalingPolicy¶
管理 OS::Heat::AutoScalingGroup 伸缩的资源。
注意，虽然它目前可能偶然支持 AWS::AutoScaling::AutoScalingGroup，但请不要为此目的使用它，而应改用 AWS::AutoScaling::ScalingPolicy。
用于管理 OS::Heat::AutoScalingGroup 伸缩的资源，即定义应根据哪个指标进行伸缩以及伸缩调整、设置冷却时间等。
必需属性¶
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
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 相比，SoftwareConfig 只能存储一个配置（例如，一个脚本），而 SoftwareComponent 可以存储多个配置，以便在一个地方处理软件组件的所有生命周期钩子（CREATE、UPDATE、SUSPEND、RESUME、DELETE）。
此资源由 SoftwareConfig 资源的持久层和 API 支持，仅增加了对额外 'configs' 属性的支持。
必需属性¶
- configs¶
- 表示的软件组件的不同生命周期操作的配置列表。期望列表值。更新会导致替换。长度必须至少为 1。列表内容
- 期望 Map 值。更新会导致替换。Map 属性
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::SoftwareComponent
properties:
configs: [{"actions": [String, String, ...], "config": String, "tool": String}, {"actions": [String, String, ...], "config": String, "tool": String}, ...]
inputs: [{"name": String, "description": String, "type": String, "default": Any, "replace_on_change": Boolean}, {"name": String, "description": String, "type": String, "default": Any, "replace_on_change": Boolean}, ...]
options: {...}
outputs: [{"name": String, "description": String, "type": String, "error_output": Boolean}, {"name": String, "description": String, "type": String, "error_output": Boolean}, ...]
OS::Heat::SoftwareConfig¶
描述和存储软件配置的资源。
支持此资源的 software_configs API 创建不可变的配置，因此对模板资源定义所做的任何更改都将导致创建新配置，并删除旧配置。
配置可以在使用它们的同一模板中定义，也可以在一个堆栈中创建，然后通过参数传递给另一个堆栈。
配置资源可以在支持配置的其他资源属性中引用。这包括 OS::Nova::Server user_data、OS::Heat::SoftwareDeployment config 和 OS::Heat::MultipartMime parts config 属性。
除了配置脚本本身，此资源还可以定义配置脚本预期消耗和生成的输入和输出的模式。输入和输出是可选的，并将映射到所使用的配置工具的特定概念。
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::SoftwareConfig
properties:
config: String
group: String
inputs: [{"name": String, "description": String, "type": String, "default": Any, "replace_on_change": Boolean}, {"name": String, "description": String, "type": String, "default": Any, "replace_on_change": Boolean}, ...]
options: {...}
outputs: [{"name": String, "description": String, "type": String, "error_output": Boolean}, {"name": String, "description": String, "type": String, "error_output": Boolean}, ...]
OS::Heat::SoftwareDeployment¶
此资源将服务器与某些配置关联。
配置将被部署到该服务器。
部署允许指定映射到配置资源中输入模式的输入值。这些输入值由配置工具以工具特定的方式解释。
每当此资源进入 IN_PROGRESS 状态时，它都会创建一个临时的配置，其中包含输入值以及一些名称前缀为 deploy_ 的额外输入。这些额外输入与堆栈的当前状态有关，以及用于报告部署结果的信息和凭据。
除非 signal_transport=NO_SIGNAL，否则此资源将保持 IN_PROGRESS 状态，直到服务器使用该部署的输出值向其发出信号。然后，这些输出值将作为资源属性可用，以及默认属性 deploy_stdout、deploy_stderr 和 deploy_status_code。
指定除默认的 CREATE 和 UPDATE 之外的其他操作将导致在这些操作中触发部署。例如，这允许在 SUSPEND 和 DELETE 操作期间执行清理配置。配置可以设计为仅与某些特定操作一起使用，或者配置可以读取 deploy_action 输入的值以允许条件逻辑为不同操作执行不同的配置。
必需属性¶
- server¶
- 要应用配置的资源的 ID。通常这应该是 Nova 服务器 ID。期望字符串值。更新会导致替换。
可选属性¶
- actions¶
- 部署资源中的哪些生命周期操作将触发此部署。期望列表值。可以在不替换的情况下更新。默认为
["CREATE", "UPDATE"]允许值：“CREATE”、“UPDATE”、“DELETE”、“SUSPEND”、“RESUME” - config¶
- 在服务器上应用配置时要执行的软件配置资源的 ID。期望字符串值。可以在不替换的情况下更新。
- input_values¶
- 要应用于服务器上软件配置的输入值。期望 Map 值。可以在不替换的情况下更新。
- name¶
- 与此部署关联的派生配置的名称。用于对服务器上当前部署的配置列表进行排序。期望字符串值。可以在不替换的情况下更新。
- signal_transport¶
- 服务器应如何使用部署输出值向 heat 发送信号。CFN_SIGNAL 允许 HTTP POST 到 CFN 密钥对签名 URL。TEMP_URL_SIGNAL 将创建一个 Swift TempURL 以通过 HTTP PUT 发送信号。HEAT_SIGNAL 允许使用提供的 keystone 凭证调用 Heat API resource-signal。ZAQAR_SIGNAL 将创建一个专用的 zaqar 队列并使用提供的 keystone 凭证进行信号传输。NO_SIGNAL 将导致资源进入 COMPLETE 状态，而不等待任何信号。期望字符串值。更新会导致替换。默认值为
"CFN_SIGNAL"允许值：“CFN_SIGNAL”、“TEMP_URL_SIGNAL”、“HEAT_SIGNAL”、“NO_SIGNAL”、“ZAQAR_SIGNAL”
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::SoftwareDeployment
properties:
actions: [Value, Value, ...]
config: String
input_values: {...}
name: String
server: String
signal_transport: String
OS::Heat::SoftwareDeploymentGroup¶
此资源将服务器组与某些配置关联。
配置将被部署到该组中的所有服务器。
该属性的工作方式类似于 OS::Heat::SoftwareDeployment，并且除了记录的属性外，您还可以传递支持 OS::Heat::SoftwareDeployment 的任何属性，包括公开任意输出的属性，并返回部署名称到指定属性的映射。
必需属性¶
- servers¶
- 要应用配置的名称和服务器 ID 的映射。名称是任意的，并用作相应部署的 Heat 资源名称。期望 Map 值。可以在不替换的情况下更新。
可选属性¶
- actions¶
- 部署资源中的哪些生命周期操作将触发此部署。期望列表值。可以在不替换的情况下更新。默认为
["CREATE", "UPDATE"]允许值：“CREATE”、“UPDATE”、“DELETE”、“SUSPEND”、“RESUME” - config¶
- 在服务器上应用配置时要执行的软件配置资源的 ID。期望字符串值。可以在不替换的情况下更新。
- input_values¶
- 要应用于服务器上软件配置的输入值。期望 Map 值。可以在不替换的情况下更新。
- name¶
- 与此部署关联的派生配置的名称。用于对服务器上当前部署的配置列表进行排序。期望字符串值。可以在不替换的情况下更新。
- signal_transport¶
- 服务器应如何使用部署输出值向 heat 发送信号。CFN_SIGNAL 允许 HTTP POST 到 CFN 密钥对签名 URL。TEMP_URL_SIGNAL 将创建一个 Swift TempURL 以通过 HTTP PUT 发送信号。HEAT_SIGNAL 允许使用提供的 keystone 凭证调用 Heat API resource-signal。ZAQAR_SIGNAL 将创建一个专用的 zaqar 队列并使用提供的 keystone 凭证进行信号传输。NO_SIGNAL 将导致资源进入 COMPLETE 状态，而不等待任何信号。期望字符串值。更新会导致替换。默认值为
"CFN_SIGNAL"允许值：“CFN_SIGNAL”、“TEMP_URL_SIGNAL”、“HEAT_SIGNAL”、“NO_SIGNAL”、“ZAQAR_SIGNAL”
属性¶
update_policy¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::SoftwareDeploymentGroup
properties:
actions: [Value, Value, ...]
config: String
input_values: {...}
name: String
servers: {...}
signal_transport: String
OS::Heat::Stack¶
代表堆栈的资源。
一种资源，允许创建堆栈，其中应定义堆栈模板（HOT 格式）、参数（如果模板有任何没有默认值的参数）以及创建超时。创建当前堆栈后，将拥有一个远程堆栈。
必需属性¶
- template¶
- 指定要创建为资源的堆栈的模板。期望字符串值。可以在不替换的情况下更新。
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::Stack
properties:
context: {"region_name": String, "credential_secret_id": String, "ca_cert": String, "insecure": Boolean}
parameters: {...}
template: String
timeout: Integer
OS::Heat::StructuredConfig¶
具有与 OS::Heat::SoftwareConfig 相同逻辑的资源。
此资源类似于 OS::Heat::SoftwareConfig，但 config 属性由 Map 表示，而不是 String。
这对于使用 YAML 或 JSON 作为其配置语法的配置工具有用。生成的配置通过 software_configs API 作为已解析的 JSON 进行传输、存储和返回。
可选属性¶
- config¶
- 表示将被序列化为 JSON 格式的配置数据结构的映射。期望 Map 值。更新会导致替换。
- group¶
- 在传递到服务器时用于对此软件配置进行分组的命名空间。这可能暗示将执行配置的配置工具。期望字符串值。更新会导致替换。默认为
"Heat::Ungrouped" - inputs¶
- 表示此软件配置预期的输入的模式。期望列表值。更新会导致替换。列表内容
- 期望 Map 值。更新会导致替换。Map 属性
- options¶
- 包含此资源使用的配置管理工具的特定选项的映射。期望 Map 值。更新会导致替换。
- outputs¶
- 表示此软件配置将生成的输出的模式。期望列表值。更新会导致替换。列表内容
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::StructuredConfig
properties:
config: {...}
group: String
inputs: [{"name": String, "description": String, "type": String, "default": Any, "replace_on_change": Boolean}, {"name": String, "description": String, "type": String, "default": Any, "replace_on_change": Boolean}, ...]
options: {...}
outputs: [{"name": String, "description": String, "type": String, "error_output": Boolean}, {"name": String, "description": String, "type": String, "error_output": Boolean}, ...]
OS::Heat::StructuredDeployment¶
此资源与 OS::Heat::SoftwareDeployment 具有相同的逻辑。
一个部署资源，如 OS::Heat::SoftwareDeployment，但它对 OS::Heat::StructuredConfig 资源定义的配置执行输入值替换。
一些配置工具没有输入概念，因此输入值替换需要在部署资源中进行。例如，cfn-init 工具使用的 JSON 元数据就是这样。
当 config 包含 {get_input: input_name} 时，它将被替换为此资源 input_values 中的 input_name 的值。如果 get_input 需要传递给被替换的配置，则可以指定不同的 input_key 属性值。
必需属性¶
- server¶
- 要应用配置的资源的 ID。通常这应该是 Nova 服务器 ID。期望字符串值。更新会导致替换。
可选属性¶
- actions¶
- 部署资源中的哪些生命周期操作将触发此部署。期望列表值。可以在不替换的情况下更新。默认为
["CREATE", "UPDATE"]允许值：“CREATE”、“UPDATE”、“DELETE”、“SUSPEND”、“RESUME” - config¶
- 在服务器上应用配置时要执行的软件配置资源的 ID。期望字符串值。可以在不替换的情况下更新。
- input_key¶
- 在部署期间用于替换输入的键名。期望字符串值。更新会导致替换。默认为
"get_input" - input_values¶
- 要应用于服务器上软件配置的输入值。期望 Map 值。可以在不替换的情况下更新。
- input_values_validate¶
- 执行检查以验证每个必需输入是否有相应值。当属性设置为 STRICT 且未传递任何值时，将引发异常。期望字符串值。更新会导致替换。默认为
"LAX"允许值：“LAX”、“STRICT” - name¶
- 与此部署关联的派生配置的名称。用于对服务器上当前部署的配置列表进行排序。期望字符串值。可以在不替换的情况下更新。
- signal_transport¶
- 服务器应如何使用部署输出值向 heat 发送信号。CFN_SIGNAL 允许 HTTP POST 到 CFN 密钥对签名 URL。TEMP_URL_SIGNAL 将创建一个 Swift TempURL 以通过 HTTP PUT 发送信号。HEAT_SIGNAL 允许使用提供的 keystone 凭证调用 Heat API resource-signal。ZAQAR_SIGNAL 将创建一个专用的 zaqar 队列并使用提供的 keystone 凭证进行信号传输。NO_SIGNAL 将导致资源进入 COMPLETE 状态，而不等待任何信号。期望字符串值。更新会导致替换。默认值为
"CFN_SIGNAL"允许值：“CFN_SIGNAL”、“TEMP_URL_SIGNAL”、“HEAT_SIGNAL”、“NO_SIGNAL”、“ZAQAR_SIGNAL”
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::StructuredDeployment
properties:
actions: [Value, Value, ...]
config: String
input_key: String
input_values: {...}
input_values_validate: String
name: String
server: String
signal_transport: String
OS::Heat::StructuredDeploymentGroup¶
此资源将服务器组与某些配置关联。
此资源的工作方式类似于 OS::Heat::SoftwareDeploymentGroup，但用于结构化资源。
必需属性¶
- servers¶
- 要应用配置的名称和服务器 ID 的映射。名称是任意的，并用作相应部署的 Heat 资源名称。期望 Map 值。可以在不替换的情况下更新。
可选属性¶
- actions¶
- 部署资源中的哪些生命周期操作将触发此部署。期望列表值。可以在不替换的情况下更新。默认为
["CREATE", "UPDATE"]允许值：“CREATE”、“UPDATE”、“DELETE”、“SUSPEND”、“RESUME” - config¶
- 在服务器上应用配置时要执行的软件配置资源的 ID。期望字符串值。可以在不替换的情况下更新。
- input_key¶
- 在部署期间用于替换输入的键名。期望字符串值。更新会导致替换。默认为
"get_input" - input_values¶
- 要应用于服务器上软件配置的输入值。期望 Map 值。可以在不替换的情况下更新。
- input_values_validate¶
- 执行检查以验证每个必需输入是否有相应值。当属性设置为 STRICT 且未传递任何值时，将引发异常。期望字符串值。更新会导致替换。默认为
"LAX"允许值：“LAX”、“STRICT” - name¶
- 与此部署关联的派生配置的名称。用于对服务器上当前部署的配置列表进行排序。期望字符串值。可以在不替换的情况下更新。
- signal_transport¶
- 服务器应如何使用部署输出值向 heat 发送信号。CFN_SIGNAL 允许 HTTP POST 到 CFN 密钥对签名 URL。TEMP_URL_SIGNAL 将创建一个 Swift TempURL 以通过 HTTP PUT 发送信号。HEAT_SIGNAL 允许使用提供的 keystone 凭证调用 Heat API resource-signal。ZAQAR_SIGNAL 将创建一个专用的 zaqar 队列并使用提供的 keystone 凭证进行信号传输。NO_SIGNAL 将导致资源进入 COMPLETE 状态，而不等待任何信号。期望字符串值。更新会导致替换。默认值为
"CFN_SIGNAL"允许值：“CFN_SIGNAL”、“TEMP_URL_SIGNAL”、“HEAT_SIGNAL”、“NO_SIGNAL”、“ZAQAR_SIGNAL”
属性¶
update_policy¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::StructuredDeploymentGroup
properties:
actions: [Value, Value, ...]
config: String
input_key: String
input_values: {...}
input_values_validate: String
name: String
servers: {...}
signal_transport: String
OS::Heat::SwiftSignal¶
处理来自 SwiftSignalHandle 的信号的资源。
此资源处理来自 SwiftSignalHandle 的信号，与 WaitCondition 资源相同。
必需属性¶
可选属性¶
- count¶
- 在堆栈创建过程继续之前必须收到的成功信号数。期望整数值。更新会导致替换。默认值为
1值必须在 1 到 1000 的范围内。
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::SwiftSignal
properties:
count: Integer
handle: String
timeout: Number
OS::Heat::SwiftSignalHandle¶
管理来自 Swift 资源的信号的资源。
此资源与 WaitConditionHandle 相同，但专为 Swift 资源使用而设计。
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::SwiftSignalHandle
OS::Heat::TestResource¶
一种存储提供字符串值的资源。
此资源仅用于测试。它具有“update_replace”、“fail”、“wait_secs”等控制旋钮。
可选属性¶
- action_wait_secs¶
- 模拟等待的选项。期望 Map 值。可以在不替换的情况下更新。Map 属性
- attr_wait_secs¶
-
解析输出值时超时的数值。预期的数字值。可以在不替换的情况下更新。默认值为
0 - client_name¶
- 要轮询的客户端。期望字符串值。可以在不替换的情况下更新。默认为
"" - constraint_prop_secs¶
-
解析约束时的延迟数值。预期的数字值。可以在不替换的情况下更新。默认值为
0值必须是 test_constr 类型 - entity_name¶
- 要轮询的客户端实体。期望字符串值。可以在不替换的情况下更新。默认为
"" - fail¶
- 可设置为失败资源操作的值，用于测试失败场景。期望布尔值。可以在不替换的情况下更新。默认为
false - update_replace¶
- 可设置为触发特定资源更新替换的值。期望布尔值。可以在不替换的情况下更新。默认为
false - update_replace_value¶
-
可以存储但不能更新的某个值。期望字符串值。更新会导致替换。
- value¶
- 要存储的输入字符串。期望字符串值。可以在不替换的情况下更新。默认为
"test_string" - wait_secs¶
- 操作后的等待秒数（-1 表示无限）。预期的数字值。可以在不替换的情况下更新。默认值为
0
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::TestResource
properties:
action_wait_secs: {"create": Number, "update": Number, "delete": Number}
attr_wait_secs: Number
client_name: String
constraint_prop_secs: Number
entity_name: String
fail: Boolean
update_replace: Boolean
update_replace_value: String
value: String
wait_secs: Number
OS::Heat::UpdateWaitConditionHandle¶
在更新时清除信号并更改句柄的 WaitConditionHandle。
此功能与 AWS::CloudFormation::WaitConditionHandle 类似，不同之处在于更新时会清除所有接收到的信号并更改句柄。使用此句柄意味着您必须设置信号发送者，以便在更新句柄更改的任何时候重新发送信号。这允许我们推出新的配置，并确信一旦达到 UPDATE COMPLETE，它们就会推出。
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::UpdateWaitConditionHandle
OS::Heat::Value¶
一个暴露其 value 属性作为属性的资源。
这对于暴露一个简单的、对其他模板参数和/或其他资源的组合的“值”非常有用。
Required Properties¶
- value¶
- 生成“value”属性的表达式。任何期望的值。可以在不替换的情况下更新。
Optional Properties¶
- type¶
- “value”属性的类型。期望字符串值。可以在不替换的情况下更新。允许的值：“string”, “number”, “comma_delimited_list”, “json”, “boolean”
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::Value
properties:
type: String
value: Any
OS::Heat::WaitCondition¶
处理 WaitConditionHandle 接收信号的资源。
该资源接收 WaitConditionHandle 并开始创建。资源处于 CREATE_IN_PROGRESS 状态，直到 WaitConditionHandle 接收到足够数量的成功信号（此数量可以通过 count 属性指定）并随后成功创建，或者因超时而失败。
Required Properties¶
Optional Properties¶
- count¶
- 在堆栈创建过程继续之前必须收到的成功信号数。期望整数值。可以在不替换的情况下更新。默认值为
1值必须至少为 1。
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::WaitCondition
properties:
count: Integer
handle: String
timeout: Number
OS::Heat::WaitConditionHandle¶
管理实例信号的资源。
- 此资源的主要特点是：
没有依赖（因此实例可以引用它）。
创建凭据，允许从实例进行信号发送。
处理来自实例的信号，验证并存储结果。
Optional Properties¶
- signal_transport¶
-
客户端将如何发送 wait condition 信号。CFN_SIGNAL 将允许通过 HTTP POST 到 CFN 密钥对签名 URL。TEMP_URL_SIGNAL 将创建一个 Swift TempURL，通过 HTTP PUT 发送信号。HEAT_SIGNAL 将允许使用提供的 keystone 凭据调用 Heat API resource-signal。ZAQAR_SIGNAL 将创建一个专用的 zaqar 队列，使用提供的 keystone 凭据发送信号。TOKEN_SIGNAL 将允许通过 HTTP POST 到 Heat API 端点，并提供 keystone 令牌。NO_SIGNAL 将导致资源进入已发送信号的状态，而不等待任何信号。期望字符串值。更新会导致替换。默认为
"TOKEN_SIGNAL"允许的值：“CFN_SIGNAL”, “TEMP_URL_SIGNAL”, “HEAT_SIGNAL”, “NO_SIGNAL”, “ZAQAR_SIGNAL”, “TOKEN_SIGNAL”
Attributes¶
- curl_cli¶
便利属性，提供 curl CLI 命令前缀，当 signal_transport 设置为 TOKEN_SIGNAL 时可用于发送完成或失败信号。您可以通过添加 –data-binary ‘{“status”: “SUCCESS”}’ 来发送成功信号，或通过添加 –data-binary ‘{“status”: “FAILURE”}’ 来发送失败信号。此属性对于所有其他信号传输都设置为 None。
- endpoint¶
当 signal_transport 设置为 TOKEN_SIGNAL 时，可用于发送 handle 信号的端点/URL。对于所有其他信号传输，则为 None。
- show¶
资源的详细信息。
- signal¶
JSON 序列化的映射，包含客户端用于发送此 handle 信号的端点、令牌和/或其他属性。此映射的内容取决于 signal_transport 属性中选择的信号类型。
- token¶
用于 stack-user 的令牌，当 signal_transport 设置为 TOKEN_SIGNAL 时可用于发送 handle 信号。对于所有其他信号传输，则为 None。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::WaitConditionHandle
properties:
signal_transport: String
OS::Ironic::Port¶
创建一个 ironic 端口的资源。
需要端口的节点 UUID 和物理硬件地址（大多数情况下是 MAC 地址）（所有端口在创建时都必须与节点关联）。
Required Properties¶
Optional Properties¶
- extra¶
- 一组或多组任意元数据键值对。期望 Map 值。可以在不替换的情况下更新。
- is_smartnic¶
- 指示端口是否为 Smart NIC 端口。期望布尔值。可以在不替换的情况下更新。
- local_link_connection¶
- 端口绑定配置文件。如果指定，则必须包含 switch_id（此字段仅接受 MAC 地址或基于 OpenFlow 的 datapath_id）和 port_id（连接到节点端口的交换机上的物理端口标识符）字段。switch_info 是一个可选字符串字段，用于存储任何特定于供应商的信息。期望 Map 值。可以在不替换的情况下更新。
- physical_network¶
- 端口连接到的物理网络的名称。可能为空。期望字符串值。可以在不替换的情况下更新。
- portgroup¶
- 此资源所属的端口组的 UUID 或名称。期望字符串值。可以在不替换的情况下更新。值必须是 ironic.portgroup 类型
- pxe_enabled¶
- 指示端口上 PXE 是否已启用或禁用。期望布尔值。可以在不替换的情况下更新。
Attributes¶
- address¶
此网络端口的物理硬件地址，通常是硬件 MAC 地址。
- extra¶
一组或多组任意元数据键值对。
- internal_info¶
端口设置和存储的内部元数据。此字段是只读的。
- is_smartnic¶
指示端口是否为 Smart NIC 端口。
- local_link_connection¶
端口绑定配置文件。如果指定，则必须包含 switch_id（此字段仅接受 MAC 地址或基于 OpenFlow 的 datapath_id）和 port_id（连接到节点端口的交换机上的物理端口标识符）字段。switch_info 是一个可选字符串字段，用于存储任何特定于供应商的信息。
- node_uuid¶
此资源所属节点的 UUID。
- physical_network¶
端口连接到的物理网络的名称。可能为空。
- portgroup_uuid¶
此资源所属端口组的 UUID。
- pxe_enabled¶
指示端口上 PXE 是否已启用或禁用。
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Ironic::Port
properties:
address: String
extra: {...}
is_smartnic: Boolean
local_link_connection: {...}
node: String
physical_network: String
portgroup: String
pxe_enabled: Boolean
OS::Keystone::Domain¶
Keystone 域的 Heat 模板资源。
此插件有助于创建、更新和删除 keystone 域。它还可以用于启用或禁用给定的 keystone 域。
Optional Properties¶
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::Domain
properties:
description: String
enabled: Boolean
name: String
OS::Keystone::Endpoint¶
Keystone 服务端点的 Heat 模板资源。
Keystone 端点只是一个可用于访问 OpenStack 中服务的 URL。端点可以由管理员、服务或公共访问，即每个人都可以使用此端点。
Required Properties¶
Optional Properties¶
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::Endpoint
properties:
enabled: Boolean
interface: String
name: String
region: String
service: String
url: String
OS::Keystone::Group¶
Keystone 组的 Heat 模板资源。
组是代表用户集合的容器。组本身必须归属于特定的域，因此所有组名不是全局唯一的，而是仅在其域内唯一。
Optional Properties¶
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::Group
properties:
description: String
domain: String
name: String
roles: [{"role": String, "project": String, "domain": String}, {"role": String, "project": String, "domain": String}, ...]
OS::Keystone::GroupRoleAssignment¶
为组授予角色的资源。
指定组及其角色的资源。
Required Properties¶
- group¶
- keystone 组的名称或 ID。期望字符串值。可以在不替换的情况下更新。值必须是 keystone.group 类型
Optional Properties¶
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::GroupRoleAssignment
properties:
group: String
roles: [{"role": String, "project": String, "domain": String}, {"role": String, "project": String, "domain": String}, ...]
OS::Keystone::Project¶
Keystone 项目的 Heat 模板资源。
项目代表 OpenStack 中的所有权基本单位，因为 OpenStack 中的所有资源都应归属于特定项目。项目本身必须归属于特定域，因此所有项目名称并非全局唯一，而仅在其域内唯一。如果未指定项目的域，则将其添加到默认域。
Optional Properties¶
- description¶
- keystone 项目的描述。期望字符串值。可以在不替换的情况下更新。默认为
"" - domain¶
- keystone 域的名称或 ID。期望字符串值。可以在不替换的情况下更新。默认为
"default"值必须是 keystone.domain 类型 - enabled¶
- 此项目已启用或禁用。期望布尔值。可以在不替换的情况下更新。默认为
true - name¶
- keystone 项目的名称。期望字符串值。可以在不替换的情况下更新。
- parent¶
-
此 keystone 项目在层级结构中的父项的名称或 ID。期望字符串值。更新会导致替换。值必须为 keystone.project 类型
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::Project
properties:
description: String
domain: String
enabled: Boolean
name: String
parent: String
tags: [Value, Value, ...]
OS::Keystone::Region¶
Keystone 区域的 Heat 模板资源。
此插件有助于创建、更新和删除 keystone 区域。它还可以用于启用或禁用给定的 keystone 区域。
Optional Properties¶
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::Region
properties:
description: String
enabled: Boolean
id: String
parent_region: String
OS::Keystone::Role¶
Keystone 角色的 Heat 模板资源。
角色决定了最终用户可以获得的授权级别。角色可以在域或项目级别授予。角色可以分配给单个用户或组。角色名称在其所属域内是唯一的。
Optional Properties¶
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::Role
properties:
domain: String
name: String
OS::Keystone::Service¶
Keystone 服务的 Heat 模板资源。
一个允许创建新服务并由 Keystone 管理的资源。
Required Properties¶
- type¶
- keystone 服务的类型。期望字符串值。可以在不替换的情况下更新。
Optional Properties¶
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::Service
properties:
description: String
enabled: Boolean
name: String
type: String
OS::Keystone::User¶
Keystone 用户的 Heat 模板资源。
用户代表单个 API 消费者。用户本身必须归属于特定域，因此所有用户名都不是全局唯一的，而仅在其域内唯一。
Optional Properties¶
- default_project¶
- keystone 用户的默认项目名称或 ID。期望字符串值。可以在不替换的情况下更新。值必须为 keystone.project 类型
- description¶
- keystone 用户的描述。期望字符串值。可以在不替换的情况下更新。默认为
"" - domain¶
- keystone 域的名称或 ID。期望字符串值。可以在不替换的情况下更新。默认为
"default"值必须是 keystone.domain 类型 - email¶
- keystone 用户的电子邮件地址。期望字符串值。可以在不替换的情况下更新。
- enabled¶
- keystone 用户已启用或禁用。期望布尔值。可以在不替换的情况下更新。默认为
true - groups¶
- keystone 用户组。期望列表值。可以在不替换的情况下更新。列表内容
- 可选。keystone 用户组。期望字符串值。可以在不替换的情况下更新。值必须是 keystone.group 类型
- name¶
- keystone 用户的名称。期望字符串值。可以在不替换的情况下更新。
- password¶
- keystone 用户的密码。期望字符串值。可以在不替换的情况下更新。
- roles¶
- 角色分配列表。期望列表值。可以在不替换的情况下更新。列表内容
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::User
properties:
default_project: String
description: String
domain: String
email: String
enabled: Boolean
groups: [String, String, ...]
name: String
password: String
roles: [{"role": String, "project": String, "domain": String}, {"role": String, "project": String, "domain": String}, ...]
OS::Keystone::UserRoleAssignment¶
为用户授予角色的资源。
指定用户及其角色的资源。
Required Properties¶
- user¶
- keystone 用户的名称或 ID。期望字符串值。可以在不替换的情况下更新。值必须是 keystone.user 类型
Optional Properties¶
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::UserRoleAssignment
properties:
roles: [{"role": String, "project": String, "domain": String}, {"role": String, "project": String, "domain": String}, ...]
user: String
OS::Magnum::Cluster¶
创建一个 magnum 集群的资源。
此资源创建一个 magnum 集群，集群是调度工作的节点对象的集合。
Required Properties¶
- cluster_template¶
- 集群模板的名称或 ID。期望字符串值。更新会导致替换。值必须是 magnum.cluster_template 类型
Optional Properties¶
- create_timeout¶
- 创建集群的超时时间（分钟）。设置为 0 表示无超时。期望整数值。可以在不替换的情况下更新。默认为
60该值必须至少为 0。 - discovery_url¶
- 指定用于节点发现的自定义发现 URL。期望字符串值。可以在不替换的情况下更新。
- keypair¶
- 密钥对的名称。如果不提供，则使用集群模板中的密钥对。期望字符串值。更新会导致替换。值必须是 nova.keypair 类型
- master_count¶
- 此集群的 master 节点数量。期望整数值。可以在不替换的情况下更新。默认值为
1值必须至少为 1。 - name¶
- 集群的名称。期望字符串值。更新会导致替换。
- node_count¶
- 此集群的节点数量。期望整数值。可以在不替换的情况下更新。默认值为
1值必须至少为 1。
Attributes¶
- api_address¶
暴露给最终用户的 COE API 的端点 URL。
- cluster_template_id¶
集群模板的 UUID。
- coe_version¶
集群中选定的 COE 的版本信息，以帮助客户端选择正确的客户端版本。
- container_version¶
集群中选定的 COE 中的容器引擎版本信息，以帮助客户端选择正确的客户端版本。
- create_timeout¶
集群创建的超时时间（分钟）。
- discovery_url¶
节点发现的自定义发现 URL。
- keypair¶
密钥对的名称。
- master_addresses¶
所有 master 节点的浮动 IP 列表。
- master_count¶
将作为集群 master 的服务器数量。
- name¶
资源的名称。
- node_addresses¶
所有充当节点服务器的浮动 IP 列表。
- node_count¶
将作为集群节点服务器的数量。
- show¶
资源的详细信息。
- stack_id¶
此 COE 集群的编排堆栈的引用 UUID。
- status¶
此 COE 集群的状态。
- status_reason¶
集群当前状态的原因。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Magnum::Cluster
properties:
cluster_template: String
create_timeout: Integer
discovery_url: String
keypair: String
master_count: Integer
name: String
node_count: Integer
OS::Magnum::ClusterTemplate¶
Magnum 中 ClusterTemplate 的资源。
ClusterTemplate 是一个对象，它存储集群的模板信息，用于一致地创建新集群。
Required Properties¶
Optional Properties¶
- dns_nameserver¶
- DNS 名称服务器地址。期望字符串值。更新会导致替换。值必须是 ip_addr 类型
- docker_storage_driver¶
- 选择一个 docker 存储驱动。期望字符串值。更新会导致替换。默认为
"devicemapper"允许的值：“devicemapper”, “overlay” - docker_volume_size¶
- docker 卷的大小（GB）。期望整数值。更新会导致替换。值必须至少为 1。
- fixed_network¶
- 要附加到集群的固定 neutron 网络名称或 UUID。期望字符串值。更新会导致替换。值必须是 neutron.network 类型
- fixed_subnet¶
- 要附加到集群的固定 neutron 子网名称或 UUID。期望字符串值。更新会导致替换。值必须是 neutron.subnet 类型
- flavor¶
- 启动集群时要使用的 nova flavor 名称或 UUID。期望字符串值。更新会导致替换。值必须是 nova.flavor 类型
- floating_ip_enabled¶
- 指示创建的集群是否应具有浮动 IP。期望布尔值。更新会导致替换。默认为
true - http_proxy¶
- 集群中节点要使用的 http_proxy 地址。期望字符串值。更新会导致替换。
- https_proxy¶
- 集群中节点要使用的 https_proxy 地址。期望字符串值。更新会导致替换。
- keypair¶
- 要加载到集群节点中的 SSH 密钥对的名称。期望字符串值。更新会导致替换。值必须是 nova.keypair 类型
- labels¶
- 要与集群关联的任意标签，形式为键值对。期望 Map 值。更新会导致替换。
- master_flavor¶
- 启动集群 master 节点时要使用的 nova flavor 名称或 UUID。期望字符串值。更新会导致替换。值必须是 nova.flavor 类型
- master_lb_enabled¶
- 指示创建的集群是否应为 master 节点设置负载均衡器。期望布尔值。更新会导致替换。默认为
true - name¶
- 集群模板的名称。期望字符串值。更新会导致替换。
- network_driver¶
- 实例化容器网络的驱动程序名称。默认情况下，Magnum 将根据 COE 类型选择预配置的网络驱动程序。期望字符串值。更新会导致替换。
- no_proxy¶
- 一个逗号分隔的地址列表，其中不应在集群中使用代理。期望字符串值。更新会导致替换。
- public¶
- 使集群模板公开。要启用此选项，您必须拥有在 magnum 中发布权利。这默认设置为仅管理员。期望布尔值。可以在不替换的情况下更新。默认为
false - registry_enabled¶
- 在集群中启用 docker 注册表。期望布尔值。更新会导致替换。默认为
false - server_type¶
- 指定要使用的服务器类型。期望字符串值。更新会导致替换。默认为
"vm"允许的值：“vm”, “bm” - tls_disabled¶
- 禁用集群中的 TLS。期望布尔值。更新会导致替换。默认为
false - volume_driver¶
- 用于实例化容器卷的卷驱动程序名称。期望字符串值。更新会导致替换。允许的值：“cinder”, “rexray”
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Magnum::ClusterTemplate
properties:
coe: String
dns_nameserver: String
docker_storage_driver: String
docker_volume_size: Integer
external_network: String
fixed_network: String
fixed_subnet: String
flavor: String
floating_ip_enabled: Boolean
http_proxy: String
https_proxy: String
image: String
keypair: String
labels: {...}
master_flavor: String
master_lb_enabled: Boolean
name: String
network_driver: String
no_proxy: String
public: Boolean
registry_enabled: Boolean
server_type: String
tls_disabled: Boolean
volume_driver: String
OS::Manila::SecurityService¶
实现 Manila 安全服务的资源。
security_service 是一组选项，用于定义特定共享文件系统协议的安全域，例如 Active Directory 域或 Kerberos 域。
Required Properties¶
- type¶
- 安全服务类型。期望字符串值。更新会导致替换。允许的值：“ldap”, “kerberos”, “active_directory”
Optional Properties¶
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Manila::SecurityService
properties:
description: String
dns_ip: String
domain: String
name: String
password: String
server: String
type: String
user: String
OS::Mistral::CronTrigger¶
实现 Mistral cron 触发器的资源。
Cron 触发器是一个允许按计划运行工作流的对象。用户指定需要运行的工作流及其输入，并指定运行频率。Pattern 属性用于描述工作流执行的频率。
Required Properties¶
Optional Properties¶
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Mistral::CronTrigger
properties:
count: Integer
first_time: String
name: String
pattern: String
workflow: {"name": String, "input": {...}}
OS::Mistral::ExternalResource¶
用于通过 Mistral 工作流管理用户定义资源的插件。
此资源允许用户管理 Heat 未知的资源。用户可以为每个资源操作（如 CREATE、UPDATE 或 DELETE）指定一个 Mistral 工作流。
工作流可以返回一个名为 ‘resource_id’ 的输出，Heat 将其视为资源的物理 ID。
资源创建后，后续的工作流运行将收到最后一个工作流执行的输出，该输出位于工作流环境的 ‘heat_extresource_data’ 键中（在工作流中可作为 env().heat_extresource_data 访问）。
模板作者可以指定一部分输入作为导致资源在更改时被替换的依据，而不是运行 UPDATE 工作流。
Required Properties¶
- actions¶
- 触发工作流执行的资源操作。期望 Map 值。更新会导致替换。Map 属性
Optional Properties¶
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Mistral::ExternalResource
properties:
actions: {"CREATE": {"workflow": String, "params": {...}}, "UPDATE": {"workflow": String, "params": {...}}, "SUSPEND": {"workflow": String, "params": {...}}, "RESUME": {"workflow": String, "params": {...}}, "DELETE": {"workflow": String, "params": {...}}}
always_update: Boolean
description: String
input: {...}
replace_on_change_inputs: [Value, Value, ...]
OS::Mistral::Workflow¶
实现 Mistral 工作流的资源。
工作流代表一个可以通过多种方式描述并能完成用户感兴趣的工作的过程。每个工作流包含任务（至少一个），这些任务描述了工作流执行期间应执行的确切步骤。
有关如何使用 Workflow 的详细信息，请阅读 Mistral 文档。
Required Properties¶
- tasks¶
- 包含工作流任务的字典。期望列表值。可以在不替换的情况下更新。长度必须至少为 1。列表内容
- 期望 Map 值。可以在不替换的情况下更新。Map 属性
- action¶
- 可选。与任务关联的操作名称。任务中可以定义 action 或 workflow。期望字符串值。可以在不替换的情况下更新。
- concurrency¶
-
可选。定义任务中同时运行的操作的最大数量。仅适用于具有 with-items 的任务。期望整数值。可以在不替换的情况下更新。
- description¶
- 可选。任务描述。期望字符串值。可以在不替换的情况下更新。
- input¶
- 任务的实际输入参数值。期望 Map 值。可以在不替换的情况下更新。
- join¶
-
可选。允许同步多个并行工作流分支并聚合其数据。有效输入：all - 仅当所有上游任务都完成时，任务才会运行。任何数字值 - 那么只要至少有此数量的上游任务完成并触发了相应条件，任务就会运行。期望字符串值。可以在不替换的情况下更新。
- keep_result¶
-
可选。允许在任务完成后不存储操作结果。期望布尔值。可以在不替换的情况下更新。
- name¶
- 必需。任务名称。期望字符串值。可以在不替换的情况下更新。
- on_complete¶
- 无论任务是否成功完成，都将在任务完成后运行的任务列表。期望列表值。可以在不替换的情况下更新。
- on_error¶
- 任务出错完成后将运行的任务列表。期望列表值。可以在不替换的情况下更新。
- on_success¶
- 任务成功完成后将运行的任务列表。期望列表值。可以在不替换的情况下更新。
- pause_before¶
-
可选。定义 Mistral 引擎在开始任务之前是否应将工作流暂停。期望布尔值。可以在不替换的情况下更新。
- publish¶
- 要发布到工作流上下文的变量字典。期望 Map 值。可以在不替换的情况下更新。
- requires¶
- 此任务之前应执行的任务列表。仅在反向工作流中使用。期望列表值。可以在不替换的情况下更新。
- retry¶
-
定义任务在出错时应如何重复的模式。期望 Map 值。可以在不替换的情况下更新。
- target¶
-
可选。它定义了一个执行器，任务操作应发送到该执行器。期望字符串值。可以在不替换的情况下更新。
- timeout¶
-
可选。定义引擎将在任务自动失败之前等待的时间（秒），如果任务未完成。期望整数值。可以在不替换的情况下更新。
- wait_after¶
-
可选。定义 Mistral 引擎在任务完成后的 on-success、on-error 或 on-complete 中定义的后续任务开始之前应等待的延迟（秒）。期望整数值。可以在不替换的情况下更新。
- wait_before¶
-
可选。定义 Mistral 引擎在开始任务之前应等待的延迟（秒）。期望整数值。可以在不替换的情况下更新。
- with_items¶
-
可选。如果配置了，它允许在提供的项目列表上多次运行与任务关联的操作或工作流。期望字符串值。可以在不替换的情况下更新。
- workflow¶
- 可选。与任务关联的工作流名称。可以通过 get_resource 内置函数或通过引用的工作流名称定义，例如 { workflow: wf_name } 或 { workflow: { get_resource: wf_name }}。任务中可以定义 action 或 workflow。期望字符串值。可以在不替换的情况下更新。值必须是 mistral.workflow 类型
- type¶
- 工作流类型。期望字符串值。可以在不替换的情况下更新。允许的值：“direct”, “reverse”
Optional Properties¶
- description¶
- 工作流描述。期望字符串值。可以在不替换的情况下更新。
- input¶
- 包含工作流输入的字典。期望 Map 值。可以在不替换的情况下更新。
- name¶
- 工作流名称。期望字符串值。更新会导致替换。
- output¶
- 任何包含 YAQL 表达式的任意数据结构，用于定义工作流输出。可以是嵌套的。期望 Map 值。可以在不替换的情况下更新。
- params¶
- 工作流附加参数。如果工作流是反向类型，则 params 需要“task_name”，它定义了初始任务。期望 Map 值。可以在不替换的情况下更新。
- task_defaults¶
-
在工作流级别定义的某些任务属性的默认设置。期望 Map 值。可以在不替换的情况下更新。Map 属性
- concurrency¶
-
可选。定义任务中同时运行的操作的最大数量。仅适用于具有 with-items 的任务。期望整数值。可以在不替换的情况下更新。
- on_complete¶
- 无论任务是否成功完成，都将在任务完成后运行的任务列表。期望列表值。可以在不替换的情况下更新。
- on_error¶
- 任务出错完成后将运行的任务列表。期望列表值。可以在不替换的情况下更新。
- on_success¶
- 任务成功完成后将运行的任务列表。期望列表值。可以在不替换的情况下更新。
- pause_before¶
- 可选。定义 Mistral 引擎在开始任务之前是否应将工作流暂停。期望布尔值。可以在不替换的情况下更新。
- requires¶
- 此任务之前应执行的任务列表。仅在反向工作流中使用。期望列表值。可以在不替换的情况下更新。
- retry¶
- 定义任务在出错时应如何重复的模式。期望 Map 值。可以在不替换的情况下更新。
- timeout¶
- 可选。定义引擎将在任务自动失败之前等待的时间（秒），如果任务未完成。期望整数值。可以在不替换的情况下更新。
- wait_after¶
- 可选。定义 Mistral 引擎在任务完成后的 on-success、on-error 或 on-complete 中定义的后续任务开始之前应等待的延迟（秒）。期望整数值。可以在不替换的情况下更新。
- wait_before¶
- 可选。定义 Mistral 引擎在开始任务之前应等待的延迟（秒）。期望整数值。可以在不替换的情况下更新。
- use_request_body_as_input¶
-
定义解析用于信号发送工作流的请求正文的方法。如果此属性设置为 True，则正文将被解析为简单的 JSON，其中每个键都是工作流输入；否则，正文将按照包含“input”和“params”两个键的特定 JSON 格式进行解析。期望布尔值。可以在不替换的情况下更新。
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Mistral::Workflow
properties:
description: String
input: {...}
name: String
output: {...}
params: {...}
tags: [Value, Value, ...]
task_defaults: {"on_success": [Value, Value, ...], "on_error": [Value, Value, ...], "on_complete": [Value, Value, ...], "requires": [Value, Value, ...], "retry": {...}, "wait_before": Integer, "wait_after": Integer, "pause_before": Boolean, "timeout": Integer, "concurrency": Integer}
tasks: [{"name": String, "description": String, "input": {...}, "action": String, "workflow": String, "publish": {...}, "on_success": [Value, Value, ...], "on_error": [Value, Value, ...], "on_complete": [Value, Value, ...], "policies": {...}, "requires": [Value, Value, ...], "retry": {...}, "wait_before": Integer, "wait_after": Integer, "pause_before": Boolean, "timeout": Integer, "with_items": String, "keep_result": Boolean, "concurrency": Integer, "target": String, "join": String}, {"name": String, "description": String, "input": {...}, "action": String, "workflow": String, "publish": {...}, "on_success": [Value, Value, ...], "on_error": [Value, Value, ...], "on_complete": [Value, Value, ...], "policies": {...}, "requires": [Value, Value, ...], "retry": {...}, "wait_before": Integer, "wait_after": Integer, "pause_before": Boolean, "timeout": Integer, "with_items": String, "keep_result": Boolean, "concurrency": Integer, "target": String, "join": String}, ...]
type: String
use_request_body_as_input: Boolean
OS::Neutron::AddressScope¶
Neutron 地址范围的资源。
此资源可以与多个子网池建立一对多的关系。地址范围下的子网池不得重叠。
可选属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::AddressScope
properties:
ip_version: Integer
name: String
shared: Boolean
tenant_id: String
OS::Neutron::ExtraRouteSet¶
用于为 Neutron 路由器指定额外路由的资源。
要求启用 Neutron 的 extraroute-atomic 扩展
$ openstack extension show extraroute-atomic
额外路由是静态路由表条目，它被添加到由路由器接口和路由器网关隐式管理的路由之外。
额外路由的 destination 是任何 CIDR 表示法中的 IP 网络。额外路由的 nexthop 是直接连接到路由器的子网中的 IP。
在一个 OS::Neutron::ExtraRouteSet 资源中，您可以在同一虚拟路由器上指定一组额外路由（表示为列表）。作为对（从未正式支持过的）OS::Neutron::ExtraRoute 资源的改进，此资源插件使用了一个不会在管理同一路由器的多个额外路由时产生竞争条件的 Neutron API 扩展（extraroute-atomic）。可以安全地从多个堆栈管理同一路由器的多个额外路由。
另一方面，从多个堆栈（或在 Heat 和非 Heat 管理的 Neutron 额外路由之间）使用同一路由到同一路由器是不安全的。
必需属性¶
- router¶
- 路由器 ID。期望字符串值。更新会导致替换。值必须是 neutron.router 类型
可选属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::ExtraRouteSet
properties:
router: String
routes: [{"destination": String, "nexthop": String}, {"destination": String, "nexthop": String}, ...]
OS::Neutron::Firewall¶
Neutron FWaaS 中防火墙资源的资源。
用于使用 Neutron 防火墙实现的资源。防火墙是一种网络安全系统，它根据预定的安全规则监视和控制进出网络流量。
必需属性¶
- firewall_policy_id¶
- 此防火墙关联的防火墙策略的 ID。期望字符串值。可以在不替换的情况下更新。
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::Firewall
properties:
admin_state_up: Boolean
description: String
firewall_policy_id: String
name: String
value_specs: {...}
OS::Neutron::FirewallPolicy¶
Neutron FWaaS 中防火墙策略资源的资源。
FirewallPolicy 资源是防火墙规则的有序集合。防火墙策略可以跨租户共享。
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::FirewallPolicy
properties:
audited: Boolean
description: String
firewall_rules: [Value, Value, ...]
name: String
shared: Boolean
OS::Neutron::FirewallRule¶
Neutron FWaaS 中防火墙规则资源的资源。
FirewallRule 代表一组属性，如端口、IP 地址等，这些属性定义了匹配标准以及对匹配数据流量需要采取的操作（允许或拒绝）。
可选属性¶
- action¶
- 对匹配规则的流量执行的操作。期望字符串值。可以在不替换的情况下更新。默认为
"deny"允许值：“allow”、“deny” - description¶
- 防火墙规则的描述。期望字符串值。可以在不替换的情况下更新。
- destination_ip_address¶
- 目标 IP 地址或 CIDR。期望字符串值。可以在不替换的情况下更新。值必须是 net_cidr 类型
- destination_port¶
- 目标端口号或范围。期望字符串值。可以在不替换的情况下更新。
- enabled¶
- 此规则是否应启用。期望布尔值。可以在不替换的情况下更新。默认为
true - ip_version¶
- 互联网协议版本。期望字符串值。可以在不替换的情况下更新。默认为
"4"允许值：“4”、“6” - name¶
- 防火墙规则的名称。期望字符串值。可以在不替换的情况下更新。
- protocol¶
- 防火墙规则的协议。期望字符串值。可以在不替换的情况下更新。默认为
"any"允许值：“tcp”、“udp”、“icmp”、“any” - source_ip_address¶
- 源 IP 地址或 CIDR。期望字符串值。可以在不替换的情况下更新。值必须是 net_cidr 类型
- source_port¶
- 源端口号或范围。期望字符串值。可以在不替换的情况下更新。
属性¶
- action¶
此防火墙规则的允许或拒绝操作。
- description¶
防火墙规则的描述。
- destination_ip_address¶
此防火墙规则的目标 IP 地址。
- destination_port¶
此防火墙规则的目标端口范围。
- enabled¶
指示此防火墙规则是否启用。
- firewall_policy_id¶
此防火墙规则所属防火墙策略的唯一标识符。
- ip_version¶
此防火墙规则的 IP 版本。
- name¶
防火墙规则的名称。
- position¶
规则在防火墙策略中的位置。
- protocol¶
此防火墙规则的协议值。
- show¶
资源的详细信息。
- source_ip_address¶
此防火墙规则的源 IP 地址。
- source_port¶
此防火墙规则的源端口范围。
- tenant_id¶
拥有防火墙的租户 ID。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::FirewallRule
properties:
action: String
description: String
destination_ip_address: String
destination_port: String
enabled: Boolean
ip_version: String
name: String
protocol: String
shared: Boolean
source_ip_address: String
source_port: String
OS::Neutron::FloatingIP¶
管理 Neutron 浮动 IP 的资源。
浮动 IP 地址可以通过用户操作在路由器之间更改其关联。浮动 IP 最常见的用例之一是为私有云提供公共 IP 地址，其中可用的 IP 地址数量有限。另一种用例是公共云用户拥有一个“静态”IP 地址，在实例升级或迁移时可以重新分配。
必需属性¶
- floating_network¶
-
用于分配浮动 IP 的网络。期望字符串值。更新会导致替换。值必须是 neutron.network 类型
可选属性¶
- dns_domain¶
-
与浮动 IP 关联的 DNS 域。期望字符串值。可以在不替换的情况下更新。值必须是 dns_domain 类型
- dns_name¶
-
与浮动 IP 关联的 DNS 名称。期望字符串值。可以在不替换的情况下更新。值必须是 rel_dns_name 类型
- fixed_ip_address¶
- 如果端口有多个地址，则使用的 IP 地址。期望字符串值。可以在不替换的情况下更新。值必须是 ip_addr 类型
- floating_ip_address¶
-
浮动 IP 的 IP 地址。注意：Neutron 中的默认策略设置将此属性的使用限制为管理员用户。期望字符串值。更新会导致替换。值必须是 ip_addr 类型
- floating_subnet¶
-
用于分配浮动 IP 的子网。期望字符串值。更新会导致替换。值必须是 neutron.subnet 类型
- port_id¶
- 现有端口的 ID，该端口至少有一个 IP 地址，将与此浮动 IP 关联。期望字符串值。可以在不替换的情况下更新。值必须是 neutron.port 类型
- value_specs¶
- 要在创建请求的“floatingip”对象中包含的额外参数。参数通常特定于已安装的硬件或扩展。期望 Map 值。更新会导致替换。默认为
{}
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::FloatingIP
properties:
dns_domain: String
dns_name: String
fixed_ip_address: String
floating_ip_address: String
floating_network: String
floating_subnet: String
port_id: String
value_specs: {...}
OS::Neutron::FloatingIPAssociation¶
用于关联浮动 IP 和端口的资源。
此资源允许将浮动 IP 关联到至少有一个 IP 地址的端口。
必需属性¶
可选属性¶
- fixed_ip_address¶
- 如果端口有多个地址，则使用的 IP 地址。期望字符串值。可以在不替换的情况下更新。值必须是 ip_addr 类型
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::FloatingIPAssociation
properties:
fixed_ip_address: String
floatingip_id: String
port_id: String
OS::Neutron::FloatingIPPortForward¶
用于创建浮动 IP 端口转发的资源。
此资源创建浮动 IP 的端口转发。它们是现有浮动 IP 的子资源，需要启用 service_plugin 和 extension port_forwarding，并且浮动 IP 未与 neutron 端口关联。
必需属性¶
- external_port¶
- 用于端口转发的外部端口地址。期望整数值。可以在不替换的情况下更新。值必须在 1 到 65535 之间。
- floating_ip¶
- 用于创建端口转发的浮动 IP 的名称或 ID。期望字符串值。更新会导致替换。
- internal_ip_address¶
- 端口转发到的内部 IP 地址。期望字符串值。可以在不替换的情况下更新。值必须是 ip_addr 类型
- internal_port¶
- 内部 IP 地址的端口名称或 ID。期望字符串值。可以在不替换的情况下更新。值必须是 neutron.port 类型
- protocol¶
- 要转发的端口协议。期望字符串值。可以在不替换的情况下更新。允许值：“tcp”、“udp”、“icmp”、“icmp6”、“sctp”、“dccp”
可选属性¶
- internal_port_number¶
- 要端口转发到的内部端口号。期望整数值。可以在不替换的情况下更新。值必须在 1 到 65535 之间。
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::FloatingIPPortForward
properties:
external_port: Integer
floating_ip: String
internal_ip_address: String
internal_port: String
internal_port_number: Integer
protocol: String
OS::Neutron::IKEPolicy¶
Neutron 中的 IKE 策略资源。
Internet Key Exchange (IKE) 策略标识 VPN 连接的阶段一和阶段二协商期间使用的认证和加密算法。
可选属性¶
- auth_algorithm¶
- IKE 策略的认证哈希算法。期望字符串值。可以在不替换的情况下更新。默认为
"sha1"允许值：“sha1”、“sha256”、“sha384”、“sha512” - description¶
- IKE 策略的描述。期望字符串值。可以在不替换的情况下更新。
- encryption_algorithm¶
- IKE 策略的加密算法。期望字符串值。可以在不替换的情况下更新。默认为
"aes-128"允许值：“3des”、“aes-128”、“aes-192”、“aes-256” - ike_version¶
- IKE 策略的版本。期望字符串值。可以在不替换的情况下更新。默认为
"v1"允许值：“v1”、“v2” - lifetime¶
- IKE 策略的安全性评估生命周期配置。期望 Map 值。可以在不替换的情况下更新。Map 属性
- name¶
- IKE 策略的名称。期望字符串值。可以在不替换的情况下更新。
- pfs¶
- IKE 策略的完美前向保密（小写）。期望字符串值。可以在不替换的情况下更新。默认为
"group5"允许值：“group2”、“group5”、“group14” - phase1_negotiation_mode¶
- IKE 策略的协商模式。期望字符串值。更新会导致替换。默认为
"main"允许值：“main”
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::IKEPolicy
properties:
auth_algorithm: String
description: String
encryption_algorithm: String
ike_version: String
lifetime: {"units": String, "value": Integer}
name: String
pfs: String
phase1_negotiation_mode: String
OS::Neutron::IPsecPolicy¶
Neutron 中的 IPsec 策略资源。
IP 安全策略，指定用于建立 VPN 连接的认证和加密算法以及封装模式。
可选属性¶
- auth_algorithm¶
- IPsec 策略的认证哈希算法。期望字符串值。更新会导致替换。默认为
"sha1"允许值：“sha1” - description¶
- IPsec 策略的描述。期望字符串值。可以在不替换的情况下更新。
- encapsulation_mode¶
- IPsec 策略的封装模式。期望字符串值。更新会导致替换。默认为
"tunnel"允许值：“tunnel”、“transport” - encryption_algorithm¶
- IPsec 策略的加密算法。期望字符串值。更新会导致替换。默认为
"aes-128"允许值：“3des”、“aes-128”、“aes-192”、“aes-256” - lifetime¶
- IPsec 策略的安全性评估生命周期配置。期望 Map 值。更新会导致替换。Map 属性
- name¶
- IPsec 策略的名称。期望字符串值。可以在不替换的情况下更新。
- pfs¶
- IPsec 策略的完美前向保密。期望字符串值。更新会导致替换。默认为
"group5"允许值：“group2”、“group5”、“group14” - transform_protocol¶
- IPsec 策略的转换协议。期望字符串值。更新会导致替换。默认为
"esp"允许值：“esp”、“ah”、“ah-esp”
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::IPsecPolicy
properties:
auth_algorithm: String
description: String
encapsulation_mode: String
encryption_algorithm: String
lifetime: {"units": String, "value": Integer}
name: String
pfs: String
transform_protocol: String
OS::Neutron::IPsecSiteConnection¶
Neutron 中的 IPsec 站点连接资源。
此资源包含站点到站点 IPsec 连接的详细信息，包括对等 CIDR、MTU、对等地址、DPD 设置和状态。
必需属性¶
- ikepolicy_id¶
- 与 IPsec 站点连接关联的 IKE 策略的唯一标识符。期望字符串值。更新会导致替换。
- ipsecpolicy_id¶
- 与 IPsec 站点连接关联的 IPsec 策略的唯一标识符。期望字符串值。更新会导致替换。
- peer_address¶
- 远程分支路由器公共 IPv4 地址或 IPv6 地址或 FQDN。期望字符串值。更新会导致替换。
- peer_cidrs¶
- 远程子网，CIDR 格式。期望列表值。更新会导致替换。列表内容
- 可选。期望字符串值。更新会导致替换。值必须是 net_cidr 类型
- peer_id¶
- 远程分支路由器的身份。期望字符串值。更新会导致替换。
- psk¶
- IPsec 站点连接的预共享密钥字符串。期望字符串值。更新会导致替换。
- vpnservice_id¶
- 与 IPsec 站点连接关联的 VPN 服务的唯一标识符。期望字符串值。更新会导致替换。
可选属性¶
- admin_state_up¶
- IPsec 站点连接的管理状态。期望布尔值。可以在不替换的情况下更新。默认为
true - description¶
- IPsec 站点连接的描述。期望字符串值。可以在不替换的情况下更新。
- dpd¶
- IPsec 站点连接的 Dead Peer Detection (DPD) 协议配置。期望 Map 值。更新会导致替换。Map 属性
- initiator¶
- IPsec 站点连接的启动器状态（小写）。期望字符串值。更新会导致替换。默认为
"bi-directional"允许值：“bi-directional”、“response-only” - mtu¶
- IPsec 站点连接的最大传输单元大小（字节）。期望整数值。更新会导致替换。默认为
1500 - name¶
- IPsec 站点连接的名称。期望字符串值。可以在不替换的情况下更新。
属性¶
- admin_state_up¶
IPsec 站点连接的管理状态。
- auth_mode¶
IPsec 站点连接的认证模式。
- description¶
IPsec 站点连接的描述。
- dpd¶
IPsec 站点连接的 DPD（Dead Peer Detection）协议配置。
- ikepolicy_id¶
与 IPsec 站点连接关联的 IKE 策略的唯一标识符。
- initiator¶
IPsec 站点连接的启动器。
- ipsecpolicy_id¶
与 IPsec 站点连接关联的 IPsec 策略的唯一标识符。
- mtu¶
IPsec 站点连接的最大传输单元大小（字节）。
- name¶
IPsec 站点连接的名称。
- peer_address¶
远程分支路由器公共 IPv4 地址或 IPv6 地址或 FQDN。
- peer_cidrs¶
IPsec 站点连接的远程子网（CIDR 格式）。
- peer_id¶
IPsec 站点连接的远程分支路由器身份。
- psk¶
IPsec 站点连接的预共享密钥字符串。
- route_mode¶
IPsec 站点连接的路由模式。
- show¶
资源的详细信息。
- status¶
IPsec 站点连接的状态。
- tenant_id¶
拥有 IPsec 站点连接的租户的唯一标识符。
- vpnservice_id¶
与 IPsec 站点连接关联的 VPN 服务的唯一标识符。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::IPsecSiteConnection
properties:
admin_state_up: Boolean
description: String
dpd: {"actions": String, "interval": Integer, "timeout": Integer}
ikepolicy_id: String
initiator: String
ipsecpolicy_id: String
mtu: Integer
name: String
peer_address: String
peer_cidrs: [String, String, ...]
peer_id: String
psk: String
vpnservice_id: String
OS::Neutron::L2Gateway¶
管理 Neutron L2 网关的资源。
L2 网关 API 可以解决许多用例。尤其是在云计算环境中，一个典型的用例是将虚拟网络与物理网络桥接。在 Neutron 和 OpenStack 世界中，这意味着依赖 L2 网关功能将 Neutron 逻辑（叠加）网络扩展到 OpenStack 之外的物理（提供商）网络。
必需属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::L2Gateway
properties:
devices: [{"device_name": String, "interfaces": [{"name": String, "segmentation_id": [Value, Value, ...]}, {"name": String, "segmentation_id": [Value, Value, ...]}, ...]}, {"device_name": String, "interfaces": [{"name": String, "segmentation_id": [Value, Value, ...]}, {"name": String, "segmentation_id": [Value, Value, ...]}, ...]}, ...]
name: String
OS::Neutron::L2GatewayConnection¶
管理 Neutron L2 网关连接的资源。
L2 网关连接提供了一个将 Neutron 网络映射到特定分割 ID 的 L2 网关的映射。
必需属性¶
可选属性¶
- segmentation_id¶
- 指定 l2gateway 上接口的分割 ID 的字符串。期望字符串值。更新会导致替换。
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::L2GatewayConnection
properties:
l2_gateway_id: String
network_id: String
segmentation_id: String
OS::Neutron::MeteringLabel¶
创建 neutron 计量标签的资源。
其理念是在 L3 路由器级别进行计量。目的是允许操作员配置 IP 范围并为其分配标签。例如，我们可以设置两个标签：一个用于内部流量，另一个用于外部流量。每个标签将测量特定 IP 范围的流量。然后，带宽测量结果将通过 Oslo 通知系统发送，并可由 Ceilometer 收集。
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::MeteringLabel
properties:
description: String
name: String
shared: Boolean
OS::Neutron::MeteringRule¶
为某个标签创建规则的资源。
允许指定标签计量特定 IP 范围流量的规则资源。
必需属性¶
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::MeteringRule
properties:
direction: String
excluded: Boolean
metering_label_id: String
remote_ip_prefix: String
OS::Neutron::Net¶
管理 Neutron 网络的资源。
网络是虚拟隔离的第二层广播域，通常保留给创建它的租户，除非该网络已明确配置为共享。
可选属性¶
- admin_state_up¶
- 指定网络管理状态的布尔值。期望布尔值。可以在不替换的情况下更新。默认为
true - availability_zone_hints¶
-
网络的可用区候选。需要 availability_zone 扩展可用。期望列表值。更新会导致替换。
- dhcp_agent_ids¶
- 安排网络的 DHCP 代理的 ID。请注意，Neutron 中的默认策略设置将此属性的使用限制为管理员用户。期望列表值。可以在不替换的情况下更新。
- dns_domain¶
-
与此网络关联的 DNS 域。期望字符串值。可以在不替换的情况下更新。值必须是 dns_domain 类型
- name¶
- 指定网络符号名称的字符串，不要求唯一。期望字符串值。可以在不替换的情况下更新。
- port_security_enabled¶
-
启用/禁用网络上端口安全性的标志。它为在此网络上创建的端口的属性提供了默认值。期望布尔值。可以在不替换的情况下更新。
- qos_policy¶
-
要附加到此网络的 QoS 策略的名称或 ID。期望字符串值。可以在不替换的情况下更新。值必须是 neutron.qos_policy 类型
- tenant_id¶
- 将拥有此网络的租户的 ID。只有管理员用户可以设置租户标识符；此标识符不能通过授权策略更改。期望字符串值。更新会导致替换。
- value_specs¶
- 要在请求中包含的额外参数。参数通常特定于已安装的硬件或扩展。期望 Map 值。可以在不替换的情况下更新。默认为
{}
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::Net
properties:
admin_state_up: Boolean
availability_zone_hints: [Value, Value, ...]
dhcp_agent_ids: [Value, Value, ...]
dns_domain: String
name: String
port_security_enabled: Boolean
qos_policy: String
shared: Boolean
tags: [String, String, ...]
tenant_id: String
value_specs: {...}
OS::Neutron::NetworkGateway¶
Neutron 网络网关中的网络网关资源。
用于将内部网络与指定设备连接的资源。
必需属性¶
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::NetworkGateway
properties:
connections: [{"network_id": String, "network": String, "segmentation_type": String, "segmentation_id": Integer}, {"network_id": String, "network": String, "segmentation_type": String, "segmentation_id": Integer}, ...]
devices: [{"id": String, "interface_name": String}, {"id": String, "interface_name": String}, ...]
name: String
OS::Neutron::Port¶
管理 Neutron 端口的资源。
端口代表逻辑网络交换机上的虚拟交换机端口。虚拟实例将它们的接口连接到端口。逻辑端口还定义了分配给插入端口的接口的 MAC 地址和 IP 地址。当 IP 地址与端口关联时，这也意味着端口与子网关联，因为 IP 地址是从特定子网的分配池中获取的。
必需属性¶
- network¶
-
此端口所属的网络。如果您计划使用当前端口分配浮动 IP，则应指定 fixed_ips 和 subnet。注意，如果更改到不同的网络，端口将被替换。期望字符串值。更新会导致替换。值必须是 neutron.network 类型
可选属性¶
- admin_state_up¶
- 此端口的管理状态。期望布尔值。可以在不替换的情况下更新。默认为
true - allowed_address_pairs¶
- 允许通过端口的其他 MAC/IP 地址对。期望列表值。可以在不替换的情况下更新。列表内容
- binding:vnic_type¶
-
要在 neutron 端口上绑定的 vnic 类型。为了支持 SR-IOV PCI 直通网络，您可以请求将 neutron 端口实现为普通（虚拟网卡）、直接（pci 直通）或 macvtap（带 tap 类软件接口的虚拟接口）。请注意，这仅适用于支持 binding 扩展的 Neutron 部署。期望字符串值。可以在不替换的情况下更新。默认为
"normal"允许值：“normal”、“direct”、“macvtap”、“direct-physical”、“baremetal”、“virtio-forwarder”、“smart-nic” - device_id¶
- 此端口的设备 ID。期望字符串值。可以在不替换的情况下更新。默认为
"" - device_owner¶
- 拥有该端口的网络名称。该值通常是 network:floatingip、network:router_interface 或 network:dhcp。期望字符串值。可以在不替换的情况下更新。默认为
"" - dns_name¶
-
与此端口关联的 DNS 名称。期望字符串值。可以在不替换的情况下更新。值必须是 dns_name 类型
- fixed_ips¶
- 此端口所需的 IP 地址。期望列表值。可以在不替换的情况下更新。列表内容
- mac_address¶
- 要为此端口提供的 MAC 地址。neutron 中此属性的默认更新策略是仅允许管理员角色。期望字符串值。更新会导致替换。值必须是 mac_addr 类型
- name¶
- 此端口的符号名称。期望字符串值。可以在不替换的情况下更新。
- no_fixed_ips¶
-
禁用端口上所有固定 IP 的标志。期望布尔值。可以在不替换的情况下更新。默认为
false - port_security_enabled¶
-
启用/禁用端口上端口安全性的标志。当禁用此功能（设置为 False）时，将不会进行任何数据包过滤，例如安全组和地址对。期望布尔值。可以在不替换的情况下更新。
- propagate_uplink_status¶
-
启用/禁用端口上上行链路状态传播的标志。期望布尔值。可以在不替换的情况下更新。
- qos_policy¶
-
要附加到此端口的 QoS 策略的名称或 ID。期望字符串值。可以在不替换的情况下更新。值必须是 neutron.qos_policy 类型
- security_groups¶
- 要与此端口关联的安全组 ID。期望列表值。可以在不替换的情况下更新。
- value_specs¶
- 要在请求中包含的额外参数。期望 Map 值。可以在不替换的情况下更新。默认为
{}
属性¶
- admin_state_up¶
此端口的管理状态。
- allowed_address_pairs¶
允许通过端口的其他 MAC/IP 地址对。
- device_id¶
设备的唯一标识符。
- device_owner¶
拥有该端口的网络名称。
- dns_assignment¶
-
分配给此端口的 DNS。
- fixed_ips¶
固定 IP 地址。
- mac_address¶
端口的 MAC 地址。
- name¶
端口的友好名称。
- network¶
-
拥有该端口的网络属性。（响应参数的完整列表可以在 `Openstack Networking service API reference <https://docs.openstack.org/api-ref/network/>`_ 中找到。）以下示例演示了一些（非全部）可能的表达式。（获取网络、MTU（最大传输单元）、网络标签和 l2_adjacency 属性）： ``{get_attr: [<port>, network]}``、``{get_attr: [<port>, network, mtu]}``、``{get_attr: [<port>, network, tags]}?``、``{get_attr: [<port>, network, l2_adjacency]}``。
- network_id¶
拥有该端口的网络的唯一标识符。
- port_security_enabled¶
-
端口的端口安全性已启用。
- propagate_uplink_status¶
-
端口的上行链路状态传播已启用/禁用。
- qos_policy_id¶
-
附加到此端口的 QoS 策略 ID。
- security_groups¶
端口的安全组列表。
- show¶
资源的详细信息。
- status¶
端口的状态。
- subnets¶
端口的所有子网属性列表。
- tenant_id¶
拥有该端口的租户。
HOT 语法¶
heat_template_version: 2015-04-30
...
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}, ...]
binding:vnic_type: String
device_id: String
device_owner: String
dns_name: String
fixed_ips: [{"subnet_id": String, "subnet": String, "ip_address": String}, {"subnet_id": String, "subnet": String, "ip_address": String}, ...]
mac_address: String
name: String
network: String
no_fixed_ips: Boolean
port_security_enabled: Boolean
propagate_uplink_status: Boolean
qos_policy: String
security_groups: [Value, Value, ...]
tags: [String, String, ...]
value_specs: {...}
OS::Neutron::ProviderNet¶
管理 Neutron 提供商网络的资源。
提供商网络指定现有网络的物理实现详细信息。
此资源的默认策略使用仅限于管理员。
必需属性¶
- network_type¶
- 指定网络提供商网络类型的字符串。期望字符串值。可以在不替换的情况下更新。允许值：“local”、“vlan”、“vxlan”、“gre”、“geneve”、“flat”
可选属性¶
- admin_state_up¶
- 指定网络管理状态的布尔值。期望布尔值。可以在不替换的情况下更新。默认为
true - availability_zone_hints¶
-
网络的可用区候选。需要 availability_zone 扩展可用。期望列表值。可以在不替换的情况下更新。
- dns_domain¶
-
与此网络关联的 DNS 域。期望字符串值。可以在不替换的情况下更新。值必须是 dns_domain 类型
- name¶
- 指定网络符号名称的字符串，不要求唯一。期望字符串值。可以在不替换的情况下更新。
- physical_network¶
- 指定网络物理网络映射的字符串。期望字符串值。可以在不替换的情况下更新。
- port_security_enabled¶
-
启用/禁用网络上端口安全性的标志。它为在此网络上创建的端口的属性提供了默认值。期望布尔值。可以在不替换的情况下更新。
- router_external¶
-
网络是否包含外部路由器。期望布尔值。可以在不替换的情况下更新。默认为
false - segmentation_id¶
- 指定网络分割 ID 的字符串。期望字符串值。可以在不替换的情况下更新。
- tenant_id¶
-
将拥有此提供商网络的租户的 ID。只有管理员用户可以设置租户标识符；此标识符不能通过授权策略更改。期望字符串值。更新会导致替换。
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::ProviderNet
properties:
admin_state_up: Boolean
availability_zone_hints: [Value, Value, ...]
dns_domain: String
name: String
network_type: String
physical_network: String
port_security_enabled: Boolean
router_external: Boolean
segmentation_id: String
shared: Boolean
tags: [String, String, ...]
tenant_id: String
OS::Neutron::QoSBandwidthLimitRule¶
Neutron QoS 带宽限制规则的资源。
此规则可以与 QoS 策略关联，然后该策略可用于 neutron 端口和网络，以提供带宽限制 QoS 功能。
此资源的默认策略使用仅限于管理员。
必需属性¶
可选属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::QoSBandwidthLimitRule
properties:
direction: String
max_burst_kbps: Integer
max_kbps: Integer
policy: String
tenant_id: String
OS::Neutron::QoSDscpMarkingRule¶
Neutron QoS DSCP 标记规则的资源。
此规则可以与 QoS 策略关联，然后该策略可用于 neutron 端口和网络，以提供 DSCP 标记 QoS 功能。
此资源的默认策略使用仅限于管理员。
必需属性¶
可选属性¶
- tenant_id¶
- 此规则的所有者租户 ID。期望字符串值。更新会导致替换。
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::QoSDscpMarkingRule
properties:
dscp_mark: Integer
policy: String
tenant_id: String
OS::Neutron::QoSMinimumBandwidthRule¶
用于保证带宽的资源。
此规则可与 QoS 策略关联，然后neutron 端口可使用该策略提供保证带宽 QoS 功能。
根据驱动程序，保证可能在两个级别上执行。首先，当服务器放置（调度）在物理基础设施上，和/或其次，在物理管理程序的平面数据中。有关详细信息，请参阅 Neutron 文档
https://docs.openstack.org/neutron/2025.2/admin/config-qos-min-bw.html
此资源的默认策略使用仅限于管理员。
必需属性¶
可选属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::QoSMinimumBandwidthRule
properties:
direction: String
min_kbps: Integer
policy: String
tenant_id: String
OS::Neutron::QoSMinimumPacketRateRule¶
用于保证包速率的资源。
此规则可与 QoS 策略关联，然后neutron 端口可使用该策略提供保证包速率 QoS 功能。
根据驱动程序，保证可能在两个级别上执行。首先，当服务器放置（调度）在物理基础设施上，和/或其次，在物理管理程序的平面数据中。有关详细信息，请参阅 Neutron 文档
https://docs.openstack.org/neutron/2025.2/admin/config-qos-min-pps.html
此资源的默认策略使用仅限于管理员。
必需属性¶
可选属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::QoSMinimumPacketRateRule
properties:
direction: String
min_kpps: Integer
policy: String
tenant_id: String
OS::Neutron::QoSPolicy¶
Neutron QoS 策略的资源。
此 QoS 策略可与 neutron 资源（如端口和网络）关联，以提供 QoS 功能。
此资源的默认策略使用仅限于管理员。
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::QoSPolicy
properties:
description: String
name: String
shared: Boolean
tenant_id: String
OS::Neutron::Quota¶
用于管理 neutron 配额的资源。
Neutron 配额用于管理项目的操作限制。目前，此资源可以管理 Neutron 的配额，用于
subnet
network
floatingip
security_group_rule
security_group
router
port
subnetpool
rbac_policy
注意，默认的 neutron 安全策略对该资源的使用仅限于管理员。管理员应谨慎为每个项目只创建一个 Neutron 配额资源，否则将难以正确管理配额。
必需属性¶
- project¶
- 设置配额的项目名称或 ID。期望字符串值。更新会导致替换。值必须为 keystone.project 类型
可选属性¶
- floatingip¶
- 浮动 IP 数量的配额。设置为 -1 表示无限。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- network¶
- 网络数量的配额。设置为 -1 表示无限。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- port¶
- 端口数量的配额。设置为 -1 表示无限。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- rbac_policy¶
-
RBAC 策略数量的配额。设置为 -1 表示无限。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- router¶
- 路由器数量的配额。设置为 -1 表示无限。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- security_group¶
- 安全组数量的配额。设置为 -1 表示无限。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- security_group_rule¶
- 安全组规则数量的配额。设置为 -1 表示无限。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- subnet¶
- 子网数量的配额。设置为 -1 表示无限。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- subnetpool¶
-
子网池数量的配额。设置为 -1 表示无限。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::Quota
properties:
floatingip: Integer
network: Integer
port: Integer
project: String
rbac_policy: Integer
router: Integer
security_group: Integer
security_group_rule: Integer
subnet: Integer
subnetpool: Integer
OS::Neutron::RBACPolicy¶
用于在 Neutron 中管理 RBAC 策略的资源。
此资源用于创建和管理 Neutron RBAC 策略，允许将 Neutron 网络和 QoS 策略共享给租户子集。
必需属性¶
可选属性¶
- tenant_id¶
- 所有者租户 ID。仅当调用者具有管理员角色并希望为其他租户创建 RBAC 时才需要。期望字符串值。更新会导致替换。
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::RBACPolicy
properties:
action: String
object_id: String
object_type: String
target_tenant: String
tenant_id: String
OS::Neutron::Router¶
实现 Neutron 路由器的资源。
路由器是一种物理或虚拟网络设备，可在不同网络之间传递网络流量。
可选属性¶
- admin_state_up¶
- 路由器的管理状态。期望布尔值。可以在不替换的情况下更新。默认为
true - availability_zone_hints¶
-
路由器的可用区域候选。需要可用区域扩展。期望列表值。可以在不替换的情况下更新。
- distributed¶
-
指示是否创建分布式路由器。注意：Neutron 中的默认策略设置将此属性的使用限制为仅管理员用户。此属性不能与 L3 代理 ID 结合使用。期望布尔值。更新会导致替换。
- external_gateway_info¶
- 路由器的外部网络网关配置。期望 Map 值。可以在不替换的情况下更新。Map 属性
- ha¶
-
指示是否创建高可用路由器。注意：Neutron 中的默认策略设置将此属性的使用限制为仅管理员用户。并且现在 neutron 不支持分布式和 HA 同时使用。期望布尔值。更新会导致替换。
- l3_agent_ids¶
-
L3 代理的 ID 列表。用户可以为高可用路由器指定多个代理。注意：Neutron 中的默认策略设置将此属性的使用限制为仅管理员用户。期望列表值。可以在不替换的情况下更新。列表内容
- 可选。期望字符串值。可以在不替换的情况下更新。
- name¶
- 路由器的名称。期望字符串值。可以在不替换的情况下更新。
- tenant_id¶
-
将拥有路由器的租户的 ID。只有管理员用户可以设置租户标识符；不能通过授权策略更改。期望字符串值。更新会导致替换。
- value_specs¶
- 创建请求中包含的附加参数。期望 Map 值。可以在不替换的情况下更新。默认为
{}
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::Router
properties:
admin_state_up: Boolean
availability_zone_hints: [Value, Value, ...]
distributed: Boolean
external_gateway_info: {"network": String, "enable_snat": Boolean, "external_fixed_ips": [{"ip_address": String, "subnet": String}, {"ip_address": String, "subnet": String}, ...]}
ha: Boolean
l3_agent_ids: [String, String, ...]
name: String
tags: [String, String, ...]
tenant_id: String
value_specs: {...}
OS::Neutron::RouterInterface¶
用于管理 Neutron 路由器接口的资源。
路由器接口将路由器与现有子网或端口关联。
必需属性¶
- router¶
- 路由器。期望字符串值。更新会导致替换。值必须是 neutron.router 类型
可选属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::RouterInterface
properties:
port: String
router: String
subnet: String
OS::Neutron::SecurityGroup¶
用于管理 Neutron 安全组的资源。
安全组是应用于实例网络的 IP 过滤器规则集。它们是项目特定的，项目成员可以编辑其组的默认规则并添加新的规则集。所有项目都有一个“默认”安全组，该组应用于没有定义其他安全组的实例。
可选属性¶
- description¶
- 安全组的描述。期望字符串值。可以在不替换的情况下更新。
- name¶
- 指定安全组的符号名称的字符串，该名称不一定唯一。期望字符串值。可以在不替换的情况下更新。
- rules¶
- 安全组规则列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 期望 Map 值。可以在不替换的情况下更新。Map 属性
- direction¶
- 可选。应用安全组规则的方向。对于计算实例，入口安全组规则匹配进（入口）实例的流量。出口规则应用于离开实例的流量。期望字符串值。可以在不替换的情况下更新。默认为
"ingress"允许值：“ingress”、“egress” - ethertype¶
- 可选。流量的以太网类型。期望字符串值。可以在不替换的情况下更新。默认为
"IPv4"允许值：“IPv4”、“IPv6” - port_range_max¶
- 可选。安全组规则匹配的范围内的最大端口号。port_range_min 属性约束 port_range_max 属性。如果协议是 ICMP，此值必须是 ICMP 类型。期望整数值。可以在不替换的情况下更新。值必须在 0 到 65535 的范围内。
- port_range_min¶
- 可选。安全组规则匹配的范围内的最小端口号。如果协议是 TCP 或 UDP，此值必须小于或等于 port_range_max 属性的值。如果协议是 ICMP，此值必须是 ICMP 类型。期望整数值。可以在不替换的情况下更新。值必须在 0 到 65535 的范围内。
- protocol¶
- 可选。安全组规则匹配的协议。有效值包括 tcp、udp 和 icmp。期望字符串值。可以在不替换的情况下更新。
- remote_group_id¶
- 可选。要与此安全组规则关联的远程组 ID。如果未指定值，则此规则将使用此安全组作为 remote_group_id。remote 模式参数必须设置为“remote_group_id”。期望字符串值。可以在不替换的情况下更新。值必须是 neutron.security_group 类型
- remote_ip_prefix¶
- 可选。要与此安全组规则关联的远程 IP 前缀（CIDR）。期望字符串值。可以在不替换的情况下更新。值必须是 net_cidr 类型
- remote_mode¶
- 可选。是指定远程组还是远程 IP 前缀。期望字符串值。可以在不替换的情况下更新。默认为
"remote_ip_prefix"允许值：“remote_ip_prefix”、“remote_group_id”
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::SecurityGroup
properties:
description: String
name: String
rules: [{"direction": String, "ethertype": String, "port_range_min": Integer, "port_range_max": Integer, "protocol": String, "remote_mode": String, "remote_group_id": String, "remote_ip_prefix": String}, {"direction": String, "ethertype": String, "port_range_min": Integer, "port_range_max": Integer, "protocol": String, "remote_mode": String, "remote_group_id": String, "remote_ip_prefix": String}, ...]
OS::Neutron::SecurityGroupRule¶
用于管理 Neutron 安全组规则的资源。
安全组资源中使用的规则。
必需属性¶
- security_group¶
- 要添加规则的安全组名称或 ID。期望字符串值。更新会导致替换。值必须是 neutron.security_group 类型
可选属性¶
- description¶
- 安全组规则的描述。期望字符串值。更新会导致替换。
- direction¶
- 应用安全组规则的方向。对于计算实例，入口安全组规则匹配进（入口）实例的流量。出口规则应用于离开实例的流量。期望字符串值。更新会导致替换。默认为
"ingress"允许值：“ingress”、“egress” - ethertype¶
- 流量的以太网类型。期望字符串值。更新会导致替换。默认为
"IPv4"允许值：“IPv4”、“IPv6” - port_range_max¶
- 安全组规则匹配的范围内的最大端口号。port_range_min 属性约束 port_range_max 属性。如果协议是 ICMP，此值必须是 ICMP 代码。期望整数值。更新会导致替换。值必须在 0 到 65535 的范围内。
- port_range_min¶
- 安全组规则匹配的范围内的最小端口号。如果协议是 TCP 或 UDP，此值必须小于或等于 port_range_max 属性的值。如果协议是 ICMP，此值必须是 ICMP 类型。期望整数值。更新会导致替换。值必须在 0 到 65535 的范围内。
- protocol¶
- 安全组规则匹配的协议。允许值包括 ah、dccp、egp、esp、gre、icmp、icmpv6、igmp、ipv6-encap、ipv6-frag、ipv6-icmp、ipv6-nonxt、ipv6-opts、ipv6-route、ospf、pgm、rsvp、sctp、tcp、udp、udplite、vrrp 以及整数表示 [0-255]。期望字符串值。更新会导致替换。默认为
"tcp"允许值：0、1、2、3、4、5、6、7、8、9、10、11、12、13、14、15、16、17、18、19、20、21、22、23、24、25、26、27、28、29、30、31、32、33、34、35、36、37、38、39、40、41、42、43、44、45、46、47、48、49、50、51、52、53、54、55、56、57、58、59、60、61、62、63、64、65、66、67、68、69、70、71、72、73、74、75、76、77、78、79、80、81、82、83、84、85、86、87、88、89、90、91、92、93、94、95、96、97、98、99、100、101、102、103、104、105、106、107、108、109、110、111、112、113、114、115、116、117、118、119、120、121、122、123、124、125、126、127、128、129、130、131、132、133、134、135、136、137、138、139、140、141、142、143、144、145、146、147、148、149、150、151、152、153、154、155、156、157、158、159、160、161、162、163、164、165、166、167、168、169、170、171、172、173、174、175、176、177、178、179、180、181、182、183、184、185、186、187、188、189、190、191、192、193、194、195、196、197、198、199、200、201、202、203、204、205、206、207、208、209、210、211、212、213、214、215、216、217、218、219、220、221、222、223、224、225、226、227、228、229、230、231、232、233、234、235、236、237、238、239、240、241、242、243、244、245、246、247、248、249、250、251、252、253、254、255、“ah”、“dccp”、“egp”、“esp”、“gre”、“icmp”、“icmpv6”、“igmp”、“ipv6-encap”、“ipv6-frag”、“ipv6-icmp”、“ipv6-nonxt”、“ipv6-opts”、“ipv6-route”、“ospf”、“pgm”、“rsvp”、“sctp”、“tcp”、“udp”、“udplite”、“vrrp” - remote_group¶
- 要与此安全组规则关联的远程组名称或 ID。期望字符串值。更新会导致替换。值必须是 neutron.security_group 类型
- remote_ip_prefix¶
- 要与此安全组规则关联的远程 IP 前缀（CIDR）。期望字符串值。更新会导致替换。值必须是 net_cidr 类型
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::SecurityGroupRule
properties:
description: String
direction: String
ethertype: String
port_range_max: Integer
port_range_min: Integer
protocol: String
remote_group: String
remote_ip_prefix: String
security_group: String
OS::Neutron::Segment¶
Neutron Segment 的资源。
这需要通过将“segments”附加到 neutron.conf 中的 service_plugins 列表来启用 segments 服务插件。
此资源的默认策略使用仅限于管理员。
必需属性¶
可选属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::Segment
properties:
description: String
name: String
network: String
network_type: String
physical_network: String
segmentation_id: Integer
OS::Neutron::Subnet¶
用于管理 Neutron 子网的资源。
子网表示可用于为虚拟实例分配 IP 地址的 IP 地址块。每个子网必须具有 CIDR 并必须与网络相关联。IP 地址可以从整个子网 CIDR 中选择，也可以从用户指定的“分配池”中选择。
必需属性¶
- network¶
-
连接网络的 ID。期望字符串值。更新会导致替换。值必须是 neutron.network 类型
可选属性¶
- allocation_pools¶
- 分配池的起始和结束地址。期望列表值。可以在不替换的情况下更新。列表内容
- cidr¶
- CIDR。期望字符串值。更新会导致替换。值必须是 net_cidr 类型
- dns_nameservers¶
- 要使用的指定 DNS 名称服务器集。期望列表值。可以在不替换的情况下更新。默认为
[] - enable_dhcp¶
- 如果启用 DHCP，则设置为 true；如果禁用 DHCP，则设置为 false。期望布尔值。可以在不替换的情况下更新。默认为
true - gateway_ip¶
- 网关 IP 地址。设置为 [ null | ~ | “” ] 中的任意一个，以创建/更新一个没有网关的子网。如果创建时省略，neutron 将自动为子网中的第一个可用 IP 地址分配给网关。如果更新时从模板中删除此项，则旧的网关 IP 地址将被分离。期望字符串值。可以在不替换的情况下更新。
- host_routes¶
- 子网的静态路由字典列表。期望列表值。可以在不替换的情况下更新。列表内容
- ip_version¶
- IP 版本，为 4 或 6。期望整数值。更新会导致替换。默认为
4允许值：4, 6 - ipv6_address_mode¶
-
IPv6 地址模式。期望字符串值。更新会导致替换。允许值：“dhcpv6-stateful”、“dhcpv6-stateless”、“slaac”
- ipv6_ra_mode¶
-
IPv6 RA（路由器通告）模式。期望字符串值。更新会导致替换。允许值：“dhcpv6-stateful”、“dhcpv6-stateless”、“slaac”
- name¶
- 子网的名称。期望字符串值。可以在不替换的情况下更新。
- prefixlen¶
-
子网池的子网分配前缀长度。期望整数值。更新会导致替换。该值必须至少为 0。
- segment¶
-
要关联的段的名称/ID。期望字符串值。可以在不替换的情况下更新。值必须是 neutron.segment 类型
- subnetpool¶
-
子网池的名称或 ID。期望字符串值。更新会导致替换。值必须是 neutron.subnetpool 类型
- tenant_id¶
- 拥有网络的租户的 ID。只有管理员用户可以指定除自己以外的租户 ID。期望字符串值。更新会导致替换。
- value_specs¶
- 要在请求中包含的额外参数。期望 Map 值。可以在不替换的情况下更新。默认为
{}
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
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
ipv6_address_mode: String
ipv6_ra_mode: String
name: String
network: String
prefixlen: Integer
segment: String
subnetpool: String
tags: [String, String, ...]
tenant_id: String
value_specs: {...}
OS::Neutron::SubnetPool¶
实现 neutron 子网池的资源。
此资源可用于创建具有大量地址块的子网池，并从中创建子网。
必需属性¶
- prefixes¶
- 要分配的子网前缀列表。期望列表值。可以在不替换的情况下更新。长度必须至少为 1。列表内容
- 可选。期望字符串值。可以在不替换的情况下更新。值必须是 net_cidr 类型
可选属性¶
- address_scope¶
- 要分配给子网池的地址范围 ID。期望字符串值。可以在不替换的情况下更新。值必须是 neutron.address_scope 类型
- default_prefixlen¶
- 在创建子网时未指定 cidr 或 prefixlen 属性时要分配的前缀大小。期望整数值。可以在不替换的情况下更新。该值必须至少为 0。
- default_quota¶
- 对可以从子网池为租户子网分配的前缀空间的每个租户的配额。期望整数值。可以在不替换的情况下更新。该值必须至少为 0。
- is_default¶
- 这是否是默认的 IPv4/IPv6 子网池。每个 IP 系列只能有一个默认子网池。请注意，默认策略设置限制管理员用户将此设置为 True。期望布尔值。可以在不替换的情况下更新。默认为
false - max_prefixlen¶
- 可以从子网池分配的最大前缀大小。期望整数值。可以在不替换的情况下更新。该值必须至少为 0。
- min_prefixlen¶
- 可以从子网池分配的最小前缀大小。期望整数值。可以在不替换的情况下更新。该值必须至少为 0。
- name¶
- 子网池的名称。期望字符串值。可以在不替换的情况下更新。
- tenant_id¶
- 拥有子网池的租户的 ID。只有管理员用户可以指定除自己以外的租户 ID。期望字符串值。更新会导致替换。
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::SubnetPool
properties:
address_scope: String
default_prefixlen: Integer
default_quota: Integer
is_default: Boolean
max_prefixlen: Integer
min_prefixlen: Integer
name: String
prefixes: [String, String, ...]
shared: Boolean
tags: [String, String, ...]
tenant_id: String
OS::Neutron::TaaS::TapFlow¶
用于 neutron tap-as-a-service tap-flow 的资源。
此插件需要 neutron-taas。因此，要启用此插件，请安装此库并重新启动 heat-engine。
Tap-Flow 表示需要镜像流量的端口。
必需属性¶
可选属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::TaaS::TapFlow
properties:
description: String
direction: String
name: String
port: String
tap_service: String
vlan_filter: String
OS::Neutron::TaaS::TapService¶
用于 neutron tap-as-a-service tap-service 的资源。
此插件需要 neutron-taas。因此，要启用此插件，请安装此库并重新启动 heat-engine。
Tap-Service 表示镜像流量的交付端口。使用镜像数据的任何 VM 都连接到此端口。
必需属性¶
- port¶
- tap-service neutron 端口的 ID 或名称。期望字符串值。更新会导致替换。值必须是 neutron.port 类型
可选属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::TaaS::TapService
properties:
description: String
name: String
port: String
OS::Neutron::Trunk¶
用于管理 Neutron Trunk 的资源。
需要启用 Neutron Trunk 扩展
$ openstack extension show trunk
网络 Trunk 服务允许使用单个虚拟 NIC (vNIC) 将多个网络连接到实例。可以通过将实例连接到单个端口来向实例呈现多个网络。
用户可以创建端口，将其关联为 trunk 的父级，并在该端口上启动实例。用户可以动态地连接和分离其他网络，而不会中断实例的运行。
每个 trunk 都有一个父端口，并且可以拥有任意数量（0、1、...）的子端口。父端口是实例直接关联的端口，其流量在实例内部始终是未标记的。用户在启动连接到 trunk 的实例时必须指定 trunk 的父端口。
子端口呈现的网络是关联端口的网络。创建子端口时，驱动程序可能需要 segmentation_type 和 segmentation_id，以便用户能够区分实例内部的网络。从 Pike 版本开始，只支持 vlan 的 segmentation_type。segmentation_id 定义了子端口网络呈现给实例的分割 ID。
请注意，某些 Neutron 后端（主要是 Open vSwitch）只允许在实例启动在父端口之前创建 trunk。为避免启动带有 trunk 的实例时可能出现的竞争条件，强烈建议在模板中通过 get_attr 间接引用 trunk 的父端口。例如：
trunk:
type: OS::Neutron::Trunk
properties:
port: ...
instance:
type: OS::Nova::Server
properties:
networks:
- { port: { get_attr: [trunk, port_id] } }
虽然其他 Neutron 后端可能容忍直接端口引用（以及由此暗示的 API 请求的可能反向排序），但最好避免编写特定于 Neutron 后端的模板。
必需属性¶
- port¶
- 用作父端口的端口的 ID 或名称。期望字符串值。不支持更新。尝试更新此属性的任何操作都将导致资源更新失败。值必须是 neutron.port 类型
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::Trunk
properties:
admin_state_up: Boolean
description: String
name: String
port: String
sub_ports: [{"port": String, "segmentation_type": String, "segmentation_id": Integer}, {"port": String, "segmentation_type": String, "segmentation_id": Integer}, ...]
OS::Neutron::VPNService¶
Neutron 中的 VPN 服务的资源。
VPN 服务是一个高级对象，它将 VPN 与特定子网和路由器关联。
必需属性¶
可选属性¶
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::VPNService
properties:
admin_state_up: Boolean
description: String
name: String
router: String
subnet: String
OS::Nova::Flavor¶
用于创建 OpenStack 虚拟硬件模板的资源。
由于默认的 nova 安全策略，此资源的使用仅限于管理员。还可以通过重新定义 nova-api 服务器上的访问控制将权限委托给其他用户。
请注意，Nova Flavor 资源的当前实现不允许为资源指定 name 和 flavorid 属性。这是为了避免在创建 flavor 时可能出现的命名冲突，因为所有 flavor 都有全局范围。
必需属性¶
可选属性¶
- disk¶
- 本地磁盘大小（单位 GB）。“0”大小是一个特殊情况，它使用原生基础映像大小作为临时根卷的大小。期望整数值。更新会导致替换。默认值为
0 - ephemeral¶
- 二次临时数据磁盘大小（单位 GB）。期望整数值。更新会导致替换。默认值为
0 - extra_specs¶
- 键/值对，用于扩展 flavor 的功能。期望 Map 值。可以在不替换的情况下更新。
- flavorid¶
-
flavor 的唯一 ID。如果未指定，将自动生成并使用 UUID。期望字符串值。更新会导致替换。
- is_public¶
-
flavor 可访问范围。公共或私有。默认值为 True，表示公共，在所有项目中共享。期望布尔值。更新会导致替换。默认为
true - name¶
-
风味的名称。期望字符串值。更新会导致替换。
- rxtx_factor¶
- RX/TX 因子。预期的数字值。更新会导致替换。默认值为
1.0 - swap¶
- 交换空间（单位 MB）。期望整数值。更新会导致替换。默认值为
0 - tenants¶
-
租户列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 可选。期望字符串值。可以在不替换的情况下更新。值必须为 keystone.project 类型
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Nova::Flavor
properties:
disk: Integer
ephemeral: Integer
extra_specs: {...}
flavorid: String
is_public: Boolean
name: String
ram: Integer
rxtx_factor: Number
swap: Integer
tenants: [String, String, ...]
vcpus: Integer
OS::Nova::HostAggregate¶
用于进一步划分可用区域与主机的资源。
可用区域对用户可见，而主机聚合仅对管理员可见。主机聚合最初是为了使用 Xen hypervisor 资源池，但已通用化，为管理员提供了一种将键值对分配给机器组的机制。每个节点可以有多个聚合，每个聚合可以有多个键值对，并且相同的键值对可以分配给多个聚合。此信息可用于调度程序以实现高级调度、设置 Xen hypervisor 资源池或定义迁移的逻辑组。
必需属性¶
- name¶
- 聚合的名称。期望字符串值。可以在不替换的情况下更新。
可选属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Nova::HostAggregate
properties:
availability_zone: String
hosts: [String, String, ...]
metadata: {...}
name: String
OS::Nova::KeyPair¶
用于创建 Nova 密钥对的资源。
密钥对是可以在启动时注入服务器的 ssh 密钥。
注意，如果生成新密钥，将 `save_private_key` 设置为 `True` 将导致系统保存私钥，然后可以通过此资源的 `private_key` 属性检索该私钥。
设置 `public_key` 属性意味着此资源的 `private_key` 属性将始终返回空字符串，无论 `save_private_key` 设置如何，因为没有私钥数据可供保存。
必需属性¶
- name¶
- 密钥对的名称。期望字符串值。更新会导致替换。长度必须在 1 到 255 之间。
可选属性¶
- public_key¶
- 公钥。这允许用户从预先存在的密钥对提供公钥。在 Nova API 版本 < 2.92 中，如果未提供，将生成一个新的密钥对。此属性自 Nova API 版本 2.92 起为必需。期望字符串值。更新会导致替换。
- save_private_key¶
- 如果系统应记住生成的私钥，则为 True；否则为 False。期望布尔值。更新会导致替换。默认为
false - type¶
-
密钥对类型。支持自 Nova API 版本 2.2 起。期望字符串值。更新会导致替换。允许值：“ssh”、“x509”
- user¶
-
要添加密钥对的用户 ID 或名称。此属性的使用仅限于管理员。支持自 Nova API 版本 2.10 起。期望字符串值。更新会导致替换。值必须是 keystone.user 类型
属性¶
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Nova::KeyPair
properties:
name: String
public_key: String
save_private_key: Boolean
type: String
user: String
OS::Nova::Quota¶
用于创建 nova 配额的资源。
Nova 配额用于管理项目的操作限制。目前，此资源可以管理 Nova 的配额，用于
cores
fixed_ips
floating_ips
instances
injected_files
injected_file_content_bytes
injected_file_path_bytes
key_pairs
metadata_items
ram
security_groups
security_group_rules
server_groups
server_group_members
请注意，默认的 nova 安全策略对该资源的使用仅限于管理员。管理员应谨慎为每个项目只创建一个 Nova 配额资源，否则将难以正确管理配额。
必需属性¶
- project¶
- 设置配额的项目名称或 ID。期望字符串值。更新会导致替换。值必须为 keystone.project 类型
可选属性¶
- cores¶
- 核心数量的配额。将值设置为 -1 将移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- fixed_ips¶
- 固定 IP 数量的配额。将值设置为 -1 将移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- floating_ips¶
- 浮动 IP 数量的配额。将值设置为 -1 将移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- instances¶
- 实例数量的配额。将值设置为 -1 将移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- key_pairs¶
- 密钥对数量的配额。将值设置为 -1 将移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- metadata_items¶
- 元数据项数量的配额。将值设置为 -1 将移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- ram¶
- 内存（MB）的配额。将值设置为 -1 将移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- security_group_rules¶
- 安全组规则数量的配额。将值设置为 -1 将移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- security_groups¶
- 安全组数量的配额。将值设置为 -1 将移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- server_group_members¶
- 服务器组成员数量的配额。将值设置为 -1 将移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- server_groups¶
- 服务器组数量的配额。将值设置为 -1 将移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- injected_file_content_bytes¶
-
注入文件内容字节数的配额。将值设置为 -1 将移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- injected_file_path_bytes¶
-
注入文件路径字节数的配额。将值设置为 -1 将移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- injected_files¶
-
注入文件数量的配额。将值设置为 -1 将移除限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Nova::Quota
properties:
cores: Integer
fixed_ips: Integer
floating_ips: Integer
instances: Integer
key_pairs: Integer
metadata_items: Integer
project: String
ram: Integer
security_group_rules: Integer
security_groups: Integer
server_group_members: Integer
server_groups: Integer
OS::Nova::Server¶
用于管理 Nova 实例的资源。
Server 资源管理 OpenStack 云中运行的虚拟机实例。
必需属性¶
- flavor¶
- 要启动的 flavor 的 ID 或名称。期望字符串值。可以在不替换的情况下更新。值必须是 nova.flavor 类型
可选属性¶
- admin_pass¶
- 服务器的管理员密码。期望字符串值。可以在不替换的情况下更新。
- availability_zone¶
- 服务器放置的可用区域名称。期望字符串值。更新会导致替换。
- block_device_mapping¶
- 此服务器的块设备映射。期望列表值。更新会导致替换。列表内容
- 期望 Map 值。更新会导致替换。Map 属性
- delete_on_termination¶
- 可选。指示服务器终止时是否应删除卷。期望布尔值。更新会导致替换。
- device_name¶
- 必需。卷将在系统中的设备名处附加，位于 /dev/device_name。此值通常是 vda。期望字符串值。更新会导致替换。
- snapshot_id¶
- 可选。创建卷的快照的 ID。期望字符串值。更新会导致替换。值必须为 cinder.snapshot 类型
- volume_id¶
- 可选。启动卷的 ID。volume_id 或 snapshot_id 只能提供一个。期望字符串值。更新会导致替换。值必须为 cinder.volume 类型
- volume_size¶
- 可选。卷的大小（单位 GB）。留空可让 Compute 服务推断大小。期望整数值。更新会导致替换。
- block_device_mapping_v2¶
-
此服务器的块设备映射 v2。期望列表值。更新会导致替换。列表内容
- 期望 Map 值。更新会导致替换。Map 属性
- boot_index¶
- 可选。用于对启动磁盘进行排序的整数。如果未指定，则为可启动源（卷、快照、镜像）设置“0”；为不可启动源设置“-1”。期望整数值。更新会导致替换。
- delete_on_termination¶
- 可选。指示服务器终止时是否应删除卷。对于卷、快照或镜像，默认为“False”；对于交换或临时存储，默认为“True”。期望布尔值。更新会导致替换。
- device_name¶
- 可选。卷将在系统中的设备名处附加，位于 /dev/device_name。此值通常是 vda。期望字符串值。更新会导致替换。
- device_type¶
- 可选。设备类型：目前我们只能区分 disk 和 cdrom。期望字符串值。更新会导致替换。允许值：“cdrom”、“disk”
- disk_bus¶
- 可选。设备总线：如果省略，hypervisor 驱动程序将选择合适的默认值。期望字符串值。更新会导致替换。允许值：“ide”、“lame_bus”、“scsi”、“usb”、“virtio”
- ephemeral_format¶
-
可选。本地临时块设备的格式。如果未指定格式，则使用 nova 配置文件中定义的默认值。期望字符串值。更新会导致替换。允许值：“ext2”、“ext3”、“ext4”、“xfs”、“ntfs”
- ephemeral_size¶
-
可选。本地临时块设备的大小（单位 GB）。期望整数值。更新会导致替换。值必须至少为 1。
- image¶
-
可选。创建卷的镜像的 ID 或名称。期望字符串值。更新会导致替换。值必须为 glance.image 类型
- snapshot_id¶
- 可选。创建卷的快照的 ID。期望字符串值。更新会导致替换。值必须为 cinder.snapshot 类型
- swap_size¶
- 可选。交换空间的大小（单位 MB）。期望整数值。更新会导致替换。
- volume_id¶
- 可选。volume_id 可以是服务器的启动设备或非启动设备。期望字符串值。更新会导致替换。值必须为 cinder.volume 类型
- volume_size¶
- 可选。块设备的大小（单位 GB）。如果省略，hypervisor 驱动程序将计算大小。期望整数值。更新会导致替换。
- config_drive¶
- 如果为 True，则在服务器上启用配置驱动器。期望布尔值。更新会导致替换。
- deployment_swift_data¶
-
用于存储服务器资源的部署数据的 Swift 容器和对象。该参数是一个映射值，具有“container”和“object”键，值为相应的容器和对象名称。software_config_transport 参数必须设置为 POLL_TEMP_URL 才能使用 swift。如果未指定且 software_config_transport 设置为 POLL_TEMP_URL，则将根据资源名称自动创建一个容器，对象名称将是生成的 uuid。期望 Map 值。可以在不替换的情况下更新。默认为
{}Map 属性 - diskConfig¶
- 控制服务器创建时磁盘的分区方式。期望字符串值。更新会导致替换。允许值：“AUTO”、“MANUAL”
- flavor_update_policy¶
- 更新 flavor 的策略；通过请求服务器调整大小或替换整个服务器。期望字符串值。可以在不替换的情况下更新。默认为
"RESIZE"允许值：“RESIZE”、“REPLACE” - image¶
- 启动镜像的 ID 或名称。期望字符串值。可以在不替换的情况下更新。值必须为 glance.image 类型
- image_update_policy¶
- 更新 image-id 的策略；通过请求服务器重建或替换整个服务器。期望字符串值。可以在不替换的情况下更新。默认为
"REBUILD"允许值：“REBUILD”、“REPLACE”、“REBUILD_PRESERVE_EPHEMERAL” - key_name¶
- 注入服务器的密钥对名称。期望字符串值。更新会导致替换。值必须是 nova.keypair 类型
- metadata¶
- 要与此服务器关联的任意键/值元数据。键和值都必须小于或等于 255 个字符。非字符串值将被序列化为 JSON（序列化后的字符串必须小于或等于 255 个字符）。期望 Map 值。可以在不替换的情况下更新。默认为
{} - name¶
- 服务器名称。期望字符串值。可以在不替换的情况下更新。
- networks¶
- 要添加到此服务器的 NIC 的有序列表，包含连接的网络、固定 IP、端口等信息。期望列表值。可以在不替换的情况下更新。列表内容
- 期望 Map 值。可以在不替换的情况下更新。Map 属性
- allocate_network¶
-
可选。network 的特殊字符串值，auto：表示将使用项目中已有的网络，或者如果不存在，将为项目自动创建一个；none：表示不会为创建的服务器分配任何网络。自版本“2.37”起支持 Nova API。此属性不能与其他网络键一起使用。期望字符串值。可以在不替换的情况下更新。允许值：“none”、“auto”
- fixed_ip¶
- 可选。要为请求的网络上创建的端口指定的固定 IP 地址。期望字符串值。可以在不替换的情况下更新。值必须是 ip_addr 类型
- floating_ip¶
-
可选。要关联的浮动 IP 的 ID。期望字符串值。可以在不替换的情况下更新。
- network¶
- 可选。创建端口的网络名称或 ID。期望字符串值。可以在不替换的情况下更新。值必须是 neutron.network 类型
- port¶
- 可选。要与此服务器关联的现有端口的 ID。期望字符串值。可以在不替换的情况下更新。值必须是 neutron.port 类型
- port_extra_properties¶
-
字典，包含端口的扩展属性。仅当未指定 port 属性用于创建端口时使用。期望 Map 值。可以在不替换的情况下更新。Map 属性
- admin_state_up¶
- 可选。此端口的管理状态。期望布尔值。可以在不替换的情况下更新。默认为
true - allowed_address_pairs¶
- 允许通过端口的其他 MAC/IP 地址对。期望列表值。可以在不替换的情况下更新。列表内容
- binding:vnic_type¶
-
可选。要在 neutron 端口上绑定的 vnic 类型。为了支持 SR-IOV PCI 直通网络，您可以请求将 neutron 端口实现为普通（虚拟网卡）、直接（pci 直通）或 macvtap（带 tap 类软件接口的虚拟接口）。请注意，这仅适用于支持 binding 扩展的 Neutron 部署。期望字符串值。可以在不替换的情况下更新。默认为
"normal"允许值：“normal”、“direct”、“macvtap”、“direct-physical”、“baremetal”、“virtio-forwarder”、“smart-nic” - mac_address¶
- 可选。要为此端口提供的 MAC 地址。neutron 中此属性的默认更新策略是仅允许管理员角色。期望字符串值。可以在不替换的情况下更新。值必须是 mac_addr 类型
- no_fixed_ips¶
-
可选。禁用端口上所有固定 IP 的标志。期望布尔值。可以在不替换的情况下更新。默认为
false - port_security_enabled¶
-
可选。启用/禁用端口上端口安全性的标志。当禁用此功能（设置为 False）时，将不会进行任何数据包过滤，例如安全组和地址对。期望布尔值。可以在不替换的情况下更新。
- propagate_uplink_status¶
-
可选。启用/禁用端口上上行链路状态传播的标志。期望布尔值。可以在不替换的情况下更新。
- qos_policy¶
-
可选。要附加到此端口的 QoS 策略的名称或 ID。期望字符串值。可以在不替换的情况下更新。值必须是 neutron.qos_policy 类型
- value_specs¶
- 要在请求中包含的额外参数。期望 Map 值。可以在不替换的情况下更新。默认为
{}
- subnet¶
-
可选。用于在端口上分配 IP 地址的子网。用于创建端口，基于派生属性。如果指定了子网，则网络属性是可选的。期望字符串值。可以在不替换的情况下更新。
- tag¶
-
可选。端口标签。Heat 会忽略此属性上的任何更新，因为 nova 不支持它。期望字符串值。可以在不替换的情况下更新。
- reservation_id¶
- 一组服务器请求的 UUID。期望字符串值。更新会导致替换。
- scheduler_hints¶
- 客户端提供的任意键值对，用于帮助启动服务器。期望 Map 值。更新会导致替换。
- security_groups¶
- 安全组名称或 ID 列表。不能与已关联 neutron 端口的服务器一起使用；应改为将安全组分配给端口。期望列表值。更新会导致替换。默认为
[] - software_config_transport¶
- 服务器应如何接收软件配置所需的元数据。POLL_SERVER_CFN 允许调用 cfn API 操作 DescribeStackResource，并使用提供的密钥对进行身份验证。POLL_SERVER_HEAT 允许使用提供的 keystone 凭证调用 Heat API 资源显示。POLL_TEMP_URL 将创建一个 TempURL 并填充元数据以供轮询。ZAQAR_MESSAGE 将创建一个专用的 zaqar 队列并发布元数据以供轮询。期望字符串值。可以在不替换的情况下更新。默认值为
"POLL_SERVER_CFN"允许值：“POLL_SERVER_CFN”、“POLL_SERVER_HEAT”、“POLL_TEMP_URL”、“ZAQAR_MESSAGE” - user_data¶
- cloud-init 或 CoreOS ignition 使用的用户数据脚本。默认情况下，更改会导致资源被替换，但可以通过设置 `user_data_update_policy` 属性完全忽略。期望字符串值。可以在不替换的情况下更新。默认为
"" - user_data_format¶
- user_data 应如何格式化为服务器。对于 HEAT_CFNTOOLS，user_data 作为 heat-cfntools cloud-init 启动配置数据的一部分进行捆绑。对于 RAW，user_data 未经修改地传递给 Nova。对于 SOFTWARE_CONFIG，user_data 作为软件配置数据的一部分进行捆绑，元数据从任何关联的 SoftwareDeployment 资源派生。如果 user_data 是 CoreOS ignition（json）格式，则元数据将由 Heat 自动注入到 user_data 中。期望字符串值。更新会导致替换。默认为
"HEAT_CFNTOOLS"允许值：“HEAT_CFNTOOLS”、“RAW”、“SOFTWARE_CONFIG” - user_data_update_policy¶
-
更新 user_data 的策略；通过忽略它，替换整个服务器，或重建服务器。期望字符串值。可以在不替换的情况下更新。默认为
"REPLACE"允许值：“REPLACE”、“IGNORE”、“REBUILD” - personality¶
-
启动服务器时要在服务器上创建/覆盖的文件映射。键是文件名，值是文件内容。期望 Map 值。更新会导致替换。默认为
{}
属性¶
- accessIPv4¶
-
服务器的手动分配的备用公共 IPv4 地址。
- accessIPv6¶
-
服务器的手动分配的备用公共 IPv6 地址。
- addresses¶
-
包含所有网络地址的字典，以及相应的 port_id 和子网。每个网络在字典中都有两个键，它们是网络名称和网络 ID。可以通过以下表达式获取端口 ID： ``{get_attr: [<server>, addresses, <network name_or_id>, 0, port]}``。可以通过以下表达式获取子网： ``{get_attr: [<server>, addresses, <network name_or_id>, 0, subnets]}``。可以通过以下表达式获取网络： ``{get_attr: [<server>, addresses, <network name_or_id>, 0, network]}``。
- console_urls¶
-
服务器控制台的 URL。要获取特定的控制台类型，可以将请求的类型作为参数传递给 get_attr 函数，例如 get_attr: [ <server>, console_urls, novnc ]。当前支持的类型为 novnc、xvpvnc、spice-html5、rdp-html5、serial 和 webmks。
- instance_name¶
AWS 兼容的实例名称。
- name¶
服务器名称。
- networks¶
已分配的网络地址的字典，格式为：“public”:[ip1, ip2…], “private”:[ip3, ip4], “public_uuid”:[ip1, ip2…], “private_uuid”:[ip3, ip4]。每个网络在字典中都有两个键，它们是网络名称和网络 ID。
- os_collect_config¶
-
服务器本地代理的 os-collect-config 配置，用于连接到 Heat 以检索部署数据。
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Nova::Server
properties:
admin_pass: String
availability_zone: String
block_device_mapping: [{"device_name": String, "volume_id": String, "snapshot_id": String, "volume_size": Integer, "delete_on_termination": Boolean}, {"device_name": String, "volume_id": String, "snapshot_id": String, "volume_size": Integer, "delete_on_termination": Boolean}, ...]
block_device_mapping_v2: [{"device_name": String, "volume_id": String, "image_id": String, "image": String, "snapshot_id": String, "swap_size": Integer, "ephemeral_size": Integer, "ephemeral_format": String, "device_type": String, "disk_bus": String, "boot_index": Integer, "volume_size": Integer, "delete_on_termination": Boolean}, {"device_name": String, "volume_id": String, "image_id": String, "image": String, "snapshot_id": String, "swap_size": Integer, "ephemeral_size": Integer, "ephemeral_format": String, "device_type": String, "disk_bus": String, "boot_index": Integer, "volume_size": Integer, "delete_on_termination": Boolean}, ...]
config_drive: Boolean
deployment_swift_data: {"container": String, "object": String}
diskConfig: String
flavor: String
flavor_update_policy: String
image: String
image_update_policy: String
key_name: String
metadata: {...}
name: String
networks: [{"uuid": String, "network": String, "allocate_network": String, "fixed_ip": String, "port": String, "port_extra_properties": {"value_specs": {...}, "admin_state_up": Boolean, "mac_address": String, "allowed_address_pairs": [{"mac_address": String, "ip_address": String}, {"mac_address": String, "ip_address": String}, ...], "binding:vnic_type": String, "port_security_enabled": Boolean, "qos_policy": String, "propagate_uplink_status": Boolean, "no_fixed_ips": Boolean}, "subnet": String, "floating_ip": String, "tag": String}, {"uuid": String, "network": String, "allocate_network": String, "fixed_ip": String, "port": String, "port_extra_properties": {"value_specs": {...}, "admin_state_up": Boolean, "mac_address": String, "allowed_address_pairs": [{"mac_address": String, "ip_address": String}, {"mac_address": String, "ip_address": String}, ...], "binding:vnic_type": String, "port_security_enabled": Boolean, "qos_policy": String, "propagate_uplink_status": Boolean, "no_fixed_ips": Boolean}, "subnet": String, "floating_ip": String, "tag": String}, ...]
reservation_id: String
scheduler_hints: {...}
security_groups: [Value, Value, ...]
software_config_transport: String
tags: [String, String, ...]
user_data: String
user_data_format: String
user_data_update_policy: String
OS::Nova::ServerGroup¶
用于管理 Nova 服务器组的资源。
服务器组允许您确保实例（VM/VPS）位于同一 hypervisor 主机上或不同主机上。
可选属性¶
属性¶
- show¶
资源的详细信息。
HOT 语法¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Nova::ServerGroup
properties:
name: String
policies: [String, String, ...]
rules: {"max_server_per_host": Number}
OS::Octavia::AvailabilityZone¶
用于创建 octavia 可用区域的资源。
此资源用于创建和管理 octavia 可用区域，这允许调整负载均衡器的功能。
必需属性¶
- availability_zone_profile¶
- 可用区域配置文件的 ID 或名称。期望字符串值。更新会导致替换。值必须是 octavia.availabilityzoneprofile 类型
可选属性¶
属性¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Octavia::AvailabilityZone
properties:
availability_zone_profile: String
description: String
enabled: Boolean
name: String
OS::Octavia::AvailabilityZoneProfile¶
用于创建 octavia 可用区配置资源的资源。
此资源创建并管理 octavia 可用区配置，这允许调整负载均衡器的功能。
Required Properties¶
- availability_zone_data¶
- 包含可用区元数据的 JSON 字符串。期望字符串值。可以在不替换的情况下更新。Value must be of type json_string
Optional Properties¶
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Octavia::AvailabilityZoneProfile
properties:
availability_zone_data: String
name: String
provider_name: String
OS::Octavia::Flavor¶
用于创建 octavia 实例的资源。
此资源创建并管理 octavia 实例，这允许调整负载均衡器的功能。
Required Properties¶
- flavor_profile¶
- 实例配置的 ID 或名称。期望字符串值。更新会导致替换。Value must be of type octavia.flavorprofile
Optional Properties¶
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Octavia::Flavor
properties:
description: String
enabled: Boolean
flavor_profile: String
name: String
OS::Octavia::FlavorProfile¶
用于创建 octavia 实例配置资源的资源。
此资源创建并管理 octavia 实例配置，这允许调整负载均衡器的功能。
Required Properties¶
- flavor_data¶
- 包含实例元数据的 JSON 字符串。期望字符串值。可以在不替换的情况下更新。Value must be of type json_string
Optional Properties¶
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Octavia::FlavorProfile
properties:
flavor_data: String
name: String
provider_name: String
OS::Octavia::HealthMonitor¶
处理负载均衡器健康检查的资源。
此资源创建并管理 octavia 健康检查，用于监控负载均衡服务器的状态。
Required Properties¶
- delay¶
- 成员之间定期连接的最小时间（秒）。期望整数值。可以在不替换的情况下更新。该值必须至少为 0。
- max_retries¶
- 在将成员状态更改为 INACTIVE 之前，允许的最大连接失败次数。期望整数值。可以在不替换的情况下更新。The value must be in the range 1 to 10.
- pool¶
- 负载均衡池的 ID 或名称。期望字符串值。更新会导致替换。Value must be of type octavia.pool
- timeout¶
- 健康检查在超时之前等待连接建立的最大秒数。期望整数值。可以在不替换的情况下更新。该值必须至少为 0。
- type¶
- 预定义的健康检查类型之一。期望字符串值。更新会导致替换。Allowed values: “PING”, “TCP”, “HTTP”, “HTTPS”, “UDP-CONNECT”
Optional Properties¶
- admin_state_up¶
- 健康检查的管理状态。期望布尔值。可以在不替换的情况下更新。默认为
true - expected_codes¶
- 用于声明成员健康的响应中预期的 HTTP 状态码。指定以下值之一：单个值，如 200。列表，如 200, 202。范围，如 200-204。期望字符串值。可以在不替换的情况下更新。
- http_method¶
- 类型为 HTTP 的健康检查使用的 HTTP 方法。期望字符串值。可以在不替换的情况下更新。Allowed values: “GET”, “HEAD”, “POST”, “PUT”, “DELETE”, “TRACE”, “OPTIONS”, “CONNECT”, “PATCH”
- tenant_id¶
- 拥有健康检查的租户的 ID。期望字符串值。更新会导致替换。
- url_path¶
- 健康检查用于测试成员健康状态的 HTTP 请求中使用的 HTTP 路径。有效值为以斜杠（/）开头的字符串。期望字符串值。可以在不替换的情况下更新。
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Octavia::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::Octavia::L7Policy¶
管理 octavia L7 策略的资源。
此资源管理 L7 策略，它代表 L7 规则的集合。L7 策略持有规则匹配时应执行的操作（重定向到池、重定向到 URL、拒绝）。L7 策略持有监听器 ID，因此监听器可以评估 L7 策略的集合。L7 策略在特定监听器下的顺序是，第一个返回匹配的 l7Policy 将被执行。当没有策略匹配时，请求将被转发到 listener.default_pool_id。
Required Properties¶
Optional Properties¶
- admin_state_up¶
- 策略的管理状态。期望布尔值。可以在不替换的情况下更新。默认为
true - description¶
- 策略的描述。期望字符串值。可以在不替换的情况下更新。
- name¶
- 策略的名称。期望字符串值。可以在不替换的情况下更新。
- position¶
- L7 策略在有序策略列表中的位置。必须是从 1 开始的整数。如果未指定，策略将放置在现有策略列表的末尾。预期的数字值。可以在不替换的情况下更新。值必须至少为 1。
- redirect_pool¶
- 用于 REDIRECT_TO_POOL 操作类型的池的 ID 或名称。期望字符串值。可以在不替换的情况下更新。Value must be of type octavia.pool
- redirect_url¶
- 用于 REDIRECT_TO_URL 操作类型的 URL。这应该是一个有效的 URL 字符串。期望字符串值。可以在不替换的情况下更新。
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Octavia::L7Policy
properties:
action: String
admin_state_up: Boolean
description: String
listener: String
name: String
position: Number
redirect_pool: String
redirect_url: String
OS::Octavia::L7Rule¶
管理 octavia L7 规则的资源。
此资源管理 L7 规则，它代表了一组属性，这些属性定义了应匹配的请求部分以及如何匹配。
Required Properties¶
- compare_type¶
- 规则比较类型。期望字符串值。可以在不替换的情况下更新。Allowed values: “REGEX”, “STARTS_WITH”, “ENDS_WITH”, “CONTAINS”, “EQUAL_TO”
- l7policy¶
- 此规则所属的 L7 策略的 ID 或名称。期望字符串值。更新会导致替换。Value must be of type octavia.l7policy
- type¶
- 规则类型。期望字符串值。可以在不替换的情况下更新。Allowed values: “HOST_NAME”, “PATH”, “FILE_TYPE”, “HEADER”, “COOKIE”
- value¶
- 要比较的值。期望字符串值。可以在不替换的情况下更新。
Optional Properties¶
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Octavia::L7Rule
properties:
admin_state_up: Boolean
compare_type: String
invert: Boolean
key: String
l7policy: String
type: String
value: String
OS::Octavia::Listener¶
管理 octavia 监听器的资源。
此资源创建并管理 Neutron octavia 监听器，它们代表 VIP 的监听终端。
Required Properties¶
Optional Properties¶
- admin_state_up¶
- 此监听器的管理状态。期望布尔值。可以在不替换的情况下更新。默认为
true - allowed_cidrs¶
-
IPv4、IPv6 或两者的 CIDR 列表。默认情况下全部允许。当提供 CIDR 列表时，默认切换为拒绝所有。期望列表值。可以在不替换的情况下更新。列表内容
- 可选。期望字符串值。可以在不替换的情况下更新。值必须是 net_cidr 类型
- connection_limit¶
- 此负载均衡器允许的最大连接数。默认为 -1，表示无限。期望整数值。可以在不替换的情况下更新。Defaults to
-1值必须至少为 -1。 - default_pool¶
- 此监听器的默认池的 ID 或名称。期望字符串值。可以在不替换的情况下更新。Value must be of type octavia.pool
- default_tls_container_ref¶
- 用于检索 TLS 信息的默认 TLS 容器引用。期望字符串值。可以在不替换的情况下更新。
- description¶
- 此监听器的描述。期望字符串值。可以在不替换的情况下更新。默认为
"" - name¶
- 此监听器的名称。期望字符串值。可以在不替换的情况下更新。
- sni_container_refs¶
- 用于 SNI 的 TLS 容器引用列表。期望列表值。可以在不替换的情况下更新。
- tenant_id¶
- 拥有此监听器的租户的 ID。期望字符串值。更新会导致替换。
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Octavia::Listener
properties:
admin_state_up: Boolean
allowed_cidrs: [String, String, ...]
connection_limit: Integer
default_pool: String
default_tls_container_ref: String
description: String
loadbalancer: String
name: String
protocol: String
protocol_port: Integer
sni_container_refs: [Value, Value, ...]
tenant_id: String
OS::Octavia::LoadBalancer¶
用于创建 octavia 负载均衡器的资源。
此资源创建并管理 octavia 负载均衡器，这允许在服务器之间引导流量。
Required Properties¶
- vip_subnet¶
- 用于分配 VIP 地址的子网的名称或 ID。期望字符串值。更新会导致替换。值必须是 neutron.subnet 类型
Optional Properties¶
- admin_state_up¶
- 此负载均衡器的管理状态。期望布尔值。可以在不替换的情况下更新。默认为
true - availability_zone¶
-
负载均衡器的可用区。期望字符串值。更新会导致替换。Value must be of type octavia.availabilityzone
- description¶
- 此负载均衡器的描述。期望字符串值。可以在不替换的情况下更新。默认为
"" - flavor¶
-
负载均衡器实例的名称或 ID。期望字符串值。更新会导致替换。Value must be of type octavia.flavor
- name¶
- 此负载均衡器的名称。期望字符串值。可以在不替换的情况下更新。
- provider¶
- 此负载均衡器的提供者。期望字符串值。更新会导致替换。
- tenant_id¶
- 拥有此负载均衡器的租户的 ID。只有管理员用户可以指定其自己的租户 ID。期望字符串值。更新会导致替换。值必须为 keystone.project 类型
- vip_address¶
- VIP 的 IP 地址。期望字符串值。更新会导致替换。值必须是 ip_addr 类型
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Octavia::LoadBalancer
properties:
admin_state_up: Boolean
availability_zone: String
description: String
flavor: String
name: String
provider: String
tenant_id: String
vip_address: String
vip_subnet: String
OS::Octavia::Pool¶
管理 Octavia 池的资源。
此资源管理 octavia LBaaS 池，它们代表一组节点。池定义节点所在的子网、负载均衡算法以及节点本身。
Required Properties¶
Optional Properties¶
- admin_state_up¶
- 此池的管理状态。期望布尔值。可以在不替换的情况下更新。默认为
true - description¶
- 此池的描述。期望字符串值。可以在不替换的情况下更新。默认为
"" - listener¶
- 要与此池关联的监听器名称或 ID。期望字符串值。更新会导致替换。Value must be of type octavia.listener
- loadbalancer¶
- 要与此池关联的负载均衡器名称或 ID。期望字符串值。更新会导致替换。Value must be of type octavia.loadbalancer
- name¶
- 此池的名称。期望字符串值。可以在不替换的情况下更新。
- session_persistence¶
- 会话持久性配置。期望 Map 值。可以在不替换的情况下更新。Map 属性
- type¶
- 必需。实现会话持久性功能的类型。期望字符串值。可以在不替换的情况下更新。Allowed values: “SOURCE_IP”, “HTTP_COOKIE”, “APP_COOKIE”
- tls_enabled¶
-
启用后端成员重新加密。期望布尔值。可以在不替换的情况下更新。默认为
false
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Octavia::Pool
properties:
admin_state_up: Boolean
description: String
lb_algorithm: String
listener: String
loadbalancer: String
name: String
protocol: String
session_persistence: {"type": String, "cookie_name": String}
tls_enabled: Boolean
OS::Octavia::PoolMember¶
管理 Octavia 池成员的资源。
池成员代表单个后端节点。
Required Properties¶
Optional Properties¶
- admin_state_up¶
- 池成员的管理状态。期望布尔值。可以在不替换的情况下更新。默认为
true - monitor_address¶
- 健康检查可以使用该地址进行健康检查的备用 IP 地址。期望字符串值。更新会导致替换。值必须是 ip_addr 类型
- monitor_port¶
- 健康检查可以使用该端口进行健康检查的备用端口。期望整数值。更新会导致替换。值必须在 1 到 65535 之间。
- subnet¶
- 此成员的子网名称或 ID。期望字符串值。更新会导致替换。值必须是 neutron.subnet 类型
- weight¶
- 池中池成员的权重（默认为 1）。期望整数值。可以在不替换的情况下更新。默认值为
1The value must be in the range 0 to 256.
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Octavia::PoolMember
properties:
address: String
admin_state_up: Boolean
monitor_address: String
monitor_port: Integer
pool: String
protocol_port: Integer
subnet: String
tags: [Value, Value, ...]
weight: Integer
OS::Octavia::Quota¶
用于创建 Octavia 配额的资源。
Ocatavia 配额用于管理 Octavia 的操作限制。目前，此资源可以管理 Octavia 的配额：
healthmonitor
listener
loadbalancer
pool
member（成员）
请注意，默认的 octavia 安全策略对该资源的使用仅限于管理员。管理员应谨慎为每个项目创建单个 Octavia 配额资源，否则将难以正确管理配额。
Required Properties¶
- project¶
- 设置配额的项目名称或 ID。期望字符串值。更新会导致替换。值必须为 keystone.project 类型
Optional Properties¶
- healthmonitor¶
- 健康检查数量的配额。将值设置为 -1 表示无限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- listener¶
- 监听器数量的配额。将值设置为 -1 表示无限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- loadbalancer¶
- 负载均衡器数量的配额。将值设置为 -1 表示无限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- member¶
- 成员数量的配额。将值设置为 -1 表示无限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
- pool¶
- 池数量的配额。将值设置为 -1 表示无限制。期望整数值。可以在不替换的情况下更新。值必须至少为 -1。
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Octavia::Quota
properties:
healthmonitor: Integer
listener: Integer
loadbalancer: Integer
member: Integer
pool: Integer
project: String
OS::Swift::Container¶
管理 Swift 容器的资源。
容器定义了对象的命名空间。在两个不同容器中同名对象代表两个不同的对象。
Optional Properties¶
- PurgeOnDelete¶
-
如果为 True，则在删除容器时删除容器中的所有对象。否则，删除非空容器将导致错误。期望布尔值。更新会导致替换。默认为
false - X-Account-Meta¶
- 要与账户关联的用户定义元数据映射。映射中的每个键都将设置 X-Account-Meta-{key} 标头及其对应的值。期望 Map 值。更新会导致替换。默认为
{} - X-Container-Meta¶
- 要与容器关联的用户定义元数据映射。映射中的每个键都将设置 X-Container-Meta-{key} 标头及其对应的值。期望 Map 值。更新会导致替换。默认为
{} - X-Container-Read¶
- 指定容器中对象读取权限的 ACL。期望字符串值。更新会导致替换。
- X-Container-Write¶
- 指定写入容器对象权限的 ACL。期望字符串值。更新会导致替换。
- name¶
- 容器的名称。如果未指定，将生成一个唯一的名称。期望字符串值。更新会导致替换。
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Swift::Container
properties:
PurgeOnDelete: Boolean
X-Account-Meta: {...}
X-Container-Meta: {...}
X-Container-Read: String
X-Container-Write: String
name: String
OS::Trove::Cluster¶
管理 Trove 群集的资源。
群集是用于存储数据库群集的非透明群集。
Required Properties¶
- datastore_type¶
- 已注册数据存储类型的名称。期望字符串值。更新会导致替换。长度不能超过 255。
- datastore_version¶
- 已注册数据存储版本的名称。它必须存在于提供的数据存储类型中。默认为使用单个活动版本。如果为提供的数据存储类型存在多个活动版本，则必须指定此参数的显式值。期望字符串值。更新会导致替换。长度不能超过 255。
- instances¶
- 数据库实例列表。期望列表值。更新会导致替换。列表内容
Optional Properties¶
- name¶
- 要创建的群集的名称。期望字符串值。更新会导致替换。长度不能超过 255。
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Trove::Cluster
properties:
datastore_type: String
datastore_version: String
instances: [{"flavor": String, "volume_size": Integer, "networks": [{"network": String, "port": String, "fixed_ip": String}, {"network": String, "port": String, "fixed_ip": String}, ...], "availability_zone": String}, {"flavor": String, "volume_size": Integer, "networks": [{"network": String, "port": String, "fixed_ip": String}, {"network": String, "port": String, "fixed_ip": String}, ...], "availability_zone": String}, ...]
name: String
OS::Trove::Instance¶
OpenStack 云数据库实例资源。
Trove 是 OpenStack 的数据库即服务。它旨在完全在 OpenStack 上运行，目标是允许用户快速轻松地利用关系数据库或非关系数据库的功能，而无需处理复杂的管理任务。
Required Properties¶
Optional Properties¶
- availability_zone¶
- 数据库实例的可用区名称。期望字符串值。更新会导致替换。
- databases¶
- 在创建数据库实例时创建的数据库列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 期望 Map 值。可以在不替换的情况下更新。Map 属性
- character_set¶
- 可选。符号和编码集。期望字符串值。可以在不替换的情况下更新。Defaults to
"utf8" - collate¶
- 可选。用于比较字符集中的字符的规则集。期望字符串值。可以在不替换的情况下更新。Defaults to
"utf8_general_ci" - name¶
- 必需。指定在创建实例时用于创建数据库的数据库名称。期望字符串值。可以在不替换的情况下更新。The length must be no greater than 64.Value must match pattern: [a-zA-Z0-9_-]+[a-zA-Z0-9_@?#\s-]*[a-zA-Z0-9_-]+
- datastore_type¶
- 已注册数据存储类型的名称。期望字符串值。更新会导致替换。长度不能超过 255。
- datastore_version¶
- 已注册数据存储版本的名称。它必须存在于提供的数据存储类型中。默认为使用单个活动版本。如果为提供的数据存储类型存在多个活动版本，则必须指定此参数的显式值。期望字符串值。更新会导致替换。长度不能超过 255。
- name¶
- 要创建的数据库实例的名称。期望字符串值。可以在不替换的情况下更新。长度不能超过 255。
- networks¶
- 要在实例上创建的网络接口列表。期望列表值。更新会导致替换。默认为
[]列表内容 - replica_count¶
-
要创建的副本数量。期望整数值。更新会导致替换。
- replica_of¶
-
要复制的源实例的标识符。期望字符串值。更新会导致替换。
- restore_point¶
- 数据库实例恢复点。期望字符串值。更新会导致替换。
- users¶
- 在创建数据库实例时创建的用户列表。期望列表值。可以在不替换的情况下更新。默认为
[]列表内容- 期望 Map 值。可以在不替换的情况下更新。Map 属性
- databases¶
- 在创建实例时，用户可以访问的数据库名称。期望列表值。可以在不替换的情况下更新。长度必须至少为 1。列表内容
- 可选。期望字符串值。可以在不替换的情况下更新。
- host¶
- 可选。用户被允许连接到数据库的主机。期望字符串值。可以在不替换的情况下更新。Defaults to
"%" - name¶
- 必需。在创建实例时创建用户的用户名。期望字符串值。可以在不替换的情况下更新。The length must be no greater than 16.Value must match pattern: [a-zA-Z0-9_]+[a-zA-Z0-9_@?#\s]*[a-zA-Z0-9_]+
- password¶
- 必需。在创建实例时，这些用户的密码。期望字符串值。可以在不替换的情况下更新。Value must match pattern: [a-zA-Z0-9_]+[a-zA-Z0-9_@?#\s]*[a-zA-Z0-9_]+
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Trove::Instance
properties:
availability_zone: String
databases: [{"character_set": String, "collate": String, "name": String}, {"character_set": String, "collate": String, "name": String}, ...]
datastore_type: String
datastore_version: String
flavor: String
name: String
networks: [{"network": String, "port": String, "fixed_ip": String}, {"network": String, "port": String, "fixed_ip": String}, ...]
replica_count: Integer
replica_of: String
restore_point: String
size: Integer
users: [{"name": String, "password": String, "host": String, "databases": [String, String, ...]}, {"name": String, "password": String, "host": String, "databases": [String, String, ...]}, ...]
OS::Vitrage::Template¶
管理 Vitrage 模板的资源。
Vitrage 模板根据 Vitrage 拓扑图定义条件和操作。例如，如果实例发生“实例宕机”警报，则执行 Mistral 恢复工作流。
VitrageTemplate 资源会根据输入参数生成模板并添加到 Vitrage。
Required Properties¶
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Vitrage::Template
properties:
template_file: String
template_params: {...}
OS::Zaqar::MistralTrigger¶
用于触发 Mistral 工作流的 Zaqar 订阅。
此 Zaqar 订阅类型侦听队列中的消息，并在每次收到消息时触发 Mistral 工作流执行。
Zaqar 消息的内容将通过名为“notification”的环境传递给工作流，因此可以从工作流内部访问：
<% env().notification %>
可以使用 params 属性中的 'env' 键设置其他环境变量。
Required Properties¶
Optional Properties¶
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Zaqar::MistralTrigger
properties:
input: {...}
params: {...}
queue_name: String
ttl: Integer
workflow_id: String
OS::Zaqar::Queue¶
管理 Zaqar 队列的资源。
队列是一个用于分组消息的逻辑实体。理想情况下，每个工作类型创建一个队列。例如，如果您想压缩文件，您将创建一个专门用于此作业的队列。从该队列读取的任何应用程序都只会压缩文件。
Optional Properties¶
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Zaqar::Queue
properties:
metadata: {...}
name: String
OS::Zaqar::SignedQueueURL¶
管理 Zaqar 队列签名 URL 的资源。
签名 URL 允许提供对队列的特定访问，例如用作警报通知。要将签名队列 URL 提供给 Aodh 作为操作 URL，请传递“zaqar://?”后跟签名队列 URL 资源的 query_str 属性。
Required Properties¶
- queue¶
- 要为其创建 URL 的队列实例的名称。期望字符串值。更新会导致替换。
Optional Properties¶
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Zaqar::SignedQueueURL
properties:
methods: [String, String, ...]
paths: [Value, Value, ...]
queue: String
ttl: Integer
OS::Zaqar::Subscription¶
管理 Zaqar 订阅的资源。
Zaqar 订阅会侦听队列中的消息，并通过电子邮件或 webhook 发送通知。
Required Properties¶
Optional Properties¶
Attributes¶
- show¶
资源的详细信息。
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Zaqar::Subscription
properties:
options: {...}
queue_name: String
subscriber: String
ttl: Integer
OS::Zun::Container¶
创建 Zun 容器的资源。
此资源创建 Zun 容器。
Required Properties¶
- image¶
- 镜像的名称或 ID。期望字符串值。更新会导致替换。
Optional Properties¶
- command¶
- 发送命令到容器。期望字符串值。更新会导致替换。
- cpu¶
- 虚拟 CPU 的数量。预期的数字值。可以在不替换的情况下更新。
- environment¶
- 环境变量。期望 Map 值。更新会导致替换。
- hints¶
-
调度器用于选择主机的任意键值对。期望 Map 值。更新会导致替换。
- hostname¶
-
容器的主机名。期望字符串值。更新会导致替换。
- image_driver¶
- 用于拉取容器镜像的镜像驱动。期望字符串值。更新会导致替换。Allowed values: “docker”, “glance”
- image_pull_policy¶
- 决定在启动容器之前是否应拉取镜像的策略。期望字符串值。更新会导致替换。Allowed values: “ifnotpresent”, “always”, “never”
- interactive¶
- 即使未连接，也要保持 STDIN 打开。期望布尔值。更新会导致替换。
- labels¶
- 向容器添加标签映射。可以多次使用。期望 Map 值。更新会导致替换。
- memory¶
- 容器内存大小（MiB）。期望整数值。可以在不替换的情况下更新。
- mounts¶
- 安装在容器内的卷列表。期望列表值。更新会导致替换。列表内容
- name¶
- 容器名称。期望字符串值。可以在不替换的情况下更新。
- networks¶
-
要添加到此服务器的 NIC 的有序列表，包含连接的网络、固定 IP、端口等信息。期望列表值。可以在不替换的情况下更新。列表内容
- restart_policy¶
- 容器退出时要应用的重启策略。可能的值为“no”、“on-failure[:max-retry]”、“always”和“unless-stopped”。期望字符串值。更新会导致替换。
- security_groups¶
-
安全组名称或 ID 列表。期望列表值。更新会导致替换。默认为
[] - tty¶
-
是否为容器分配 TTY。期望布尔值。更新会导致替换。
- workdir¶
- 命令将在其中运行的工作目录。期望字符串值。更新会导致替换。
Attributes¶
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Zun::Container
properties:
command: String
cpu: Number
environment: {...}
hints: {...}
hostname: String
image: String
image_driver: String
image_pull_policy: String
interactive: Boolean
labels: {...}
memory: Integer
mounts: [{"volume_id": String, "volume_size": Integer, "mount_path": String}, {"volume_id": String, "volume_size": Integer, "mount_path": String}, ...]
name: String
networks: [{"network": String, "fixed_ip": String, "port": String}, {"network": String, "fixed_ip": String, "port": String}, ...]
restart_policy: String
security_groups: [Value, Value, ...]
tty: Boolean
workdir: String
