使用ROS在线编辑器编写模板

更新时间:
复制为 MD 格式

本文为您介绍如何使用ROS在线编辑器编写模板。ROS在线编辑器可以为您提供自动补全模板内容、预览模板参数和预览模板架构图的功能。

前提条件

请确保您已熟悉ROS模板的模板语法和模板基本结构。更多信息,请参见模板语法模板基本结构

操作步骤

  1. 登录资源编排控制台

  2. 在左侧导航栏,选择模板>我的模板

  3. 我的模板页面,单击创建模板

  4. 创建模板页面,编辑ROS模板内容。

    您可以通过ROS模板编辑器或Terraform模板编辑器编辑模板内容。

ROS模板编辑器

ROS模板编辑器支持脚本编辑和可视化编辑两种模式。

  • 脚本编辑(JSON/YAML模板编辑)

    脚本编辑支持自动补全模板内容、提示参数等功能。

    • 资源类型与参数类型智能提示

      当您在定义ROS模板的资源信息(Resources)与参数信息(Parameters)时,ROS模板编辑器可以快速准确的提示您需要的资源类型和参数类型。

      编辑器同时支持 JSON 和 YAML 两种格式的自动补全。例如,在 JSON 格式的 Resources 中输入资源类型关键字时,会弹出 ALIYUN::ECS::VPC 等候选项;在 YAML 格式的 Parameters 中输入参数类型时,会提示 Boolean 等可选值。

    • 资源属性智能提示

      当您在定义ROS模板的资源信息(Resources)时,ROS模板编辑器可以快速准确地提示您需要定义的资源属性(Properties)。

      例如,在定义类型为 ALIYUN::ECS::VPC 的资源属性时,输入字母 V,编辑器自动补全下拉菜单提示 VpcName 等候选属性。

    • 引用智能提示

      当您在定义ROS模板的资源(Resources)、输出(Outputs)、映射(Mappings)、条件(Conditions)和元数据(Metadata)信息时,ROS模板编辑器可以使用Ref函数对参数、资源ID或伪参数进行提示。

      例如输入 "Ref": "v" 时,编辑器弹出自动补全下拉菜单,显示匹配的资源名 VPC、参数名 VpcName 和伪参数 ALIYUN::NoValue

    • 参数信息的映射预览

      当您完成ROS模板定义后,可以单击编辑模板内容右上角的预览按钮查看模板预览效果,从而完善模板参数的信息。

      预览面板以表单形式展示模板中定义的各参数信息,包括参数标签(Label)、参数类型(Type)、默认值(Default)及对应的输入控件(如文本框、下拉列表等),便于您直观检查参数配置是否符合预期。

  • 可视化编辑

    可视化编辑支持下拉选择、文本输入等功能。

    编辑器提供通过可视化编辑界面手动编辑信息,从而定义生成对应的ROS模板。您可以通过可视化模板编辑树进行更新或删除模板参数、资源、元数据和输出等操作。

    可视化编辑树以树形结构展示 MappingsConditionsResourcesOutputsMetadata 等节点。示例中 Resources 下定义了一个名为 Vpc 的资源(Type 为 ALIYUN::ECS::VPC),包含 VpcNameCidrBlock 属性;Outputs 定义了 VRouterIdRouteTableIdVpcId 三个输出项。右侧提供快速导航栏,可快速跳转到各节点。

Terraform模板编辑器

  • Terraform模板的导入与编辑

    您可以在Terraform编辑器中通过打开一个本地文件夹来导入一个已有的Terraform项目。

  • Terraform模板和ROS模板的相互转换

    当您完成Terraform定义并将Terraform模板切换为ROS模板后,Terraform模板会被转换为ROS托管Terraform后支持的模板格式。

    转换后的 ROS 模板为 JSON 格式,包含 ROSTemplateFormatVersion(值为 2015-09-01)、Transform(值为 Aliyun::Terraform-v1.2)和 Workspace 对象,Workspace 将 Terraform 代码文件(如 main.tf)的内容嵌入 ROS 模板中。