资源编排
概述
资源编排:一款帮助云计算用户简化云资源管理和自动化部署运维的服务。通过资源栈模板,定义所需的云资源、资源间的依赖关系、资源配置等,可实现自动化批量部署和配置资源,轻松管理云资源生命周期,通过API和SDK集成自动化运维能力。
功能特点
- 用户只需创建资源栈模板或修改已有模板,定义所需的云资源、资源间的依赖关系、资源配置等,资源编排将通过编排引擎自动完成所有资源的创建和配置。
- 云平台提供示例模板,也可使用可视化编辑器,快速创建资源栈模板。
- 可根据业务需要,动态调整资源栈模板,从而调整资源栈以灵活应对业务发展需要。
- 如果不再需要某资源栈,可一键删除该栈及栈内所有资源。
- 可重复使用已创建的资源栈模板快速复制整套资源,无需重复配置。
- 可根据业务场景灵活组合云服务,以满足自动化运维的需求。
资源栈
资源栈:资源编排通过资源栈模板快速创建和配置一组资源(以及资源间的依赖关系),这组资源定义为一个资源栈,通过管理资源栈,维护这组资源。
资源栈支持以下操作:
- 创建资源栈
- 查看资源栈信息
- 删除资源栈
登录 ZCF,切换至对应可用区,在主菜单,点击资源中心 > 资源编排 > 资源栈,进入资源栈界面。点击创建资源栈,弹出创建资源栈界面。
创建资源栈
创建资源栈分为以下三步:
资源栈配置。
可参考以下示例输入相应内容:
区域:自动显示当前区域
名称:设置资源栈名称。 命名规则:长度限制1~128字符,输入内容只能包含中文汉字、英文字母、数字、空格和以下7种英文字符
- _ . ( ) : +且不支持以空格开头或结尾简介:可选项,可留空不填
超时设置:设置创建资源栈的超时时限,超时将失败,默认为60分钟
失败回滚:设置创建失败是否清理已创建的资源,默认开启
创建方式:选择创建资源栈方式,本章节以创建LNMP为例。支持以下三种方式:
模板配置。
模板配置项与所选的模板有关,不同类型的资源栈需要输入的参数不同,本章节以创建LNMP为例。
可参考以下示例输入相应内容:
- 镜像:选择创建云主机的镜像
- 计算规格:选择创建云主机的计算规格
- 网络:选择创建云主机的网络
- 该功能通过调用
DecodeStackTemplateAPI实现。 - 开始创建资源栈前,可点击预览查看将要创建的资源列表。
- 创建资源栈需要一定时长,请等待创建完成。
确认信息。
查看将要创建的资源栈,支持跳转修改。
查看资源栈信息
在资源栈界面,选择某一资源栈,查看其详情页,可查看当前创建的资源栈状态和信息,包括:总览、资源、事件、审计。
- 总览:显示资源栈当前状态、所有者、UUID、模板内容等信息,其中模板内容支持修改
- 资源:显示资源栈所包括的全部资源信息
- 事件:显示资源栈生命周期中发生的每一个事件
- 审计:查看此资源栈的相关操作
删除资源栈
如果不再使用某一资源栈,可将该资源栈删除。
- 删除资源栈默认会删除栈内编排创建的所有资源,包括云主机或云盘。
- 若资源栈所对应的模板事先已设置
DeletionPolicy为Retain,栈内编排创建的所有资源将会被保留,详情可参考资源(Resources)章节。
资源栈模板
资源栈模板:一个UTF8编码格式的文件,基于模板可快速创建资源栈,用户在模板中定义所需的云资源、资源间的依赖关系、资源配置等,资源编排将解析模板,自动完成所有资源的创建和配置。
资源栈模板支持以下操作:
- 创建资源栈模板
- 查看模板信息
- 启用模板
- 停用模板
- 从模板创建资源栈
- 修改模板
- 删除模板
创建资源栈模板
登录 ZCF,切换至对应可用区,在主菜单,点击资源中心 > 资源编排 > 资源栈模板,进入资源栈模板界面。点击创建资源栈模板,弹出创建资源栈模板界面。
可参考以下示例输入相应内容:
名称:设置资源栈模板名称。 命名规则:长度限制1~128字符,输入内容只能包含中文汉字、英文字母、数字、空格和以下7种英文字符
- _ . ( ) : +且不支持以空格开头或结尾简介:可选项,可留空不填
创建方式:选择创建资源栈方式。支持以下两种方式:
查看模板信息
在资源栈模板界面,选择某一模板,展开其详情页,可查看当前创建的模板状态和信息,包括:基本属性、资源栈模板内容、审计。
- 基本信息:显示模板当前状态、名称、简介、模板UUID、MD5码等信息,其中名称和简介支持修改
- 资源栈模板内容:显示模板具体内容,关于模板语法的详细介绍,请参考资源栈模板语法章节
- 审计:查看此模板的相关操作
启用/停用模板
- 启用模板:将已停用的模板启用
- 停用模板:将模板停用,停用的模板不能创建资源栈
修改模板
支持在文件编辑器中修改模板。
从模板创建资源栈
在资源栈模板界面,选择需生成的资源栈模板,点击更多操作 > 生成资源栈,弹出创建资源栈界面。可参考资源栈章节填写参数。
删除模板
如果不再使用某一模板,可将该模板删除。
约束条件
- 每个模板文件大小不超过4MB。
- 若通过API提交,则参数大小不可超过64K。
资源栈示例模板
资源栈模板支持以下操作:
- 查看示例模板信息
- 使用示例模板创建资源栈
查看示例模板信息
登录 ZCF,切换至对应可用区,在主菜单,点击资源中心 > 资源编排 > 资源栈模板,进入资源栈模板界面。点击创建资源栈模板,弹出创建资源栈模板界面,选择某一示例模板,进入其详情页,可查看模板状态和信息,包括:总览、审计。
- 总览:显示示例模板的启用状态、UUID、MD5码、模板内容等信息
- 审计:查看此模板的相关操作
使用示例模板生成资源栈
使用示例模板生成资源栈分为以下三步:
资源栈配置。
可参考以下示例输入相应内容:
- 区域:自动显示当前区域
- 名称:设置资源栈名称
- 简介:可选项,可留空不填
- 超时设置:设置创建资源栈的超时时限,超时将失败,默认为60分钟
- 失败回滚:设置创建失败是否清理已创建的资源,默认开启
模板配置。
模板配置项与所选的模板有关,不同类型的资源栈需要输入的参数不同,本章节以ZStack.System.v4.EIP模板为例。
可参考以下示例输入相应内容:
- 计算规格:选择创建云主机的计算规格
- 镜像:选择创建云主机的计算镜像
- 私有网络:选择创建云主机的私有网络
- 公有网络:选择创建弹性IP的公有网络
- 该功能通过调用
DecodeStackTemplateAPI实现。 - 开始创建资源栈前,可点击预览查看将要创建的资源列表。
- 创建资源栈需要一定时长,请等待创建完成。
确认信息。
查看将要创建的资源栈,支持跳转修改。
注意事项
示例模板不允许修改模板内容。
可视化编排
使用可视化编排,可以更直观高效地创建资源栈模板以及显示资源栈结构。打开可视化编排,通过拖曳资源到画布中适当位置,连线创建资源间的依赖关系,并输入需要的参数,即可快速创建资源栈模板,高效编排云资源。
可视化编排界面
登录 ZCF,切换至对应可用区,在主菜单,点击资源中心 > 资源编排 > 可视化编排,进入可视化编排界面。
可视化编排界面分为三个部分:
顶部菜单:可视化资源编辑器的功能菜单。包括:预览模板、生成资源栈、另存为资源栈模板。
左侧菜单:可视化资源编辑器支持的资源列表。可通过拖曳连线直观呈现云资源间的关系,高效编排云资源。目前支持以下资源:
- 云资源池:云主机、云盘
- 网络资源:二层网络、公有网络、扁平网络、VPC网络
- 网络服务:安全组、弹性IP、端口转发、负载均衡、监听器
- 网络设备:VPC路由器
中间部分:可视化资源编辑器的画布,在此进行可视化资源编排。
- 支持撤销、重做、放大、缩小、适应画布、删除、清除、预览、全局参数操作。
- 当画布中资源布局足够多时,可通过拖动缩略框调整画布位置,也可通过滚动鼠标放大缩小画布。
可视化编排
可视化编排分为三个步骤:拖拽资源到画布、编辑资源属性、资源连线
拖拽资源到画布。
以创建扁平网络为例,从左侧资源列表拖拽云主机、扁平网络、二层网络到画布。
编辑资源属性。
资源拖拽至画布后,点击资源图标,可进行属性编辑。
资源连线。
每个资源属性编辑完成后,从连接点通过单击+的方式对资源进行连线。
可视化编排操作
可视化资源编辑器顶部的功能菜单,可对已编辑好的资源进行以下操作。包括:生成资源栈、另存为资源栈模板、预览模板、设置全局参数。
生成资源栈:
点击生成资源栈按钮,将跳转到生成资源栈界面,输入资源栈名称,点击下一步 > 确定按钮,可将编辑好的图形化资源栈模板生成资源栈。
另存为资源栈模板:
点击另存为资源栈模板按钮,将跳转到创建资源栈模板界面,输入资源栈模板名称,点击确定按钮,可将编辑好的图形化资源栈另存为资源栈模板。
预览模板:
点击预览按钮,将编辑好的图形化资源栈模板以代码的形式呈现,进行预览。
资源栈模板语法
资源栈模板是一个UTF8编码格式的文件。
基于模板可快速创建资源栈,用户在模板中定义所需的云资源、资源间的依赖关系、资源配置等,资源编排将解析模板,自动完成所有资源的创建和配置。
资源栈模板结构
资源栈模板结构如下:
{
"ZStackTemplateFormatVersion" : "YYYY-MM-DD",
"Description" : "模板描述信息,可用于说明模板的适用场景、架构说明等。",
"Parameters" : {
// 定义创建资源栈时,用户可以定制化的参数。
},
"Mappings" : {
// 定义映射信息表,映射信息是一种多层的Map结构。
},
"Resources" : {
// 所需资源的详细定义,包括资源间的依赖关系、配置细节等。
},
"Outputs" : {
// 用于输出一些资源属性等有用信息,可以通过API获取输出的内容。
}
ZStackTemplateFormatVersion(必需)模板版本号。
- 格式为:
YYYY-MM-DD
- 格式为:
Description(可选)模板描述信息,可用于说明模板的适用场景、架构说明等。
- 对模板进行详细描述,有利于用户理解模板内容。
Parameters(可选)定义创建资源栈时,用户可以定制化的参数。
- 例如,用户将创建云主机的计算规格设计成一个参数。
- 参数支持默认值。
- 使用参数可以增强模板的灵活性,提高复用性。
- 关于参数(Parameters)的详细介绍,请参考参数(Parameters)章节。
Mappings(可选)定义映射信息表,映射信息是一种多层的Map结构。
- 可通过
Fn::FindInMap函数选择key对应的值。 - 可根据不同的输入参数值作为
key查找映射表。 - 例如,可根据区域不同,自动查找区域-镜像映射表,从而找到适用的镜像。
- 关于映射(Mappings)的详细介绍,请参考映射(Mappings)章节。
- 可通过
Resources(可选)所需资源的详细定义,包括资源间的依赖关系、配置细节等。
- 关于资源(Resources)的详细介绍,请参考资源(Resources)章节。
Outputs(可选)用于输出一些资源属性等有用信息,可以通过API获取输出的内容。
- 关于输出(Outputs)的详细介绍,请参考输出(Outputs)章节。
Action类型
| Action类型 | 说明 |
|---|---|
| ZStack::Action::AddIpRange | 添加IP地址范围(AddIpRange) |
| ZStack::Action::AddDnsToL3Network | 向三层网络添加DNS(AddDnsToL3Network) |
| ZStack::Action::AddVmToAffinityGroup | 添加云主机到亲和组(AddVmToAffinityGroup) |
| ZStack::Action::AddVRouterRouteEntry | 添加路由条目(AddVRouterRouteEntry) |
| ZStack::Action::AddCertificateToLoadBalancerListener | 添加证书到负载均衡(AddCertificateToLoadBalancerListener) |
| ZStack::Action::AddIpRangeByNetworkCidr | 通过网络CIDR添加IP地址范围(AddIpRangeByNetworkCidr) |
| ZStack::Action::AddVmNicToLoadBalancer | 添加云主机网卡到负载均衡器(AddVmNicToLoadBalancer) |
| ZStack::Action::AddVmNicToSecurityGroup | 添加虚拟机网卡到安全组(AddVmNicToSecurityGroup) |
| ZStack::Action::AddRemoteCidrsToIPsecConnection | 添加远端CIDR到IPsec连接(AddRemoteCidrsToIPsecConnection) |
| ZStack::Action::AttachEip | 绑定弹性IP(AttachEip) |
| ZStack::Action::AttachDataVolumeToVm | 挂载云盘到云主机上(AttachDataVolumeToVm) |
| ZStack::Action::AttachPortForwardingRule | 挂载规则到虚拟机网卡上(AttachPortForwardingRule) |
| ZStack::Action::AttachIsoToVmInstance | 加载ISO到云主机(AttachIsoToVmInstance) |
| ZStack::Action::AttachPciDeviceToVm | 绑定PCI设备到云主机(AttachPciDeviceToVm) |
| ZStack::Action::AttachUsbDeviceToVm | 云主机加载物理机USB设备(AttachUsbDeviceToVm) |
| ZStack::Action::AttachL2NetworkToCluster | 挂载二层网络到集群(AttachL2NetworkToCluster) |
| ZStack::Action::AttachL3NetworkToVm | 加载L3网络到云主机(AttachL3NetworkToVm) |
| ZStack::Action::AttachNetworkServiceToL3Network | 挂载网络服务到三层网络(AttachNetworkServiceToL3Network) |
| ZStack::Action::AttachSecurityGroupToL3Network | 挂载安全组到L3网络(AttachSecurityGroupToL3Network) |
| ZStack::Action::AttachL3NetworksToIPsecConnection | 添加三层网络到IPsec连接(AttachL3NetworksToIPsecConnection) |
| ZStack::Action::AttachVRouterRouteTableToVRouter | 绑定路由表到路由器(AttachVRouterRouteTableToVRouter) |
| ZStack::Action::AddCertificateToLoadBalancerListener | 添加证书到负载均衡(AddCertificateToLoadBalancerListener) |
| ZStack::Action::AddHostRouteToL3Network | 向三层网络添加主机路由(AddHostRouteToL3Network) |
| ZStack::Action::SetL3NetworkRouterInterfaceIp | 设置三层网络路由器接口IP(SetL3NetworkRouterInterfaceIp) |
| ZStack::Action::AddDnsToVpcRouter | 向VPC路由器添加DNS(AddDnsToVpcRouter) |
| ZStack::Action::AttachTagToResources | 加载资源标签(AttachTagToResources) |
| ZStack::Action::UpdateTag | 更新资源标签(UpdateTag) |
Resource类型
| Resouce类型 | 说明 |
|---|---|
| ZStack::Resource::VmInstance | 创建云主机(CreateVMInstance) |
| ZStack::Resource::DataVolume | 创建云盘(CreateDataVolume) |
| ZStack::Resource::Image | 添加镜像(AddImage) |
| ZStack::Resource::RootVolumeTemplate | 从根云盘创建根云盘镜像(CreateRootVolumeTemplateFromRootVolume) |
| ZStack::Resource::DataVolumeTemplate | 从云盘创建数据云盘镜像(CreateDataVolumeTemplateFromVolume) |
| ZStack::Resource::AffinityGroup | 创建亲和组(CreateAffinityGroup) |
| ZStack::Resource::InstanceOffering | 创建云主机规格(CreateInstanceOffering) |
| ZStack::Resource::DiskOffering | 创建云盘规格(CreateDiskOffering) |
| ZStack::Resource::L2VxlanNetworkPool | 创建VXLAN网络池(CreateL2VxlanNetworkPool) |
| ZStack::Resource::L2NoVlanNetwork | 创建普通二层网络(CreateL2NoVlanNetwork) |
| ZStack::Resource::L2VlanNetwork | 创建二层VLAN网络(CreateL2VlanNetwork) |
| ZStack::Resource::L2VxlanNetwork | 创建VXLAN网络(CreateL2VxlanNetwork) |
| ZStack::Resource::L3Network | 创建三层网络(CreateL3Network) |
| ZStack::Resource::VRouterRouteTable | 创建路由表(CreateVRouterRouteTable) |
| ZStack::Resource::VpcVRouter | 创建VPC路由器(CreateVpcVRouter) |
| ZStack::Resource::SecurityGroup | 创建安全组(CreateSecurityGroup) |
| ZStack::Resource::SecurityGroupRule | 添加规则到安全组(AddSecurityGroupRule) |
| ZStack::Resource::Vip | 创建虚拟IP(CreateVip) |
| ZStack::Resource::Eip | 创建弹性IP(CreateEip) |
| ZStack::Resource::PortForwardingRule | 创建端口转发规则(CreatePortForwardingRule) |
| ZStack::Resource::LoadBalancer | 创建负载均衡器(CreateLoadBalancer) |
| ZStack::Resource::LoadBalancerListener | 创建负载均衡监听器(CreateLoadBalancerListener) |
| ZStack::Resource::IPsecConnection | 创建IPsec连接(CreateIPsecConnection) |
| ZStack::Resource::VirtualRouterOffering | 创建路由器规格(CreateVirtualRouterOffering) |
| ZStack::Resource::VniRange | 创建VNI Range(CreateVniRange) |
| ZStack::Resource::UserTag | 创建用户标签(CreateUserTag) |
| ZStack::Resource::DataVolumeFromVolumeTemplate | 从镜像创建云盘(CreateDataVolumeFromVolumeTemplate) |
| ZStack::Resource::Tag | 创建资源标签(CreateTag) |
