ALIYUN::ECI::ContainerGroup - 资源编排

语法

{
  "Type": "ALIYUN::ECI::ContainerGroup",
  "Properties": {
    "SecurityContextSysctl": List,
    "Memory": Number,
    "InitContainer": List,
    "Cpu": "Number",
    "EipInstanceId": String,
    "ContainerGroupName": String,
    "Container": List,
    "ImageSnapshotId": String,
    "DnsConfig": Map,
    "AutoMatchImageCache": Boolean,
    "Ipv6AddressCount": Integer,
    "ImageRegistryCredential": List,
    "SpotPriceLimit": Number,
    "InstanceType": String,
    "SpotStrategy": String,
    "ActiveDeadlineSeconds": Integer,
    "HostAliase": List,
    "ZoneId": String,
    "TerminationGracePeriodSeconds": Integer,
    "VSwitchId": String,
    "SecurityGroupId": String,
    "SlsEnable": Boolean,
    "RestartPolicy": String,
    "RamRoleName": String,
    "Volume": List,
    "Tag": List
  }
}

属性

Container语法

"Container": [
  {
    "EnvironmentVar": List,
    "Tty": Boolean,
    "SecurityContext": Map,
    "Name": String,
    "ImagePullPolicy": String,
    "Image": String,
    "Stdin": boolean,
    "WorkingDir": String,
    "LivenessProbe": Map,
    "Cpu": Number,
    "Command": List,
    "Memory": Number,
    "ReadinessProbe": Map,
    "VolumeMount": List,
    "Port": List,
    "Arg": List,
    "StdinOnce": Boolean
  }
]

Container属性

LivenessProbe语法

"LivenessProbe": {
  "TcpSocket.Port": Integer,
  "HttpGet.Scheme": String,
  "HttpGet.Port": Integer,
  "FailureThreshold": Integer,
  "InitialDelaySeconds": Integer,
  "TimeoutSeconds": Integer,
  "SuccessThreshold": Integer,
  "Exec.Command": List,
  "PeriodSeconds": Integer,
  "HttpGet.Path": String
}

LivenessProbe属性

DnsConfig语法

"DnsConfig": {
  "NameServer": List,
  "Search": List,
  "Option": List
}

DnsConfig属性

InitContainer语法

"InitContainer": [
  {
    "EnvironmentVar": List,
    "SecurityContext": Map,
    "Name": String,
    "Image": String,
    "Arg": List,
    "WorkingDir": String,
    "Port": List,
    "Command": List,
    "Memory": Number,
    "ImagePullPolicy": String,
    "VolumeMount": List,
    "Cpu": Number
  }
]

InitContainer属性

Volume语法

"Volume": [
  {
    "NFSVolume.Path": String,
    "Name": String,
    "EmptyDirVolume.Medium": String,
    "NFSVolume.Server": String,
    "NFSVolume.ReadOnly": Boolean,
    "ConfigFileVolume.ConfigFileToPath": List,
    "Type": String
  }
]

Volume属性

HostAliase语法

"HostAliase": [
  {
    "Ip": String,
    "Hostname": List
  }
]

HostAliase属性

ImageRegistryCredential语法

"ImageRegistryCredential": [
  {
    "UserName": String,
    "Password": String,
    "Server": String
  }
]

ImageRegistryCredential属性

EnvironmentVar语法

"EnvironmentVar": {
  "Key": String,
  "Value": String,
  "FieldRef.FieldPath": String
}

EnvironmentVar属性

SecurityContext语法

"SecurityContext": {
  "Capability.Add": List,
  "RunAsUser": Interger,
  "ReadOnlyRootFilesystem": Boolen
}

SecurityContext属性

VolumeMount语法

"VolumeMount": [
  {
    "Name": String,
    "ReadOnly": Boolen,
    "MountPath": String
  }
]

VolumeMount属性

Port语法

"Port": [
  {
    "Port": Interger,
    "Protocol": String
  }
]

Port属性

ConfigFileVolume.ConfigFileToPath语法

"onfigFileVolume.ConfigFileToPath": [
  {
    "Content": String,
    "Path": String
  }
]

ConfigFileVolume.ConfigFileToPath属性

SecurityContextSysctl语法

"SecurityContextSysctl": [
  {
    "Value": String,
    "Name": String
  }
] 

SecurityContextSysctl属性

ReadinessProbe语法

"ReadinessProbe": {
  "TimeoutSeconds": Integer,
  "InitialDelaySeconds": Integer,
  "Exec.Command": List,
  "PeriodSeconds": Integer,
  "HttpGet.Port": Integer,
  "TcpSocket.Port": Integer,
  "FailureThreshold": Integer,
  "HttpGet.Scheme": String,
  "HttpGet.Path": String,
  "SuccessThreshold": Integer
} 

ReadinessProbe属性

Option语法

"Option": [
  {
    "Name": String,
    "Value": String
  }
] 

Option属性

Tag语法

"Tag": [
  {
    "Key": String,
    "Value": String
  }
]

Tag属性

返回值

Fn::GetAtt

• ContainerGroupId：容器组ID。
• ContainerGroupName：容器组的名称。
• SecurityGroupId：安全组ID。
• Ipv6Address：Ipv6地址。
• InternetIp：公网IP。
• RegionId：实例所属地域。
• IntranetIp：内网IP。
• ZoneId：可用区。
• VSwitchId：交换机ID。
• EniInstanceId：弹性网卡ID。

示例

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SecurityContextSysctl": {
      "Type": "Json",
      "Description": "ECI Sysctl is valid for every container in ECI.\nCurrently only two Sysctl keyNames are supported:\nKernel.shm_rmid_forced\nKernel.msgmax"
    },
    "Memory": {
      "Type": "Number",
      "Description": "memory size"
    },
    "InitContainer": {
      "Type": "Json",
      "Description": "The containers that constitute the container group for initializing."
    },
    "Cpu": {
      "Type": "Number",
      "Description": "CPU size"
    },
    "EipInstanceId": {
      "Type": "String",
      "Description": "Elastic IP ID"
    },
    "ContainerGroupName": {
      "Type": "String",
      "Description": "The name of the container group. \nThe length is [2,128] English lowercase letters, numbers or hyphens (-), cannot begin or end with a hyphens.",
      "MinLength": 2,
      "MaxLength": 128
    },
    "Container": {
      "Type": "Json",
      "Description": "The containers that constitute the container group."
    },
    "ImageSnapshotId": {
      "Type": "String",
      "Description": "Image cache ID or snapshot ID."
    },
    "DnsConfig": {
      "Type": "Json",
      "Description": "The information about DNS configurations."
    },
    "AutoMatchImageCache": {
      "Type": "Boolean",
      "Description": "Specifies whether to automatically match the image cache.",
      "AllowedValues": [
        true,
        false
      ]
    },
    "Ipv6AddressCount": {
      "Type": "Number",
      "Description": "The number of IPv6 addresses."
    },
    "ImageRegistryCredential": {
      "Type": "Json",
      "Description": "The information that you need to log on to the container image repository, including the server address, username, and password.",
      "MaxLength": 10
    },
    "SpotPriceLimit": {
      "Type": "Number",
      "Description": "Set the hourly maximum price of the instance. It supports a maximum of 3 decimal places. It takes effect when the value of the parameter SpotStrategy is SpotWithPriceLimit."
    },
    "InstanceType": {
      "Type": "String",
      "Description": "The type of the ECS instance."
    },
    "SpotStrategy": {
      "Type": "String",
      "Description": "Instance preemption strategy.\nRanges:\nNoSpot (default): normal pay-as-you-go instances.\nSpotWithPriceLimit: Preemptive instance that sets a cap price.\nSpotAsPriceGo: The system automatically bids, following the current market actual price.",
      "AllowedValues": [
        "NoSpot",
        "SpotWithPriceLimit",
        "SpotAsPriceGo"
      ]
    },
    "ActiveDeadlineSeconds": {
      "Type": "Number",
      "Description": "The validity period in seconds."
    },
    "HostAliase": {
      "Type": "Json",
      "Description": "Customize the hostname mapping of a container inside the pod"
    },
    "ZoneId": {
      "Type": "String",
      "Description": "The ID of the zone in which the instance resides. If you leave the parameter blank, the system assigns a zone for you. The default value is blank."
    },
    "TerminationGracePeriodSeconds": {
      "Type": "Number",
      "Description": "The buffer time for the program to handle operations before it is stopped."
    },
    "VSwitchId": {
      "Type": "String",
      "Description": "The ID of the specified VSwitch. Currently, ECI instances can only be deployed in VPCs."
    },
    "SecurityGroupId": {
      "Type": "String",
      "Description": "The ID of the security group to which the instance belongs. Instances in the same security group can access one another."
    },
    "SlsEnable": {
      "Type": "Boolean",
      "Description": "Enable user log collection. The default is False.",
      "AllowedValues": [
        true,
        false
      ]
    },
    "RestartPolicy": {
      "Type": "String",
      "Description": "The policy for restarting the instance. Default value: Always.",
      "AllowedValues": [
        "Always",
        "OnFailure",
        "Never"
      ]
    },
    "RamRoleName": {
      "Type": "String",
      "Description": "The RAM role that the container group assumes. ECI and ECS share the same RAM role."
    },
    "Volume": {
      "Type": "Json",
      "Description": "The data volume. You can specify a maximum of 20 data volumes.",
      "MaxLength": 20
    },
    "Tag": {
      "Type": "Json",
      "Description": "The list of container group tags in the form of key/value pairs. You can define a maximum of 20 tags for each container group.",
      "MaxLength": 20
    }
  },
  "Resources": {
    "ContainerGroup": {
      "Type": "ALIYUN::ECI::ContainerGroup",
      "Properties": {
        "SecurityContextSysctl": {
          "Ref": "SecurityContextSysctl"
        },
        "Memory": {
          "Ref": "Memory"
        },
        "InitContainer": {
          "Ref": "InitContainer"
        },
        "Cpu": {
          "Ref": "Cpu"
        },
        "EipInstanceId": {
          "Ref": "EipInstanceId"
        },
        "ContainerGroupName": {
          "Ref": "ContainerGroupName"
        },
        "Container": {
          "Ref": "Container"
        },
        "ImageSnapshotId": {
          "Ref": "ImageSnapshotId"
        },
        "DnsConfig": {
          "Ref": "DnsConfig"
        },
        "AutoMatchImageCache": {
          "Ref": "AutoMatchImageCache"
        },
        "Ipv6AddressCount": {
          "Ref": "Ipv6AddressCount"
        },
        "ImageRegistryCredential": {
          "Ref": "ImageRegistryCredential"
        },
        "SpotPriceLimit": {
          "Ref": "SpotPriceLimit"
        },
        "InstanceType": {
          "Ref": "InstanceType"
        },
        "SpotStrategy": {
          "Ref": "SpotStrategy"
        },
        "ActiveDeadlineSeconds": {
          "Ref": "ActiveDeadlineSeconds"
        },
        "HostAliase": {
          "Ref": "HostAliase"
        },
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "TerminationGracePeriodSeconds": {
          "Ref": "TerminationGracePeriodSeconds"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "SecurityGroupId": {
          "Ref": "SecurityGroupId"
        },
        "SlsEnable": {
          "Ref": "SlsEnable"
        },
        "RestartPolicy": {
          "Ref": "RestartPolicy"
        },
        "RamRoleName": {
          "Ref": "RamRoleName"
        },
        "Volume": {
          "Ref": "Volume"
        },
        "Tag": {
          "Ref": "Tag"
        }
      }
    }
  },
  "Outputs": {
    "InternetIp": {
      "Description": "Internet IP.",
      "Value": {
        "Fn::GetAtt": [
          "ContainerGroup",
          "InternetIp"
        ]
      }
    },
    "ZoneId": {
      "Description": "The ID of the zone in which the instance resides. If you leave the parameter blank, the system assigns a zone for you. The default value is blank.",
      "Value": {
        "Fn::GetAtt": [
          "ContainerGroup",
          "ZoneId"
        ]
      }
    },
    "SecurityGroupId": {
      "Description": "The ID of the security group to which the instance belongs. Instances in the same security group can access one another.",
      "Value": {
        "Fn::GetAtt": [
          "ContainerGroup",
          "SecurityGroupId"
        ]
      }
    },
    "VSwitchId": {
      "Description": "The ID of the VSwitch. Currently, ECI instances can only be deployed in VPCs.",
      "Value": {
        "Fn::GetAtt": [
          "ContainerGroup",
          "VSwitchId"
        ]
      }
    },
    "EniInstanceId": {
      "Description": "ENI instance ID.",
      "Value": {
        "Fn::GetAtt": [
          "ContainerGroup",
          "EniInstanceId"
        ]
      }
    },
    "ContainerGroupId": {
      "Description": "The ID of the container group.",
      "Value": {
        "Fn::GetAtt": [
          "ContainerGroup",
          "ContainerGroupId"
        ]
      }
    },
    "RegionId": {
      "Description": "The ID of the region in which the instance resides.",
      "Value": {
        "Fn::GetAtt": [
          "ContainerGroup",
          "RegionId"
        ]
      }
    },
    "ContainerGroupName": {
      "Description": "The name of the container group.",
      "Value": {
        "Fn::GetAtt": [
          "ContainerGroup",
          "ContainerGroupName"
        ]
      }
    },
    "IntranetIp": {
      "Description": "Intranet IP.",
      "Value": {
        "Fn::GetAtt": [
          "ContainerGroup",
          "IntranetIp"
        ]
      }
    },
    "Ipv6Address": {
      "Description": "Ipv6 address.",
      "Value": {
        "Fn::GetAtt": [
          "ContainerGroup",
          "Ipv6Address"
        ]
      }
    }
  }
}

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SecurityContextSysctl:
    Type: Json
    Description: |-
      ECI Sysctl is valid for every container in ECI.
      Currently only two Sysctl keyNames are supported:
      Kernel.shm_rmid_forced
      Kernel.msgmax
  Memory:
    Type: Number
    Description: memory size
  InitContainer:
    Type: Json
    Description: The containers that constitute the container group for initializing.
  Cpu:
    Type: Number
    Description: CPU size
  EipInstanceId:
    Type: String
    Description: Elastic IP ID
  ContainerGroupName:
    Type: String
    Description: >-
      The name of the container group.

      The length is [2,128] English lowercase letters, numbers or hyphens (-),
      cannot begin or end with a hyphens.
    MinLength: 2
    MaxLength: 128
  Container:
    Type: Json
    Description: The containers that constitute the container group.
  ImageSnapshotId:
    Type: String
    Description: Image cache ID or snapshot ID.
  DnsConfig:
    Type: Json
    Description: The information about DNS configurations.
  AutoMatchImageCache:
    Type: Boolean
    Description: Specifies whether to automatically match the image cache.
    AllowedValues:
      - true
      - false
  Ipv6AddressCount:
    Type: Number
    Description: The number of IPv6 addresses.
  ImageRegistryCredential:
    Type: Json
    Description: >-
      The information that you need to log on to the container image repository,
      including the server address, username, and password.
    MaxLength: 10
  SpotPriceLimit:
    Type: Number
    Description: >-
      Set the hourly maximum price of the instance. It supports a maximum of 3
      decimal places. It takes effect when the value of the parameter
      SpotStrategy is SpotWithPriceLimit.
  InstanceType:
    Type: String
    Description: The type of the ECS instance.
  SpotStrategy:
    Type: String
    Description: >-
      Instance preemption strategy.

      Ranges:

      NoSpot (default): normal pay-as-you-go instances.

      SpotWithPriceLimit: Preemptive instance that sets a cap price.

      SpotAsPriceGo: The system automatically bids, following the current market
      actual price.
    AllowedValues:
      - NoSpot
      - SpotWithPriceLimit
      - SpotAsPriceGo
  ActiveDeadlineSeconds:
    Type: Number
    Description: The validity period in seconds.
  HostAliase:
    Type: Json
    Description: Customize the hostname mapping of a container inside the pod
  ZoneId:
    Type: String
    Description: >-
      The ID of the zone in which the instance resides. If you leave the
      parameter blank, the system assigns a zone for you. The default value is
      blank.
  TerminationGracePeriodSeconds:
    Type: Number
    Description: The buffer time for the program to handle operations before it is stopped.
  VSwitchId:
    Type: String
    Description: >-
      The ID of the specified VSwitch. Currently, ECI instances can only be
      deployed in VPCs.
  SecurityGroupId:
    Type: String
    Description: >-
      The ID of the security group to which the instance belongs. Instances in
      the same security group can access one another.
  SlsEnable:
    Type: Boolean
    Description: Enable user log collection. The default is False.
    AllowedValues:
      - true
      - false
  RestartPolicy:
    Type: String
    Description: 'The policy for restarting the instance. Default value: Always.'
    AllowedValues:
      - Always
      - OnFailure
      - Never
  RamRoleName:
    Type: String
    Description: >-
      The RAM role that the container group assumes. ECI and ECS share the same
      RAM role.
  Volume:
    Type: Json
    Description: The data volume. You can specify a maximum of 20 data volumes.
    MaxLength: 20
  Tag:
    Type: Json
    Description: >-
      The list of container group tags in the form of key/value pairs. You can
      define a maximum of 20 tags for each container group.
    MaxLength: 20
Resources:
  ContainerGroup:
    Type: 'ALIYUN::ECI::ContainerGroup'
    Properties:
      SecurityContextSysctl:
        Ref: SecurityContextSysctl
      Memory:
        Ref: Memory
      InitContainer:
        Ref: InitContainer
      Cpu:
        Ref: Cpu
      EipInstanceId:
        Ref: EipInstanceId
      ContainerGroupName:
        Ref: ContainerGroupName
      Container:
        Ref: Container
      ImageSnapshotId:
        Ref: ImageSnapshotId
      DnsConfig:
        Ref: DnsConfig
      AutoMatchImageCache:
        Ref: AutoMatchImageCache
      Ipv6AddressCount:
        Ref: Ipv6AddressCount
      ImageRegistryCredential:
        Ref: ImageRegistryCredential
      SpotPriceLimit:
        Ref: SpotPriceLimit
      InstanceType:
        Ref: InstanceType
      SpotStrategy:
        Ref: SpotStrategy
      ActiveDeadlineSeconds:
        Ref: ActiveDeadlineSeconds
      HostAliase:
        Ref: HostAliase
      ZoneId:
        Ref: ZoneId
      TerminationGracePeriodSeconds:
        Ref: TerminationGracePeriodSeconds
      VSwitchId:
        Ref: VSwitchId
      SecurityGroupId:
        Ref: SecurityGroupId
      SlsEnable:
        Ref: SlsEnable
      RestartPolicy:
        Ref: RestartPolicy
      RamRoleName:
        Ref: RamRoleName
      Volume:
        Ref: Volume
      Tag:
        Ref: Tag
Outputs:
  InternetIp:
    Description: Internet IP.
    Value:
      'Fn::GetAtt':
        - ContainerGroup
        - InternetIp
  ZoneId:
    Description: >-
      The ID of the zone in which the instance resides. If you leave the
      parameter blank, the system assigns a zone for you. The default value is
      blank.
    Value:
      'Fn::GetAtt':
        - ContainerGroup
        - ZoneId
  SecurityGroupId:
    Description: >-
      The ID of the security group to which the instance belongs. Instances in
      the same security group can access one another.
    Value:
      'Fn::GetAtt':
        - ContainerGroup
        - SecurityGroupId
  VSwitchId:
    Description: >-
      The ID of the VSwitch. Currently, ECI instances can only be deployed in
      VPCs.
    Value:
      'Fn::GetAtt':
        - ContainerGroup
        - VSwitchId
  EniInstanceId:
    Description: ENI instance ID.
    Value:
      'Fn::GetAtt':
        - ContainerGroup
        - EniInstanceId
  ContainerGroupId:
    Description: The ID of the container group.
    Value:
      'Fn::GetAtt':
        - ContainerGroup
        - ContainerGroupId
  RegionId:
    Description: The ID of the region in which the instance resides.
    Value:
      'Fn::GetAtt':
        - ContainerGroup
        - RegionId
  ContainerGroupName:
    Description: The name of the container group.
    Value:
      'Fn::GetAtt':
        - ContainerGroup
        - ContainerGroupName
  IntranetIp:
    Description: Intranet IP.
    Value:
      'Fn::GetAtt':
        - ContainerGroup
        - IntranetIp
  Ipv6Address:
    Description: Ipv6 address.
    Value:
      'Fn::GetAtt':
        - ContainerGroup
        - Ipv6Address