All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::EHPC::Users

Last Updated:Nov 23, 2023

ALIYUN::EHPC::Users is used to add one or more users to a specified cluster.

Syntax

{
  "Type": "ALIYUN::EHPC::Users",
  "Properties": {
    "ClusterId": String,
    "Users": List
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

ClusterId

String

Yes

No

The cluster ID.

None.

Users

List

Yes

Yes

The user information.

You can add no more than 100 users to a cluster. For more information, see Users properties.

Users syntax

"Users": [
  {
    "Group": String,
    "Password": String,
    "Name": String
  }
]

Users properties

Property

Type

Required

Editable

Description

Constraint

Group

String

Yes

Yes

The permission group to which you want to add users.

Valid values:

  • users: an ordinary permission group. It is applicable to ordinary users that need only to submit and debug jobs.

  • wheel: a sudo permission group. It is applicable to the administrator who needs to manage the cluster. In addition to submitting and debugging jobs, users who have sudo permissions can run sudo commands to install software and restart nodes.

Password

String

Yes

Yes

The password of the user that you want to add to the cluster.

The password must be 8 to 30 characters in length and contain three of the following character types:

  • Uppercase letters

  • Lowercase letters

  • Digits

  • Special characters: ( ) ~ ! @ # $ % ^ & * - _ + = | { } [ ] : ; ' / < > , . ? /.

Name

String

Yes

No

The name of the user that you want to add to the cluster.

The name must be 6 to 30 characters in length and can contain letters, digits, and periods (.). It must start with a letter.

Return values

Fn::GetAtt

None.

Examples

  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      ClusterId:
        Type: String
        Description:
          en: The cluster ID.
        Default: ehpc-hz-FYUr32****
      Users:
        AssociationPropertyMetadata:
          Parameter:
            AssociationPropertyMetadata:
              Parameters:
                Group:
                  Type: String
                  Description:
                    en: |-
                      The permission group to which the user N belongs. Valid values:
                      - **users**: an ordinary permission group. It is applicable to ordinary users that need only to submit and debug jobs.
                      - **wheel**: a sudo permission group. It is applicable to the administrator who needs to manage the cluster. In addition to submitting and debugging jobs, users who have sudo permissions can run sudo commands to install software and restart nodes.
                      Valid values of N: 1 to 100.
                Password:
                  Type: String
                  Description:
                    en: |-
                      The password of the Nth user. The password must be 8 to 30 characters in length and contain three of the following items:
                      - Uppercase letter
                      - Lowercase letter
                      - Digit
                      - Special character: ()~!@#$%^&*-_+=|{}[]:;'/<>,.?/
                      Valid values of N: 1 to 100.
                Name:
                  Type: String
                  Description:
                    en: |-
                      The name of the user that you want to add. The name must be 6 to 30 characters in length and can contain letters, digits, and periods (.). It must start with a letter. 
                      Valid values of N: 1 to 100.
            Type: Json
        AssociationProperty: List[Parameter]
        Type: Json
        Description:
          en: The information about the users.
        MaxLength: 100
        Default:
          - Group: user1
            Password: 1@a2****
            Name: users
    Resources:
      EHPCUsers:
        Type: ALIYUN::EHPC::Users
        Properties:
          ClusterId:
            Ref: ClusterId
          Users:
            Ref: Users
  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "ClusterId": {
          "Type": "String",
          "Description": {
            "en": "The cluster ID."
          },
          "Default": "ehpc-hz-FYUr32****"
        },
        "Users": {
          "AssociationPropertyMetadata": {
            "Parameter": {
              "AssociationPropertyMetadata": {
                "Parameters": {
                  "Group": {
                    "Type": "String",
                    "Description": {
                      "en": "The permission group to which the user N belongs. Valid values:\n- **users**: an ordinary permission group. It is applicable to ordinary users that need only to submit and debug jobs.\n- **wheel**: a sudo permission group. It is applicable to the administrator who needs to manage the cluster. In addition to submitting and debugging jobs, users who have sudo permissions can run sudo commands to install software and restart nodes.\nValid values of N: 1 to 100."
                    }
                  },
                  "Password": {
                    "Type": "String",
                    "Description": {
                      "en": "The password of the Nth user. The password must be 8 to 30 characters in length and contain three of the following items:\n- Uppercase letter\n- Lowercase letter\n- Digit\n- Special character: ()~!@#$%^&*-_+=|{}[]:;'/<>,.?/\nValid values of N: 1 to 100."
                    }
                  },
                  "Name": {
                    "Type": "String",
                    "Description": {
                      "en": "The name of the user that you want to add. The name must be 6 to 30 characters in length and can contain letters, digits, and periods (.). It must start with a letter. \nValid values of N: 1 to 100."
                    }
                  }
                }
              },
              "Type": "Json"
            }
          },
          "AssociationProperty": "List[Parameter]",
          "Type": "Json",
          "Description": {
            "en": "The information about the users."
          },
          "MaxLength": 100,
          "Default": [
      {
        "Group": "user1",
        "Password": "1@a2****",
        "Name": "users"
      }
    ]
        }
      },
      "Resources": {
        "EHPCUsers": {
          "Type": "ALIYUN::EHPC::Users",
          "Properties": {
            "ClusterId": {
              "Ref": "ClusterId"
            },
            "Users": {
              "Ref": "Users"
            }
          }
        }
      }
    }