This topic describes how to create an Elasticsearch cluster. You can create an Elasticsearch cluster in either of the following ways:
Table 1 lists key parameters that differentiate between different types of clusters.
Cluster Type | Security Mode | HTTPS Access |
|---|---|---|
Cluster in non-security mode | Disabled | N/A |
Cluster in security mode + HTTP | Enabled | Disabled |
Cluster in security mode + HTTPS | Enabled | Enabled |
You have planned the Elasticsearch cluster configuration by following the instructions in Cluster Planning.
Alternatively, choose Clusters > Elasticsearch in the navigation tree on the left. Click Create Cluster in the upper right corner. The Create Cluster page is displayed.
Parameter | Description |
|---|---|
Region | Select the region where the cluster is located. Resources in different regions cannot communicate with each other over an internal network. For lower network latency and quicker resource access, select the nearest region. |
AZ | Select one or more AZs associated with the cluster region. A maximum of three AZs can be configured. For details about the use of multiple AZs, see Suggestions on Multi-AZ Deployment. |
Type | Select Elasticsearch. |
Version | Select a cluster version from the drop-down list. |
Name | User-defined cluster name. The cluster name must start with a letter and can contain 4 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. |
Cluster Description | Add a description for the cluster for easy recognition. The value can contain 0 to 128 characters. |
Nodes | Number of data nodes in the cluster. Data nodes store the cluster's data. If there are no client nodes in the cluster, data nodes will need to additionally handle cluster access and data analytics requests; if there are no master nodes, data nodes will also need to provide cluster management.
Principles:
|
CPU Architecture | x86. The supported types depend on the actual regional environment. |
Node Specifications | Data node flavor. You can select a node flavor based on your needs. Each cluster supports only one specification. |
Node Storage Type | If you select EVS for node storage, you need to further select the EVS disk type for data nodes of the cluster. Supported node storage types: Common I/O, High I/O, Ultra-high I/O. |
Node Storage Capacity | Data node storage capacity. Its value range varies with node specifications. The node storage capacity must be a multiple of 20. |
Master node | Master nodes manage cluster-wide operations, including metadata, indexes, and shard allocation. For large-scale deployments, using dedicated master nodes enhances cluster stability, service availability, and centralized control. After enabling master nodes, specify Node Specifications, Nodes, and Node Storage Type. The value of Nodes must be an odd number greater than or equal to 3. Up to nine nodes are supported. The value of Node Storage Capacity is fixed. You can select a storage type based on your needs. |
Client node | Client nodes route and coordinate search and index requests, offloading processing from data nodes for enhanced query performance and cluster scalability when there are heavy loads. After enabling client nodes, specify Node Specifications, Nodes and Node Storage Type. The value of Nodes ranges from 1 to 64. The value of Node Storage Capacity is fixed. You can select a storage type based on your needs. To ensure high service availability and prevent individual node overload in a multi-AZ deployment, the number of client nodes should be greater than or equal to the number of AZs. (For a cluster spanning two AZs, this means a minimum of two client nodes; for a three-AZ deployment, a minimum of three client nodes.) |
Cold data node | Cold data nodes are used to store and query large quantities of latency-insensitive data. They offer an effective way to manage large datasets while cutting storage costs. After enabling cold data nodes, configure Node Specifications, Nodes, Node Storage Type, and Node Storage Capacity. The value of Nodes ranges from 1 to 32. Select Node Storage Type and Node Storage Capacity as required.
When cold data nodes are enabled, you can switch between cold and hot data nodes. For details, see Switching Between Hot and Cold Data. |
Enterprise Project | When creating a CSS cluster, you can bind an enterprise project to the cluster if you have enabled the enterprise project function. Select an enterprise project from the Enterprise Project drop-down list, or click View Enterprise Project to go to the Enterprise Project Management Service page and check existing enterprise projects. |
Parameter | Description |
|---|---|
VPC | Specify a VPC to isolate the cluster's network. Click View VPC to go to the VPC management console and check the created VPCs. If no VPC is available, contact the CSS administrator to create a new VPC. For details, see section "Creating a VPC with a Subnet" in VPC User Guide. NOTE: The VPC must contain CIDRs. Otherwise, cluster creation will fail. By default, a created VPC contains CIDRs. |
Subnet | A subnet provides dedicated network resources that are isolated from other networks, improving network security. Select a subnet needed by the cluster in the current VPC. If no existing subnets meet your requirements, click Create Subnet to create a new subnet. For details, see section "Creating a VPC with a Subnet" in Virtual Private Cloud User Guide. |
Security Group | A security group serves as a virtual firewall that provides access control policies for clusters. Select a security group for the cluster. Click View Security Group to go to the security group list, where you can view details about security groups. NOTE:
|
Security Mode | Whether to enable the security mode for the cluster.
|
HTTPS Access | HTTPS access can be enabled only when security mode is enabled for the cluster. With HTTPS access enabled, communication will be encrypted when you access the cluster. NOTE: Compared with a non-security mode cluster that uses HTTP, a security-mode cluster that uses HTTPS has lower read performance. The performance loss is estimated at around 20% under high concurrency. If you want fast read performance as well as the isolation and permission control (such as indexes, documents, and fields) enabled by the security mode, you can disable HTTPS Access. After HTTPS Access is disabled, HTTP protocol is used for cluster communication. In this case, data security cannot be guaranteed and public network access is disabled. |
Cluster snapshots are disabled by default. To enable them, toggle on Cluster Snapshots. To store automatically created snapshots in OBS, an agency will need to be created in order to access OBS. Fees will be incurred for using OBS storage (storage class: Standard).
Parameter | Description |
|---|---|
OBS Bucket | From the drop-down list, select an OBS bucket for storing snapshots. You can also click Create Bucket on the right to create an OBS bucket. The created or existing OBS bucket must meet the following requirements:
|
Backup Path | Snapshot storage path in the OBS bucket. The backup path cannot: CAUTION: Only standard OBS storage can be used to store snapshots. Do not apply OBS lifecycle rules to the backup path. |
Maximum Backup Rate (per Second) | The parameter sets the maximum backup rate per node. When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual backup rate may not reach the configured value, as it depends on factors such as OBS performance and disk I/O. Value format: number + unit Default value: 40 MB The value 0MB means there is no limit on how fast data is backed up to snapshots. An overly high backup rate may lead to excessive resource usage, which may impact cluster stability. Therefore, set this parameter carefully. |
Maximum Recovery Rate (per Second) | The parameter sets the maximum recovery rate per node. When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual recovery rate may not reach the configured value, as it depends on factors such as OBS performance and disk I/O. Value format: number + unit Default value: An overly high recovery rate may lead to excessive resource usage, which may impact cluster stability. Configure this parameter carefully to maintain optimal performance. For Elasticsearch clusters later than 7.6.2, the recovery rate is also limited by the indices.recovery.max_bytes_per_sec parameter. NOTE:
|
IAM Agency | IAM agency authorized by the current account for CSS to access or maintain data stored in OBS. If no agency is available, contact the CSS administrator to create one. The selected IAM agency must meet the following requirements: WARNING: The agency name can contain only letters (case-sensitive), digits, underscores (_), and hyphens (-). Otherwise, the backup will fail. |
Parameter | Description |
|---|---|
Snapshot Name Prefix | The snapshot name prefix contains 1 to 32 characters and must start with a lowercase letter. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed. A snapshot name consists of a snapshot name prefix and a timestamp, for example, snapshot-1566921603720. |
Time Zone | Time zone for the backup time. Specify Backup Started Time based on the time zone. |
Backup Start Time | Specify the start time of auto backup. Select a value from the drop-down list. The interval can be Daily, Hourly, or weekly (by selecting a specific day of the week), and the backup time can be set to any hour from 00:00 to 23:00 (full hours only). |
Tags
Adding tags to clusters helps you identify and manage your cluster resources. You can configure your own tags or use tags predefined by the Tag Management Service (TMS). If you want to use the same tag to identify multiple cloud resources for better resource grouping, we recommend that you predefine tags in Tag Management Service (TMS). For details, see Tag Management Service User Guide. If your organization has configured tag policies for CSS, add cluster tags based on these policies. Tags that do not comply with predefined tag policies will cause a cluster creation failure. Contact the administrator to learn about the tag policies.
If cluster creation fails, try creating the cluster again by rectifying the errors returned.