ALIYUN::EDAS::Cluster-Resource Orchestration Service(ROS)-阿里云帮助中心

Use `ALIYUN::EDAS::Cluster` to create a cluster.

Syntax

{
  "Type": "ALIYUN::EDAS::Cluster",
  "Properties": {
    "VpcId": String,
    "NetworkMode": Integer,
    "LogicalRegionId": String,
    "ClusterName": String,
    "ClusterType": Integer,
    "OversoldFactor": Integer,
    "ResourceGroupId": String
  }
}

Properties

Property	Type	Required	Update allowed	Description	Constraints
VpcId	String	No	No	The ID of the virtual private cloud (VPC).	This parameter is required if NetworkMode is set to 2.
NetworkMode	Integer	Yes	No	The network type.	Valid values: 1: classic network. 2: virtual private cloud (VPC).
LogicalRegionId	String	No	No	The ID of the region for the custom namespace.	Format: `PhysicalRegion:CustomNamespaceIdentifier`. Example: `cn-beijing:prod`.
ResourceGroupId	String	No	Yes	The ID of the resource group.	None
ClusterName	String	Yes	No	The name of the cluster.	The name must be 1 to 64 characters in length. It can contain letters, digits, underscores (_), and periods (.).
ClusterType	Integer	Yes	No	The type of the cluster.	Valid values: 1: Swarm cluster. 2: ECS cluster. 3: Kubernetes cluster.
OversoldFactor	Integer	No	No	The CPU overcommit ratio for the Docker cluster.	Valid values: 2.5 4 (1/4) 8 (1/8)

Return values

Fn::GetAtt

ClusterName: The name of the cluster.
IaasProvider: The IaaS provider.
ClusterId: The ID of the cluster.
ClusterType: The type of the cluster.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
Resources:
  Cluster:
    Type: ALIYUN::EDAS::Cluster
    Properties:
      LogicalRegionId:
        Fn::Join:
          - ':'
          - - Ref: ALIYUN::Region
            - prod
      OversoldFactor: 4
      VpcId:
        Ref: VpcId
      ClusterName: TestCluster
      NetworkMode: 2
      ClusterType: 2
Outputs:
  ClusterName:
    Description: Cluster name
    Value:
      Fn::GetAtt:
        - Cluster
        - ClusterName
  IaasProvider:
    Description: Provider
    Value:
      Fn::GetAtt:
        - Cluster
        - IaasProvider
  ClusterId:
    Description: Cluster ID
    Value:
      Fn::GetAtt:
        - Cluster
        - ClusterId
  ClusterType:
    Description: Cluster type
    Value:
      Fn::GetAtt:
        - Cluster
        - ClusterType

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    }
  },
  "Resources": {
    "Cluster": {
      "Type": "ALIYUN::EDAS::Cluster",
      "Properties": {
        "LogicalRegionId": {
          "Fn::Join": [
            ":",
            [
              {
                "Ref": "ALIYUN::Region"
              },
              "prod"
            ]
          ]
        },
        "OversoldFactor": 4,
        "VpcId": {
          "Ref": "VpcId"
        },
        "ClusterName": "TestCluster",
        "NetworkMode": 2,
        "ClusterType": 2
      }
    }
  },
  "Outputs": {
    "ClusterName": {
      "Description": "Cluster name",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "ClusterName"
        ]
      }
    },
    "IaasProvider": {
      "Description": "Provider",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "IaasProvider"
        ]
      }
    },
    "ClusterId": {
      "Description": "Cluster ID",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "ClusterId"
        ]
      }
    },
    "ClusterType": {
      "Description": "Cluster type",
      "Value": {
        "Fn::GetAtt": [
          "Cluster",
          "ClusterType"
        ]
      }
    }
  }
}