Updated on 2022-02-22 GMT+08:00

CCE.NodePool

Property Description

Table 1 Property description

Property

Mandatory

Type

Description

dataVolumes

Yes

CCE.DataVolume

Data disk of the created node

Value Description: Customize the value, for example, [{"volumeType":"SATA","size":100}].

Value Constraint: Array format. Currently, only one object is supported.

Suggestion: Customize the value.

availabilityZone

Yes

Cloud.ECS.AvailabilityZone.Name

AZ where the node is located

Value Description: AZ where the to-be-created ECS is located. The name of the AZ needs to be specified, for example, ae-ad-1a. For details, see the Regions and Endpoints page.

Value Constraint: Select a value based on the region.

Suggestion: Use the get_input function to set this field, and then the value can be automatically selected on the AOS console.

name

No

string

Name of the created node

Value Description: Customize the value.

Value Constraint: The value contains 4 to 32 characters and must start with a lowercase letter. Only lowercase letters, digits, and underscores (_) are allowed.

Suggestion: Customize the value. Generally, the stack name is used as the node name.

publicKey

No

Cloud.ECS.KeyPair.PublicKey

Public key of the key pair when the stack is billed in the yearly/monthly mode

Value Description: Selects an existing public key.

Suggestion: Use the get_input function to set this field, and then the value can be automatically selected on the AOS console based on the value of sshKeyName.

postInstall

No

string

Node post-installation script

Value Description: Customize the value.

Value Constraint: The script you specify here will be executed after K8S software is installed

Suggestion: The script is usually used to modify Docker parameters.

labels

No

dict

labels of the created node

Value Description: Customize the value, for example, {"key": "aos","value": "app","scope":[1,2]}.

Suggestion: Enter the key, value, and scope as required.

preInstall

No

string

Node pre-installation script

Value Description: Customize the value.

Value Constraint: The script you specify here will be executed before K8S software is installed. Note that if the script is incorrect, K8S software may not be installed successfully.

Suggestion: The script is usually used to format data disks.

publicIp

No

CCE.PublicIP

Virtual IP address of the created node

Value Description: Customize the value, for example, {"eip":{"bandwidth:{" shareType":PER}, 5_sbgp"}}.

Value Constraint: Only one elastic IP address can be defined for each node.

Suggestion: Customize the value.

instances

Yes

integer

Number of created nodes

Value Description: Customize the value. The value ranges from 1 to 50.

Value Constraint: {u'in_range': [1, 50]}

Suggestion: Set the value based on specifications and requirements.

rootVolume

Yes

ECS.RootVolume

System disk of the created node

Value Description: Customize the value, for example, {"volumeType":"SATA","size":40}.

Suggestion: Customize the value.

os

No

string

os of the created node

Value Description: ["EulerOS 2.2", "CentOS 7.4"]

Value Constraint: Customize the value. If this parameter is left blank, EulerOS 2.2 is used by default.

Suggestion: The options are EulerOS 2.2 and CentOS 7.4.

nodePasswd

No

password

Password of the node root user

Value Description: Customize the value.

Value Constraint: 1. The parameter must be written into inputs and set using the get_input function. 2. The value must not be left blank or is a weak password. Enter 8 to 26 characters. Only uppercase and lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./? are allowed. The value must contain at least two types of characters. 3. sshkeyName and nodePasswd cannot be used at the same time.

Suggestion: You are advised to use the get_input function to obtain the value and avoid plaintext passwords to ensure security.

flavor

Yes

Cloud.CCE.Node.Flavor.Name

Container node specification

Value Description: ID of the system flavor of the ECS to be created. You are advised to set this parameter in get_input mode.

Suggestion: Select the node specification during node creation on the CCE console. In the node template, you can set the inputs to specify the node specification.

sshKeyName

Yes

Cloud.ECS.KeyPair.Name

Key pair used for logging in to a node, which needs to be kept properly

Value Description: It must be created on the ECS console in advance.

Value Constraint: sshkeyName and nodePasswd cannot be used at the same time.

Suggestion: 1. You are advised to use the get_input function to assign values so that you can select a value when using the template. 2. Obtain the information on the ECS console and then enter the information accordingly.

annotations

No

dict

Annotations of Node

Value Description: Customize the value, for example, {"app": "aos"}.

Suggestion: You can enter multiple key-value pairs.