All Products
Search
Document Center

Resource Orchestration Service:Online template editor

Last Updated:Aug 01, 2023

This topic describes how to use an online template editor of Resource Orchestration Service (ROS) to create a template. The online template editor of ROS provides a variety of features, such as automatic code completion and previews for template structures and parameters.

Prerequisites

You are familiar with the syntax and the basic structure of ROS templates. For more information, see Template syntax and Template structure.

Procedure

  1. Log on to the ROS console.
  2. In the left-side navigation pane, choose Templates > My Templates.
  3. On the My Templates page, click Create Template.
  4. On the Create Template page, edit your template in the template editor.

    The following types of template editors are supported: ROS and Terraform template editors.

ROS template editor

A ROS template editor supports the following modes: script editor and visual editor modes.

  • Script editor

    The script editor supports automatic code completion and hinting. You can use the script editor to create JSON and YAML templates.

    • Intelligent code hinting of resource and parameter types

      When you configure the Resources and Parameters sections of a ROS template, the script editor responsively displays hints of the resource and parameter types.

      1.png
    • Intelligent code hinting of resource properties

      When you configure the Resources section of a ROS template, the script editor responsively displays hints of the resource properties.

      2.png
    • Intelligent code hinting of references

      When you use the Ref function in the Resources, Outputs, Mappings, Conditions, and Metadata sections of a ROS template, the script editor responsively displays hints about the parameters, resource IDs, and pseudo parameters.

      3.png
    • Template preview

      After you define a ROS template, you can click Preview in the upper-right corner of the script editor to preview the template. This feature helps you identify and fix invalid mappings.

      4.png
  • Visual editor

    The visual editor supports GUI elements such as drop-down lists and fields.

    You can enter the content of a template in the visual editor to define and generate a ROS template. In a visual editor, the list of template sections is displayed. You can update or delete template parameters, resources, metadata, and outputs based on the list.

    5.png

Terraform template editor

  • Import and editing of Terraform templates

    You can import an existing Terraform template from a local folder to a Terraform template editor.

  • Conversion between Terraform and ROS templates

    After you define a Terraform template and convert the Terraform template into a ROS template, the template format is changed to the template format that is supported by the Terraform hosting feature.

    6.png