文档

模板转换工具的常用命令

更新时间:

本文为您介绍阿里云ROS模板转换工具的常用命令。

查看帮助信息

执行以下代码,查看模板转换工具的帮助信息。

rostran --help

转换模板

执行以下代码,转换模板。

rostran transform SOURCE_PATH [OPTIONS]

参数说明如下表所示:

参数

是否必选

说明

SOURCE_PATH

源模板文件的路径。源模板文件可以为Excel、Terraform或AWS CloudFormation格式。

OPTIONS

取值:

  • --source-format:源模板文件的格式,根据SOURCE_PATH后缀确定源文件格式。取值:

    • auto(默认值)

    • terraform

    • excel

    • cloudformation

    例如:以下代码表示将Terraform模板转换为ROS模板,并指定源模板文件格式为Terraform,将文件命名为main.tf

    rostran transform templates/terraform/alicloud --source-format terraform
  • --target-path:生成ROS模板的文件路径,默认为当前目录。取值:

    • 目录:在目录下生成的文件名为template的ROS模板。

    • 文件路径:生成指定文件名的ROS模板。文件必须是JSON或YAML格式。

  • --target-format:生成的ROS模板格式。取值:

    • auto(默认值)

      说明

      -target-path取值为文件路径时,生成的ROS模板格式与--target-path文件格式相同。--target-path取值为目录时,生成的ROS模板名为template.yml

    • json

    • yaml

    例如:以下代码表示将Terraform模板转换为ROS模板,并在当前目录生成JSON格式的ROS模板文件template.json

    rostran transform templates/terraform/alicloud/main.tf --target-format json

转换模板示例如下:

格式化模板

执行以下代码,格式化模板。

rostran format [OPTIONS] PATH...

参数说明如下所示。

参数

是否必选

说明

PATH

需要格式化的ROS模板文件路径。

说明

支持指定多个模板文件路径。

OPTIONS

取值:

  • --replace:将源文件内容替换为格式化后的内容。

  • --no-replace(默认值):仅输出格式化内容。

  • --skip PATH:需要跳过格式化的ROS模板文件路径。

    说明

    支持指定多个模板文件路径。

格式化规则

模板区块按照ROSTemplateFormatVersionTransformDescriptionConditionsMappingsParametersResourcesOutputsMetadataWorkspace排序。

各区块的排序规则如下所示。

  • Conditions区块:按照字母升序排序。

  • Mappings区块:按照字母升序排序。

  • Parameters区块:以Metadata.ALIYUN::ROS::Interface.ParameterGroups.Parameters(若存在)中定义的顺序排序,每个参数的属性以类型、描述、约束等顺序排序。

  • Resources区块:以资源依赖顺序排序,其中被依赖的资源放在前面。每个资源属性按照一定规则排序。

  • Outputs区块:输出属性按照DescriptionConditionValue排序。

  • Metadata区块:按照ALIYUN::ROS::InterfaceALIYUN::ROS::DesignerPredefinedParameters排序,每项值属性按照一定规则排序。

  • Workspace区块:按照字母升序排序,其中main.tf永远放在第一个。

  • 本页导读 (1)
文档反馈