ALIYUN::CS::ClusterAddons is used to install components in a cluster.
Syntax
{
"Type": "ALIYUN::CS::ClusterAddons",
"Properties": {
"ClusterId": String,
"Addons": List,
"InstalledIgnore": Boolean
}
}
Properties
Property | Operation | Required | Editable | Description | Constraint |
ClusterId | String | Yes | No | The cluster ID. | None. |
Addons | List | Yes | No | The configurations of the components. | For more information, see Addons properties. |
InstalledIgnore | Boolean | No | No | Specifies whether to ignore existing components when you create a cluster. | Valid values: true: ignores existing components. When you create a cluster, you can install only new components in the cluster. When you delete a cluster, you can uninstall only the components that you installed when you created the cluster. false (default): does not ignore existing components.
|
Addons syntax
"Addons": [
{
"Version": String,
"Config": String,
"Name": String
}
]
Addons properties
Property | Operation | Required | Editable | Description | Constraint |
Version | String | No | No | The version of the component. | None. |
Config | String | No | No | The configurations of the component. | None. |
Name | String | Yes | No | The component name. | None. |
Return values
Fn::GetAtt
ClusterId: the cluster ID.
Examples
YAML format
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
Addons:
Description: 'A combination of addon plugins for Kubernetes clusters.
Network plug-in: including Flannel and Terway network plug-ins
Log service: Optional. If the log service is not enabled, the cluster audit
function cannot be used.
Ingress: The installation of the Ingress component is enabled by default.'
Type: Json
ClusterId:
Description: Cluster ID.
Type: String
Resources:
ClusterAddons:
Properties:
Addons:
Ref: Addons
ClusterId:
Ref: ClusterId
Type: ALIYUN::CS::ClusterAddons
Outputs:
ClusterId:
Description: Cluster ID.
Value:
Fn::GetAtt:
- ClusterAddons
- ClusterId
JSON format
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"ClusterId": {
"Type": "String",
"Description": "Cluster ID."
},
"Addons": {
"Type": "Json",
"Description": "A combination of addon plugins for Kubernetes clusters.\nNetwork plug-in: including Flannel and Terway network plug-ins\nLog service: Optional. If the log service is not enabled, the cluster audit function cannot be used.\nIngress: The installation of the Ingress component is enabled by default."
}
},
"Resources": {
"ClusterAddons": {
"Type": "ALIYUN::CS::ClusterAddons",
"Properties": {
"ClusterId": {
"Ref": "ClusterId"
},
"Addons": {
"Ref": "Addons"
}
}
}
},
"Outputs": {
"ClusterId": {
"Description": "Cluster ID.",
"Value": {
"Fn::GetAtt": [
"ClusterAddons",
"ClusterId"
]
}
}
}
}