ALIYUN::CS::ClusterHelmApplication - Resource Orchestration Service

ALIYUN::CS::ClusterHelmApplication is used to deploy an application by using Helm.

Syntax

{
  "Type": "ALIYUN::CS::ClusterHelmApplication",
  "Properties": {
    "ChartValues": Map,
    "ClusterId": String,
    "ChartUrl": String,
    "Namespace": String,
    "Name": String,
    "Credential": Map
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
ChartValues	Map	No	No	The custom values of the chart.	None.
ClusterId	String	Yes	No	The ID of the cluster.	None.
ChartUrl	String	Yes	No	The request URL of the chart.	None.
Namespace	String	No	No	The namespace to which Helm belongs.	None.
Name	String	Yes	No	The name of the chart.	None.
Credential	Map	No	No	The information about the access credential.	None.

Credential syntax

"Credential": [
  {
    "Password": String,
    "UserName": String
  }
]

Credential properties

Property	Type	Required	Editable	Description	Constraint
Password	String	Yes	No	The password.	None.
UserName	String	Yes	No	The username.	None.

Return values

Fn::GetAtt

ClusterId: the ID of the cluster.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ChartUrl:
    AllowedPattern: ^(http|https)://[\w\W]+$
    Description: The URL of chart. Supports HTTP or HTTPS.
    Type: String
  ClusterId:
    Description: The ID of the kubernetes cluster.
    Type: String
  Name:
    Description: The name for helm release.
    Type: String
Resources:
  ClusterHelmApplication:
    Properties:
      ChartUrl:
        Ref: ChartUrl
      ClusterId:
        Ref: ClusterId
      Name:
        Ref: Name
    Type: ALIYUN::CS::ClusterHelmApplication
Outputs:
  ClusterId:
    Description: The ID of the cluster.
    Value:
      Fn::GetAtt:
      - ClusterHelmApplication
      - ClusterId

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ClusterId": {
      "Type": "String",
      "Description": "The ID of the kubernetes cluster."
    },
    "ChartUrl": {
      "Type": "String",
      "Description": "The URL of chart. Supports HTTP or HTTPS.",
      "AllowedPattern": "^(http|https)://[\\w\\W]+$"
    },
    "Name": {
      "Type": "String",
      "Description": "The name for helm release."
    }
  },
  "Resources": {
    "ClusterHelmApplication": {
      "Type": "ALIYUN::CS::ClusterHelmApplication",
      "Properties": {
        "ClusterId": {
          "Ref": "ClusterId"
        },
        "ChartUrl": {
          "Ref": "ChartUrl"
        },
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Outputs": {
    "ClusterId": {
      "Description": "The ID of the cluster.",
      "Value": {
        "Fn::GetAtt": [
          "ClusterHelmApplication",
          "ClusterId"
        ]
      }
    }
  }
}