ACS::CICD::DockerDeploy.json

{
  "FormatVersion": "OOS-2019-06-01",
  "Description": {
    "name-en": "ACS::CICD::DockerDeploy",
    "name-zh-cn": "部署Docker镜像",
    "en": "Deploy docker image on multiple Linux ECS instances",
    "zh-cn": "在多个Linux ECS实例上部署Docker镜像"
  },
  "Parameters": {
    "targets": {
      "Type": "Json",
      "Label": {
        "en": "TargetInstance",
        "zh-cn": "目标实例"
      },
      "AssociationProperty": "Targets",
      "AssociationPropertyMetadata": {
        "ResourceType": "ALIYUN::ECS::Instance",
        "RegionId": "{{ ACS::RegionId }}"
      }
    },
    "acrType": {
      "Label": {
        "en": "ACR Type",
        "zh-cn": "容器镜像服务类型"
      },
      "Description": {
        "en": "If you do not have a container image service, You can choose to open <a href=\"https://www.alibabacloud.com/help/en/acr/user-guide/create-a-container-registry-personal-edition-instance\" target=\"_blank\"> Personal edition </a> or <a href=\"https://www.alibabacloud.com/help/en/acr/user-guide/create-a-container-registry-enterprise-edition-instance\" target=\"_blank\"> Enterprise Edition </a>.",
        "zh-cn": "如您还没有容器镜像服务，您可以选择开通<a href=\"https://help.aliyun.com/zh/acr/user-guide/create-a-container-registry-personal-edition-instance?spm=a2c4g.11186623.0.i7\" target=\"_blank\">个人版</a>或<a href=\"https://help.aliyun.com/zh/acr/user-guide/create-a-container-registry-enterprise-edition-instance?spm=a2c4g.11186623.0.i10\" target=\"_blank\">企业版</a>。"
      },
      "Type": "String",
      "Default": "Personal",
      "AllowedValues": [
        "Personal",
        "Enterprise"
      ],
      "AssociationPropertyMetadata": {
        "ValueLabelMapping": {
          "Enterprise": "企业版",
          "Personal": "个人版"
        }
      }
    },
    "username": {
      "Label": {
        "en": "Username",
        "zh-cn": "用户名"
      },
      "Description": {
        "en": "Username, represents the username of the container image",
        "zh-cn": "容器镜像仓库用户名"
      },
      "Type": "String",
      "Default": "",
      "AssociationPropertyMetadata": {
        "Visible": {
          "Condition": {
            "Fn::Equals": [
              "${acrType}",
              "Personal"
            ]
          }
        },
        "Required": {
          "Condition": {
            "Fn::Equals": [
              "${acrType}",
              "Personal"
            ]
          }
        }
      }
    },
    "password": {
      "Label": {
        "en": "Password",
        "zh-cn": "密码"
      },
      "Description": {
        "en": "Password, represents the password of the container image",
        "zh-cn": "容器镜像仓库密码"
      },
      "Default": "",
      "Type": "String",
      "AssociationPropertyMetadata": {
        "Visible": {
          "Condition": {
            "Fn::Equals": [
              "${acrType}",
              "Personal"
            ]
          }
        },
        "Required": {
          "Condition": {
            "Fn::Equals": [
              "${acrType}",
              "Personal"
            ]
          }
        }
      }
    },
    "acrId": {
      "Label": {
        "en": "ACR Instance ID",
        "zh-cn": "容器镜像服务实例ID"
      },
      "Description": {
        "en": "ACR ID, represents the ID of the cloud container registry",
        "zh-cn": "容器镜像服务实例ID"
      },
      "Type": "String",
      "Default": "",
      "AssociationProperty": "ALIYUN::CR::Instance::InstanceId",
      "AssociationPropertyMetadata": {
        "Visible": {
          "Condition": {
            "Fn::Equals": [
              "${acrType}",
              "Enterprise"
            ]
          }
        },
        "Required": {
          "Condition": {
            "Fn::Equals": [
              "${acrType}",
              "Enterprise"
            ]
          }
        }
      }
    },
    "namespace": {
      "Label": {
        "en": "NameSpace",
        "zh-cn": "命名空间"
      },
      "Description": {
        "en": "namespace, represents the namespace of the container image",
        "zh-cn": "容器镜像仓库命名空间"
      },
      "Type": "String",
      "Default": "",
      "AssociationProperty": "ALIYUN::CR::NameSpace::Name",
      "AssociationPropertyMetadata": {
        "InstanceId": "${acrId}",
        "Attribute": "NamespaceName",
        "Visible": {
          "Condition": {
            "Fn::Equals": [
              "${acrType}",
              "Enterprise"
            ]
          }
        },
        "Required": {
          "Condition": {
            "Fn::Equals": [
              "${acrType}",
              "Enterprise"
            ]
          }
        }
      }
    },
    "repoName": {
      "Label": {
        "en": "Repo Name",
        "zh-cn": "仓库名称"
      },
      "Description": {
        "en": "Repo Name, represents the repository name of the container image",
        "zh-cn": "容器镜像仓库名称"
      },
      "Type": "String",
      "AssociationProperty": "ALIYUN::CR::Repository::RepoName",
      "AssociationPropertyMetadata": {
        "AcrType": "${acrType}",
        "RegionId": "{{ ACS::RegionId }}",
        "InstanceId": "${acrId}",
        "RepoNamespaceName": "${namespace}",
        "RepoStatus": "ALL"
      }
    },
    "imageVersion": {
      "Label": {
        "en": "Image Version",
        "zh-cn": "镜像版本"
      },
      "Description": {
        "en": "Image Version, represents the version of the container image to pull",
        "zh-cn": "要拉取的镜像版本"
      },
      "Type": "String"
    },
    "dockerRunOptions": {
      "Label": {
        "en": "DockerRunOptions",
        "zh-cn": "Docker运行选项"
      },
      "Description": {
        "en": "DockerRunOptions, represents the options of the command \"docker run\", such as \"-p 80:80\". These will be added to the docker run command. Note that --name is not open for specification, OOS will automatically generate the default container name.",
        "zh-cn": "docker run命令的选项, 例如\"-p 80:80\"，这些选项会被添加到docker run命令中。注意，--name不开放指定，由OOS自动生成默认容器名。"
      },
      "Type": "String",
      "AllowedPattern": "^(?!.*--name).*$",
      "Default": ""
    },
    "isInternal": {
      "Label": {
        "en": "whether to use internal link to pull image",
        "zh-cn": "是否通过内网链接拉取镜像"
      },
      "Description": {
        "en": "If you want to use internal link to pull image, please ensure that your image repository and ECS instance are in the same VPC (personal acr, accessible to all VPC machines, no separate configuration required), please refer to <a href=\"https://help.aliyun.com/zh/acr/user-guide/configure-access-over-vpcs/?spm=a2c4g.11186623.0.0.3af016be83KUhr\" target=\"_blank\">acr configuration access VPC</a>.",
        "zh-cn": "如果您想要使用内网链接拉取镜像，请确保您的镜像仓库和ECS实例在同一个VPC内(个人版acr，VPC机器均可访问，无需单独配置)，具体请参考<a href=\"https://help.aliyun.com/zh/acr/user-guide/configure-access-over-vpcs/?spm=a2c4g.11186623.0.0.3af016be83KUhr\" target=\"_blank\">acr配置访问VPC</a>。"
      },
      "Type": "Boolean",
      "Default": false
    },
    "rateControl": {
      "Label": {
        "en": "RateControl",
        "zh-cn": "任务执行的并发比率"
      },
      "Type": "Json",
      "AssociationProperty": "RateControl",
      "Default": {
        "Mode": "Concurrency",
        "MaxErrors": 0,
        "Concurrency": 10
      }
    }
  },
  "Tasks": [
    {
      "Name": "getInstanceFromTargets",
      "Description": {
        "en": "Views the ECS instances",
        "zh-cn": "获取ECS实例"
      },
      "Action": "ACS::SelectTargets",
      "Properties": {
        "ResourceType": "ALIYUN::ECS::Instance",
        "RegionId": "{{ ACS::RegionId }}",
        "Filters": [
          "{{ targets }}"
        ]
      },
      "Outputs": {
        "instanceIds": {
          "Type": "List",
          "ValueSelector": "Instances.Instance[].InstanceId"
        }
      }
    },
    {
      "Name": "bulkyDockerDeploy",
      "Description": {
        "en": "Deploy Docker Image on Multiple ECS Instances",
        "zh-cn": "在多个ECS实例上部署Docker镜像"
      },
      "Action": "ACS::CICD::DockerDeployOnSingleECS",
      "Properties": {
        "regionId": "{{ ACS::RegionId }}",
        "instanceId": "{{ ACS::TaskLoopItem }}",
        "acrId": "{{ acrId }}",
        "acrType": "{{ acrType }}",
        "username": "{{ username }}",
        "password": "{{ password }}",
        "namespace": "{{ namespace }}",
        "repoName": "{{ repoName }}",
        "imageVersion": "{{ imageVersion }}",
        "dockerRunOptions": "{{ dockerRunOptions }}",
        "isInternal": "{{ isInternal }}"
      },
      "Loop": {
        "Items": "{{ getInstanceFromTargets.instanceIds }}",
        "RateControl": "{{ rateControl }}"
      }
    }
  ],
  "Metadata": {
    "ALIYUN::OOS::Interface": {
      "ParameterGroups": [
        {
          "Parameters": [
            "targets"
          ],
          "Label": {
            "default": {
              "zh-cn": "要部署到的目标ECS",
              "en": "Target Instance"
            }
          }
        },
        {
          "Parameters": [
            "acrType",
            "username",
            "password",
            "acrId",
            "namespace",
            "repoName",
            "imageVersion",
            "isInternal"
          ],
          "Label": {
            "default": {
              "zh-cn": "镜像信息",
              "en": "Image Repository"
            }
          }
        },
        {
          "Parameters": [
            "dockerRunOptions"
          ],
          "Label": {
            "default": {
              "zh-cn": "Docker运行选项",
              "en": "Docker Run Options"
            }
          }
        },
        {
          "Parameters": [
            "rateControl"
          ],
          "Label": {
            "default": {
              "zh-cn": "并发控制",
              "en": "Rate Control"
            }
          }
        }
      ]
    }
  }
}