ACS::テンプレート - CloudOps Orchestration Service - Alibaba Cloud ドキュメントセンター

ACS::Template 操作を使用して、テンプレートを子テンプレートとして別のテンプレートに埋め込むことができます。

説明

ACS::Template 操作を使用すると、テンプレートを子テンプレートとして別のテンプレートに埋め込むことができます。この操作を使用すると、複雑なテンプレートをモジュール化し、テンプレートを呼び出し用に複数の子テンプレートに分割できます。また、共通の O&M 操作を再利用可能な子テンプレートとして定義することもできます。さらに、CloudOps Orchestration Service（OOS）は、クラウドプロダクト操作を共通クラウドサービスの操作テンプレートとして提供します。これらのテンプレートをテンプレートに埋め込むことができます。

構文

テンプレート名を使用して作成済みテンプレートを埋め込む

一般的な形式（埋め込み可能なすべてのテンプレートに適用可能）

YAML

Tasks:
- Name: callChildTemplate1
  Action: ACS::Template
  Properties:
    TemplateName: child_template_name # 必須。子テンプレートの名前。
    TemplateVersion: v2 # オプション。デフォルトでは、最新バージョンが使用されます。
    Parameters: # オプション。子テンプレートの実行に必要なパラメーター。
      ParameterName1: value1

JSON

{
  "Tasks": [
    {
      "Name": "callChildTemplate1",
      "Action": "ACS::Template",
      "Properties": {
        "TemplateName": "child_template_name",
        "TemplateVersion": "v2",
        "Parameters": {
          "ParameterName1": "value1"
        }
      }
    }
  ]
}

簡略形式（クラウドプロダクト操作にのみ適用可能）

YAML

Tasks:
- Name: taskName # 必須。タスクの名前。例：runMyInstances。
  Action: CloudProductActionName1 # 必須。クラウドプロダクト操作の名前。例：ACS::ECS::RunInstances。
  Properties:
    ParameterName1: value1 # オプション。クラウドプロダクト操作の実行に必要なパラメーター。例：ImageId。

JSON

{
  "Tasks": [
    {
      "Name": "taskName",
      "Action": "CloudProductActionName1",
      "Properties": {
        "ParameterName1": "parameterName1"
      }
    }
  ]
}

テンプレートコンテンツを使用して新しいテンプレートを埋め込む

YAML

Tasks:
- Name: callChildTemplate1
  Action: ACS::Template
  Properties:
    TemplateContent:
      FormatVersion: OOS-2019-06-01 # 必須。テンプレートのバージョン。
      Parameters: # オプション。子テンプレートの実行に必要なパラメーター。
      Tasks: # オプション。子テンプレートによって実行される操作。

JSON

{
  "Tasks": [
    {
      "Name": "callChildTemplate1",
      "Action": "ACS::Template",
      "Properties": {
        "TemplateContent": {
          "FormatVersion": "OOS-2019-06-01",
          "Parameters": null,
          "Tasks": null
        }
      }
    }
  ]
}

制限

操作の埋め込みには、次の制限があります。

テンプレートは自身を埋め込むことはできません。
ループ埋め込みは許可されていません。たとえば、A が B を埋め込み、B が C を埋め込み、C が A を埋め込むことはできません。
埋め込みレイヤーの合計数は 3 を超えることはできません。
クラウドプロダクト操作の埋め込みは 1 つの埋め込みレイヤーと見なされ、ループタスクは埋め込みと見なされません。

例

ACS::ECS::CreateImage 操作を埋め込んで、Elastic Compute Service（ECS）インスタンスのイメージを作成します。

一般的な形式（埋め込み可能なすべてのテンプレートに適用可能）

YAML

---
FormatVersion: OOS-2019-06-01
Description: Creates a custom image.
Parameters:
  imageName:
    Description: The image name.
    Type: String
  instanceId:
    Description: The ID of the instance.
    Type: String
    AllowedPattern: i-[A-Za-z0-9]*
    MinLength: 1
    MaxLength: 30
  OOSAssumeRole:
    Type: String
    Description: oos assume this role to execution task
    Default: OOSServiceRole
RamRole: '{{OOSAssumeRole}}'
Tasks:
- Name: createImage
  Action: ACS::Template
  Description: Creates a custom image.
  Properties:
    TemplateName: 'ACS::ECS::CreateImage'
    Parameters:
      ImageName: '{{ imageName }}'
      InstanceId: '{{ instanceId }}'
  Outputs:
    imageId:
      Type: String
      ValueSelector: ImageId
Outputs:
  imageId:
    Type: String
    Value: '{{ createImage.imageId }}'

JSON

{
    "FormatVersion": "OOS-2019-06-01",
    "Description": "カスタムイメージを作成します。",
    "Parameters": {
        "imageName": {
            "Description": "イメージ名。",
            "Type": "String"
        },
        "instanceId": {
            "Description": "インスタンスの ID。",
            "Type": "String",
            "AllowedPattern": "i-[A-Za-z0-9]*",
            "MinLength": 1,
            "MaxLength": 30
        },
        "OOSAssumeRole": {
            "Type": "String",
            "Description": "タスクを実行するためにこのロールを引き受けます。",
            "Default": "OOSServiceRole"
        }
    },
    "RamRole": "{{OOSAssumeRole}}",
    "Tasks": [
        {
            "Name": "createImage",
            "Action": "ACS::Template",
            "Description": "カスタムイメージを作成します。",
            "Properties": {
                "TemplateName": "ACS::ECS::CreateImage",
                "Parameters": {
                    "ImageName": "{{ imageName }}",
                    "InstanceId": "{{ instanceId }}"
                }
            },
            "Outputs": {
                "imageId": {
                    "Type": "String",
                    "ValueSelector": "ImageId"
                }
            }
        }
    ],
    "Outputs": {
        "imageId": {
            "Type": "String",
            "Value": "{{ createImage.imageId }}"
        }
    }
}

簡略形式（クラウドプロダクト操作にのみ適用可能）

YAML

---
FormatVersion: OOS-2019-06-01
Description: Creates a new Image from existing ECS Instance.
Parameters:
  InstanceId:
    Description: the Instance Type for the new instances
    Type: String
  ImageName:
    Description:  name of the new image
    Type: String
  OOSAssumeRole:
    Type: String
    Description: oos assume this role to execution task
    Default: OOSServiceRole
RamRole: "{{OOSAssumeRole}}"
Tasks:
  - Name: createImage
    Action: ACS::ECS::CreateImage
    Properties:
      ImageName: "{{ ImageName }}"
      InstanceId: "{{ InstanceId }}"
    Outputs:
      ImageId:
        ValueSelector: ImageId
        Type: String
Outputs:
  ImageId:
    Type: String
    Value: "{{ createImage.ImageId }}"

JSON

{
  "FormatVersion": "OOS-2019-06-01",
  "Description": "既存の ECS インスタンスから新しいイメージを作成します。",
  "Parameters": {
    "InstanceId": {
      "Description": "新しいインスタンスのインスタンスタイプ",
      "Type": "String"
    },
    "ImageName": {
      "Description": "新しいイメージの名前",
      "Type": "String"
    },
    "OOSAssumeRole": {
      "Type": "String",
      "Description": "タスクを実行するためにこのロールを引き受けます。",
      "Default": "OOSServiceRole"
    }
  },
  "RamRole": "{{OOSAssumeRole}}",
  "Tasks": [
    {
      "Name": "createImage",
      "Action": "ACS::ECS::CreateImage",
      "Properties": {
        "ImageName": "{{ ImageName }}",
        "InstanceId": "{{ InstanceId }}"
      },
      "Outputs": {
        "ImageId": {
          "ValueSelector": "ImageId",
          "Type": "String"
        }
      }
    }
  ],
  "Outputs": {
    "ImageId": {
      "Type": "String",
      "Value": "{{ createImage.ImageId }}"
    }
  }
}

テンプレートコンテンツに基づいて、指定されたタグが追加されている ECS インスタンスをクエリします。

YAML

FormatVersion: OOS-2019-06-01
Description:
  name-en: DescribeInstances
   
Parameters:
  regionId:
    Label:
      en: The ID of region
       
    Type: String
    Default: '{{ ACS::RegionId }}'
Tasks:
  - Name: describeInstances_out
    Action: ACS::Template
    Description:
      en: Queries the ECS instances by specifying tag
       
    Properties:
      TemplateContent:
        FormatVersion: OOS-2019-06-01
        Description: ''
        Parameters:
          regionId:
            Label:
              en: The ID of region
               
            Type: String
            Default: '{{ ACS::RegionId }}'
        Tasks:
          - Name: describeInstances_1
            Action: ACS::Template
            Description:
              en: Queries the ECS instances by specifying tag
               
            Properties:
              TemplateContent:
                FormatVersion: OOS-2019-06-01
                Description: ''
                Parameters:
                  regionId:
                    Label:
                      en: The ID of region
                       
                    Type: String
                    Default: '{{ ACS::RegionId }}'
                Tasks:
                  - Name: describeInstances_2
                    Action: ACS::ExecuteAPI
                    Description:
                      en: Queries the ECS instances by specifying tag
                       
                    Properties:
                      Service: ECS
                      API: DescribeInstances
                      Parameters:
                        RegionId: '{{ regionId }}'
                    Outputs:
                      instanceIdss:
                        Type: List
                        ValueSelector: Instances.Instance[].InstanceId
                Outputs:
                  instanceId1:
                    Type: List
                    Value: '{{ describeInstances_2.instanceIdss}}'
              Parameters:
                regionId: '{{ regionId }}'
            Outputs:
              instanceId2:
                Type: List
                ValueSelector: .instanceId1
        Outputs:
          instanceId1:
            Type: List
            Value: '{{ describeInstances_1.instanceId2 }}'
      Parameters:
        regionId: '{{ regionId }}'
    Outputs:
      instanceId2:
        Type: List
        ValueSelector: .instanceId1
Outputs:
  instanceId4:
    Type: List
    Value: '{{ describeInstances_out.instanceId2}}'

JSON

{
  "FormatVersion": "OOS-2019-06-01",
  "Description": {
    "name-en": "DescribeInstances",
     
  },
  "Parameters": {
    "regionId": {
      "Label": {
        "en": "リージョンの ID",
         
      },
      "Type": "String",
      "Default": "{{ ACS::RegionId }}"
    }
  },
  "Tasks": [
    {
      "Name": "describeInstances_out",
      "Action": "ACS::Template",
      "Description": {
        "en": "タグを指定して ECS インスタンスをクエリします。",
         
      },
      "Properties": {
        "TemplateContent": {
          "FormatVersion": "OOS-2019-06-01",
          "Description": "",
          "Parameters": {
            "regionId": {
              "Label": {
                "en": "リージョンの ID",
                 
              },
              "Type": "String",
              "Default": "{{ ACS::RegionId }}"
            }
          },
          "Tasks": [
            {
              "Name": "describeInstances_1",
              "Action": "ACS::Template",
              "Description": {
                "en": "タグを指定して ECS インスタンスをクエリします。",
                 
              },
              "Properties": {
                "TemplateContent": {
                  "FormatVersion": "OOS-2019-06-01",
                  "Description": "",
                  "Parameters": {
                    "regionId": {
                      "Label": {
                        "en": "リージョンの ID",
                         
                      },
                      "Type": "String",
                      "Default": "{{ ACS::RegionId }}"
                    }
                  },
                  "Tasks": [
                    {
                      "Name": "describeInstances_2",
                      "Action": "ACS::ExecuteAPI",
                      "Description": {
                        "en": "タグを指定して ECS インスタンスをクエリします。",
                         
                      },
                      "Properties": {
                        "Service": "ECS",
                        "API": "DescribeInstances",
                        "Parameters": {
                          "RegionId": "{{ regionId }}"
                        }
                      },
                      "Outputs": {
                        "instanceIdss": {
                          "Type": "List",
                          "ValueSelector": "Instances.Instance[].InstanceId"
                        }
                      }
                    }
                  ],
                  "Outputs": {
                    "instanceId1": {
                      "Type": "List",
                      "Value": "{{ describeInstances_2.instanceIdss}}"
                    }
                  }
                },
                "Parameters": {
                  "regionId": "{{ regionId }}"
                }
              },
              "Outputs": {
                "instanceId2": {
                  "Type": "List",
                  "ValueSelector": ".instanceId1"
                }
              }
            }
          ],
          "Outputs": {
            "instanceId1": {
              "Type": "List",
              "Value": "{{ describeInstances_1.instanceId2 }}"
            }
          }
        },
        "Parameters": {
          "regionId": "{{ regionId }}"
        }
      },
      "Outputs": {
        "instanceId2": {
          "Type": "List",
          "ValueSelector": ".instanceId1"
        }
      }
    }
  ],
  "Outputs": {
    "instanceId4": {
      "Type": "List",
      "Value": "{{ describeInstances_out.instanceId2}}"
    }
  }
}