2018-08-20
- Modified the screenshots and output examples. -
- Added operation examples in the following section: +
- Added operation examples in the following section:
- Added the link to the operation guide for enabling CTS in the following section:
- Deleted the following two sections:
- What is CSS?
- Which Scenarios Can CSS Be Applied To?
Getting Started with Elasticsearch
-This section describes how to use Elasticsearch to provide the search function for users. You can use the Elasticsearch search engine of CSS to search for data based on the scenario example. The basic operation process is as follows:
+This section describes how to use Elasticsearch for product search. You can use the Elasticsearch search engine of CSS to search for data based on the scenario example. The basic operation process is as follows:
Scenario Description
A women's clothing brand builds an e-commerce website. It uses traditional databases to provide a product search function for users. However, due to an increase in the number of users and business growth, the traditional databases have slow response and low accuracy. To improve user experience and user retention, the e-commerce website plans to use Elasticsearch to provide the product search function for users.
This section describes how to use Elasticsearch to provide the search function for users.
@@ -18,13 +18,14 @@ ] }Step 1: Create a Cluster
Create a cluster using Elasticsearch as the search engine. In this example, suppose that you create a cluster named Es-xfx. This cluster is used only for getting started with Elasticsearch. For this cluster, you are advised to select css.medium.8 for Node Specifications, Common I/O for Node Storage Type, and 40 GB for Node Storage Capacity. For details, see Creating an Elasticsearch Cluster in Non-Security Mode.
+Step 1: Create a Cluster
Create a cluster using Elasticsearch as the search engine. In this example, suppose that you create a cluster named Es-xfx. This cluster is used only for getting started with Elasticsearch. For this cluster, you are advised to select css.medium.8 for Node Specifications, Common I/O for Node Storage Type, and 40 GB for Node Storage Capacity. For details, see Creating an Elasticsearch Cluster in Non-Security Mode.
+Create a cluster using Elasticsearch as the search engine. In this example, suppose that you create a cluster named Sample-ESCluster. This cluster is used only for getting started with Elasticsearch. For this cluster, you are advised to select ess.spec-4u8g for Node Specifications, High I/O for Node Storage Type, and 40 GB for Node Storage Capacity. For details, see or .
After you create the cluster, switch to the cluster list to view the created cluster. If the Status of the cluster is Available, the cluster is created successfully.
-
Step 2: Import Data
CSS supports importing data to Elasticsearch using Logstash, Kibana, or APIs. Kibana lets you visualize your Elasticsearch data. The following procedure illustrates how to import data to Elasticsearch using Kibana.
-- On the Clusters page of the CSS management console, locate the row containing the target cluster and click Access Kibana in the Operation column.
- In the left navigation pane of Kibana, choose Dev Tools.
The text box on the left is the input box. The triangle icon in the upper right corner of the input box is the command execution button. The text box on the right area is the result output box.
-Figure 2 Console page+
- On the Clusters page, locate the target cluster and click More > Cerebro in the Operation column to go to the Cerebro login page.
- Non-security cluster: Click the cluster name on the Cerebro login page to go to the Cerebro console.
- Security cluster: Click the cluster name on the Cerebro login page, enter the username and password, and click Authenticate to go to the Cerebro console. The default username is admin and the password is the one specified during cluster creation.
- In the navigation pane of Kibana on the left, choose Dev Tools.
The text box on the left is the input box. The triangle icon in the upper right corner of the input box is the command execution button. The text box on the right area is the result output box.
+Figure 1 Console page
The Kibana UI varies depending on the Kibana version.
- On the Console page, run the following command to create index named my_store:(Versions earlier than 7.x)-
PUT /my_store @@ -106,7 +107,7 @@
If the value of the errors field in the command output is false, the data is imported successfully.
Step 3: Search for Data
- Full-text search
If you access the e-commerce website and want to search for commodities whose names include "spring jeans", enter "spring jeans" to begin your search. The following text provides the command to be executed on Kibana and the command output.
+Step 3: Search for Data
- Full-text search
If you access the e-commerce website and want to search for commodities whose names include "spring jeans", enter "spring jeans" to begin your search. The following example shows the command to be executed on Kibana and the command output.
Command to be executed on Kibana:
(Versions earlier than 7.x)
GET /my_store/products/_search @@ -179,9 +180,9 @@ ] } }-- Elasticsearch supports full-text search. The preceding command searches for the information about all commodities whose names include "spring" or "jeans".
- Unlike traditional databases, Elasticsearch can return results in milliseconds by using inverted indices.
- Elasticsearch supports sorting by score. In the command output, information about the first two commodities contains both "spring" and "jeans", while that about the last two products contains only "spring". Therefore, the first two commodities rank prior to the last two due to high keyword match.
- Elasticsearch supports full-text search. The preceding command searches for the information about all commodities whose names include "spring" or "jeans".
- Unlike traditional databases, Elasticsearch can return results in milliseconds by using inverted indexes.
- Elasticsearch supports sorting by score. In the command output, information about the first two commodities contains both "spring" and "jeans", while that about the last two products contain only "spring". Therefore, the first two commodities rank prior to the last two due to high keyword match.
- Aggregation result display
The e-commerce website provides the function of displaying aggregation results. For example, it classifies commodities corresponding to "spring" based on the size so that you can collect the number of products of different sizes. The following provides the command to be executed on Kibana and the command output.
+- Aggregation result display
The e-commerce website provides the function of displaying aggregation results. For example, it classifies commodities corresponding to "spring" based on the size so that you can collect the number of products of different sizes. The following example shows the command to be executed on Kibana and the command output.
Command to be executed on Kibana:
(Versions earlier than 7.x)
GET /my_store/products/_search @@ -196,7 +197,6 @@ } } }
-(Versions later than 7.x)
GET /my_store/_search { @@ -289,8 +289,9 @@
- Aggregation result display
Step 4: Delete the Cluster
Once you understand the process and method of using Elasticsearch, you can perform the following steps to delete the cluster you created for the example and its data to avoid resource wastage.
-After you delete a cluster, its data cannot be restored. Exercise caution when deleting a cluster.
-- Log in to the CSS management console. In the left navigation pane, click Clusters to switch to the Clusters page.
- Locate the row that contains cluster Es-xfx and click More > Delete in the Operation column.
- In the displayed dialog box, enter the name of the cluster to be deleted and click OK.
+ After you delete a cluster, its data cannot be restored. Exercise caution when deleting a cluster.
+- Log in to the CSS management console. In the navigation pane on the left, choose Clusters > Elasticsearch.
- Locate the row that contains cluster Es-xfx and click More > Delete in the Operation column.
- In the displayed dialog box, enter the name of the cluster to be deleted and click OK.
- Full-text search
@@ -299,10 +300,3 @@ - Full-text search
- On the Clusters page, locate the target cluster and click More > Cerebro in the Operation column to go to the Cerebro login page.
+
Creating an Elasticsearch Cluster in Security Mode
-You can enable security mode when you create a cluster of version 6.5.4 and later versions.
- - You can enable security mode only when you create a cluster. The security mode setting of an existing cluster cannot be modified.
- Public IP address access and Kibana public access can be used only after security mode is enabled.
This section describes how to create an Elasticsearch cluster in security mode.
+ - After a cluster is created, its security group information cannot be changed.
- Public IP address access and Kibana public access can be used only after security mode is enabled.
Procedure
- Log in to the CSS management console.
- Click Create Cluster in the upper right corner. The Create Cluster page is displayed.
- Specify Region and AZ.
-
Table 1 Parameter description for Region and AZ Parameter
++Context
- When creating a cluster, the number of nodes that can be added varies according to the node type. For details, see Table 1.
++
+Table 1 Number of nodes in different types Node Type
Description
+Number
Region
+ess
Select a region for the cluster from the drop-down list on the right. Currently, only eu-de is supported.
+ess: 1-32
AZ
+ess, ess-master
Select an AZ associated with the cluster region.
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess, ess-client
+ess: 1-32
+ess-client: 1-32
+ess, ess-cold
+ess: 1-32
+ess-cold: 1-32
+ess, ess-master, ess-client
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess-client: 1-32
+ess, ess-master, ess-cold
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess-cold: 1-32
+ess, ess-client, ess-cold
+ess: 1-32
+ess-client: 1-32
+ess-cold: 1-32
+ess, ess-master, ess-client, ess-cold
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess-client: 1-32
+ess-cold: 1-32
+- ess: the default node type that is mandatory for cluster creation. The other three node types are optional.
- ess-master: master node
- ess-client: client node
- ess-cold: cold data node
Procedure
- Log in to the CSS management console.
- Click Create Cluster in the upper right corner. The Create Cluster page is displayed.
- Specify Region and AZ.
+
Table 2 Parameter description for Region and AZ Parameter
+Description
+Region
+Select a region for the cluster from the drop-down list on the right. Currently, only eu-de is supported.
+AZ
+Select an AZ associated with the cluster region.
You can select one or more AZs. For details, see Multi-AZ HA.
- Set basic information about the cluster. Specifically, specify Version and Name.
-
Table 2 Description of basic parameters Parameter
+-Table 3 Description of basic parameters Parameter
Description
+Description
Version
+Version
Select a cluster version from the drop-down list box.
+Select a cluster version from the drop-down list box.
Name
+Name
Name of a cluster. Cluster names contain 4 to 32 characters. Only letters, numbers, hyphens (-), and underscores (_) are allowed and the value must start with a letter.
-NOTE:After a cluster is created, you can modify the cluster name as required. Click the name of a cluster to be modified. On the displayed Basic Information page, click
+
next to the cluster name. After the modification is completed, click 
to save the modification. If you want to cancel the modification, click 
.Name of a cluster. Cluster names contain 4 to 32 characters. Only letters, numbers, hyphens (-), and underscores (_) are allowed and the value must start with a letter.
+NOTE:After a cluster is created, you can modify the cluster name as required. Click the name of a cluster to be modified. On the displayed Basic Information page, click
next to the cluster name. After the modification is completed, click 
to save the modification. If you want to cancel the modification, click 
.Figure 1 Configuring basic information+
Figure 1 Configuring basic information
- Set host specifications of the cluster. -
Table 3 Parameter description Parameter
+-Table 4 Parameter description Parameter
Description
+Description
Nodes
+Nodes
Number of nodes in a cluster.
+Number of nodes in a cluster.
- If neither a master node nor client node is enabled, the nodes specified by this parameter are used to serve as both the master node and client node. Nodes provide the cluster management, data storage, cluster access, and data analysis functions. To ensure data stability in the cluster, it is recommended that you set this parameter to a value no less than 3.
- If only the master node function is enabled, nodes specified by this parameter are used to store data and provide functions of client nodes.
- If both the master and client node functions are enabled, the nodes specified by this parameter are only used for storing data.
- If only the client node function is enabled, nodes specified by this parameter are used to store data and provide functions of the master node.
CPU Architecture
+CPU Architecture
Currently, x86 and Kunpeng are supported. The supported type is determined by the actual regional environment.
+Currently, x86 and Kunpeng are supported. The supported type is determined by the actual regional environment.
Node Specifications
+Node Specifications
Specifications of nodes in a cluster. You can select a specified specification based on your needs. Only one node specification can be selected for each cluster. You cannot select the CPU and memory resources that have been sold out.
+Specifications of nodes in a cluster. You can select a specified specification based on your needs. Only one node specification can be selected for each cluster. You cannot select the CPU and memory resources that have been sold out.
Currently, the following flavors are supported: css.medium.8, css.large.8, css.xlarge.8, css.2xlarge.8, and css.4xlarge.8.
After you select a flavor, the CPU and memory corresponding to the current specification are displayed below the parameter. For example, if you select css.medium.8, then 1 vCPUs | 8 GB will be displayed, indicating that the node flavor you select contains one vCPU and 8 GB memory.
Node Storage Type
+Node Storage Type
In the current version, the following options are available: Common I/O, High I/O, and Ultra-high I/O.
+In the current version, the following options are available: Common I/O, High I/O, and Ultra-high I/O.
Node Storage Capacity
+Node Storage Capacity
Storage space. Its value varies with node specifications.
+Storage space. Its value varies with node specifications.
- Value range of flavor css.medium.8: 40 GB to 640 GB
- Value range of flavor css.large.8: 40 GB to 1,280 GB
- Value range of flavor css.xlarge.8: 40 GB to 2,560 GB
- Value range of flavor css.2xlarge.8: 80 GB to 5,120 GB
- Value range of flavor css.4xlarge.8: 160 GB to 10,240 GB
Disk Encryption
+Disk Encryption
If you select this option, the nodes in the cluster you create will use encrypted EVS disks to protect data. By default, this option is not selected. Note that you cannot modify this setting after the cluster is created. Therefore, exercise caution when performing the setting.
+If you select this option, the nodes in the cluster you create will use encrypted EVS disks to protect data. By default, this option is not selected. Note that you cannot modify this setting after the cluster is created. Therefore, exercise caution when performing the setting.
After you select this option, you need to select an available key from the Key Name drop-down list. If no key is available, click Create/View Key to go to the KMS management console and create or modify a key. For details, see Creating a CMK.
Enabling disk encryption has no impact on your operations on a cluster (such as accessing the cluster and importing data to the cluster). However, after you enable disk encryption, operation performance deteriorates by about 10%.
NOTE:- If the cluster is in the Available status and the key used for disk encryption is in the Pending deletion or disable status or has been deleted after a cluster is created, cluster scale-out is not allowed. However, other operations on the cluster, such as restarting the cluster, creating snapshots, restoring the cluster, and importing data to the cluster are not affected. In addition, this key cannot be used for cluster creation in the future.
- After a cluster is created, do not delete the key used by the cluster. Otherwise, the cluster will become unavailable.
- The Default Master Keys cannot be used to create grants. Specifically, you cannot use Default Master Keys whose aliases end with /default in KMS to create clusters.
Master node
+Master node
The master node manages all nodes in the cluster. If 20 or more nodes are required to store and analyze the large amount of data, you are advised to enable the master node to ensure cluster stability. Otherwise, you are advised to set only the Nodes parameter and use the nodes as both master and client nodes..
+The master node manages all nodes in the cluster. If 20 or more nodes are required to store and analyze the large amount of data, you are advised to enable the master node to ensure cluster stability. Otherwise, you are advised to set only the Nodes parameter and use the nodes as both master and client nodes..
After enabling the master node, specify Node Specifications, Nodes, and Node Storage Type. The value of Nodes must be an odd number equal to or greater than 3. You can set a maximum of nine nodes. The value of Node Storage Capacity is fixed. You can select a storage type based on your needs. By default, the node storage type is High I/O and the node storage capacity is 40 GB.
Client node
+Client node
The client node allows clients to access clusters and analyze data. If more than 20 nodes are required to store and analyze a large amount of data, you are advised to enable the client node to ensure cluster stability. Otherwise, you are advised to set only the Nodes parameter and use the nodes as both master and client nodes..
+The client node allows clients to access clusters and analyze data. If more than 20 nodes are required to store and analyze a large amount of data, you are advised to enable the client node to ensure cluster stability. Otherwise, you are advised to set only the Nodes parameter and use the nodes as both master and client nodes..
After enabling the client node, specify Node Specifications, Nodes and Node Storage Type. The value of Nodes ranges from 1 to 32. The value of Node Storage Capacity is fixed. You can select a storage type based on your needs. By default, the node storage type is High I/O and the node storage capacity is 40 GB.
Cold data node
+Cold data node
The cold data node is used to store historical data, for which query responses can be returned in minutes. If you do not quire a quick query response, store historical data on cold data nodes to reduce costs.
+The cold data node is used to store historical data, for which query responses can be returned in minutes. If you do not quire a quick query response, store historical data on cold data nodes to reduce costs.
After enabling cold data node, 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 requirement.
After the cold data node is enabled, CSS automatically adds cold and hot tags to related nodes.
Figure 2 Configuring node specifications+
Figure 2 Configuring node specifications
- Set network specifications of the cluster. -
Table 4 Parameter description Parameter
+-Table 5 Parameter description Parameter
Description
+Description
VPC
+VPC
A VPC is a secure, isolated, and logical network environment.
+A VPC is a secure, isolated, and logical network environment.
Select the target VPC. Click View VPC to enter the VPC management console and view the created VPC names and IDs. If no VPC is available, create a VPC.
NOTE:The VPC must contain CIDRs. Otherwise, cluster creation will fail. By default, a VPC will contain CIDRs.
Subnet
+Subnet
A subnet provides dedicated network resources that are isolated from other networks, improving network security.
+A subnet provides dedicated network resources that are isolated from other networks, improving network security.
Select the target subnet. You can access the VPC management console to view the names and IDs of the existing subnets in the VPC.
Security Group
+Security Group
A security group is a collection of access control rules for ECSs that have the same security protection requirements and are mutually trusted in a VPC. To view more details about the security group, click View Security Group.
-NOTE:- For cluster access purposes, ensure that the security group contains port 9200.
- If your cluster version is 7.6.2 or 7.9.3, ensure that all the ports used for communication between nodes in the same security group are allowed. If such settings cannot be configured, ensure at least the access to port 9300 is allowed.
- After a cluster is created, its security group cannot be changed.
A security group is a collection of access control rules for ECSs that have the same security protection requirements and are mutually trusted in a VPC. To view more details about the security group, click View Security Group.
+NOTE:- For cluster access purposes, ensure that the security group contains port 9200.
- If your cluster version is 7.6.2, 7.9.3 or 7.10.2, ensure that all the ports used for communication between nodes in the same security group are allowed. If such settings cannot be configured, ensure at least the access to port 9300 is allowed.
- After a cluster is created, its security group cannot be changed.
Security Mode
+Security Mode
This parameter is supported in version 6.5.4 and later versions. After enabling security mode, communication is encrypted and authentication is required for the cluster. The default administrator username is admin, and the password needs to be set and confirmed. For details about the security mode, see Clusters in Security Mode.
+This parameter is supported in version 6.5.4 and later versions. After enabling security mode, communication is encrypted and authentication is required for the cluster. The default administrator username is admin, and the password needs to be set and confirmed. For details about the security mode, see Clusters in Security Mode.
NOTE:You can enable Security Mode only when you create a cluster. After a cluster is created, its security mode cannot be changed.
HTTPS Access
+HTTPS Access
When security mode is enabled for a cluster, HTTPS access is enabled by default. A security cluster uses HTTPS for communication. Compared with a non-security cluster that uses HTTP for communication, the read performance of a security cluster is much slower. If you need fast read performance and user permission isolation for a security cluster for the purpose of isolating resources (such as indices, documents, and fields), you can disable HTTPS access. After HTTPS access is disabled, HTTP is used to communicate with the cluster. In this case, data security cannot be ensured and public IP address access cannot be enabled.
+When security mode is enabled for a cluster, HTTPS access is enabled by default. A security cluster uses HTTPS for communication. Compared with a non-security cluster that uses HTTP for communication, the read performance of a security cluster is much slower. If you need fast read performance and user permission isolation for a security cluster for the purpose of isolating resources (such as indices, documents, and fields), you can disable HTTPS access. After HTTPS access is disabled, HTTP is used to communicate with the cluster. In this case, data security cannot be ensured and public IP address access cannot be enabled.
After a cluster is created, HTTPS access status cannot be changed.
Public IP Address
+Public IP Address
You can configure this parameter only when the cluster has the Security Mode enabled. After enabling this function, you can obtain an IP address for accessing the cluster from the Internet. For details, see Public Network Access.
+You can configure this parameter only when the cluster has the Security Mode enabled. After enabling this function, you can obtain an IP address for accessing the cluster from the Internet. For details, see Public Network Access.
Figure 3 Configuring network specifications+
Figure 3 Configuring network specifications
- Set the enterprise project of the cluster.
When creating a CSS cluster, you can bind an enterprise project to the cluster if you have enabled enterprise project. You can select an enterprise project created by the current user from the drop-down list or click View Project Project to go to the Enterprise Project Management console and create a new project or view existing projects.
- Configure automatic snapshot creation for the cluster.
By default, the cluster snapshot function is enabled. If you do not need this function, you can disable Cluster Snapshot.
Basic Configuration- OBS Bucket: name of the OBS bucket used for storing snapshots.
- Backup Path: storage path of the snapshot in the OBS bucket.
- IAM Agency: authorized by the current account for CSS to access or maintain data stored in the OBS bucket.
- Snapshot Name Prefix: Enter a maximum of 32 characters starting 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.
- Backup Started: indicates the time when the backup starts automatically every day. You can specify this parameter only in hours, for example, 00:00 or 01:00. The value ranges from 00:00 to 23:00. Select a time from the drop-down list box.
- Retention Period (days): indicates the duration when snapshots are retained in the OBS bucket, in days. The value ranges from 1 to 90. You can specify this parameter as required. The system automatically deletes expired snapshots every hour at half past the hour.
- Configure advanced settings for the cluster.
- Default: The the VPC Endpoint Service, Kibana Public Access, and Tag functions are disabled by default. You can manually enable these functions after the cluster is created.
- Custom: You can enable the VPC Endpoint Service, Kibana Public Access, and Tag functions as required.
Table 5 Parameters for advanced settings Parameter
+Table 6 Parameters for advanced settings Parameter
Description
+Description
VPC Endpoint Service
+VPC Endpoint Service
After enabling this function, you can obtain a private domain name for accessing the cluster in the same VPC. For details, see VPC Endpoint Service.
+After enabling this function, you can obtain a private domain name for accessing the cluster in the same VPC. For details, see VPC Endpoint Service.
Kibana Public Access
+Kibana Public Access
You can configure this parameter only when security mode is enabled for a cluster. After enabling this function, you can obtain a public IP address for accessing Kibana. For details, see Kibana Public Access.
+You can configure this parameter only when security mode is enabled for a cluster. After enabling this function, you can obtain a public IP address for accessing Kibana. For details, see Kibana Public Access.
Tag
+Tag
Adding tags to clusters can help you identify and manage your cluster resources. You can customize tags or use tags predefined by Tag Management Service (TMS). For details, see Managing Tags.
+Adding tags to clusters can help you identify and manage your cluster resources. You can customize tags or use tags predefined by Tag Management Service (TMS). For details, see Managing Tags.
diff --git a/docs/css/umn/css_01_0048.html b/docs/css/umn/css_01_0048.html index 055d149e..849d0630 100644 --- a/docs/css/umn/css_01_0048.html +++ b/docs/css/umn/css_01_0048.html @@ -10,7 +10,7 @@After a cluster is created, you can access the cluster to use Elasticsearch and perform operations, such as, defining index data, importing data, and searching for data. For more information about Elasticsearch, see the Elasticsearch Reference. You can use any of the following methods to access a cluster:
- Accessing a Cluster Using Kibana on the Management Console
- Accessing a Cluster by Calling Elasticsearch APIs on the ECS That Is Located in the Same VPC as the Cluster
- Accessing a Cluster Using Java API in Non-security Mode
- Accessing a Cluster Using the Java API in Security Mode with Elasticsearch
Accessing a Cluster Using Kibana on the Management Console
- Log in to the CSS management console.
- In the left navigation pane, click Clusters.
- On the displayed Clusters page, locate the row containing the target cluster and click Access Kibana in the Operation column. -
- On the Kibana page that is displayed, you can create indices, query indices and documents, and analyze document fields. For details about Kibana, see Kibana. For details about how to import data to Elasticsearch, see the following sections: +
- On the Kibana page that is displayed, you can create indices, query indices and documents, and analyze document fields. For details about Kibana, see Product Components. For details about how to import data to Elasticsearch, see the following sections:
Accessing a Cluster by Calling Elasticsearch APIs on the ECS That Is Located in the Same VPC as the Cluster
The ECS that you use to access the cluster by calling Elasticsearch APIs, must meet the following requirements. For details about how to create and log in to an ECS, see Logging In to a Linux ECS or Logging In to a Windows ECS.
@@ -20,63 +20,66 @@ In the preceding command, the private network address and port number of only one node in the cluster are used. If the node fails, the command will fail to be executed. If the cluster contains multiple nodes, you can replace the private network address and port number of the faulty node with those of any available node in the cluster. If the cluster contains only one node, restore the node and execute the command again.
If encryption has not been enabled for the communication with the cluster, the command output is similar to that shown in the following figure.
-Figure 1 Command output+
Figure 1 Command output
Accessing a Cluster Using Java API in Non-security Mode
For clusters in the non-security mode, you are advised to use use RestHighLevelClient.
-- Create a client using the default method of the RestHighLevelClient class.+
1 -2 -3
-RestHighLevelClient client = new RestHighLevelClient( - RestClient.builder( - new HttpHost("localhost", 9200, "http"))); -
- Create a client using the default method of the RestHighLevelClient class.+ +
1 +2 +3
RestHighLevelClient client = new RestHighLevelClient( + RestClient.builder( + new HttpHost("localhost", 9200, "http"))); +
- Create a client using the default method of the RestHighLevelClient class.
- - \ No newline at end of file diff --git a/docs/css/umn/css_01_0041.html b/docs/css/umn/css_01_0041.html index dd23740c..e126cbb7 100644 --- a/docs/css/umn/css_01_0041.html +++ b/docs/css/umn/css_01_0041.html @@ -6,9 +6,7 @@Accessing a Cluster Using the Java API in Security Mode with Elasticsearch
After enabling the security mode function for Elasticsearch 7.1.1 and later versions, accessing a cluster requires the use of HTTPS and the username and password for authentication.
You need to use clusters 7.1.1 and later versions as well as related APIs if you use the Java API to access a cluster, because the TransportClient class in the earlier version cannot access a cluster using the username and password.
Two access modes are available: Create a client using either the TransportClient or RestHighLevelClient class. RestHighLevelClient is recommended.
-- Create a client using the TransportClient class.Run the following commands on the client to generate the keystore and truststore files. The certificate (CloudSearchService.cer) downloaded from the cluster management page is used.- - \ No newline at end of file diff --git a/docs/css/umn/css_01_0014.html b/docs/css/umn/css_01_0014.html index 44b76152..f29fda8d 100644 --- a/docs/css/umn/css_01_0014.html +++ b/docs/css/umn/css_01_0014.html @@ -1,13 +1,20 @@+
1 -2
-keytool -genkeypair -alias certificatekey -keyalg RSA -keystore transport-keystore.jks -keytool -import -alias certificatekey -file CloudSearchService.cer -keystore truststore.jks -
- Create a client using the TransportClient class.Run the following commands on the client to generate the keystore and truststore files. The certificate (CloudSearchService.cer) downloaded from the cluster management page is used.+ +
1 +2
keytool -genkeypair -alias certificatekey -keyalg RSA -keystore transport-keystore.jks +keytool -import -alias certificatekey -file CloudSearchService.cer -keystore truststore.jks +
Use the keystore and truststore files to access the cluster, create the TransportClient class using the PreBuiltTransportClient method, and add the settings in the client thread.
-The key code is as follows:+1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 -10 -11 -12 -13 -14 -15 -16
-String userPw = "username:password"; -String path = Paths.get(SecurityTransportClientDemo.class.getClassLoader().getResource(".").toURI()).toString(); - -Settings settings = Settings.builder() - .put("opendistro_security.ssl.transport.enforce_hostname_verification", false) - .put("opendistro_security.ssl.transport.keystore_filepath", path + "/transport-keystore.jks") - .put("opendistro_security.ssl.transport.keystore_password", "tscpass") - .put("opendistro_security.ssl.transport.truststore_filepath", path + "/truststore.jks") - .put("client.transport.ignore_cluster_name", "true") - .put("client.transport.sniff", false).build(); - -TransportClient client = (new PreBuiltTransportClient(settings, new Class[]{OpenDistroSecurityPlugin.class})).addTransportAddress(new - TransportAddress(InetAddress.getByName(ip), 9300)); - -String base64UserPw = Base64.getEncoder().encodeToString(userPw.getBytes("utf-8")); - client.threadPool().getThreadContext().putHeader("Authorization", "Basic " + base64UserPw); -
The key code is as follows:+ +1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16
String userPw = "username:password"; +String path = Paths.get(SecurityTransportClientDemo.class.getClassLoader().getResource(".").toURI()).toString(); + +Settings settings = Settings.builder() + .put("opendistro_security.ssl.transport.enforce_hostname_verification", false) + .put("opendistro_security.ssl.transport.keystore_filepath", path + "/transport-keystore.jks") + .put("opendistro_security.ssl.transport.keystore_password", "tscpass") + .put("opendistro_security.ssl.transport.truststore_filepath", path + "/truststore.jks") + .put("client.transport.ignore_cluster_name", "true") + .put("client.transport.sniff", false).build(); + +TransportClient client = (new PreBuiltTransportClient(settings, new Class[]{OpenDistroSecurityPlugin.class})).addTransportAddress(new + TransportAddress(InetAddress.getByName(ip), 9300)); + +String base64UserPw = Base64.getEncoder().encodeToString(userPw.getBytes("utf-8")); + client.threadPool().getThreadContext().putHeader("Authorization", "Basic " + base64UserPw); +
- Create a client using the RestHighLevelClient class.
The HttpHost class is used to process HTTP requests. In the HttpHost class, the CredentialsProvider and SSLIOSessionStrategy configuration parameter classes are encapsulated in the customized SecuredHttpClientConfigCallback class to configure request connection parameters.
SecuredHttpClientConfigCallback: encapsulates all user-defined connection parameters.
@@ -84,807 +87,812 @@SSLIOSessionStrategy: Configure SSL parameters, including the SSL domain name authentication mode and certificate processing mode. The SSLContext class is used to encapsulate related settings.
You can access a cluster through either of the following modes: ignore certificates and use certificates.
- Ignore all certificates and skip certificate authentication.
Construct the TrustManager. Use the default X509TrustManager. Do not rewrite any method. That is, ignore all related operations.
-Construct the SSLContext. Use TrustManager in the preceding step as the parameter and construct the SSLContext with the default method.+1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34
-static TrustManager[] trustAllCerts = new TrustManager[] { new X509TrustManager() { - @Override - public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException { - - } - @Override - public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException { - - } - @Override - public X509Certificate[] getAcceptedIssuers() { - return null; - } - }}; - final CredentialsProvider credentialsProvider = new BasicCredentialsProvider(); - credentialsProvider.setCredentials(AuthScope.ANY, - new UsernamePasswordCredentials(userName, password)); - SSLContext sc = null; - try{ - sc = SSLContext.getInstance("SSL"); - sc.init(null, trustAllCerts, new SecureRandom()); - }catch(KeyManagementException e){ - e.printStackTrace(); - }catch(NoSuchAlgorithmException e){ - e.printStackTrace(); - } - SSLIOSessionStrategy sessionStrategy = new SSLIOSessionStrategy(sc, new NullHostNameVerifier()); - - SecuredHttpClientConfigCallback httpClientConfigCallback = new SecuredHttpClientConfigCallback(sessionStrategy,credentialsProvider); - - RestClientBuilder builder = RestClient.builder(new HttpHost(clusterAddress, 9200, - "https")).setHttpClientConfigCallback(httpClientConfigCallback); - - RestHighLevelClient client = new RestHighLevelClient(builder); -
Construct the SSLContext. Use TrustManager in the preceding step as the parameter and construct the SSLContext with the default method.+ +1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34
static TrustManager[] trustAllCerts = new TrustManager[] { new X509TrustManager() { + @Override + public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException { + + } + @Override + public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException { + + } + @Override + public X509Certificate[] getAcceptedIssuers() { + return null; + } + }}; + final CredentialsProvider credentialsProvider = new BasicCredentialsProvider(); + credentialsProvider.setCredentials(AuthScope.ANY, + new UsernamePasswordCredentials(userName, password)); + SSLContext sc = null; + try{ + sc = SSLContext.getInstance("SSL"); + sc.init(null, trustAllCerts, new SecureRandom()); + }catch(KeyManagementException e){ + e.printStackTrace(); + }catch(NoSuchAlgorithmException e){ + e.printStackTrace(); + } + SSLIOSessionStrategy sessionStrategy = new SSLIOSessionStrategy(sc, new NullHostNameVerifier()); + + SecuredHttpClientConfigCallback httpClientConfigCallback = new SecuredHttpClientConfigCallback(sessionStrategy,credentialsProvider); + + RestClientBuilder builder = RestClient.builder(new HttpHost(clusterAddress, 9200, + "https")).setHttpClientConfigCallback(httpClientConfigCallback); + + RestHighLevelClient client = new RestHighLevelClient(builder); +
- Upload the downloaded certificate (CloudSearchService.cer) for accessing the cluster.
Upload the certificate to the client and use the keytool to convert the certificate into a format that can be read by Java. (The default password of the keytool is changeit).keytool -import -alias custom name -keystore path for exporting the certificate and its new name -file path for uploading the certificate
Customize the TrustManager class, which is inherited from the X509TrustManager. Read the certificate generated in the preceding step, add it to the trust certificate, and rewrite the three methods of the X509TrustManager interface.
-Construct the SSLContext. Use TrustManager in the preceding step as the parameter and construct the SSLContext with the default method.+1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44
-public static class MyX509TrustManager implements X509TrustManager { - - X509TrustManager sunJSSEX509TrustManager; - MyX509TrustManager() throws Exception { - File file = new File("certification file path"); - if (file.isFile() == false) { - throw new Exception("Wrong Certification Path"); - } - System.out.println("Loading KeyStore " + file + "..."); - InputStream in = new FileInputStream(file); - KeyStore ks = KeyStore.getInstance("JKS"); - ks.load(in, "changeit".toCharArray()); - TrustManagerFactory tmf = - TrustManagerFactory.getInstance("SunX509", "SunJSSE"); - tmf.init(ks); - TrustManager tms [] = tmf.getTrustManagers(); - for (int i = 0; i < tms.length; i++) { - if (tms[i] instanceof X509TrustManager) { - sunJSSEX509TrustManager = (X509TrustManager) tms[i]; - return; - } - } - throw new Exception("Couldn't initialize"); - } - -final CredentialsProvider credentialsProvider = new BasicCredentialsProvider(); - credentialsProvider.setCredentials(AuthScope.ANY, - new UsernamePasswordCredentials(userName, password)); - - SSLContext sc = null; - try{ - TrustManager[] tm = {new MyX509TrustManager()}; - sc = SSLContext.getInstance("SSL", "SunJSSE"); - sc.init(null, tm, new SecureRandom()); - }catch (Exception e) { - e.printStackTrace(); - } - - SSLIOSessionStrategy sessionStrategy = new SSLIOSessionStrategy(sc, new NullHostNameVerifier()); - - SecuredHttpClientConfigCallback httpClientConfigCallback = new SecuredHttpClientConfigCallback(sessionStrategy,credentialsProvider); - RestClientBuilder builder = RestClient.builder(new HttpHost(clusterAddress, 9200, "https")) - .setHttpClientConfigCallback(httpClientConfigCallback); - RestHighLevelClient client = new RestHighLevelClient(builder); -
Construct the SSLContext. Use TrustManager in the preceding step as the parameter and construct the SSLContext with the default method.+ +1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44
public static class MyX509TrustManager implements X509TrustManager { + + X509TrustManager sunJSSEX509TrustManager; + MyX509TrustManager() throws Exception { + File file = new File("certification file path"); + if (file.isFile() == false) { + throw new Exception("Wrong Certification Path"); + } + System.out.println("Loading KeyStore " + file + "..."); + InputStream in = new FileInputStream(file); + KeyStore ks = KeyStore.getInstance("JKS"); + ks.load(in, "changeit".toCharArray()); + TrustManagerFactory tmf = + TrustManagerFactory.getInstance("SunX509", "SunJSSE"); + tmf.init(ks); + TrustManager tms [] = tmf.getTrustManagers(); + for (int i = 0; i < tms.length; i++) { + if (tms[i] instanceof X509TrustManager) { + sunJSSEX509TrustManager = (X509TrustManager) tms[i]; + return; + } + } + throw new Exception("Couldn't initialize"); + } + +final CredentialsProvider credentialsProvider = new BasicCredentialsProvider(); + credentialsProvider.setCredentials(AuthScope.ANY, + new UsernamePasswordCredentials(userName, password)); + + SSLContext sc = null; + try{ + TrustManager[] tm = {new MyX509TrustManager()}; + sc = SSLContext.getInstance("SSL", "SunJSSE"); + sc.init(null, tm, new SecureRandom()); + }catch (Exception e) { + e.printStackTrace(); + } + + SSLIOSessionStrategy sessionStrategy = new SSLIOSessionStrategy(sc, new NullHostNameVerifier()); + + SecuredHttpClientConfigCallback httpClientConfigCallback = new SecuredHttpClientConfigCallback(sessionStrategy,credentialsProvider); + RestClientBuilder builder = RestClient.builder(new HttpHost(clusterAddress, 9200, "https")) + .setHttpClientConfigCallback(httpClientConfigCallback); + RestHighLevelClient client = new RestHighLevelClient(builder); +
- Sample code
When the code is running, transfer three parameters: access address, cluster login username, and password. The request is GET /_search{"query": {"match_all": {}}}.
The access address of a cluster with security mode enabled usually starts with https.
ESSecuredClient class (Ignore certificates)
-+ +1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 - 51 - 52 - 53 - 54 - 55 - 56 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 - 77 - 78 - 79 - 80 - 81 - 82 - 83 - 84 - 85 - 86 - 87 - 88 - 89 - 90 - 91 - 92 - 93 - 94 - 95 - 96 - 97 - 98 - 99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111
package securitymode; +
+1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111
-package securitymode; -import org.apache.http.auth.AuthScope; -import org.apache.http.auth.UsernamePasswordCredentials; -import org.apache.http.client.CredentialsProvider; -import org.apache.http.impl.client.BasicCredentialsProvider; -import org.apache.http.HttpHost; -import org.apache.http.nio.conn.ssl.SSLIOSessionStrategy; -import org.elasticsearch.action.search.SearchRequest; -import org.elasticsearch.action.search.SearchResponse; -import org.elasticsearch.client.RequestOptions; -import org.elasticsearch.client.RestClient; -import org.elasticsearch.client.RestClientBuilder; -import org.elasticsearch.client.RestHighLevelClient; -import org.elasticsearch.index.query.QueryBuilders; -import org.elasticsearch.search.SearchHit; -import org.elasticsearch.search.SearchHits; -import org.elasticsearch.search.builder.SearchSourceBuilder; +import org.apache.http.auth.AuthScope; +import org.apache.http.auth.UsernamePasswordCredentials; +import org.apache.http.client.CredentialsProvider; +import org.apache.http.impl.client.BasicCredentialsProvider; +import org.apache.http.HttpHost; +import org.apache.http.nio.conn.ssl.SSLIOSessionStrategy; +import org.elasticsearch.action.search.SearchRequest; +import org.elasticsearch.action.search.SearchResponse; +import org.elasticsearch.client.RequestOptions; +import org.elasticsearch.client.RestClient; +import org.elasticsearch.client.RestClientBuilder; +import org.elasticsearch.client.RestHighLevelClient; +import org.elasticsearch.index.query.QueryBuilders; +import org.elasticsearch.search.SearchHit; +import org.elasticsearch.search.SearchHits; +import org.elasticsearch.search.builder.SearchSourceBuilder; -import java.io.IOException; -import java.security.KeyManagementException; -import java.security.NoSuchAlgorithmException; -import java.security.SecureRandom; -import java.security.cert.CertificateException; -import java.security.cert.X509Certificate; +import java.io.IOException; +import java.security.KeyManagementException; +import java.security.NoSuchAlgorithmException; +import java.security.SecureRandom; +import java.security.cert.CertificateException; +import java.security.cert.X509Certificate; -import javax.net.ssl.HostnameVerifier; -import javax.net.ssl.SSLContext; -import javax.net.ssl.SSLSession; -import javax.net.ssl.TrustManager; -import javax.net.ssl.X509TrustManager; +import javax.net.ssl.HostnameVerifier; +import javax.net.ssl.SSLContext; +import javax.net.ssl.SSLSession; +import javax.net.ssl.TrustManager; +import javax.net.ssl.X509TrustManager; -public class ESSecuredClientIgnoreCerDemo { +public class ESSecuredClientIgnoreCerDemo { - public static void main(String[] args) { - String clusterAddress = args[0]; - String userName = args[1]; - String password = args[2]; - // Create a client. - RestHighLevelClient client = initESClient(clusterAddress, userName, password); - try { - // Search match_all, which is equivalent to {\"query\": {\"match_all\": {}}}. - SearchRequest searchRequest = new SearchRequest(); - SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder(); - searchSourceBuilder.query(QueryBuilders.matchAllQuery()); - searchRequest.source(searchSourceBuilder); + public static void main(String[] args) { + String clusterAddress = args[0]; + String userName = args[1]; + String password = args[2]; + // Create a client. + RestHighLevelClient client = initESClient(clusterAddress, userName, password); + try { + // Search match_all, which is equivalent to {\"query\": {\"match_all\": {}}}. + SearchRequest searchRequest = new SearchRequest(); + SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder(); + searchSourceBuilder.query(QueryBuilders.matchAllQuery()); + searchRequest.source(searchSourceBuilder); - SearchResponse searchResponse = client.search(searchRequest, RequestOptions.DEFAULT); - System.out.println("query result: " + searchResponse.toString()); - SearchHits hits = searchResponse.getHits(); - for (SearchHit hit : hits) { - System.out.println(hit.getSourceAsString()); - } - System.out.println("query success"); - Thread.sleep(2000L); - } catch (InterruptedException | IOException e) { - e.printStackTrace(); - } finally { - try { - client.close(); - System.out.println("close client"); - } catch (IOException e) { - e.printStackTrace(); - } - } - } + SearchResponse searchResponse = client.search(searchRequest, RequestOptions.DEFAULT); + System.out.println("query result: " + searchResponse.toString()); + SearchHits hits = searchResponse.getHits(); + for (SearchHit hit : hits) { + System.out.println(hit.getSourceAsString()); + } + System.out.println("query success"); + Thread.sleep(2000L); + } catch (InterruptedException | IOException e) { + e.printStackTrace(); + } finally { + try { + client.close(); + System.out.println("close client"); + } catch (IOException e) { + e.printStackTrace(); + } + } + } - private static RestHighLevelClient initESClient(String clusterAddress, String userName, String password) { - final CredentialsProvider credentialsProvider = new BasicCredentialsProvider(); - credentialsProvider.setCredentials(AuthScope.ANY, new UsernamePasswordCredentials(userName, password)); - SSLContext sc = null; - try { - sc = SSLContext.getInstance("SSL"); - sc.init(null, trustAllCerts, new SecureRandom()); - } catch (KeyManagementException | NoSuchAlgorithmException e) { - e.printStackTrace(); - } - SSLIOSessionStrategy sessionStrategy = new SSLIOSessionStrategy(sc, new NullHostNameVerifier()); - SecuredHttpClientConfigCallback httpClientConfigCallback = new SecuredHttpClientConfigCallback(sessionStrategy, - credentialsProvider); - RestClientBuilder builder = RestClient.builder(new HttpHost(clusterAddress, 9200, "https")) - .setHttpClientConfigCallback(httpClientConfigCallback); - RestHighLevelClient client = new RestHighLevelClient(builder); - return client; - } + private static RestHighLevelClient initESClient(String clusterAddress, String userName, String password) { + final CredentialsProvider credentialsProvider = new BasicCredentialsProvider(); + credentialsProvider.setCredentials(AuthScope.ANY, new UsernamePasswordCredentials(userName, password)); + SSLContext sc = null; + try { + sc = SSLContext.getInstance("SSL"); + sc.init(null, trustAllCerts, new SecureRandom()); + } catch (KeyManagementException | NoSuchAlgorithmException e) { + e.printStackTrace(); + } + SSLIOSessionStrategy sessionStrategy = new SSLIOSessionStrategy(sc, new NullHostNameVerifier()); + SecuredHttpClientConfigCallback httpClientConfigCallback = new SecuredHttpClientConfigCallback(sessionStrategy, + credentialsProvider); + RestClientBuilder builder = RestClient.builder(new HttpHost(clusterAddress, 9200, "https")) + .setHttpClientConfigCallback(httpClientConfigCallback); + RestHighLevelClient client = new RestHighLevelClient(builder); + return client; + } - static TrustManager[] trustAllCerts = new TrustManager[] { - new X509TrustManager() { - @Override - public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException { - } + static TrustManager[] trustAllCerts = new TrustManager[] { + new X509TrustManager() { + @Override + public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException { + } - @Override - public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException { - } + @Override + public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException { + } - @Override - public X509Certificate[] getAcceptedIssuers() { - return null; - } - } - }; + @Override + public X509Certificate[] getAcceptedIssuers() { + return null; + } + } + }; - public static class NullHostNameVerifier implements HostnameVerifier { - @Override - public boolean verify(String arg0, SSLSession arg1) { - return true; - } - } + public static class NullHostNameVerifier implements HostnameVerifier { + @Override + public boolean verify(String arg0, SSLSession arg1) { + return true; + } + } } -
ESSecuredClient class (Uses certificates)
-+ +1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 - 36 - 37 - 38 - 39 - 40 - 41 - 42 - 43 - 44 - 45 - 46 - 47 - 48 - 49 - 50 - 51 - 52 - 53 - 54 - 55 - 56 - 57 - 58 - 59 - 60 - 61 - 62 - 63 - 64 - 65 - 66 - 67 - 68 - 69 - 70 - 71 - 72 - 73 - 74 - 75 - 76 - 77 - 78 - 79 - 80 - 81 - 82 - 83 - 84 - 85 - 86 - 87 - 88 - 89 - 90 - 91 - 92 - 93 - 94 - 95 - 96 - 97 - 98 - 99 -100 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144
package securitymode; +
+1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + 11 + 12 + 13 + 14 + 15 + 16 + 17 + 18 + 19 + 20 + 21 + 22 + 23 + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 31 + 32 + 33 + 34 + 35 + 36 + 37 + 38 + 39 + 40 + 41 + 42 + 43 + 44 + 45 + 46 + 47 + 48 + 49 + 50 + 51 + 52 + 53 + 54 + 55 + 56 + 57 + 58 + 59 + 60 + 61 + 62 + 63 + 64 + 65 + 66 + 67 + 68 + 69 + 70 + 71 + 72 + 73 + 74 + 75 + 76 + 77 + 78 + 79 + 80 + 81 + 82 + 83 + 84 + 85 + 86 + 87 + 88 + 89 + 90 + 91 + 92 + 93 + 94 + 95 + 96 + 97 + 98 + 99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144
-package securitymode; -import org.apache.http.auth.AuthScope; -import org.apache.http.auth.UsernamePasswordCredentials; -import org.apache.http.client.CredentialsProvider; -import org.apache.http.impl.client.BasicCredentialsProvider; -import org.apache.http.HttpHost; -import org.apache.http.nio.conn.ssl.SSLIOSessionStrategy; -import org.elasticsearch.action.search.SearchRequest; -import org.elasticsearch.action.search.SearchResponse; -import org.elasticsearch.client.RequestOptions; -import org.elasticsearch.client.RestClient; -import org.elasticsearch.client.RestClientBuilder; -import org.elasticsearch.client.RestHighLevelClient; -import org.elasticsearch.index.query.QueryBuilders; -import org.elasticsearch.search.SearchHit; -import org.elasticsearch.search.SearchHits; -import org.elasticsearch.search.builder.SearchSourceBuilder; +import org.apache.http.auth.AuthScope; +import org.apache.http.auth.UsernamePasswordCredentials; +import org.apache.http.client.CredentialsProvider; +import org.apache.http.impl.client.BasicCredentialsProvider; +import org.apache.http.HttpHost; +import org.apache.http.nio.conn.ssl.SSLIOSessionStrategy; +import org.elasticsearch.action.search.SearchRequest; +import org.elasticsearch.action.search.SearchResponse; +import org.elasticsearch.client.RequestOptions; +import org.elasticsearch.client.RestClient; +import org.elasticsearch.client.RestClientBuilder; +import org.elasticsearch.client.RestHighLevelClient; +import org.elasticsearch.index.query.QueryBuilders; +import org.elasticsearch.search.SearchHit; +import org.elasticsearch.search.SearchHits; +import org.elasticsearch.search.builder.SearchSourceBuilder; -import java.io.File; -import java.io.FileInputStream; -import java.io.IOException; -import java.io.InputStream; -import java.security.KeyStore; -import java.security.SecureRandom; -import java.security.cert.CertificateException; -import java.security.cert.X509Certificate; +import java.io.File; +import java.io.FileInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.security.KeyStore; +import java.security.SecureRandom; +import java.security.cert.CertificateException; +import java.security.cert.X509Certificate; -import javax.net.ssl.HostnameVerifier; -import javax.net.ssl.SSLContext; -import javax.net.ssl.SSLSession; -import javax.net.ssl.TrustManager; -import javax.net.ssl.TrustManagerFactory; -import javax.net.ssl.X509TrustManager; +import javax.net.ssl.HostnameVerifier; +import javax.net.ssl.SSLContext; +import javax.net.ssl.SSLSession; +import javax.net.ssl.TrustManager; +import javax.net.ssl.TrustManagerFactory; +import javax.net.ssl.X509TrustManager; -public class ESSecuredClientWithCerDemo { +public class ESSecuredClientWithCerDemo { - public static void main(String[] args) { - String clusterAddress = args[0]; - String userName = args[1]; - String password = args[2]; - String cerFilePath = args[3]; - String cerPassword = args[4]; - // Create a client. - RestHighLevelClient client = initESClient(clusterAddress, userName, password, cerFilePath, cerPassword); - try { - // Search match_all, which is equivalent to {\"query\": {\"match_all\": {}}}. - SearchRequest searchRequest = new SearchRequest(); - SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder(); - searchSourceBuilder.query(QueryBuilders.matchAllQuery()); - searchRequest.source(searchSourceBuilder); + public static void main(String[] args) { + String clusterAddress = args[0]; + String userName = args[1]; + String password = args[2]; + String cerFilePath = args[3]; + String cerPassword = args[4]; + // Create a client. + RestHighLevelClient client = initESClient(clusterAddress, userName, password, cerFilePath, cerPassword); + try { + // Search match_all, which is equivalent to {\"query\": {\"match_all\": {}}}. + SearchRequest searchRequest = new SearchRequest(); + SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder(); + searchSourceBuilder.query(QueryBuilders.matchAllQuery()); + searchRequest.source(searchSourceBuilder); - // query - SearchResponse searchResponse = client.search(searchRequest, RequestOptions.DEFAULT); - System.out.println("query result: " + searchResponse.toString()); - SearchHits hits = searchResponse.getHits(); - for (SearchHit hit : hits) { - System.out.println(hit.getSourceAsString()); - } - System.out.println("query success"); - Thread.sleep(2000L); - } catch (InterruptedException | IOException e) { - e.printStackTrace(); - } finally { - try { - client.close(); - System.out.println("close client"); - } catch (IOException e) { - e.printStackTrace(); - } - } - } + // query + SearchResponse searchResponse = client.search(searchRequest, RequestOptions.DEFAULT); + System.out.println("query result: " + searchResponse.toString()); + SearchHits hits = searchResponse.getHits(); + for (SearchHit hit : hits) { + System.out.println(hit.getSourceAsString()); + } + System.out.println("query success"); + Thread.sleep(2000L); + } catch (InterruptedException | IOException e) { + e.printStackTrace(); + } finally { + try { + client.close(); + System.out.println("close client"); + } catch (IOException e) { + e.printStackTrace(); + } + } + } - private static RestHighLevelClient initESClient(String clusterAddress, String userName, String password, - String cerFilePath, String cerPassword) { - final CredentialsProvider credentialsProvider = new BasicCredentialsProvider(); - credentialsProvider.setCredentials(AuthScope.ANY, new UsernamePasswordCredentials(userName, password)); - SSLContext sc = null; - try { - TrustManager[] tm = {new MyX509TrustManager(cerFilePath, cerPassword)}; - sc = SSLContext.getInstance("SSL", "SunJSSE"); - //You can also use SSLContext sslContext = SSLContext.getInstance("TLSv1.2"); - sc.init(null, tm, new SecureRandom()); - } catch (Exception e) { - e.printStackTrace(); - } + private static RestHighLevelClient initESClient(String clusterAddress, String userName, String password, + String cerFilePath, String cerPassword) { + final CredentialsProvider credentialsProvider = new BasicCredentialsProvider(); + credentialsProvider.setCredentials(AuthScope.ANY, new UsernamePasswordCredentials(userName, password)); + SSLContext sc = null; + try { + TrustManager[] tm = {new MyX509TrustManager(cerFilePath, cerPassword)}; + sc = SSLContext.getInstance("SSL", "SunJSSE"); + //You can also use SSLContext sslContext = SSLContext.getInstance("TLSv1.2"); + sc.init(null, tm, new SecureRandom()); + } catch (Exception e) { + e.printStackTrace(); + } - SSLIOSessionStrategy sessionStrategy = new SSLIOSessionStrategy(sc, new NullHostNameVerifier()); - SecuredHttpClientConfigCallback httpClientConfigCallback = new SecuredHttpClientConfigCallback(sessionStrategy, - credentialsProvider); - RestClientBuilder builder = RestClient.builder(new HttpHost(clusterAddress, 9200, "https")) - .setHttpClientConfigCallback(httpClientConfigCallback); - RestHighLevelClient client = new RestHighLevelClient(builder); - return client; - } + SSLIOSessionStrategy sessionStrategy = new SSLIOSessionStrategy(sc, new NullHostNameVerifier()); + SecuredHttpClientConfigCallback httpClientConfigCallback = new SecuredHttpClientConfigCallback(sessionStrategy, + credentialsProvider); + RestClientBuilder builder = RestClient.builder(new HttpHost(clusterAddress, 9200, "https")) + .setHttpClientConfigCallback(httpClientConfigCallback); + RestHighLevelClient client = new RestHighLevelClient(builder); + return client; + } - public static class MyX509TrustManager implements X509TrustManager { - X509TrustManager sunJSSEX509TrustManager; + public static class MyX509TrustManager implements X509TrustManager { + X509TrustManager sunJSSEX509TrustManager; - MyX509TrustManager(String cerFilePath, String cerPassword) throws Exception { - File file = new File(cerFilePath); - if (!file.isFile()) { - throw new Exception("Wrong Certification Path"); - } - System.out.println("Loading KeyStore " + file + "..."); - InputStream in = new FileInputStream(file); - KeyStore ks = KeyStore.getInstance("JKS"); - ks.load(in, cerPassword.toCharArray()); - TrustManagerFactory tmf = TrustManagerFactory.getInstance("SunX509", "SunJSSE"); - tmf.init(ks); - TrustManager[] tms = tmf.getTrustManagers(); - for (TrustManager tm : tms) { - if (tm instanceof X509TrustManager) { - sunJSSEX509TrustManager = (X509TrustManager) tm; - return; - } - } - throw new Exception("Couldn't initialize"); - } + MyX509TrustManager(String cerFilePath, String cerPassword) throws Exception { + File file = new File(cerFilePath); + if (!file.isFile()) { + throw new Exception("Wrong Certification Path"); + } + System.out.println("Loading KeyStore " + file + "..."); + InputStream in = new FileInputStream(file); + KeyStore ks = KeyStore.getInstance("JKS"); + ks.load(in, cerPassword.toCharArray()); + TrustManagerFactory tmf = TrustManagerFactory.getInstance("SunX509", "SunJSSE"); + tmf.init(ks); + TrustManager[] tms = tmf.getTrustManagers(); + for (TrustManager tm : tms) { + if (tm instanceof X509TrustManager) { + sunJSSEX509TrustManager = (X509TrustManager) tm; + return; + } + } + throw new Exception("Couldn't initialize"); + } - @Override - public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException { + @Override + public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException { - } + } - @Override - public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException { + @Override + public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException { - } + } - @Override - public X509Certificate[] getAcceptedIssuers() { - return new X509Certificate[0]; - } - } + @Override + public X509Certificate[] getAcceptedIssuers() { + return new X509Certificate[0]; + } + } - public static class NullHostNameVerifier implements HostnameVerifier { - @Override - public boolean verify(String arg0, SSLSession arg1) { - return true; - } - } + public static class NullHostNameVerifier implements HostnameVerifier { + @Override + public boolean verify(String arg0, SSLSession arg1) { + return true; + } + } } -
SecuredHttpClientConfigCallback class
-+ +1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59
import org.apache.http.client.CredentialsProvider; -import org.apache.http.impl.nio.client.HttpAsyncClientBuilder; -import org.apache.http.nio.conn.ssl.SSLIOSessionStrategy; -import org.elasticsearch.client.RestClientBuilder; -import org.elasticsearch.common.Nullable; -import java.util.Objects; -class SecuredHttpClientConfigCallback implements RestClientBuilder.HttpClientConfigCallback { - @Nullable - private final CredentialsProvider credentialsProvider; - /** +
+1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59
-import org.apache.http.client.CredentialsProvider; +import org.apache.http.impl.nio.client.HttpAsyncClientBuilder; +import org.apache.http.nio.conn.ssl.SSLIOSessionStrategy; +import org.elasticsearch.client.RestClientBuilder; +import org.elasticsearch.common.Nullable; +import java.util.Objects; +class SecuredHttpClientConfigCallback implements RestClientBuilder.HttpClientConfigCallback { + @Nullable + private final CredentialsProvider credentialsProvider; + /** * The {@link SSLIOSessionStrategy} for all requests to enable SSL / TLS encryption. */ - private final SSLIOSessionStrategy sslStrategy; - /** + private final SSLIOSessionStrategy sslStrategy; + /** * Create a new {@link SecuredHttpClientConfigCallback}. * * @param credentialsProvider The credential provider, if a username/password have been supplied * @param sslStrategy The SSL strategy, if SSL / TLS have been supplied * @throws NullPointerException if {@code sslStrategy} is {@code null} */ - SecuredHttpClientConfigCallback(final SSLIOSessionStrategy sslStrategy, - @Nullable final CredentialsProvider credentialsProvider) { - this.sslStrategy = Objects.requireNonNull(sslStrategy); - this.credentialsProvider = credentialsProvider; - } - /** + SecuredHttpClientConfigCallback(final SSLIOSessionStrategy sslStrategy, + @Nullable final CredentialsProvider credentialsProvider) { + this.sslStrategy = Objects.requireNonNull(sslStrategy); + this.credentialsProvider = credentialsProvider; + } + /** * Get the {@link CredentialsProvider} that will be added to the HTTP client. * * @return Can be {@code null}. */ - @Nullable - CredentialsProvider getCredentialsProvider() { - return credentialsProvider; - } - /** + @Nullable + CredentialsProvider getCredentialsProvider() { + return credentialsProvider; + } + /** * Get the {@link SSLIOSessionStrategy} that will be added to the HTTP client. * * @return Never {@code null}. */ - SSLIOSessionStrategy getSSLStrategy() { - return sslStrategy; - } - /** + SSLIOSessionStrategy getSSLStrategy() { + return sslStrategy; + } + /** * Sets the {@linkplain HttpAsyncClientBuilder#setDefaultCredentialsProvider(CredentialsProvider) credential provider}, * * @param httpClientBuilder The client to configure. * @return Always {@code httpClientBuilder}. */ - @Override - public HttpAsyncClientBuilder customizeHttpClient(final HttpAsyncClientBuilder httpClientBuilder) { - // enable SSL / TLS - httpClientBuilder.setSSLStrategy(sslStrategy); - // enable user authentication - if (credentialsProvider != null) { - httpClientBuilder.setDefaultCredentialsProvider(credentialsProvider); - } - return httpClientBuilder; - } + @Override + public HttpAsyncClientBuilder customizeHttpClient(final HttpAsyncClientBuilder httpClientBuilder) { + // enable SSL / TLS + httpClientBuilder.setSSLStrategy(sslStrategy); + // enable user authentication + if (credentialsProvider != null) { + httpClientBuilder.setDefaultCredentialsProvider(credentialsProvider); + } + return httpClientBuilder; + } } -
- Upload the downloaded certificate (CloudSearchService.cer) for accessing the cluster.
pom.xml file<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> @@ -991,10 +999,3 @@ - Create a client using the RestHighLevelClient class.
Restarting a Cluster
-If a cluster becomes faulty, you can restart it to check if it can run normally. Only clusters in the Available or Abnormal status can be restarted.
-diff --git a/docs/css/umn/css_01_0033.html b/docs/css/umn/css_01_0033.html index 32d8787a..efc1945b 100644 --- a/docs/css/umn/css_01_0033.html +++ b/docs/css/umn/css_01_0033.html @@ -8,10 +8,7 @@Quick Restart
- The cluster is in the Available or Abnormal status.
- There are no running tasks, such as importing data, searching for data on the cluster.
-
- The cluster will be unavailable during quick restart. If quick restart fails, data may be lost or the cluster may become unavailable. Therefore, exercise caution when performing this operation.
- If the cluster you want to restart is available, you are advised to stop all data processing tasks on the cluster before restarting it. If there are running tasks, for example, importing data, searching for data, the transmitted data may be lost upon the restart. Therefore you are advised to stop all cluster tasks before the quick restart.
- Log in to the CSS management console.
- Click Clusters to switch to the Clusters page. In the row that contains the cluster you want to restart, click More > Restart in the Operation column. The Restart Cluster page is displayed. Select Quick Restart.
-
- You can quick restart nodes by Node type or Node name. If you select Node type, then you can select multiple node types and perform quick restart at the time. If you select Node name, you can perform quick restart only on one node at a time.
- The cluster is unavailable during quick restart.
- Refresh the page and check the cluster status. During the restart, the cluster status is Processing, and the task status is Restarting. If the cluster status changes to Available, the cluster has been restarted successfully. If the cluster status changes to Abnormal, contact the technical support for troubleshooting.
If a cluster becomes faulty, you can restart it to check if it can run normally.
++Prerequisites
- The target cluster is not frozen and has no task in progress.
- If a cluster is available, ensure that it has stopped processing service requests (such as importing data and searching for data). Otherwise, data may be lost when the cluster is restarted. You are advised to perform this operation during off-peak hours.
+Context
CSS supports quick restart and rolling restart.
+Quick Restart+- All clusters support this function.
- If you select a node type for quick restart, all nodes of the selected type will be restarted together.
- If you select a node name for quick restart, only the specified node will be restarted.
- The cluster is unavailable during quick restart.
Rolling Restart+- Rolling restart is supported only when a cluster has more than three nodes (including master nodes, client nodes, and cold data nodes).
- Rolling restart can be performed only by specifying node types. If you select a node type for rolling restart, the nodes of the selected type will be restarted in sequence.
- During the rolling restart, only the nodes that are being restarted are unavailable and other nodes can run normally.
- When the data volume is large, rolling restart will take a long time.
+Quick Restart
- Log in to the CSS management console.
- In the navigation pane on the left, choose Clusters > Elasticsearch. On the displayed Clusters page, locate the target cluster and choose More > Restart in the Operation column.
- On the Restart Cluster page, select Quick Restart.
You can quick restart nodes by Node type or Node name. If you select Node type, then you can select multiple node types and perform quick restart at the time. If you select Node name, you can perform quick restart only on one node at a time.
+ - Refresh the page and check the cluster status. During the restart, the cluster status is Processing, and the task status is Restarting. If the cluster status changes to Available, the cluster has been restarted successfully.
Rolling Restart
- Log in to the CSS management console.
- In the navigation pane on the left, choose Clusters > Elasticsearch. On the displayed Clusters page, locate the target cluster and choose More > Restart in the Operation column.
- On the Restart Cluster page, select Rolling Restart.
You can perform rolling restart by Node type. Select specific node types for restart.
+ - Refresh the page and check the cluster status. During the restart, the cluster status is Processing, and the task status is Restarting. If the cluster status changes to Available, the cluster has been restarted successfully.
diff --git a/docs/css/umn/css_01_0024.html b/docs/css/umn/css_01_0024.html index 89f4526c..c5f5087b 100644 --- a/docs/css/umn/css_01_0024.html +++ b/docs/css/umn/css_01_0024.html @@ -49,7 +49,7 @@ {"index":{}} {"productName":"Latest art shirts for women in 2017 autumn","size":"L"}The command output is similar to that shown in Figure 1. If the value of the errors field in the result is false, the data is successfully imported.
- +-Prerequisites
To use the function of creating or restoring snapshots, the account or IAM user that logs in to the CSS management console must have both of the following permissions:
- Tenant Administrator for project OBS in region Global service
- CSS Administrator in the current region
@@ -21,10 +19,3 @@Managing Automatic Snapshot Creation
- In the left navigation pane of the CSS management console, click Clusters.
- On the Clusters page that is displayed, click the name of the target cluster. On the displayed page, click Cluster Snapshots.
Alternatively, on the Clusters page, locate the row that contains the target cluster and click More > Back Up and Restore in the Operation column to switch to the Cluster Snapshots page.
- - On the displayed Cluster Snapshots page, click the icon to the right of Cluster Snapshot to enable the cluster snapshot function.
-
indicates that the cluster snapshot function is disabled.
-
indicates that the cluster snapshot function is enabled. - (Optional) After the cluster snapshot function is enabled, CSS automatically creates the OBS bucket and IAM agency for you to store snapshots. The automatically created OBS bucket and IAM agency are displayed on the page. If you want to change the OBS bucket and IAM agency, click
to the right of Basic Configuration. To ensure the security of snapshot data, you can select a key to encrypt the snapshot.In the displayed Edit Basic Configuration dialog box, you can either select an existing OBS bucket and IAM agency or create an OBS bucket and IAM agency. To create an OBS bucket, click Create Bucket. To create an IAM agency, click Create IAM Agency. For details, see Creating a Bucket and Creating an Agency. To encrypt the snapshot, select Snapshot Encryption and select a key.
+Managing Automatic Snapshot Creation
- In the left navigation pane of the CSS management console, click Clusters.
- On the Clusters page that is displayed, click the name of the target cluster. On the displayed page, click Cluster Snapshots.
- On the displayed Cluster Snapshots page, click the icon to the right of Cluster Snapshot to enable the cluster snapshot function.
- (Optional) After the cluster snapshot function is enabled, CSS automatically creates the OBS bucket and IAM agency for you to store snapshots. The automatically created OBS bucket and IAM agency are displayed on the page. If you want to change the OBS bucket and IAM agency, click
to the right of Basic Configuration. To ensure the security of snapshot data, you can select a key to encrypt the snapshot.In the displayed Edit Basic Configuration dialog box, you can either select an existing OBS bucket and IAM agency or create an OBS bucket and IAM agency. To create an OBS bucket, click Create Bucket. To create an IAM agency, click Create IAM Agency. For details, see Creating a Bucket and Creating an Agency. To encrypt the snapshot, select Snapshot Encryption and select a key.
-Table 1 Parameter description Parameter
Figure 1 Edit Basic configuration-
- Click the icon to the right of Automatic Snapshot Creation to enable the automatic snapshot creation function.
-
indicates that the automatic snapshot function is enabled.
- indicates that the automatic snapshot function is disabled. - In the displayed Edit Snapshot Policy dialog box, specify parameters as required.
- Snapshot Name Prefix: Enter a maximum of 31 characters starting with a 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-2018022405925.
- Time Zone: indicates the time zone for the backup time. Specify Backup Started based on the time zone.
- Index: Enter the name of an index. The automatic snapshot creation function supports backup of certain indices in the cluster. Uppercase letters, spaces, and certain special characters (including "\<|>/?) are not allowed. Use commas (,) to separate multiple indices. If you do not specify this parameter, data of all indices in the cluster is backed up by default. You can use the asterisk (*) to back up data of certain indices. For example, if you enter index*, then data of indices with the name prefix of index will be backed up.
You can run the GET /_cat/indices command in Kibana to query names of all indices in the cluster. You can then enter the names of the indices you want to back up.
- - Backup Started: indicates the time when the backup starts automatically every day. You can specify this parameter only in hours and not minutes, for example, 00:00 or 01:00. The value ranges from 00:00 to 23:00. Select the backup time from the drop-down list box.
- Retention Period (days): indicates the duration when snapshots are retained in the OBS bucket, in days. The value ranges from 1 to 90. You can specify this parameter as required. The system automatically deletes snapshots that are retained over the specified retention period on the half hour. For example, if you set the snapshot policy as shown in Figure 2, the system will automatically delete in 35 days at 00:30 the automated snapshots that were created 35 days earlier at 00:00.
- Click OK.
After the policy for automatic snapshot creation is created, the policy information will be displayed on the Cluster Snapshots page. If you need to change the policy due to business changes, click
-.Snapshots that are automatically created according to the snapshot policy are displayed in the snapshot list, along with manually created snapshots. You can distinguish them by the Snapshot Type setting. In the upper right corner of the snapshot list, enter the keyword of the snapshot name or snapshot ID to search for the desired snapshots. You can also click
-
to sort snapshots based on related parameter settings.Figure 3 Automatic snapshot creation+
- Click the icon to the right of Automatic Snapshot Creation to enable the automatic snapshot creation function.
- In the displayed Edit Snapshot Policy dialog box, specify parameters as required.
- Snapshot Name Prefix: Enter a maximum of 31 characters starting with a 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-2018022405925.
- Time Zone: indicates the time zone for the backup time. Specify Backup Started based on the time zone.
- Index: Enter the name of an index. The automatic snapshot creation function supports backup of certain indices in the cluster. Uppercase letters, spaces, and certain special characters (including "\<|>/?) are not allowed. Use commas (,) to separate multiple indices. If you do not specify this parameter, data of all indices in the cluster is backed up by default. You can use the asterisk (*) to back up data of certain indices. For example, if you enter index*, then data of indices with the name prefix of index will be backed up.
You can run the GET /_cat/indices command in Kibana to query names of all indices in the cluster. You can then enter the names of the indices you want to back up.
+ - Backup Started: indicates the time when the backup starts automatically every day. You can specify this parameter only in hours and not minutes, for example, 00:00 or 01:00. The value ranges from 00:00 to 23:00. Select the backup time from the drop-down list box.
- Retention Period (days): indicates the duration when snapshots are retained in the OBS bucket, in days. The value ranges from 1 to 90. You can specify this parameter as required. The system automatically deletes snapshots that are retained over the specified retention period on the half hour. For example, if you set the snapshot policy as shown in Figure 1, the system will automatically delete in 35 days at 00:30 the automated snapshots that were created 35 days earlier at 00:00.
- Click OK.
After the policy for automatic snapshot creation is created, the policy information will be displayed on the Cluster Snapshots page. If you need to change the policy due to business changes, click
+.Snapshots that are automatically created according to the snapshot policy are displayed in the snapshot list, along with manually created snapshots. You can distinguish them by the Snapshot Type setting. In the upper right corner of the snapshot list, enter the keyword of the snapshot name or snapshot ID to search for the desired snapshots. You can also click
+
to sort snapshots based on related parameter settings.Figure 2 Automatic snapshot creation
- (Optional) Disable the automatic snapshot creation function.
After you disable the automatic snapshot creation function, the system stops automatic creation of snapshots. If the system is creating a snapshot based on the automatic snapshot creation policy and the snapshot is not yet displayed in the snapshot list, you cannot disable the automatic snapshot creation function. In this case, if you click the button next to Automatic Snapshot Creation, a message is displayed, indicating that you cannot disable the function. You are advised to disable the function after the system completes automatic creation of the snapshot, and the created snapshot is displayed in the snapshot list.
When disabling the automatic snapshot creation function, you can choose whether to delete the snapshots that have been automatically created by selecting Delete automated snapshots in the displayed dialog box. By default, automatically created snapshots are not deleted.
- If you do not select Delete automated snapshots, automatically created snapshots are not deleted when you disable the automatic snapshot creation function. You can manually delete them later. For details, see Deleting a Snapshot. If you do not manually delete the automatically created snapshots and enable the automatic snapshot creation function again, then all snapshots with Snapshot Type set to Automated in the snapshot list of the cluster can only be automatically deleted by the system. Specifically, the system automatically deletes snapshots based on the snapshot policy configured when you enable the automatic snapshot creation function again. For example, if you set Retention Period (days) to 10, the system will automatically delete the snapshots that have been retained for more than 10 days.
- If you select Delete automated snapshots, all snapshots with Snapshot Type set to Automated in the snapshot list will be deleted when you disable the automatic snapshot creation function.
Manually Creating a Snapshot
- In the left navigation pane of the CSS management console, click Clusters.
- On the Clusters page that is displayed, click the name of the target cluster. On the displayed page, click Cluster Snapshots.
Alternatively, on the Clusters page, locate the row that contains the target cluster and click More > Back Up and Restore in the Operation column to switch to the Cluster Snapshots page.
- - On the displayed Cluster Snapshots page, click the icon to the right of Cluster Snapshot to enable the cluster snapshot function.
- indicates that the cluster snapshot function is disabled.
-
indicates that the cluster snapshot function is enabled. - (Optional) After the cluster snapshot function is enabled, CSS automatically creates the OBS bucket and IAM agency for you to store snapshots. The automatically created OBS bucket and IAM agency are displayed on the page. If you want to change the OBS bucket and IAM agency, click to the right of Basic Configuration. For details about how to configure parameters involved in the basic configuration, see 4.
- After basic configurations are completed, click Create.
- Name indicates the name of the manually created snapshot, which can contain 4 to 64 characters and must start with a lowercase letter. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed. For snapshots you create manually, you can specify the snapshot name. The system will not automatically add the time information to the snapshot name.
- Index: Enter the name of an index. The manually created snapshot can back up data of certain indices in the cluster. The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?) are not allowed. Multiple index names are separated by commas (,). If you do not specify this parameter, data of all indices in the cluster is backed up by default. You can use the asterisk (*) to back up data of certain indices. For example, if you enter 2018-06*, then data of indices with the name prefix of 2018-06 will be backed up.- - \ No newline at end of file diff --git a/docs/css/umn/css_01_0040.html b/docs/css/umn/css_01_0040.html index 9dac8d90..f0b8285f 100644 --- a/docs/css/umn/css_01_0040.html +++ b/docs/css/umn/css_01_0040.html @@ -8,10 +8,8 @@
Run the GET /_cat/indices command in Kibana to query all index names in the cluster.
+- On the displayed Cluster Snapshots page, click the icon to the right of Cluster Snapshot to enable the cluster snapshot function.
+
indicates that the cluster snapshot function is disabled.
+
indicates that the cluster snapshot function is enabled.- (Optional) After the cluster snapshot function is enabled, CSS automatically creates the OBS bucket and IAM agency for you to store snapshots. The automatically created OBS bucket and IAM agency are displayed on the page. If you want to change the OBS bucket and IAM agency, click
to the right of Basic Configuration. For details about how to configure parameters involved in the basic configuration, see 4.- After basic configurations are completed, click Create.
- Name indicates the name of the manually created snapshot, which can contain 4 to 64 characters and must start with a lowercase letter. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed. For snapshots you create manually, you can specify the snapshot name. The system will not automatically add the time information to the snapshot name.
- Index: Enter the name of an index. The manually created snapshot can back up data of certain indices in the cluster. The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?) are not allowed. Multiple index names are separated by commas (,). If you do not specify this parameter, data of all indices in the cluster is backed up by default. You can use the asterisk (*) to back up data of certain indices. For example, if you enter 2018-06*, then data of indices with the name prefix of 2018-06 will be backed up.
Run the GET /_cat/indices command in Kibana to query all index names in the cluster.
- Description: indicates the description of the created snapshot. The value contains 0 to 256 characters, and certain special characters (<>) are not allowed.
Figure 4 Creating a snapshot-
- Click OK.
After the snapshot is created, it will be displayed in the snapshot list. The status Available indicates that the snapshot is created successfully. All automatically and manually created snapshots are displayed in the snapshot list. You can distinguish them by the Snapshot Type setting. In the upper right corner of the snapshot list, enter the keyword of the snapshot name or snapshot ID to search for the desired snapshots. You can also click
+ to sort snapshots based on related parameter settings.Figure 3 Creating a snapshot+
- Click OK.
After the snapshot is created, it will be displayed in the snapshot list. The status Available indicates that the snapshot is created successfully. All automatically and manually created snapshots are displayed in the snapshot list. You can distinguish them by the Snapshot Type setting. In the upper right corner of the snapshot list, enter the keyword of the snapshot name or snapshot ID to search for the desired snapshots. You can also click
to sort snapshots based on related parameter settings.Restoring Data
You can use snapshots whose Snapshot Status is Available to restore cluster data. The stored snapshot data can be restored to other clusters.
@@ -82,9 +76,9 @@Rename Pattern: Enter a regular expression. Indices that match the regular expression are restored. The default value index_(.+) indicates restoring data of all indices. The value contains 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?,) are not allowed.
Rename Replacement: Enter the index renaming rule. The default value restored_index_$1 indicates that restored_ is added in front of the names of all restored indices. The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?,) are not allowed. You can set Rename Replacement only if you have specified Rename Pattern.
Cluster: Select the cluster that you want to restore. You can select the current cluster or others. However, you can only restore the snapshot to clusters whose status is Available. If the status of the current cluster is Unavailable, you cannot restore the snapshot to the current cluster. If you select another cluster and two or more indices in the cluster have the same name, data of all indices with the same name as the name you specify will be overwritten. Therefore, exercise caution when you set the parameters.
-Figure 5 Restoring a snapshot+
Figure 4 Restoring a snapshot-
- Click OK. If restoration succeeds, Task Status of the snapshot in the snapshot list will change to Restoration succeeded, and the index data is generated again according to the snapshot information.
Figure 6 Successful restoration+
- Click OK. If restoration succeeds, Task Status of the snapshot in the snapshot list will change to Restoration succeeded, and the index data is generated again according to the snapshot information.
Figure 5 Successful restoration
Deleting a Snapshot
If you no longer need a snapshot, delete it to release storage resources. If the automatic snapshot creation function is enabled, snapshots that are automatically created cannot be deleted manually, and the system automatically deletes these snapshots on the half hour after the time specified by Retention Period (days). If you disable the automatic snapshot creation function while retaining the automated snapshots, then you can manually delete them later. If you do not manually delete the automatically created snapshots and enable the automatic snapshot creation function again, then all snapshots with Snapshot Type set to Automated in the snapshot list of the cluster can only be automatically deleted by the system.
@@ -99,10 +93,3 @@ - On the displayed Cluster Snapshots page, click the icon to the right of Cluster Snapshot to enable the cluster snapshot function.
In this section, assume that data of cluster Es-1 is migrated to cluster Es-2. Cluster Es-2 runs a version later than that of cluster Es-1 and the number of nodes in cluster Es-2 is greater than half of that in cluster Es-1.
Procedure
- On the Clusters page, click Es-1. On the displayed page, click Cluster Snapshots.
- Click Create Snapshot to manually create a snapshot. In the displayed dialog box, enter the snapshot name and click OK.
If you use the index backup and restoration function for the first time, you need to perform basic configurations first. For more details, see Manually Creating a Snapshot.
-Figure 1 Creating a snapshot
- In the snapshot list, locate the row that contains the target snapshot and click Restore in the Operation column to restore data to cluster Es-2.
- Leave the Index option blank (default setting), indicating that you want to restore data of all indices in cluster Es-1.
- From the Cluster drop-down list, select Es-2.
Click OK. You can also rename the restored index.
-Figure 2 Restoring a snapshot
- After restoration is complete, data in cluster Es-1 will be migrated to cluster Es-2.
- Create a client using the TransportClient class.
- After installing Logstash, perform the following steps to import data. For details about how to install Logstash, visit the following website: https://www.elastic.co/guide/en/logstash/current/installing-logstash.html
- The JDK must be installed before Logstash is installed. In Linux OS, you can run the yum -y install java-1.8.0 command to install JDK 1.8.0. In Windows OS, you can download the required JDK version from the official website of JDK, and install it by following the installation guide.
- In the Importing Data When Logstash Is Deployed on an ECS scenario, ensure that the ECS and the Elasticsearch cluster to which data is imported reside in the same VPC.
Importing Data When Logstash Is Deployed on the External Network
Figure 1 illustrates how data is imported when Logstash is deployed on an external network.
- +- Create a jump host and configure it as follows:
- The jump host is an ECS running the Linux OS and has been bound with an EIP.
- The jump host resides in the same VPC as the CSS cluster.
- SSH local port forwarding is configured for the jump host to forward requests from a chosen local port to port 9200 on one node of the CSS cluster.
- Refer to SSH documentation for the local port forwarding configuration.
- Use PuTTY to log in to the created jump host with the EIP.
- Run the following command to perform port mapping and transfer the request sent to the port on the jump host to the target cluster:
ssh -g -L <Local port of the jump host:Private network address and port number of a node> -N -f root@<Private IP address of the jump host>
@@ -69,7 +69,7 @@ output { If a license error is reported, set ilm_enabled to false.
If the cluster has the security mode enabled, you need to download a certificate first.
-- Download a certificate on the Basic Information page of the cluster.Figure 2 Downloading a certificate+
- Download a certificate on the Basic Information page of the cluster.Figure 2 Downloading a certificate
- Store the certificate to the server where Logstash is deployed.
- Modify the logstash-simple.conf configuration file.Consider the data files in the /tmp/access_log/ path mentioned in 4 as an example. Assume that data import starts from data in the first row of the data file, the filtering condition is left unspecified (indicating no data processing operations are performed), and the public IP address and port number of the jump host are 192.168.0.227 and 9200, respectively. The name of the index for importing data is myindex, and the certificate is stored in /logstash/logstash6.8/config/CloudSearchService.cer. Edit the configuration file as follows, and enter :wq to save the configuration file and exit.
input{ file { path => "/tmp/access_log/*" @@ -94,13 +94,13 @@ output{- Run the following command to import the data collected by Logstash to the cluster:
./bin/logstash -f logstash-simple.conf
- This command must be executed in the directory where the logstash-simple.conf file is stored. For example, if the logstash-simple.conf file is stored in /root/logstash-7.1.1/, go to the directory before running the command.
- Log in to the CSS management console.
- In the left navigation pane, click Clusters to switch to the Clusters page.
- From the cluster list, locate the row that contains the cluster to which you want to import data and click Access Kibana in the Operation column.
- In the left navigation pane of the displayed Kibana window, click Dev Tools.
Figure 3 Logging in to Dev Tools+
- Log in to the CSS management console.
- In the left navigation pane, click Clusters to switch to the Clusters page.
- From the cluster list, locate the row that contains the cluster to which you want to import data and click Access Kibana in the Operation column.
- In the left navigation pane of the displayed Kibana window, click Dev Tools.
Figure 3 Logging in to Dev Tools
- On the Console page of Kibana, search for the imported data.
On the Console page of Kibana, enter the following command to search for data. View the search results. If the searched data is consistent with the imported data, the data has been imported successfully.
GET myindex/_search
Importing Data When Logstash Is Deployed on an ECS
Figure 4 illustrates how data is imported when Logstash is deployed on an ECS that resides in the same VPC as the cluster to which data is to be imported.
- +- Ensure that the ECS where Logstash is deployed and the cluster to which data is to be imported reside in the same VPC, port 9200 of the ECS security group has been assigned external network access permissions, and an EIP has been bound to the ECS.
- If there are multiple servers in a VPC, you do not need to associate EIPs to other servers as long as one server is associated with an EIP. Switch to the node where Logstash is deployed from the node with which the EIP is associated.
- If a private line or VPN is available, you do not need to associate an EIP.
- Use PuTTY to log in to the ECS.For example, data file access_20181029_log is stored in the /tmp/access_log/ path of the ECS, and the data file includes the following data:
| All | Heap used for segments | | 18.6403 | MB | @@ -153,7 +153,7 @@ output { } }If the cluster has the security mode enabled, you need to download a certificate first.
-- - \ No newline at end of file diff --git a/docs/css/umn/css_01_0051.html b/docs/css/umn/css_01_0051.html index 0ce5903e..92b24de2 100644 --- a/docs/css/umn/css_01_0051.html +++ b/docs/css/umn/css_01_0051.html @@ -2,12 +2,12 @@- Download a certificate on the Basic Information page of the cluster.Figure 5 Downloading a certificate+
- Download a certificate on the Basic Information page of the cluster.Figure 5 Downloading a certificate
- Store the certificate to the server where Logstash is deployed.
- Modify the logstash-simple.conf configuration file.Consider the data files in the /tmp/access_log/ path mentioned in 2 as an example. Assume that data import starts from data in the first row of the data file, the filtering condition is left unspecified (indicating no data processing operations are performed), the public IP address and port number of the jump host are 192.168.0.227 and 9200, respectively. The name of the index for importing data is myindex, and the certificate is stored in /logstash/logstash6.8/config/CloudSearchService.cer. Edit the configuration file as follows, and enter :wq to save the configuration file and exit.
input{ file { path => "/tmp/access_log/*" @@ -177,7 +177,7 @@ output{ - Run the following command to import the ECS data collected by Logstash to the cluster:
./bin/logstash -f logstash-simple.conf
- - Log in to the CSS management console.
- In the left navigation pane, click Clusters to switch to the Clusters page.
- From the cluster list, locate the row that contains the cluster to which you want to import data and click Access Kibana in the Operation column.
- In the left navigation pane of the displayed Kibana window, click Dev Tools.Figure 6 Choosing Dev Tools+
- Log in to the CSS management console.
- In the left navigation pane, click Clusters to switch to the Clusters page.
- From the cluster list, locate the row that contains the cluster to which you want to import data and click Access Kibana in the Operation column.
- In the left navigation pane of the displayed Kibana window, click Dev Tools.Figure 6 Choosing Dev Tools
- On the Console page of Kibana, search for the imported data.
On the Console page of Kibana, enter the following command to search for data. View the search results. If the searched data is consistent with the imported data, the data has been imported successfully.
GET myindex/_search
- Download a certificate on the Basic Information page of the cluster.
Viewing Audit Logs
After you enable CTS, it starts recording operations related to CSS. The CTS management console stores the last seven days of operation records. This section describes how to query the last seven days of operation records on the CTS management console.
-diff --git a/docs/css/umn/css_01_0056.html b/docs/css/umn/css_01_0056.html index 6bbbd911..de86c699 100644 --- a/docs/css/umn/css_01_0056.html +++ b/docs/css/umn/css_01_0056.html @@ -2,8 +2,8 @@Procedure
- Log in to the CTS management console.
- Click
in the upper left corner and select a region. - In the left navigation pane, click Trace List.
- You can use filters to query traces. The following four filter criteria are available:
- Trace Source, Resource Type, and Search By
Select a filter criterion from the drop-down list.
+Procedure
- Log in to the CTS management console.
- Click
in the upper left corner and select a region. - In the left navigation pane, click Trace List.
- You can use filters to query traces. The following four filter criteria are available:
- Trace Source, Resource Type, and Search By
Select a filter criterion from the drop-down list.
When you select Trace name for Search By, select a specific trace name.
When you select Resource ID for Search By, enter a specific resource ID.
When you select Resource name for Search By, select or enter a specific resource name.
- Operator: Select a specific operator (at user level rather than tenant level).
- Trace Status: Available options include All trace statuses, normal, warning, and incident. You can only select one of them.
- Time Range: You can query traces generated during any time range of the last seven days.
- Trace Source, Resource Type, and Search By
- Click
on the left of a trace to expand its details. - Click View Trace in the Operation column. In the displayed View Trace dialog box, the trace structure details are displayed.
For details about the key fields in the CTS trace structure, see the Cloud Trace Service User Guide.
+ - Click
on the left of a trace to expand its details. - Click View Trace in the Operation column. In the displayed View Trace dialog box, the trace structure details are displayed.
For details about the key fields in the CTS trace structure, see the Cloud Trace Service User Guide.
- Trace Source, Resource Type, and Search By
Introduction to the Cluster List
The cluster list displays all CSS clusters. If there are a large number of clusters, these clusters will be displayed on multiple pages. You can view clusters of all statuses from the cluster list.
-Clusters are listed in chronological order by default in the cluster list, with the most recent cluster displayed at the top. You can click
-
next to the related parameter in the table heading to modify cluster sorting. Table 1 describes the parameters involved in the cluster list.In the upper right corner of the cluster list, you can enter the name or ID of a cluster and click
+
to search for a cluster. You can also click 
in the upper right corner to refresh the cluster list.Clusters are listed in chronological order by default in the cluster list, with the most recent cluster displayed at the top. You can click
+
next to the related parameter in the table heading to modify cluster sorting. Table 1 describes the parameters involved in the cluster list.In the upper right corner of the cluster list, you can enter the name or ID of a cluster and click
to search for a cluster. You can also click 
in the upper right corner to refresh the cluster list.Table 1 Cluster list parameter description Parameter
Binding an Enterprise Project
++You must configure an enterprise project for each cluster. If you do not need to distinguish enterprise projects for clusters, you can bind clusters to the default project. For clusters created before the binding an enterprise project feature was released, their enterprise projects were bound to the default project. You can modify the enterprise project based on the site requirements.
++Binding an Enterprise Project
When creating a cluster, you can bind it to an enterprise project by specifying the Enterprise Project parameter. For details, see .
++Modifying an Enterprise Project
For a cluster that has been created, you can modify its enterprise project based on the site requirements.
+- On the CSS management console, click Clusters.
- In the cluster list on the displayed page, click the target cluster name to switch to the Basic Information page.
- On the displayed page, click the parameter value on the right of Enterprise Project. The Project Management page of the Resource Management is displayed.
- On the Resources tab page, select the corresponding Region and select Cloud Search Service from Service. In this case, the corresponding CSS cluster is displayed in the resource list.
- Select the cluster whose enterprise project you want to modify and click Remove.
- On the Remove Resource page, specify Mode and select Destination Enterprise Project, and click OK.
- After you complete the preceding steps, you can view the enterprise project bound to the cluster in either of the following ways:
- Switch to the CSS cluster list, where the value of Enterprise Project for the cluster is changed to the new enterprise project.
- On the Resource Management page, click Project Management in the navigation pane on the left. On the displayed page, click View Migration Event to obtain the cluster information.
++ diff --git a/docs/css/umn/css_01_0060.html b/docs/css/umn/css_01_0060.html index 81e6a557..a42de352 100644 --- a/docs/css/umn/css_01_0060.html +++ b/docs/css/umn/css_01_0060.html @@ -2,13 +2,11 @@++Parent topic: Managing Elasticsearch Clusters+Managing Failed Tasks
In the Failed Tasks dialog box, you can view the failed tasks related to a cluster, such as failing to create, restart, scale out, back up, or restore a cluster. In addition, you can view the failure cause of each task and choose to delete one or all failed tasks.
-Viewing Failed Tasks
- Log in to the CSS management console.
- Click Clusters to switch to the Clusters page. Click the digit next to Failed Tasks to switch to the Failed Tasks dialog box.Figure 1 Clicking the digit next to Failed Tasks-
- The Failed Tasks dialog box presents all failed tasks of the current account. The following information about the failed tasks is displayed: Name/ID, Task Status, and Failure Time.
- Click the question mark in the Task Status column to view the failure cause of a task. You are advised to troubleshoot faults based on failure causes. For details about failure causes, see Error Code.Figure 2 Viewing the failure cause of a task-
Viewing Failed Tasks
- Log in to the CSS management console.
- Click Clusters to switch to the Clusters page. Click the digit next to Failed Tasks to switch to the Failed Tasks dialog box.
- The Failed Tasks dialog box presents all failed tasks of the current account. The following information about the failed tasks is displayed: Name/ID, Task Status, and Failure Time.
- Click the question mark in the Task Status column to view the failure cause of a task. You are advised to troubleshoot faults based on failure causes. For details about failure causes, see Error Code.
Deleting a Failed Task
You can delete one or all failed tasks at a time.
- To delete a failed task, perform the following operations: Locate the row that contains the target task and click Delete in the Operation column. In the displayed dialog box, confirm the task you want to delete and click Yes.
- To delete all failed tasks, perform the following operations: In the Failed Tasks dialog box, click Delete All. In the displayed dialog box, confirm the information about all failed tasks and click Yes.
Figure 3 Deleting a failed task+
Figure 1 Deleting a failed task
Error Code
Table 1 Failure causes Error Code
@@ -86,10 +84,3 @@ - - \ No newline at end of file diff --git a/docs/css/umn/css_01_0061.html b/docs/css/umn/css_01_0061.html index 46e09ffd..254c6e1d 100644 --- a/docs/css/umn/css_01_0061.html +++ b/docs/css/umn/css_01_0061.html @@ -3,20 +3,20 @@Elasticsearch SQL
For Elasticsearch 6.5.4 and later versions, Open Distro for Elasticsearch SQL lets you write queries in SQL rather than in the Elasticsearch query domain-specific language (DSL).
If you are already familiar with SQL and do not want to learn query DSL, this feature is a great option.
-Basic Operations
To use this function, send requests to the _opendistro/_sql URI. You can use a request parameter or the request body (recommended).
-GET https://<host>:<port>/_opendistro/_sql?sql=select * from my-index limit 50
-POST https://<host>:<port>/_opendistro/_sql +
Basic Operations
- Kibana (recommended)
- Log in to Kibana and send requests using request parameters or request body to _opendistro/_sqlURI in the Dev Tools page.
GET _opendistro/_sql?sql=select * from my-index limit 50
+POST _opendistro/_sql { "query": "SELECT * FROM my-index LIMIT 50" }-You can run the cURL command:
-curl -XPOST https://localhost:9200/_opendistro/_sql -u username:password -k -d '{"query": "SELECT * FROM kibana_sample_data_flights LIMIT 10"}' -H 'Content-Type: application/json'-By default, JSON is returned for query. You can also set the format parameter for the data to be returned in CSV format.
-POST _opendistro/_sql?format=csv +
- By default, the result is returned in the JSON structure. If you want the result to be returned in the CSV format, run the following command:
POST _opendistro/_sql?format=csv { "query": "SELECT * FROM my-index LIMIT 50" }-When data is returned in CSV format, each row corresponds to a document and each column corresponds to a field.
+When data is returned in the CSV format, each row corresponds to a document and each column corresponds to a field.
+
- Log in to Kibana and send requests using request parameters or request body to _opendistro/_sqlURI in the Dev Tools page.
- cURL commands
You can also run cURL commands in ECS to execute SQL statements.
+curl -XPOST https://localhost:9200/_opendistro/_sql -u username:password -k -d '{"query": "SELECT * FROM kibana_sample_data_flights LIMIT 10"}' -H 'Content-Type: application/json'+
Supported Operations
Open Distro for Elasticsearch supports the following SQL operations: statements, conditions, aggregations, include and exclude fields, common functions, joins, and show.
- Statements @@ -266,17 +266,17 @@
Inner join
SELECT p.firstname, p.lastname, p.gender, dogs.name FROM people p JOIN dogs d ON d.holdersName = p.firstname WHERE p.age > 12 AND d.age > 1
+SELECT s.firstname, s.lastname, s.gender, sc.name FROM student s JOIN school sc ON sc.name = s.school_name WHERE s.age > 20
Left outer join
SELECT p.firstname, p.lastname, p.gender, dogs.name FROM people p LEFT JOIN dogs d ON d.holdersName = p.firstname
+SELECT s.firstname, s.lastname, s.gender, sc.name FROM student s LEFT JOIN school sc ON sc.name = s.school_name
Cross join
SELECT p.firstname, p.lastname, p.gender, dogs.name FROM people p CROSS JOIN dogs d
+SELECT s.firstname, s.lastname, s.gender, sc.name FROM student s CROSS JOIN school sc
Permissions Management
+ + + diff --git a/docs/css/umn/css_01_0072.html b/docs/css/umn/css_01_0072.html new file mode 100644 index 00000000..110f9e39 --- /dev/null +++ b/docs/css/umn/css_01_0072.html @@ -0,0 +1,22 @@ + + +Creating a User and Granting Permissions
++This chapter describes how to use to implement fine-grained permissions control for your CloudSearch Service (CSS) resources. With IAM, you can:
+- Create IAM users for employees based on your enterprise's organizational structure. Each IAM user will have their own security credentials for accessing CSS resources.
- Grant only the permissions required for users to perform a specific task.
- Entrust a account or cloud service to perform efficient O&M on your CSS resources.
If your account does not require individual IAM users, skip this chapter.
+This section describes the procedure for granting permissions (see Figure 1).
++Prerequisites
Before assigning permissions to user groups, you should learn about the system policies listed in Permissions Management.
++Process Flow
+- Create a user group and assign permissions
Create a user group on the IAM console, and assign the CSS permission to the group.
+ - Create a user and add it to a user group
Create a user on the IAM console and add the user to the group created in 1. Create a user group a....
+ - Log in as an IAM user and verify permissions.
Log in to the CSS console as the created user, and verify that it only has read permissions for CSS.
+
++ diff --git a/docs/css/umn/css_01_0074.html b/docs/css/umn/css_01_0074.html new file mode 100644 index 00000000..e7ee6b1f --- /dev/null +++ b/docs/css/umn/css_01_0074.html @@ -0,0 +1,20 @@ + + +++Parent topic: Permissions Management+Changing Specifications
++If the workloads on the data plane of a cluster change, you can change its node specifications as needed.
++Prerequisites
- The target cluster is available and has no tasks in progress.
- The target cluster has sufficient quotas available.
+Constraints
- The node number and storage capacity cannot be modified when you change the node specifications.
- The specifications can only be increased. To decrease cluster specifications, create a cluster with smaller specifications and migrate the data from the current cluster to it.
- If a cluster has multiple node types, you can change the specifications of only one type at a time. After the change, nodes in other types still maintain their original specifications.
- If the data volume is large, it may take long to modify the node specifications. You are advised to modify specifications during off-peak hours.
- Kibana is unavailable during specification change.
- When changing the node specifications, ensure that all service data has copies so the services will not be interrupted.
Run the GET _cat/indices?v command in Kibana. If the returned rep value is greater than 0, the data has copies. If the returned rep value is 0, the data has no copies. In this case, create snapshot for the cluster by referring to Manually Creating a Snapshot.
+ - During the specification modification, the nodes are stopped and restarted in sequence. It is a rolling process.
+Procedure
- Log in to the CSS management console.
- In the navigation pane on the left, choose Clusters. On the displayed Clusters page, locate the target cluster and choose More > Scale Cluster in the Operation column.
- On the Modify Configuration page, set parameters to change specifications.
- New Node Specifications The specifications of the default data nodes. Select the specifications from the drop-down list as required.
- If a cluster has master nodes, client nodes, or cold data nodes, you can change their specifications.
- Click Next: Scale Now.
- Confirm the information and click Submit.
- In the displayed Verify Index Copy dialog box, select Verify index copies if you need. Click OK.
- If you selected Verify index copies and the cluster has no master node, indexes must have at least one copy and the cluster must have at least three nodes.
- If you selected Verify index copies and the cluster has no master node, indexes must have at least one copy.
- Click Back to Cluster List to switch to the Clusters page. The Cluster Status is Configuration modified. When Cluster Status changes to Available, the cluster specifications have been successfully modified.
++ diff --git a/docs/css/umn/css_01_0077.html b/docs/css/umn/css_01_0077.html index bc52a972..b0ddbfbf 100644 --- a/docs/css/umn/css_01_0077.html +++ b/docs/css/umn/css_01_0077.html @@ -2,7 +2,7 @@++Parent topic: Scaling In/Out a Cluster+Managing Logs
CSS provides log backup and search functions to help you locate faults. You can back up cluster logs to OBS buckets and download required log files to analyze and locate faults.
-Enabling Log Management
- Log in to the CSS management console.
- On the Clusters page, click the name of the cluster whose logs you want to back up. The Basic Information page is displayed.
- Click the Logs tab and enable Log Management.
+
indicates that the log management function is disabled. 
indicates that it is enabled.diff --git a/docs/css/umn/css_01_0078.html b/docs/css/umn/css_01_0078.html index c02cd56c..51331e45 100644 --- a/docs/css/umn/css_01_0078.html +++ b/docs/css/umn/css_01_0078.html @@ -1,11 +1,20 @@Enabling Log Management
- Log in to the CSS management console.
- On the Clusters page, click the name of the cluster whose logs you want to back up. The Basic Information page is displayed.
- Click the Logs tab and enable Log Management.
indicates that the log management function is disabled. 
indicates that it is enabled. - Enable the Log Management function. In the Edit Log Backup Configuration dialog box, set the parameters.
In the displayed dialog box, OBS Bucket, Backup Path, and IAM Agency are automatically created for log backup. You can modify the default value by referring to Table 1.
- - (Optional) If the Log Management function has been enabled for the cluster, you can modify the log backup parameters.
Click
+
on the right of Log Backup Configuration. The Edit Log Backup Configuration dialog box is displayed. You can modify the log backup parameters. - (Optional) If the Log Management function has been enabled for the cluster, you can modify the log backup parameters.
Click
on the right of Log Backup Configuration. The Edit Log Backup Configuration dialog box is displayed. You can modify the log backup parameters. - Back up logs.
- Automatically backing up logs
Click the icon on the right of Auto Backup to enable the auto backup function.
-
-
indicates that the auto backup function is enabled, and indicates that it is disabled.After the automatic backup function is enabled, set the backup start time in the Modify Log Backup Policy dialog box. When the scheduled time arrives, the system will back up logs automatically. Click
+
on the right of the switch to change Backup Start Time.
+
indicates that the auto backup function is enabled, and indicates that it is disabled.After the automatic backup function is enabled, set the backup start time in the Modify Log Backup Policy dialog box. When the scheduled time arrives, the system will back up logs automatically. Click
on the right of the switch to change Backup Start Time. - Manually backing up logs
On the Log Backup tab page, click Back Up. On the displayed page, click Yes to start backup.
If Task Status in the log backup list is Successful, the backup is successful.
All logs in the cluster are copied to a specified OBS path. You can view or download log files from the path of the OBS bucket.
- Automatically backing up logs
- Search for logs.
On the Log Search page, select the desired node, log type, and log level, and click
+
. The search results are displayed. - Search for logs.
On the Log Search page, select the desired node, log type, and log level, and click
. The search results are displayed.When you search for logs, the latest 10,000 logs are matched. A maximum of 100 logs are displayed.
Managing Plugins
-CSS allows you to view default plugins.
-- Log in to the CSS management console.
- On the Clusters page, click the name of a cluster for which you want to install a plugin.
The Basic Information page is displayed.
- - Click the Plugins tab.
- View the information about default plugins.
On the Default page, view default plugins supported by the current version.
+CSS clusters have default plugins. You can view the default plugin information on the console or Kibana.
++Viewing Plugins on the Console
- Log in to the CSS management console.
- In the navigation pane, choose Clusters. Click the target cluster name and go to the Basic Information page of the cluster.
- Click the Plugins tab.
- On the Default page, view default plugins supported by the current version.
+Viewing Plugins on the Kibana
- Log in to the CSS management console.
- In the navigation pane, choose Clusters. Locate the target cluster and click Access Kibana in the Operation column to log in to Kibana.
- Go to Dev Tools and run the following command to view the cluster plugin information:
GET _cat/plugins?v
+The following is an example of the response body:
+name component version +css-2918-ess-esn-1-1 analysis-dynamic-synonym 7.10.2-h0.cbu.css.v1.0.0.0.r1 +css-2918-ess-esn-1-1 analysis-icu 7.10.2-h0.cbu.css.v1.0.0.3.r1 +css-2918-ess-esn-1-1 analysis-ik 7.10.2-h0.cbu.css.v1.0.0.0.r1 +......
+name indicates the cluster node name, component indicates the plugin name, and version indicates the plugin version.
Parent topic: Managing Elasticsearch Clustersdiff --git a/docs/css/umn/css_01_0081.html b/docs/css/umn/css_01_0081.html new file mode 100644 index 00000000..77c9a811 --- /dev/null +++ b/docs/css/umn/css_01_0081.html @@ -0,0 +1,17 @@ + + +Removing Specified Nodes
++If a cluster can process existing data without fully using its nodes, you can remove one or more specified nodes from the cluster to reduce costs. Services will not be interrupted during the removal of specified nodes.
++Prerequisites
The target cluster is available and has no tasks in progress.
++Constraints
- Ensure that the disk usage after scale-in is less than 80% and each AZ of each node type has at least one node.
- In a cross-AZ cluster, the difference between the numbers of the same type nodes in different AZs cannot exceed 1.
- For a cluster without master nodes, the number of removed data nodes and cold data nodes in a scale-in must be fewer than half of the original number of data nodes and cold data nodes, and the number of remaining data nodes and cold data nodes after a scale-in must be greater than the maximum number of index replicas.
- For a cluster with master nodes, the number of removed master nodes in a scale-in must be fewer than half of the original master node number. After scale-in, there has to be an odd number of master nodes, and there has to be at least three of them.
+Procedure
- Log in to the CSS management console.
- In the navigation pane on the left, choose Clusters. On the displayed Clusters page, locate the target cluster and choose More > Scale Cluster in the Operation column.
- Choose the Scale In tab.
- Select the target nodes.
- Click Scale Now.
- Confirm the information and click Submit.
- Click Back to Cluster List to switch to the Clusters page. The Task Status is Scaling in. When Cluster Status changes to Available, the cluster has been successfully scaled in.
++ diff --git a/docs/css/umn/css_01_0082.html b/docs/css/umn/css_01_0082.html index 2381f387..233502bf 100644 --- a/docs/css/umn/css_01_0082.html +++ b/docs/css/umn/css_01_0082.html @@ -4,7 +4,7 @@++Parent topic: Scaling In/Out a Cluster+The VPC endpoint service allows you to access the cluster through a private domain name. When the VPC endpoint service is enabled, the system creates a VPC endpoint for you by default. To create a VPC endpoint, you must have the required permissions. For details, see .
-
The public IP address access and VPC endpoint service share a load balancer. If you have configured a public access whitelist, public and private IP addresses that access the cluster through VPCEP are restricted because the public IP address access shares the load balancer with the VPC endpoint service. In this case, you need to add IP address 198.19.128.0/17 to the public access whitelist to allow traffic through VPCEP.
Enabling the VPC Endpoint Service
- Log in to the CSS management console.
- On the Create Cluster page, set Advanced Settings to Custom. Enable the VPC endpoint service.
- Private Domain Name Creation: If you enable this function, the system automatically creates a private domain name for you, which you can use to access the cluster.
- VPC Endpoint Service Whitelist: You can add an authorized account ID to the VPC endpoint service whitelist. Then you can access the cluster using the domain name or the node IP address.
Click
+
to add multiple accounts. You can also click Delete in the Operation column to delete accounts.Enabling the VPC Endpoint Service
- Log in to the CSS management console.
- On the Create Cluster page, set Advanced Settings to Custom. Enable the VPC endpoint service.
- Private Domain Name Creation: If you enable this function, the system automatically creates a private domain name for you, which you can use to access the cluster.
- VPC Endpoint Service Whitelist: You can add an authorized account ID to the VPC endpoint service whitelist. Then you can access the cluster using the domain name or the node IP address.
Click
to add multiple accounts. You can also click Delete in the Operation column to delete accounts.
@@ -12,7 +12,7 @@ - If the authorization account ID is set to *, all users are allowed to access the cluster.
- You can view authorized account IDs on the My Credentials page.
- After the VPC endpoint service is enabled for a cluster, you will be billed per use. For more information, see .
Managing VPC Endpoint Service
You can enable the VPC endpoint service while creating a cluster, and also enable it by performing the following steps after cluster creation.
-- Log in to the CSS management console.
- On the Clusters page, click the name of the target cluster.
- Click the VPC Endpoint Service tab, and turn on the button next to VPC Endpoint Service.
+
indicates disabling the VPC endpoint service and 
indicates enabling the VPC endpoint service.- Log in to the CSS management console.
- On the Clusters page, click the name of the target cluster.
- Click the VPC Endpoint Service tab, and turn on the button next to VPC Endpoint Service.
indicates disabling the VPC endpoint service and 
indicates enabling the VPC endpoint service.In the displayed dialog box, you can determine whether to enable the private domain name. After a private domain name is created, you can access the cluster using the private domain name.
diff --git a/docs/css/umn/css_01_0086.html b/docs/css/umn/css_01_0086.html new file mode 100644 index 00000000..838b2899 --- /dev/null +++ b/docs/css/umn/css_01_0086.html @@ -0,0 +1,82 @@ + + + - After you enable the VPC endpoint service, you can use the private domain name or node IP address generated by the endpoint to access the cluster. For details, see Accessing the Cluster Using the Private Domain Name or Node IP Address.
- If you disable the VPC endpoint service, none of the users can access the cluster using the private domain name.
CSS Custom Policies
++Custom policies can be created to supplement the system-defined policies of CSS. For the actions supported for custom policies, see Permissions Policies and Supported Actions.
+You can create custom policies in either of the following ways:
+- Visual editor: Select cloud services, actions, resources, and request conditions. You do not need to have knowledge of the policy syntax.
- JSON: Create a JSON policy or edit based on an existing policy.
For details about how to create custom policies, see Creating a Custom Policy. The following section contains examples of common CSS custom policies.
++ IAM permissions and data plane cluster permissions are managed separately. To enable the security capability of the data plane, you need to use the security mode.
++Example Custom Policies
Example 1: Allowing users to create a CSS cluster+{ + "Version": "1.1", + "Statement": [ + { + "Action": [ + "css:cluster:create", + "vpc:securityGroups:get", + "vpc:securityGroups:create", + "vpc:securityGroups:delete", + "vpc:securityGroupRules:get", + "vpc:securityGroupRules:create", + "vpc:securityGroupRules:delete", + "vpc:vpcs:list", + "vpc:privateIps:list", + "vpc:ports:get", + "vpc:ports:create", + "vpc:ports:update", + "vpc:ports:delete", + "vpc:quotas:list", + "vpc:subnets:get", + "ecs:cloudServerFlavors:get", + "ecs:serverInterfaces:use", + "ecs:cloudServers:addNics", + "ecs:quotas:get", + "evs:types:get", + "evs:quotas:get" + ], + "Effect": "Allow" + } + ] +}+Example 2: Denying cluster deletion
+A policy with only Deny permissions must be used in conjunction with other policies for it to take effect. If the permissions assigned to a user contain both Allow and Deny, the Deny permissions take precedence over the Allow permissions.
+The following method can be used if you need to assign permissions of the CSS Admin policy to a user but you want to prevent the user from deleting clusters. Create a custom policy for denying cluster deletion, and attach both policies to the group to which the user belongs. Then, the user can perform all operations on CSS except deleting clusters. The following is an example of a deny policy:
+{ + "Version": "1.1", + "Statement": [ + { + "Effect": "Deny", + "Action": [ + "css:cluster:delete" + ] + } + ] +} ++Example 3: Defining permissions for multiple services in a policy
+A custom policy can contain the actions of multiple services that are of the global or project-level type. The following is an example policy containing actions of multiple services:
+{ + "Version": "1.1", + "Statement": [ + { + "Action": [ + "ecs:cloudServers:resize", + "ecs:cloudServers:delete", + "ecs:cloudServers:delete", + "css:cluster:restart", + "css:*:get*", + "css:*:list*" + ], + "Effect": "Allow" + } + ] +}+++ diff --git a/docs/css/umn/css_01_0088.html b/docs/css/umn/css_01_0088.html index b1fe4f1a..40fdc345 100644 --- a/docs/css/umn/css_01_0088.html +++ b/docs/css/umn/css_01_0088.html @@ -38,7 +38,7 @@++Parent topic: Permissions Management+
Configuring Kibana Public Access for an Existing Cluster
You can enable, disable, modify, and view Kibana public access for an existing cluster that has security mode enabled.
-- Log in to the CSS management console.
- On the Clusters page, click the name of the target cluster.
- Click the Kibana Public Access tab. Turn on the Kibana Public Access switch to enable the Kibana public access function.
+
indicates that Kibana public access is disabled. 
indicates that Kibana public access is enabled.- Log in to the CSS management console.
- On the Clusters page, click the name of the target cluster.
- Click the Kibana Public Access tab. Turn on the Kibana Public Access switch to enable the Kibana public access function.
indicates that Kibana public access is disabled. 
indicates that Kibana public access is enabled. - On the displayed page, set parameters.
Table 2 Kibana public access parameters Parameter
Managing Index Statuses
+ ++ + ++ diff --git a/docs/css/umn/css_01_0092.html b/docs/css/umn/css_01_0092.html new file mode 100644 index 00000000..ec7bf4c4 --- /dev/null +++ b/docs/css/umn/css_01_0092.html @@ -0,0 +1,40 @@ + + +++Parent topic: Working with Kibana+Changing Policies
++You can change any managed index policy. ISM has constraints to ensure that policy changes do not break indices.
+If an index is stuck in its current status, never proceeding, and you want to update its policy immediately, make sure that the new policy includes the same status (same name, action, and order) as the old policy. In this case, ISM applies the new policy even if the policy is being executed.
+If you update the policy without including an identical status, ISM updates the policy only after all actions in the current status finish executing. Alternatively, you can select a specific status in the old policy and have the new policy take effect.
+To change a policy using Kibana, do the following:
+- Under Managed Indices, select the indices to which you want to attach the new policy.
- Click Change policy in the upper right corner. The Choose managed indices page is displayed. Configure parameters required for changing a policy.
++
+Table 1 Parameters required for changing a policy Parameter
+Description
+Managed indices
+Select the indices to which you want to attach the new policy. Multiple indices can be selected.
+State filters
+Select an index status. When a status is selected, the new policy is attached to an index in this status.
+New policy
+Select a new policy.
+ - After configuration is complete, click Change.
++ diff --git a/docs/css/umn/css_01_0093.html b/docs/css/umn/css_01_0093.html new file mode 100644 index 00000000..e6c8c954 --- /dev/null +++ b/docs/css/umn/css_01_0093.html @@ -0,0 +1,38 @@ + + +++Parent topic: Managing Index Statuses+Creating and Managing Indices
++Clusters of versions 7.6.2 and 7.9.3 support index status management (ISM). ISM is a plugin that allows you to automate periodic and administrative operations based on changes on the index age, index size, or number of documents. When using the ISM plug-in, you can define policies that automatically handle index rolleovers or deletions based on your needs.
++ The following procedure uses Kibana 7.6.2 as an example. The Kibana UI varies depending on the Kibana version, but their operations are similar.
++Creating an Index Policy
- Log in to Kibana and choose IM or Index Management on the left. The Index Management page is displayed.Figure 1 Choosing IM+
- Click Create policy to create an index policy.
- Enter a policy ID in the Policy ID text box and enter your policy in the Define policy text box.Figure 2 Configuring a policy+
- Click Create.
After you create a policy, attach the policy to one or more indices. You can also include policy_id in an index template, so when you create an index that matches the index template pattern, the policy is attached to the index.
+For details about how to create an index template, see Index Templates.
+PUT _template/<template_name> +{ + "index_patterns": [ + "index_name-*" + ], + "settings": { + "opendistro.index_state_management.policy_id": "policy_id" + } +}+- <template_name>: Replace it with the name of the created index template.
- policy_id: Replace it with the policy ID created in 3.
+Attach the policy to an index.
- Click Indices.Figure 3 Choosing Indices+
- In the Indices list, select the target index to which you want to attach the policy.
- Click Apply policy in the upper right corner.Figure 4 Adding a policy+
- Select the policy you created from the Policy ID drop-down list.Figure 5 Selecting a policy+
- Click Apply.
After you attach a policy to an index, ISM creates a job that runs every five minutes by default, to execute the policy, check conditions, and convert the index to different statuses.
+
+Managing Indices
- Click Managed Indices.
- If you want to change the policy, click Change policy. For details, see Changing Policies.
- To delete a policy, select your policy, and click Remove policy.
- To retry a policy, select your policy, and click Retry policy.
For details, see Index State Management.
+++ diff --git a/docs/css/umn/css_01_0094.html b/docs/css/umn/css_01_0094.html index 32cbcf1e..f5ab85cd 100644 --- a/docs/css/umn/css_01_0094.html +++ b/docs/css/umn/css_01_0094.html @@ -1,149 +1,218 @@++Parent topic: Managing Index Statuses+Creating an Elasticsearch Cluster in Non-Security Mode
-Procedure
- Log in to the CSS management console.
- Click Create Cluster in the upper right corner. The Create Cluster page is displayed.
- Specify Region and AZ.
-
Table 1 Parameter description for Region and AZ Parameter
+This section describes how to create an Elasticsearch cluster in non-security mode.
+Context
- When creating a cluster, the number of nodes that can be added varies according to the node type. For details, see Table 1.
+-
Table 1 Number of nodes in different types Node Type
Description
+Number
Region
+ess
Select a region for the cluster from the drop-down list on the right. Currently, only eu-de is supported.
+ess: 1-32
AZ
+ess, ess-master
Select an AZ associated with the cluster region.
-You can select one or more AZs. For details, see Multi-AZ HA.
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess, ess-client
+ess: 1-32
+ess-client: 1-32
+ess, ess-cold
+ess: 1-32
+ess-cold: 1-32
+ess, ess-master, ess-client
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess-client: 1-32
+ess, ess-master, ess-cold
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess-cold: 1-32
+ess, ess-client, ess-cold
+ess: 1-32
+ess-client: 1-32
+ess-cold: 1-32
+ess, ess-master, ess-client, ess-cold
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess-client: 1-32
+ess-cold: 1-32
+Details about the four node types:- ess: the default node type that is mandatory for cluster creation. The other three node types are optional.
- ess-master: master node
- ess-client: client node
- ess-cold: cold data node
- Set basic information about the cluster. Specifically, specify Version and Name.
-
Table 2 Description of basic parameters Parameter
+ + +Procedure
- Log in to the CSS management console.
- Click Create Cluster in the upper right corner. The Create Cluster page is displayed.
- Specify Region and AZ.
++
+Table 2 Parameter description for Region and AZ Parameter
Description
+Description
Version
+Region
Select a cluster version from the drop-down list box.
+Select a region for the cluster from the drop-down list on the right. Currently, only eu-de is supported.
Name
+AZ
Name of a cluster. Cluster names contain 4 to 32 characters. Only letters, numbers, hyphens (-), and underscores (_) are allowed and the value must start with a letter.
-NOTE:After a cluster is created, you can modify the cluster name as required. Click the name of a cluster to be modified. On the displayed Basic Information page, click
+ next to the cluster name. After the modification is completed, click to save the modification. If you want to cancel the modification, click .Select an AZ associated with the cluster region.
+You can select one or more AZs. For details, see Multi-AZ HA.
+ - Set basic information about the cluster. Specifically, specify Version and Name.
+-
Table 3 Description of basic parameters Parameter
+Description
+Version
+Select a cluster version from the drop-down list box.
+Name
+Name of a cluster. Cluster names contain 4 to 32 characters. Only letters, numbers, hyphens (-), and underscores (_) are allowed and the value must start with a letter.
+NOTE:After a cluster is created, you can modify the cluster name as required. Click the name of a cluster to be modified. On the displayed Basic Information page, click
next to the cluster name. After the modification is completed, click to save the modification. If you want to cancel the modification, click .Figure 1 Configuring basic information+Figure 1 Configuring basic information - Set host specifications of the cluster.
-
Table 3 Parameter description Parameter
+-Table 4 Parameter description Parameter
Description
+Description
Nodes
+Nodes
Number of nodes in a cluster.
-- If neither a master node nor client node is enabled, the nodes specified by this parameter are used to serve as both the master node and client node. Nodes provide the cluster management, data storage, cluster access, and data analysis functions. To ensure data stability in the cluster, it is recommended that you set this parameter to a value no less than 3.
- If only the master node function is enabled, nodes specified by this parameter are used to store data and provide functions of client nodes.
- If both the master and client node functions are enabled, the nodes specified by this parameter are only used for storing data.
- If only the client node function is enabled, nodes specified by this parameter are used to store data and provide functions of the master node.
Number of nodes in a cluster.
+- If neither a master node nor client node is enabled, the nodes specified by this parameter are used to serve as both the master node and client node. Nodes provide the cluster management, data storage, cluster access, and data analysis functions. To ensure data stability in the cluster, it is recommended that you set this parameter to a value no less than 3.
- If only the master node function is enabled, nodes specified by this parameter are used to store data and provide functions of client nodes.
- If both the master and client node functions are enabled, the nodes specified by this parameter are only used for storing data.
- If only the client node function is enabled, nodes specified by this parameter are used to store data and provide functions of the master node.
CPU Architecture
+CPU Architecture
Currently, x86 and Kunpeng are supported. The supported type is determined by the actual regional environment.
+Currently, x86 and Kunpeng are supported. The supported type is determined by the actual regional environment.
Node Specifications
+Node Specifications
Specifications of nodes in a cluster. You can select a specified specification based on your needs. Only one node specification can be selected for each cluster. You cannot select the CPU and memory resources that have been sold out.
-Currently, the following flavors are supported: css.medium.8, css.large.8, css.xlarge.8, css.2xlarge.8, and css.4xlarge.8.
-After you select a flavor, the CPU and memory corresponding to the current specification are displayed below the parameter. For example, if you select css.medium.8, then 1 vCPUs | 8 GB will be displayed, indicating that the node flavor you select contains one vCPU and 8 GB memory.
+Specifications of nodes in a cluster. You can select a specified specification based on your needs. Only one node specification can be selected for each cluster. You cannot select the CPU and memory resources that have been sold out.
+Currently, the following flavors are supported: css.medium.8, css.large.8, css.xlarge.8, css.2xlarge.8, and css.4xlarge.8.
+After you select a flavor, the CPU and memory corresponding to the current specification are displayed below the parameter. For example, if you select css.medium.8, then 1 vCPUs | 8 GB will be displayed, indicating that the node flavor you select contains one vCPU and 8 GB memory.
Node Storage Type
+Node Storage Type
In the current version, the following options are available: Common I/O, High I/O, and Ultra-high I/O.
+In the current version, the following options are available: Common I/O, High I/O, and Ultra-high I/O.
Node Storage Capacity
+Node Storage Capacity
Storage space. Its value varies with node specifications.
-- Value range of flavor css.medium.8: 40 GB to 640 GB
- Value range of flavor css.large.8: 40 GB to 1,280 GB
- Value range of flavor css.xlarge.8: 40 GB to 2,560 GB
- Value range of flavor css.2xlarge.8: 80 GB to 5,120 GB
- Value range of flavor css.4xlarge.8: 160 GB to 10,240 GB
Storage space. Its value varies with node specifications.
+- Value range of flavor css.medium.8: 40 GB to 640 GB
- Value range of flavor css.large.8: 40 GB to 1,280 GB
- Value range of flavor css.xlarge.8: 40 GB to 2,560 GB
- Value range of flavor css.2xlarge.8: 80 GB to 5,120 GB
- Value range of flavor css.4xlarge.8: 160 GB to 10,240 GB
Disk Encryption
+Disk Encryption
If you select this option, the nodes in the cluster you create will use encrypted EVS disks to protect data. By default, this option is not selected. Note that you cannot modify this setting after the cluster is created. Therefore, exercise caution when performing the setting.
-After you select this option, you need to select an available key from the Key Name drop-down list. If no key is available, click Create/View Key to go to the KMS management console and create or modify a key. For details, see Creating a CMK.
-Enabling disk encryption has no impact on your operations on a cluster (such as accessing the cluster and importing data to the cluster). However, after you enable disk encryption, operation performance deteriorates by about 10%.
-NOTE:- If the cluster is in the Available status and the key used for disk encryption is in the Pending deletion or disable status or has been deleted after a cluster is created, cluster scale-out is not allowed. However, other operations on the cluster, such as restarting the cluster, creating snapshots, restoring the cluster, and importing data to the cluster are not affected. In addition, this key cannot be used for cluster creation in the future.
- After a cluster is created, do not delete the key used by the cluster. Otherwise, the cluster will become unavailable.
- The Default Master Keys cannot be used to create grants. Specifically, you cannot use Default Master Keys whose aliases end with /default in KMS to create clusters.
If you select this option, the nodes in the cluster you create will use encrypted EVS disks to protect data. By default, this option is not selected. Note that you cannot modify this setting after the cluster is created. Therefore, exercise caution when performing the setting.
+After you select this option, you need to select an available key from the Key Name drop-down list. If no key is available, click Create/View Key to go to the KMS management console and create or modify a key. For details, see Creating a CMK.
+Enabling disk encryption has no impact on your operations on a cluster (such as accessing the cluster and importing data to the cluster). However, after you enable disk encryption, operation performance deteriorates by about 10%.
+NOTE:- If the cluster is in the Available status and the key used for disk encryption is in the Pending deletion or disable status or has been deleted after a cluster is created, cluster scale-out is not allowed. However, other operations on the cluster, such as restarting the cluster, creating snapshots, restoring the cluster, and importing data to the cluster are not affected. In addition, this key cannot be used for cluster creation in the future.
- After a cluster is created, do not delete the key used by the cluster. Otherwise, the cluster will become unavailable.
- The Default Master Keys cannot be used to create grants. Specifically, you cannot use Default Master Keys whose aliases end with /default in KMS to create clusters.
Master node
+Master node
The master node manages all nodes in the cluster. If 20 or more nodes are required to store and analyze the large amount of data, you are advised to enable the master node to ensure cluster stability. Otherwise, you are advised to set only the Nodes parameter and use the nodes as both master and client nodes..
-After enabling the master node, specify Node Specifications, Nodes, and Node Storage Type. The value of Nodes must be an odd number equal to or greater than 3. You can set a maximum of nine nodes. The value of Node Storage Capacity is fixed. You can select a storage type based on your needs. By default, the node storage type is High I/O and the node storage capacity is 40 GB.
+The master node manages all nodes in the cluster. If 20 or more nodes are required to store and analyze the large amount of data, you are advised to enable the master node to ensure cluster stability. Otherwise, you are advised to set only the Nodes parameter and use the nodes as both master and client nodes..
+After enabling the master node, specify Node Specifications, Nodes, and Node Storage Type. The value of Nodes must be an odd number equal to or greater than 3. You can set a maximum of nine nodes. The value of Node Storage Capacity is fixed. You can select a storage type based on your needs. By default, the node storage type is High I/O and the node storage capacity is 40 GB.
Client node
+Client node
The client node allows clients to access clusters and analyze data. If more than 20 nodes are required to store and analyze a large amount of data, you are advised to enable the client node to ensure cluster stability. Otherwise, you are advised to set only the Nodes parameter and use the nodes as both master and client nodes..
-After enabling the client node, specify Node Specifications, Nodes and Node Storage Type. The value of Nodes ranges from 1 to 32. The value of Node Storage Capacity is fixed. You can select a storage type based on your needs. By default, the node storage type is High I/O and the node storage capacity is 40 GB.
+The client node allows clients to access clusters and analyze data. If more than 20 nodes are required to store and analyze a large amount of data, you are advised to enable the client node to ensure cluster stability. Otherwise, you are advised to set only the Nodes parameter and use the nodes as both master and client nodes..
+After enabling the client node, specify Node Specifications, Nodes and Node Storage Type. The value of Nodes ranges from 1 to 32. The value of Node Storage Capacity is fixed. You can select a storage type based on your needs. By default, the node storage type is High I/O and the node storage capacity is 40 GB.
Cold data node
+Cold data node
The cold data node is used to store historical data, for which query responses can be returned in minutes. If you do not quire a quick query response, store historical data on cold data nodes to reduce costs.
-After enabling cold data node, 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 requirement.
-After the cold data node is enabled, CSS automatically adds cold and hot tags to related nodes.
+The cold data node is used to store historical data, for which query responses can be returned in minutes. If you do not quire a quick query response, store historical data on cold data nodes to reduce costs.
+After enabling cold data node, 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 requirement.
+After the cold data node is enabled, CSS automatically adds cold and hot tags to related nodes.
Figure 2 Configuring node specifications+Figure 2 Configuring node specifications- Set network specifications of the cluster. -
Table 4 Parameter description Parameter
+-Table 5 Parameter description Parameter
Description
+Description
VPC
+VPC
A VPC is a secure, isolated, and logical network environment.
+A VPC is a secure, isolated, and logical network environment.
Select the target VPC. Click View VPC to enter the VPC management console and view the created VPC names and IDs. If no VPC is available, create a VPC.
NOTE:The VPC must contain CIDRs. Otherwise, cluster creation will fail. By default, a VPC will contain CIDRs.
Subnet
+Subnet
A subnet provides dedicated network resources that are isolated from other networks, improving network security.
+A subnet provides dedicated network resources that are isolated from other networks, improving network security.
Select the target subnet. You can access the VPC management console to view the names and IDs of the existing subnets in the VPC.
Security Group
+Security Group
A security group is a collection of access control rules for ECSs that have the same security protection requirements and are mutually trusted in a VPC. To view more details about the security group, click View Security Group.
-NOTE:- For cluster access purposes, ensure that the security group contains port 9200.
- If your cluster version is 7.6.2 or 7.9.3, ensure that all the ports used for communication between nodes in the same security group are allowed. If such settings cannot be configured, ensure at least the access to port 9300 is allowed.
- After a cluster is created, its security group cannot be changed.
A security group is a collection of access control rules for ECSs that have the same security protection requirements and are mutually trusted in a VPC. To view more details about the security group, click View Security Group.
+NOTE:- For cluster access purposes, ensure that the security group contains port 9200.
- If your cluster version is 7.6.2, 7.9.3 or 7.10.2, ensure that all the ports used for communication between nodes in the same security group are allowed. If such settings cannot be configured, ensure at least the access to port 9300 is allowed.
- After a cluster is created, its security group cannot be changed.
Security Mode
+Security Mode
Security mode is disabled.
+Security mode is disabled.
NOTE:You can enable Security Mode only when you create a cluster. After a cluster is created, its security mode cannot be changed.
Figure 3 Configuring network specifications-
- Set the enterprise project of the cluster.
When creating a CSS cluster, you can bind an enterprise project to the cluster if you have enabled enterprise project. You can select an enterprise project created by the current user from the drop-down list or click View Project Project to go to the Enterprise Project Management console and create a new project or view existing projects.
-- Configure automatic snapshot creation for the cluster.
By default, the cluster snapshot function is enabled. If you do not need this function, you can disable Cluster Snapshot.
-Basic Configuration- OBS Bucket: name of the OBS bucket used for storing snapshots.
- Backup Path: storage path of the snapshot in the OBS bucket.
- IAM Agency: authorized by the current account for CSS to access or maintain data stored in the OBS bucket.
Figure 3 Configuring network specifications+
- Set the enterprise project of the cluster.
When creating a CSS cluster, you can bind an enterprise project to the cluster if you have enabled enterprise project. You can select an enterprise project created by the current user from the drop-down list or click View Project Project to go to the Enterprise Project Management console and create a new project or view existing projects.
+- Configure automatic snapshot creation for the cluster.
By default, the cluster snapshot function is enabled. If you do not need this function, you can disable Cluster Snapshot.
+Basic Configuration-- OBS Bucket: name of the OBS bucket used for storing snapshots.
- Backup Path: storage path of the snapshot in the OBS bucket.
- IAM Agency: authorized by the current account for CSS to access or maintain data stored in the OBS bucket.
For details, see Managing Automatic Snapshot Creation.
-Automatic Snapshot Creation
-You can customize Snapshot Name Prefix, Backup Start Time, and Retention Period (days) as required.
-- Snapshot Name Prefix: Enter a maximum of 32 characters starting 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.
- Backup Started: indicates the time when the backup starts automatically every day. You can specify this parameter only in hours, for example, 00:00 or 01:00. The value ranges from 00:00 to 23:00. Select a time from the drop-down list box.
- Retention Period (days): indicates the duration when snapshots are retained in the OBS bucket, in days. The value ranges from 1 to 90. You can specify this parameter as required. The system automatically deletes expired snapshots every hour at half past the hour.
For details, see Managing Automatic Snapshot Creation.
+Automatic Snapshot Creation
+You can customize Snapshot Name Prefix, Backup Start Time, and Retention Period (days) as required.
+- Snapshot Name Prefix: Enter a maximum of 32 characters starting 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.
- Backup Started: indicates the time when the backup starts automatically every day. You can specify this parameter only in hours, for example, 00:00 or 01:00. The value ranges from 00:00 to 23:00. Select a time from the drop-down list box.
- Retention Period (days): indicates the duration when snapshots are retained in the OBS bucket, in days. The value ranges from 1 to 90. You can specify this parameter as required. The system automatically deletes expired snapshots every hour at half past the hour.
- Configure advanced settings for the cluster.
- Default: The the VPC Endpoint Service, Kibana Public Access, and Tag functions are disabled by default. You can manually enable these functions after the cluster is created.
- Custom: You can enable the VPC Endpoint Service and Tag functions as required.
Table 5 Parameters for advanced settings Parameter
+Table 6 Parameters for advanced settings Parameter
Description
+Description
VPC Endpoint Service
+VPC Endpoint Service
After enabling this function, you can obtain a private domain name for accessing the cluster in the same VPC. For details, see VPC Endpoint Service.
+After enabling this function, you can obtain a private domain name for accessing the cluster in the same VPC. For details, see VPC Endpoint Service.
Kibana Public Access
+Kibana Public Access
Clusters in non-security mode cannot access Kibana through the Internet.
+Clusters in non-security mode cannot access Kibana through the Internet.
Tag
+Tag
Adding tags to clusters can help you identify and manage your cluster resources. You can customize tags or use tags predefined by TMS. For details, see Managing Tags.
+Adding tags to clusters can help you identify and manage your cluster resources. You can customize tags or use tags predefined by TMS. For details, see Managing Tags.
Working with Kibana
+ +++ ++ ++ diff --git a/docs/css/umn/css_01_0108.html b/docs/css/umn/css_01_0108.html new file mode 100644 index 00000000..93871364 --- /dev/null +++ b/docs/css/umn/css_01_0108.html @@ -0,0 +1,19 @@ + + +Logging In to Kibana
+++Prerequisites
A CSS cluster has been created.
++Procedure
- Logging in to the console
- Log in to the CSS management console.
- On the Clusters page, in the row of a cluster, and click Access Kibana in the Operation column.+
If the cluster has the security mode enabled, enter the username and password you for login. Generally, the username is admin and the password is the one specified during cluster creation.
+If you forget the password, you can reset it on the cluster details page and then log in. Log in and perform operations on the Kibana page.
+
- Logging in using an EIP
If you have enabled Kibana public access during cluster creation, you can use the Kibana public IP address to log in to the cluster.
+
++ diff --git a/docs/css/umn/css_01_0109.html b/docs/css/umn/css_01_0109.html new file mode 100644 index 00000000..b25c8d31 --- /dev/null +++ b/docs/css/umn/css_01_0109.html @@ -0,0 +1,37 @@ + + +++Parent topic: Working with Kibana+Creating a User and Granting Permissions by Using Kibana
+++Prerequisites
The security mode has been enabled for the cluster.
++Procedure
+ This section takes Kibana 7.6.2 as an example to describe the procedure.
+- Log in to the CSS management console.
- Click Access Kibana in the Operation column of a cluster.Figure 1 Logging in to Kibana (1)+
- Log in to Kibana.Figure 2 Logging in to Kibana (2)+
+- Username: admin
- Password: Enter the password set during cluster creation.
- Click the Security icon on the Kibana operation page.Figure 3 Going to the Security page+
- Create a user.
- Choose Authentication Backends >Internal Users Database.Figure 4 Adding a user (1)+
- On the Internal Users Database page, choose
. The page for adding user information is displayed.Figure 5 Adding a user (2)+
- On the user creation page, configure Username and Password, and click Submit.
The user will be displayed in the user list.
+
- Choose Authentication Backends >Internal Users Database.
- Configure roles and permissions for the user.
- Click Roles.Figure 6 Adding a role+
- On the Open Distro Security Roles page, click .
- Enter a role name on the Overview page.Figure 7 Entering a role name+
- Configure CSS cluster permissions on the Cluster Permissions page. You can skip this step.
- Configure index permissions on the Index Permissions page.Index patterns: Set this parameter to the name of the index whose permission needs to be configured. For example, my_store.++
Use different names for the index and the user.
+Configure Permissions: Action Groups as required, for example, select the read-only permission Search.
+ - Retain the default settings on the Tenant Permissions page.
After the configuration is complete, the role will be displayed.
+
- Enter a role name on the Overview page.
- Click Roles.
- Assign a role to the user.
- Click Role Mappings.Figure 8 Role mapping+
- Click to add the mapping between users and roles.Figure 9 Users and roles+
- Click Submit.
- Click Role Mappings.
- Verify that the configuration takes effect in Kibana.
++ diff --git a/docs/css/umn/css_01_0149.html b/docs/css/umn/css_01_0149.html new file mode 100644 index 00000000..56bc5f56 --- /dev/null +++ b/docs/css/umn/css_01_0149.html @@ -0,0 +1,17 @@ + + +++Parent topic: Working with Kibana+Scaling In/Out a Cluster
+ ++ ++ diff --git a/docs/css/umn/css_01_0151.html b/docs/css/umn/css_01_0151.html new file mode 100644 index 00000000..0ab71144 --- /dev/null +++ b/docs/css/umn/css_01_0151.html @@ -0,0 +1,86 @@ + + +Scaling Out a Cluster
++If the workloads on the data plane of a cluster change, you can scale out the cluster by increasing the number or capacity of its nodes. Services are not interrupted during cluster scale-out.
++Prerequisites
- The target cluster is available and has no tasks in progress.
- The target cluster has sufficient quotas available.
+Constraints
- Node specifications cannot be modified during cluster scale-out.
- If you change the number and storage capacity of a specified type of node, nodes in other types will not be changed.
- The quota of nodes in different types varies. For details, see Table 1.
++
+Table 1 Number of nodes in different types Node Type
+Number
+ess
+ess: 1-32
+ess, ess-master
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess, ess-client
+ess: 1-32
+ess-client: 1-32
+ess, ess-cold
+ess: 1-32
+ess-cold: 1-32
+ess, ess-master, ess-client
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess-client: 1-32
+ess, ess-master, ess-cold
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess-cold: 1-32
+ess, ess-client, ess-cold
+ess: 1-32
+ess-client: 1-32
+ess-cold: 1-32
+ess, ess-master, ess-client, ess-cold
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess-client: 1-32
+ess-cold: 1-32
+- ess: the default node type that is mandatory for cluster creation. The other three node types are optional.
- ess-master: master node
- ess-client: client node
- ess-cold: cold data node
+Procedure
- Log in to the CSS management console.
- In the navigation pane on the left, choose Clusters. On the displayed Clusters page, locate the target cluster and choose More > Scale Cluster in the Operation column.
- On the Modify Configuration page, set scale-out parameters.
- New Nodes: The number of default nodes. For details about the quota, see Table 1.
- Node Storage Capacity: The storage capacity of the default nodes. The quota is determined by the New Node Specifications. The value must be a multiple of 20.
+ If a cluster has master, client, or cold data nodes, you can change the number of these nodes and expand the storage capacity of cold data nodes. For details about the quotas of the master, client, and cold data node, see Table 1.
+ - Click Next.
- Confirm the information and click Submit.
- Click Back to Cluster List to switch to the Clusters page. The Task Status is Scaling out. When Cluster Status changes to Available, the cluster has been successfully scaled out.
++ diff --git a/docs/css/umn/css_01_0153.html b/docs/css/umn/css_01_0153.html new file mode 100644 index 00000000..b805e3e8 --- /dev/null +++ b/docs/css/umn/css_01_0153.html @@ -0,0 +1,84 @@ + + +++Parent topic: Scaling In/Out a Cluster+Scaling in a Cluster
++If a cluster can process existing data without fully using its resources, you can scale in the cluster to reduce costs. Services are not interrupted during cluster scale-in.
++Prerequisites
The target cluster is available and has no tasks in progress.
++Constraints
- The node specifications and storage capacity cannot be modified during scale-in.
- If you change the number and storage capacity of a specified type of node, nodes in other types will not be changed.
- Ensure that the disk usage after scale-in is less than 80% and each AZ of each node type has at least one node.
- When scaling in a cluster, the data in the node to be deleted is migrated to other nodes. The timeout threshold for data migration is five hours. If data migration is not complete within 5 hours, the cluster scale-in fails. You are advised to perform scale-in for multiple times when the cluster has huge amounts of data.
- For a cluster without master nodes, the number of remaining data nodes (including cold data nodes and other types of nodes) after scale-in must be greater than half of the original node number, and greater than the maximum number of index replicas.
- The quota of nodes in different types varies. For details, see Table 1.
++
+Table 1 Number of nodes in different types Node Type
+Number
+ess
+ess: 1-32
+ess, ess-master
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess, ess-client
+ess: 1-32
+ess-client: 1-32
+ess, ess-cold
+ess: 1-32
+ess-cold: 1-32
+ess, ess-master, ess-client
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess-client: 1-32
+ess, ess-master, ess-cold
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess-cold: 1-32
+ess, ess-client, ess-cold
+ess: 1-32
+ess-client: 1-32
+ess-cold: 1-32
+ess, ess-master, ess-client, ess-cold
+ess: 1-200
+ess-master: an odd number ranging from 3 to 9
+ess-client: 1-32
+ess-cold: 1-32
+- ess: the default node type that is mandatory for cluster creation. The other three node types are optional.
- ess-master: master node
- ess-client: client node
- ess-cold: cold data node
+Procedure
- Log in to the CSS management console.
- In the navigation pane on the left, choose Clusters. On the displayed Clusters page, locate the target cluster and choose More > Scale Cluster in the Operation column.
- On the Modify Configuration page, set scale-in parameters. +
- Click Next.
- Confirm the information and click Submit.
- Click Back to Cluster List to switch to the Clusters page. The Task Status is Scaling in. When Cluster Status changes to Available, the cluster has been successfully scaled in.
++ diff --git a/docs/css/umn/css_01_0155.html b/docs/css/umn/css_01_0155.html new file mode 100644 index 00000000..4d2412e8 --- /dev/null +++ b/docs/css/umn/css_01_0155.html @@ -0,0 +1,80 @@ + + +++Parent topic: Scaling In/Out a Cluster+Configuring Cluster Monitoring
++You can use Cloud Eye to monitor the created clusters. After configuring the cluster monitoring, you can log in to the Cloud Eye management console to view cluster metrics.
+The procedure for configuring cluster monitoring:
+- Creating Alarm Rules: Customize alarm rules for the monitoring metrics. Once a metric exceeds the threshold, the system will notify you by sending emails or HTTP/HTTPS requests.
- Configuring Monitoring Metrics: Configure monitoring metrics for a cluster or a node in the cluster.
- Viewing Monitoring Metrics: View the statistics of the monitoring metrics in specific periods.
+Prerequisites
- The cluster is in the Available or Processing status.
- The cluster has been running properly for more than 10 minutes.
+Recommended Monitoring Metrics
- Cluster CPU and JVM usage. You are advised to configure the following monitoring metrics: average JVM heap usage, maximum JVM heap usage, average CPU usage, and maximum CPU usage.
- Cluster write and query latency and throughput. You are advised to configure the following monitoring metrics: average index latency, average index rate, average search latency, and average QPS.
- Cluster write and query queue and rejected tasks. You are advised to configure the following monitoring metrics: tasks in write queue, tasks in search queue, rejected tasks in write queue, and rejected tasks in search queue.
+Creating Alarm Rules
- Log in to the Cloud Eye console.
- In the navigation pane on the left, choose Alarm Management > Alarm Rules.
- In the Resource Type column, select Cloud Search Service as criteria to search for alarm rules that meet the requirements.
If no alarm rules are available, create one by referring to Creating an Alarm Rule and Notification. For details about how to set Resource Type and Dimension, see Table 1.
+ ++
+Table 1 Alarm rule configuration parameter Parameter
+Description
+Remark
+Resource Type
+Type of the resource that the alarm rule is created for
+Select Cloud Search Service.
+Dimension
+Metric dimension of the selected resource type
+CSS supports two dimensions. Select a dimension as required.
+- CSS Clusters: Alarm rules are specified by cluster.
- CSS Clusters - CSS Instances: Alarm rules are specified by node in a cluster.
+ + +Configuring Monitoring Metrics
- Create a monitoring panel. For details, see Creating a Monitoring Panel. If an available monitoring panel has been created, skip this step.
- Add CSS monitoring graphs. For details, see Adding a Graph.
For details about how to set Resource Type and Dimension, see Table 2.
+ ++
+Table 2 Graph configuration parameter Parameter
+Description
+Remark
+Resource Type
+Type of the resource to be monitored
+Select Cloud Search Service.
+Dimension
+Metric dimension
+CSS supports two dimensions. Select a dimension as required.
+- CSS Clusters: Monitoring is executed by cluster.
- CSS Clusters - CSS Instances: Monitoring is executed by node in a cluster.
++ diff --git a/docs/css/umn/css_01_0185.html b/docs/css/umn/css_01_0185.html new file mode 100644 index 00000000..6bd1e041 --- /dev/null +++ b/docs/css/umn/css_01_0185.html @@ -0,0 +1,164 @@ + + +++Parent topic: Monitoring a Cluster+Viewing Cluster Information
++On the Cluster Information page, you can view the information about a cluster, including the private network address, public IP address, version, and node.
+- Log in to the CSS management console.
- Choose Clusters > Elasticsearch. The cluster list page is displayed.
- Click a cluster name to go to the Cluster Information page and view the basic information about the cluster.
++
+Table 1 Parameters for configuring basic information Type
+Parameter
+Description
+Cluster Information
+Name
+User-defined cluster name.
+You can click
+
on the right to change the cluster name.ID
+Unique ID of a cluster, which is automatically generated by the system.
+Each cluster in the same region has a unique ID.
+Version
+Cluster version information.
+Cluster Status
+Current status of a cluster
+Task Status
+Current task status of a cluster. If no task is in progress, -- is displayed.
+Created
+Time when a cluster was created
+Cluster Storage Capacity (GB)
+Storage capacity of a cluster
+Used Cluster Storage (GB)
+Used storage capacity of a cluster
+Configuration
+Region
+Region where a cluster is located
+AZ
+AZ where a cluster is located
+VPC
+VPC to which the cluster belongs
+Subnet
+Subnet to which the cluster belongs
+Security Group
+Security group to which a cluster belongs.
+Security Mode
+Security mode of a cluster.
+- Enabled: The current cluster is a security cluster.
- Disabled: The current cluster is a non-security cluster.
Reset Password
+This parameter is displayed only for security clusters.
+Click Reset to change the password of the administrator account admin of the security cluster.
+NOTE:+Requirements for administrator passwords:
+- The password can contain 8 to 32 characters.
- The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported: ~!@#$%^&*()-_=+\|[{}];:,<.>/?
- Do not use the administrator name, or the administrator name spelled backwards.
- You are advised to change the password periodically.
Enterprise Project
+Enterprise project to which a cluster belongs.
+You can click the project name to view the basic information about the enterprise project.
+Public IP Address
+Public network access information, which is displayed only for clusters in security mode.
+- For a security cluster with public network access enabled, the configured public network address is displayed. You can use this address to access the security cluster from the public network.
- For a security cluster with public network access disabled, -- is displayed.
When using a public IP address to access a cluster, you are advised to enable access control and configure an access whitelist to improve cluster security. For details about how to configure the public network access, see Public Network Access.
+Access Control
+Whether to set access control for a cluster. This parameter is displayed only for clusters with public network access enabled.
+- Enabled: Only IP addresses in the whitelist can access the cluster through the public network.
- Disabled: Any IP address can access the cluster through the public network.
Click Set to configure the access control and the whitelist.
+Bandwidth
+The bandwidth for public network access. This parameter is displayed only for clusters with public network access enabled.
+Click Edit to change the bandwidth size.
+HTTPS Access
+Whether to enable the HTTPS access protocol for a cluster.
+- Disabled: The HTTP protocol is used for cluster access.
- Enabled: The HTTPS protocol is used for cluster access. Only security clusters can enable this function. If HTTPS Access is enabled, you can click Download Certificate to obtain the CER security certificate for accessing the security cluster.
Private Network Address
+Private IP address and port number of a cluster, which can be used to access the cluster. If the cluster has only one node, the IP address and port number of only one node are displayed, for example, 10.62.179.32:9200. If the cluster has multiple nodes, the IP addresses and port numbers of all nodes are displayed, for example, 10.62.179.32:9200,10.62.179.33:9200.
+Node
+Node Specifications
+Specifications of nodes in a cluster
+Node Storage Type
+Storage capacity and storage type of nodes in a cluster
+Nodes
+Number of nodes in a cluster
+
++ diff --git a/docs/css/umn/css_01_0190.html b/docs/css/umn/css_01_0190.html new file mode 100644 index 00000000..954be2ed --- /dev/null +++ b/docs/css/umn/css_01_0190.html @@ -0,0 +1,17 @@ + + +++Parent topic: Creating and Accessing a Cluster+Accessing an Elasticsearch Cluster
++Elasticsearch clusters have built-in Kibana and Cerebro components. You can quickly access an Elasticsearch cluster through Kibana and Cerebro.
++Access a Cluster Through Kibana
- Log in to the CSS management console.
- On the Clusters page, locate the target cluster and click Access Kibana in the Operation column to go to the Kibana login page.
- Non-security cluster: The Kibana console is displayed.
- Security cluster: Enter the username and password on the login page and click Log In to go to the Kibana console. The default username is admin and the password is the one specified during cluster creation.
- After the login is successful, you can access the Elasticsearch cluster through Kibana.
+Accessing a Cluster Through Cerebro
- Log in to the CSS management console.
- On the Clusters page, locate the target cluster and click More > Cerebro in the Operation column to go to the Cerebro login page.
- Non-security cluster: Click the cluster name on the Cerebro login page to go to the Cerebro console.
- Security cluster: Click the cluster name on the Cerebro login page, enter the username and password, and click Authenticate to go to the Cerebro console. The default username is admin and the password is the one specified during cluster creation.
- After the login is successful, you can access the Elasticsearch cluster through Cerebro.
++ diff --git a/docs/css/umn/css_02_0001.html b/docs/css/umn/css_02_0001.html index 3c2b55bc..8f732c5e 100644 --- a/docs/css/umn/css_02_0001.html +++ b/docs/css/umn/css_02_0001.html @@ -1,38 +1,24 @@++Parent topic: Creating and Accessing a Cluster+FAQs
- +diff --git a/docs/css/umn/css_02_0006_0.html b/docs/css/umn/css_02_0006_0.html new file mode 100644 index 00000000..9b254614 --- /dev/null +++ b/docs/css/umn/css_02_0006_0.html @@ -0,0 +1,17 @@ + + +-
-
- What Are Regions and AZs?
+ - General Consulting
- - How Does CSS Ensure Data and Service Security?
+ - Functions
- - Which CSS Metrics Should I Focus On?
+ - Clusters in Security Mode
- - What Storage Options Does CSS Provide?
+ - Resource Usage and Change
- - What Is the Maximum Storage Capacity of CSS?
+ - Components
- - What Can the Disk Space of a CSS Cluster Be Used For?
+ - Kibana
- - How Can I Manage CSS?
+ - Clusters
- - Which Elasticsearch Versions Does CSS Support?
-
- - Can CSS Interconnect with Logstash?
-
- - Why Does My ECS Fail to Connect to a Cluster?
-
- - Which Search Functions Does CSS Support?
-
- - Why Does Cluster Creation Fail?
-
- - Why Does Index Backup Fail?
-
- - How Can I Improve Filebeat Performance?
-
- - Failed to Open Kibana
+ - Ports
How Does CSS Ensure Data and Service Security?
++CSS uses network isolation, in addition to various host and data security measures.
+- Network isolation
The entire network is divided into two planes: service plane and management plane. The two planes are deployed and isolated physically to ensure the security of the service and management networks.
+- Service plane: This is the network plane of the cluster. It provides service channels for users and delivers data definitions, indexing, and search capabilities.
- Management plane: This is the management console, where you manage CSS.
- Host security
CSS provides the following security measures:
+- The VPC security group ensures the security of the hosts in a VPC.
- Network access control lists (ACLs) allow you to control what data can enter or exit your network.
- The internal security infrastructure (including the network firewall, intrusion detection system, and protection system) monitors all network traffic that enters or exits the VPC through an IPsec VPN.
- Data security
Multiple replicas, cross-AZ deployment of clusters, and third-party (OBS) backup of index data ensure the security of user data.
+
++ diff --git a/docs/css/umn/css_02_0007_0.html b/docs/css/umn/css_02_0007_0.html new file mode 100644 index 00000000..d1ccdd10 --- /dev/null +++ b/docs/css/umn/css_02_0007_0.html @@ -0,0 +1,15 @@ + + +++Parent topic: General Consulting+Which CSS Metrics Should I Focus On?
++Disk usage and cluster health status are two key metrics that you can focus on. You can log in to Cloud Eye and configure alarm rules for these metrics. If alarms are reported, handle them by taking appropriate measures.
+Configuration examples:
+- Alarms are reported if the disk usage is higher than or equal to a specified value (for example, 85%) and has reached this value multiple times (for example, 5 times) within a specified time period (for example, 5 minutes).
- Alarms are reported if the value of the cluster health status metric exceeds 0 for multiple times (for example, 5 times) within a specified time period (for example, 5 minutes).
Measures:
+- If disk usage alarms are reported, view available disk space, check whether data can be deleted from cluster nodes or archived to other systems to free up space, or check if you can expand the disk capacity.
- If cluster health status alarms are reported, check whether shard allocation is normal, whether shards have been lost, and check whether the process has been restarted on Cerebro.
++ diff --git a/docs/css/umn/css_02_0008_0.html b/docs/css/umn/css_02_0008_0.html new file mode 100644 index 00000000..892236db --- /dev/null +++ b/docs/css/umn/css_02_0008_0.html @@ -0,0 +1,12 @@ + + +++Parent topic: General Consulting+What Storage Options Does CSS Provide?
++CSS uses EVS and local disks to store your indices. During cluster creation, you can specify the EVS disk type and specifications (the EVS disk size).
+- Supported EVS disk types include common I/O, high I/O, and ultra-high I/O.
- The EVS disk size varies depending on the node specifications selected when you create a cluster.
++ diff --git a/docs/css/umn/css_02_0009_0.html b/docs/css/umn/css_02_0009_0.html new file mode 100644 index 00000000..5d3bc819 --- /dev/null +++ b/docs/css/umn/css_02_0009_0.html @@ -0,0 +1,11 @@ + + +++Parent topic: General Consulting+What Is the Maximum Storage Capacity of CSS?
++You can configure up to 200 nodes for a cluster (each node corresponds to an ECS). The maximum storage capacity of an ECS is the total capacity of EVS disks attached to the ECS. You can calculate the total storage capacity of CSS based on the sizes of EVS disks attached to different ECSs. The EVS disk size is determined by the node specifications selected when you create the cluster.
+++ diff --git a/docs/css/umn/css_02_0010_0.html b/docs/css/umn/css_02_0010_0.html new file mode 100644 index 00000000..7de7a851 --- /dev/null +++ b/docs/css/umn/css_02_0010_0.html @@ -0,0 +1,12 @@ + + +++Parent topic: General Consulting+What Can the Disk Space of a CSS Cluster Be Used For?
++You can store the following logs and files:
+- Log files: Elasticsearch logs
- Data files: Elasticsearch index files
- Other files: cluster configuration files
- OS: 5% storage space reserved for the OS by default
++ diff --git a/docs/css/umn/css_02_0017_0.html b/docs/css/umn/css_02_0017_0.html new file mode 100644 index 00000000..a56e1711 --- /dev/null +++ b/docs/css/umn/css_02_0017_0.html @@ -0,0 +1,17 @@ + + +++Parent topic: General Consulting+How Can I Manage CSS?
++You can use any of the following three methods to manage CSS or to use search engine APIs. You can initiate requests based on constructed request messages.+- curl
curl is a command-line tool used to transfer data to or from a given URL. It serves as an HTTP client that can send HTTP requests to the HTTP server and receive response messages. You can also use curl to debug APIs. For more information about curl, visit https://curl.haxx.se/.
+ - Code
You can call APIs through code to assemble, send, and process request messages.
+ - REST client
Both Mozilla Firefox and Google Chrome provide a graphical browser plugin, the REST client, which you can use to send and process requests.
+– For Mozilla Firefox, see Firefox REST Client.
+– For Google Chrome, see Postman.
+
++ diff --git a/docs/css/umn/css_02_0025_0.html b/docs/css/umn/css_02_0025_0.html new file mode 100644 index 00000000..2526994d --- /dev/null +++ b/docs/css/umn/css_02_0025_0.html @@ -0,0 +1,20 @@ + + +++Parent topic: General Consulting+Why Does My ECS Fail to Connect to a Cluster?
++Perform the following steps to troubleshoot this problem:
+- Check whether the ECS instance and cluster are in the same VPC.
- If they are, go to 2.
- If they are not, create an ECS instance and ensure that the ECS instance is in the same VPC as the cluster.
- View the security group rule setting of the cluster to check whether port 9200 (TCP protocol) is allowed or port 9200 is included in the port range allowed in both the outbound and inbound directions.
- If it is allowed, go to 3.
- If it is not allowed, switch to the VPC management console and configure the security group rule of the cluster to allow port 9200 in both the outbound and inbound directions.
- Check whether the ECS instance has been added to a security group.
- If the instance has been added to a security group, check whether the security group configuration rules are appropriate. You can view the Security Group information on the Basic Information tab page of the cluster. Then, go to step 4.Figure 1 Viewing security group information+
- If the instance has not been added to the security group, go to the VPC page from the ECS instance details page, select a security group, and add the ECS to the group.
- If the instance has been added to a security group, check whether the security group configuration rules are appropriate. You can view the Security Group information on the Basic Information tab page of the cluster. Then, go to step 4.
- Check whether the ECS instance can connect to the cluster.ssh <Private network address and port number of a node>++
If the cluster contains multiple nodes, check whether the ECS can be connected to each node in the cluster.
+- If the connection is normal, the network is running properly.
- If the connection still fails, contact technical support.
++ diff --git a/docs/css/umn/css_02_0034_0.html b/docs/css/umn/css_02_0034_0.html new file mode 100644 index 00000000..ffe4803b --- /dev/null +++ b/docs/css/umn/css_02_0034_0.html @@ -0,0 +1,22 @@ + + +++Parent topic: Clusters+What Are Regions and AZs?
+++Regions and AZs
A region and availability zone (AZ) identify the location of a data center. You can create resources in a specific region and AZ.
+- A region is a physical data center. Each region is completely independent, and thereby improves fault tolerance and stability. After a resource is created, its region cannot be changed.
- An AZ is a physical location using independent power supplies and networks. Faults in an AZ do not affect other AZs. A region can contain multiple AZs that are physically isolated but networked together. This enables low-cost and low-latency network connections.
Figure 1 shows the relationship between regions and AZs. +++Region Selection
You are advised to select a region close to you or your target users. This reduces network latency and improves the access success rate.
++AZ Selection
When determining whether to deploy resources in the same AZ, consider your application's requirements for disaster recovery (DR) and network latency.
+- To prioritize DR capabilities, deploy resources in different AZs in the same region.
- To prioritize network latency, deploy resources in the same AZ.
+Regions and Endpoints
Before using an API to call resources, you will need to specify the resource region and endpoint. For details, see "Endpoints" in Cloud Search Service API Reference.
+++ diff --git a/docs/css/umn/css_02_0041.html b/docs/css/umn/css_02_0041.html new file mode 100644 index 00000000..26c1adf8 --- /dev/null +++ b/docs/css/umn/css_02_0041.html @@ -0,0 +1,25 @@ + + +++Parent topic: General Consulting+What Data Compression Algorithms Does CSS Use?
++CSS supports two data compression algorithms: LZ4 (by default) and best_compression.
+- LZ4 algorithm
LZ4 is the default compression algorithm of Elasticsearch. This algorithm can compress and decompress data quickly, but its compression ratio is low.
+LZ4 scans data with a 4-byte window, which slides 1 byte forward at a time. Duplicate data is compressed. This algorithm applies to scenarios where a large amount of data to be read while a small amount of data to be written.
+ - best_compression algorithm
This algorithm can be used when a large amount of data is written and the index storage cost is high, such as logs and time sequence analysis. This algorithm can greatly reduce the index storage cost.
+
Run the following command to switch the default compression algorithm (LZ4) to best_compression:+PUT index-1 +{ + "settings": { + "index": { + "codec": "best_compression" + } + } +}+The LZ4 algorithm can quickly compress and decompress data while the best_compression algorithm has a higher compression and decompression ratio.
+++ diff --git a/docs/css/umn/css_02_0042.html b/docs/css/umn/css_02_0042.html new file mode 100644 index 00000000..66136e83 --- /dev/null +++ b/docs/css/umn/css_02_0042.html @@ -0,0 +1,23 @@ + + +++Parent topic: General Consulting+Why All New Index Shards Are Allocated to the Same Node?
+++Possible Cause
The possible causes are as follows:
+- Shards were unevenly distributed in previous index allocations, and the predominate parameter in the latest indexed shard allocation was balance.shard. To balance the shard distribution across nodes, the new shards were allocated to the node with only a small number of shards.
- After a new node was added to a cluster and before the automatic cluster rebalancing completes, the predominate parameter was balance.shard. The shards of a new index are allocated to the new node, where there are no shards yet.
The following two parameters are used to balance the shard allocation in a cluster:
+cluster.routing.allocation.balance.index (default value: 0.45f)
+cluster.routing.allocation.balance.shard (default value: 0.55f)
++ - balance.index: A larger value indicates that all the shards of an index are more evenly distributed across nodes. For example, if an index has six shards and there are three data nodes, two shards will be distributed on each node.
- balance.shard: A larger value indicates that all the shards of all the indexes are more evenly distributed across nodes. For example, if index a has two shards, index b has four, and there are three data nodes, two shards will be distributed on each node.
- You can specify both balance.index and balance.shard to balance the shard allocation.
+Solution
To prevent the all the shards of an index from being allocated to a single node, use either of the following methods:
+- To create an index during cluster scale-out, configure the following parameter:
"index.routing.allocation.total_shards_per_node": 2
+That is, allow no more than two shards of an index to be allocated on each node. Determine the maximum number of shards allocated to each node based on the number of data nodes in your cluster and the number of index shards (both primary and secondary).
+
- If too many shards are distributed on only a few nodes, you can move some of the shards to other nodes to balance the distribution. Run the move command of POST _cluster/reroute. The rebalance module will automatically exchange the shard with a shard on the destination node. Determine the values of balance.index and balance.shard as needed.
++ diff --git a/docs/css/umn/css_02_0043.html b/docs/css/umn/css_02_0043.html new file mode 100644 index 00000000..1ada87bb --- /dev/null +++ b/docs/css/umn/css_02_0043.html @@ -0,0 +1,23 @@ + + +++Parent topic: Functions+How Do I Query Snapshot Information?
+++Prerequisites
The snapshot function has been enabled for the cluster and snapshot information has been configured.
++Querying a Snapshot
- Log in to the CSS management console, and click Clusters in the navigation pane. On the displayed Clusters page, locate the target cluster and click Access Kibana in the Operation column.
- In the left navigation pane of the Kibana page, click Dev Tools. Click Get to work to switch to the Console page.
Enter the code as required in the left pane, click
+
to execute the command, and view the result in the right pane. - Run the GET _snapshot/_all command to query information about all repositories.Figure 1 Querying information about all repositories+
- bucket: OBS bucket name
- base_path: Path. It consists of a fixed prefix and a cluster name.
- endpoint: OBS domain name
- region: your region
- Query snapshot information.
- Run the GET _snapshot/repo_auto/_all command to query the list of all the snapshots in the current repository.Figure 2 Snapshot information+
- snapshot: snapshot name
- state: snapshot status
- start_time, start_time_in_millis, end_time, and end_time_in_millis: snapshot time
- shards: the number of shards. total indicates the total number of shards. failed indicates the number of failures. successful indicates the number of successes.
- Run the GET _snapshot/repo_auto/$snapshot-xxx command to query information about a specified snapshot.
- Replace $snapshot-xxx with the actual snapshot name.
- repo_auto is followed by a snapshot name or wildcard characters.
- Run the GET _snapshot/repo_auto/_all command to query the list of all the snapshots in the current repository.
- (Optional) Delete information about a specified snapshot.
To delete a specific snapshot, run the DELETE _snapshot/ repo_auto/$snapshot-xxx command.
+Replace $snapshot-xxx with the actual snapshot name.
+
++ diff --git a/docs/css/umn/css_02_0051_0.html b/docs/css/umn/css_02_0051_0.html new file mode 100644 index 00000000..a714fa26 --- /dev/null +++ b/docs/css/umn/css_02_0051_0.html @@ -0,0 +1,32 @@ + + +++Parent topic: Functions+General Consulting
+++++ diff --git a/docs/css/umn/css_02_0052.html b/docs/css/umn/css_02_0052.html new file mode 100644 index 00000000..6e9e25b4 --- /dev/null +++ b/docs/css/umn/css_02_0052.html @@ -0,0 +1,12 @@ + + +-
+
- What Are Regions and AZs?
+
+ - How Does CSS Ensure Data and Service Security?
+
+ - Which CSS Metrics Should I Focus On?
+
+ - What Storage Options Does CSS Provide?
+
+ - What Is the Maximum Storage Capacity of CSS?
+
+ - How Can I Manage CSS?
+
+ - What Can the Disk Space of a CSS Cluster Be Used For?
+
+ - How Do I Check the Numbers of Shards and Replicas in a Cluster on the CSS Console?
+
+ - What Data Compression Algorithms Does CSS Use?
+
+
++Parent topic: FAQs+Can I Upgrade a Cluster from an Earlier Version to a Later Version?
++A cluster cannot be directly upgraded. You can purchase a cluster of a later version and migrate your data to it.
+- Creating a Cluster: Create a cluster of a later version in the region where your current cluster is deployed.
- Migrating a Cluster: Migrate your cluster by backing data up and restoring indexes.
++ diff --git a/docs/css/umn/css_02_0055.html b/docs/css/umn/css_02_0055.html new file mode 100644 index 00000000..86ad80b8 --- /dev/null +++ b/docs/css/umn/css_02_0055.html @@ -0,0 +1,43 @@ + + + +++Parent topic: Functions+Functions
+ +++ +++ diff --git a/docs/css/umn/css_02_0058.html b/docs/css/umn/css_02_0058.html new file mode 100644 index 00000000..f18f3328 --- /dev/null +++ b/docs/css/umn/css_02_0058.html @@ -0,0 +1,15 @@ + + +-
+
- Can Elasticsearch Data Be Migrated Between VPCs?
+
+ - How Do I Migrate a CSS Cluster Across Regions?
+
+ - How Do I Configure the Threshold for CSS Slow Query Logs?
+
+ - How Do I Update the CSS Lifecycle Policy?
+
+ - How Do I Set the Numbers of Index Copies to 0 in Batches?
+
+ - Why All New Index Shards Are Allocated to the Same Node?
+
+ - How Do I Query Snapshot Information?
+
+ - Can I Upgrade a Cluster from an Earlier Version to a Later Version?
+
+ - Can I Restore a Deleted Cluster?
+
+ - Can I Modify the TLS Algorithm of an Elasticsearch Cluster?
+
+ - How Do I Set the search.max_buckets Parameter for an ES Cluster?
+
+ - Does the Value i of node.roles Indicate an Injest Node?
+
+ - How Do I Create a Type Under an Index in an Elasticsearch 7.x Cluster?
+
+
++Parent topic: FAQs+Can Elasticsearch Data Be Migrated Between VPCs?
++Elasticsearch does not support direct data migration between different VPCs. You can use either of the following methods to migrate data.
++Method 1
Use the backup and restoration function to migrate cluster data.
++Method 2
- Connect the VPC network and establish a VPC peering connection.
- After the network is connected, use Logstash to migrate data.
++ diff --git a/docs/css/umn/css_02_0063.html b/docs/css/umn/css_02_0063.html new file mode 100644 index 00000000..e763f951 --- /dev/null +++ b/docs/css/umn/css_02_0063.html @@ -0,0 +1,23 @@ + + + +++Parent topic: Functions+Clusters in Security Mode
+ +++ +++ diff --git a/docs/css/umn/css_02_0064.html b/docs/css/umn/css_02_0064.html new file mode 100644 index 00000000..2400c447 --- /dev/null +++ b/docs/css/umn/css_02_0064.html @@ -0,0 +1,11 @@ + + +-
+
- What Is the Relationship Between the Filebeat Version and Cluster Version?
+
+ - How Do I Obtain the Security Certificate of CSS?
+
+ - How Do I Convert the Format of a CER Security Certificate?
+
+
++Parent topic: FAQs+What Is the Relationship Between the Filebeat Version and Cluster Version?
++- Non-security mode: no restrictions.
- Cluster in security mode: The Filebeat OSS version must match the cluster version. For details on how to download the Filebeat OSS version, see Past Releases of Elastic Stack Software.
++ diff --git a/docs/css/umn/css_02_0066.html b/docs/css/umn/css_02_0066.html new file mode 100644 index 00000000..3bfbc128 --- /dev/null +++ b/docs/css/umn/css_02_0066.html @@ -0,0 +1,35 @@ + + + +++Parent topic: Clusters in Security Mode+Resource Usage and Change
+ +++ +++ diff --git a/docs/css/umn/css_02_0067.html b/docs/css/umn/css_02_0067.html new file mode 100644 index 00000000..a4252af1 --- /dev/null +++ b/docs/css/umn/css_02_0067.html @@ -0,0 +1,18 @@ + + +-
+
- How Do I Clear Expired Data to Release Storage Space?
+
+ - How Do I Configure a Two-Replica CSS Cluster?
+
+ - How Do I Delete Index Data?
+
+ - Can I Change the Number of Shards to Four with Two Replicas When There Is One Shard Set in the JSON File?
+
+ - What Are the Impacts If an Elasticsearch Cluster Has Too Many Shards?
+
+ - How Do I Set the Default Maximum Number of Records Displayed on a Page for an Elasticsearch Cluster
+
+ - Why Does the Disk Usage Increase After the delete_by_query Command Was Executed to Delete Data?
+
+ - How Do I Clear the Cache of a CSS Cluster?
+
+ - The Average Memory Usage of an Elasticsearch Cluster Reaches 98%
+
+
++Parent topic: FAQs+How Do I Clear Expired Data to Release Storage Space?
++- Run the following command to delete a single index data record.
curl -XDELETE http://IP:9200/Index_name
++ IP: the IP address of any node in the cluster
+ - Run the following command to delete all Logstash data of a day. For example, delete all data on June 19, 2017:
For a cluster in non-security mode: curl -XDELETE 'http://IP:9200/logstash-2017.06.19*'
+For a cluster in security mode: curl -XDELETE -u username:password 'https://IP:9200/logstash-2017.06.19' -k
++ - username: username of the administrator. The default value is admin.
- password: the password set during cluster creation
- IP: the IP address of any node in the cluster
++ diff --git a/docs/css/umn/css_02_0068.html b/docs/css/umn/css_02_0068.html new file mode 100644 index 00000000..9f9ee56d --- /dev/null +++ b/docs/css/umn/css_02_0068.html @@ -0,0 +1,18 @@ + + +++Parent topic: Resource Usage and Change+How Do I Configure a Two-Replica CSS Cluster?
++- Run GET _cat/indices?v in Kibana to check the number of cluster replicas. If the value of rep is 1, the cluster has two replicas.
+
- If the value of rep is not 1, run the following command to set the number of replicas:
PUT /index/_settings
+{
+"number_of_replicas" : 1 //Number of replicas
+}
++ index specifies the index name. Set this parameter based on site requirements.
+
++ diff --git a/docs/css/umn/css_02_0069.html b/docs/css/umn/css_02_0069.html new file mode 100644 index 00000000..2d22b747 --- /dev/null +++ b/docs/css/umn/css_02_0069.html @@ -0,0 +1,11 @@ + + +++Parent topic: Resource Usage and Change+How Do I Delete Index Data?
++- Manually: Run the DELETE /my_index command in Kibana.
- Automatically: Create scheduled tasks to call the index deletion request and periodically execute the tasks. CSS supports Open Distro Index State Management. For details, see: https://opendistro.github.io/for-elasticsearch-docs/docs/im/ism/
++ diff --git a/docs/css/umn/css_02_0070.html b/docs/css/umn/css_02_0070.html new file mode 100644 index 00000000..e6b7adfc --- /dev/null +++ b/docs/css/umn/css_02_0070.html @@ -0,0 +1,19 @@ + + + +++Parent topic: Resource Usage and Change+Components
+ +++ ++ + ++ diff --git a/docs/css/umn/css_02_0073.html b/docs/css/umn/css_02_0073.html new file mode 100644 index 00000000..e01401f0 --- /dev/null +++ b/docs/css/umn/css_02_0073.html @@ -0,0 +1,18 @@ + + +++Parent topic: FAQs+Kibana
++++ + ++ diff --git a/docs/css/umn/css_02_0077.html b/docs/css/umn/css_02_0077.html new file mode 100644 index 00000000..860db2c6 --- /dev/null +++ b/docs/css/umn/css_02_0077.html @@ -0,0 +1,22 @@ + + +++Parent topic: FAQs+Clusters
+++++ diff --git a/docs/css/umn/css_02_0078.html b/docs/css/umn/css_02_0078.html new file mode 100644 index 00000000..fba54405 --- /dev/null +++ b/docs/css/umn/css_02_0078.html @@ -0,0 +1,11 @@ + + +-
+
- Why Does My ECS Fail to Connect to a Cluster?
+
+ - Can a New Cluster Use the IP Address of the Old Cluster?
+
+ - Can I Associate My EIP If I Want to Access the Cluster from the Internet?
+
+ - Can I Use x-pack-sql-jdbc to Access CSS Clusters and Query Data?
+
+
++Parent topic: FAQs+Can a New Cluster Use the IP Address of the Old Cluster?
++No.
+++ diff --git a/docs/css/umn/css_02_0079.html b/docs/css/umn/css_02_0079.html new file mode 100644 index 00000000..65bc1b26 --- /dev/null +++ b/docs/css/umn/css_02_0079.html @@ -0,0 +1,11 @@ + + +++Parent topic: Clusters+Can I Associate My EIP If I Want to Access the Cluster from the Internet?
++No. To access a cluster from the Internet, see Public IP Address Access.
+++ diff --git a/docs/css/umn/css_02_0081.html b/docs/css/umn/css_02_0081.html new file mode 100644 index 00000000..77c2dc4a --- /dev/null +++ b/docs/css/umn/css_02_0081.html @@ -0,0 +1,11 @@ + + +++Parent topic: Clusters+Can I Use x-pack-sql-jdbc to Access CSS Clusters and Query Data?
++No. Currently, CSS does not integrate the x-pack component.
+++ diff --git a/docs/css/umn/css_02_0082.html b/docs/css/umn/css_02_0082.html new file mode 100644 index 00000000..35e1f0c0 --- /dev/null +++ b/docs/css/umn/css_02_0082.html @@ -0,0 +1,19 @@ + + + +++Parent topic: Clusters+Ports
+ +++ ++ + ++ diff --git a/docs/css/umn/css_02_0083.html b/docs/css/umn/css_02_0083.html new file mode 100644 index 00000000..78180044 --- /dev/null +++ b/docs/css/umn/css_02_0083.html @@ -0,0 +1,13 @@ + + +++Parent topic: FAQs+Do Ports 9200 and 9300 Both Open?
++Yes. Port 9200 is used by external systems to access CSS clusters, and port 9300 is used for communication between nodes.
+The methods for accessing port 9300 are as follows:
+- If your client is in the same VPC and subnet with the CSS cluster, you can access it directly.
- If your client is in the same VPC with but different subnet from the CSS cluster, apply for a route separately.
- If your client is in the different VPCs and subnets from the CSS cluster, create a VPC peering connection to enable communication between the two VPCs, and then apply for routes to connect the two subnets.
++ diff --git a/docs/css/umn/css_02_0088.html b/docs/css/umn/css_02_0088.html new file mode 100644 index 00000000..9ec12c0f --- /dev/null +++ b/docs/css/umn/css_02_0088.html @@ -0,0 +1,12 @@ + + +++Parent topic: Ports+Can I Install Search Guard on CSS?
++CSS does not currently support installation of Search Guard.
+CSS provides clusters in security mode, which have the same functions as Search Guard.
+++ diff --git a/docs/css/umn/css_02_0089.html b/docs/css/umn/css_02_0089.html new file mode 100644 index 00000000..8e8c9533 --- /dev/null +++ b/docs/css/umn/css_02_0089.html @@ -0,0 +1,18 @@ + + +++Parent topic: Components+Can I Change the Number of Shards to Four with Two Replicas When There Is One Shard Set in the JSON File?
++Once an index is created, the number of primary shards cannot be changed.
+You can run the following command in Kibana to change the number of replicas:
+PUT /indexname/_settings +{ +"number_of_replicas":1 //Number of replicas +}++ index specifies the index name. Set this parameter based on site requirements.
+++ diff --git a/docs/css/umn/css_02_0093.html b/docs/css/umn/css_02_0093.html new file mode 100644 index 00000000..626534e0 --- /dev/null +++ b/docs/css/umn/css_02_0093.html @@ -0,0 +1,13 @@ + + +++Parent topic: Resource Usage and Change+How Do I Check the Numbers of Shards and Replicas in a Cluster on the CSS Console?
++- Log in to the console.
- On the Clusters page, click Access Kibana in the Operation column of a cluster.
- Log in to Kibana and choose Dev Tools.
+
- On the Console page, run the GET _cat/indices?v command query the number of shards and replicas in a cluster. In the following figure, the pri column indicates the number of index shards, and the rep column indicates the number of replicas. After an index is created, its pri value cannot be modified. Its rep value can be modified.
+
++ diff --git a/docs/css/umn/css_02_0094.html b/docs/css/umn/css_02_0094.html new file mode 100644 index 00000000..6b04b9a2 --- /dev/null +++ b/docs/css/umn/css_02_0094.html @@ -0,0 +1,14 @@ + + +++Parent topic: General Consulting+How Do I Migrate a CSS Cluster Across Regions?
++CSS clusters cannot be directly migrated. You can back up a cluster to an OBS bucket and restore it to a new region.
+- If the OBS bucket is in the same region as your CSS cluster, migrate the cluster by following the instructions in Index Backup and Restoration.
- If the OBS bucket is not in the same region as your CSS cluster, configure cross-region replication to back up the cluster to the bucket, and migrate the cluster by following the instructions in Index Backup and Restoration.
+ - Before cross-region replication, ensure the snapshot folder of the destination cluster is empty. Otherwise, the snapshot information cannot be updated to the snapshot list of the destination cluster.
- Before every migration, ensure the folder is empty.
++ diff --git a/docs/css/umn/css_02_0096.html b/docs/css/umn/css_02_0096.html new file mode 100644 index 00000000..e7af26b8 --- /dev/null +++ b/docs/css/umn/css_02_0096.html @@ -0,0 +1,19 @@ + + +++Parent topic: Functions+How Do I Configure the Threshold for CSS Slow Query Logs?
++The slow query log settings of CSS are the same as those of Elasticsearch. You can configure slow query logs via the _settings API. For example, you can run the following command in Kibana to set the index level:
+PUT /my_index/_settings +{ + "index.search.slowlog.threshold.query.warn": "10s", + "index.search.slowlog.threshold.fetch.debug": "500ms", + "index.indexing.slowlog.threshold.index.info": "5s" +}+- If a query takes longer than 10 seconds, a WARN log will be generated.
- If retrieval takes longer than 500 milliseconds, a DEBUG log will be generated.
- If an index takes longer than 5 seconds, an INFO log will be generated.
For details, visit the official website: https://www.elastic.co/guide/cn/elasticsearch/guide/current/logging.html
+++ diff --git a/docs/css/umn/css_02_0098.html b/docs/css/umn/css_02_0098.html new file mode 100644 index 00000000..9061ce16 --- /dev/null +++ b/docs/css/umn/css_02_0098.html @@ -0,0 +1,13 @@ + + +++Parent topic: Functions+Can I Export Data from Kibana?
++Exporting data from Kibana requires the SQL Workbench plugin. Currently, you can only export data from Kibana 7.6.2 or later.
+In SQL Workbench of Kibana, you can enter Elasticsearch SQL statements to query data or click Download to export data. You can export 1 to 200 data records. By default, 200 data records are exported.
+Figure 1 SQL Workbench+
++ diff --git a/docs/css/umn/css_02_0099.html b/docs/css/umn/css_02_0099.html new file mode 100644 index 00000000..fa4a3f5d --- /dev/null +++ b/docs/css/umn/css_02_0099.html @@ -0,0 +1,17 @@ + + +++Parent topic: Kibana+How Do I Query Index Data on Kibana in an ES Cluster?
+++Run the following command to query index data through an API on Kibana:
+GET indexname/_search
+The returned data is shown in the following figure.
+Figure 1 Returned data+
+ - took: How many milliseconds the query cost.
- time_out: Whether a timeout occurred.
- _shard: Data is split into five shards. All of the five shards have been searched and data is returned successfully. No query result fails to be returned. No data is skipped.
- hits.total: Number of query results. Three documents are returned in this example.
- max_score: Score of the returned documents. The document that is more relevant to your search criteria would have a higher score.
- hits.hits: Detailed information of the returned documents.
++ diff --git a/docs/css/umn/css_02_0101.html b/docs/css/umn/css_02_0101.html new file mode 100644 index 00000000..09754f25 --- /dev/null +++ b/docs/css/umn/css_02_0101.html @@ -0,0 +1,16 @@ + + +++Parent topic: Kibana+Can I Modify the TLS Algorithm of an Elasticsearch Cluster?
++You can modify TLS algorithms in CSS 7.6.2 and later versions.
+- Log in to the CSS management console.
- In the navigation pane, choose Clusters. The cluster list is displayed.
- Click the name of the target cluster to go to the cluster details page.
- Select Parameter Configurations, click Edit, expand the Customize parameter, and click Add.
Add the opendistro_security.ssl.http.enabled_ciphers parameter and set it to ['TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256', 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384'].
++ If the parameter value contains multiple algorithm protocols, enclose the value with a pair of square brackets ([]). If the parameter value is a single algorithm protocol, enclose the value with a pair of single quotation marks(' ').
+ - After the modification is complete, click Submit.In the displayed Submit Configuration dialog box, select the box indicating "I understand that the modification will take effect after the cluster is restarted." and click Yes.
If the Status is Succeeded in the parameter modification list, the modification has been saved.
+ - Return to the cluster list and choose More > Restart in the Operation column to restart the cluster and make the modification take effect.
++ diff --git a/docs/css/umn/css_02_0102.html b/docs/css/umn/css_02_0102.html new file mode 100644 index 00000000..bf75d966 --- /dev/null +++ b/docs/css/umn/css_02_0102.html @@ -0,0 +1,20 @@ + + +++Parent topic: Functions+How Do I Set the search.max_buckets Parameter for an ES Cluster?
+++Function
If the query results on shards exceed the upper limit of records that can be returned (default value: 10000), you need to increase the limit by changing the value of search.max_buckets.
++Solution
Run the following command on the Dev Tools page of Kibana:+PUT _cluster/settings +{ + "persistent": { + "search.max_buckets": 20000 + } +}+++ diff --git a/docs/css/umn/css_02_0106.html b/docs/css/umn/css_02_0106.html new file mode 100644 index 00000000..86f87bd7 --- /dev/null +++ b/docs/css/umn/css_02_0106.html @@ -0,0 +1,12 @@ + + +++Parent topic: Functions+How Do I Obtain the Security Certificate of CSS?
++The security certificate (CloudSearchService.cer) can be downloaded only for security clusters that have enabled HTTPS access.
+- Log in to the CSS management console.
- In the navigation pane, choose Clusters. The cluster list is displayed.
- Click the name of a cluster to go to the cluster details page.
- On the Configuration page, click Download Certificate next to Security Mode.
++ diff --git a/docs/css/umn/css_02_0118.html b/docs/css/umn/css_02_0118.html new file mode 100644 index 00000000..a7dabd53 --- /dev/null +++ b/docs/css/umn/css_02_0118.html @@ -0,0 +1,13 @@ + + +++Parent topic: Clusters in Security Mode+How Do I Set the Numbers of Index Copies to 0 in Batches?
++- Log in to the Kibana page of the cluster. In the navigation pane, choose Dev Tools.
- Modify and run the PUT /*/_settings{"number_of_replicas":0} command.+
Do not directly run the preceding command, because the asterisk (*) may match security indexes. You are advised to specify the index required for the batch operation. Example: PUT /test*/_settings{"number_of_replicas":0}
+
++ diff --git a/docs/css/umn/css_02_0119.html b/docs/css/umn/css_02_0119.html new file mode 100644 index 00000000..b2ca351b --- /dev/null +++ b/docs/css/umn/css_02_0119.html @@ -0,0 +1,29 @@ + + +++Parent topic: Functions+How Do I Update the CSS Lifecycle Policy?
++The CSS lifecycle is implemented using the Index State Management (ISM) of Open Distro. For details about how to configure policies related to the ISM template, see the Open Distro documentation.
+- When a policy is created, the system writes a record to the .opendistro-ism-config index. In the record, _id is the policy name, and the content is the policy definition.Figure 1 Writing a data record+
- After a policy is bound to an index, the system writes another record to the .opendistro-ism-config index. The following figure shows the initial status of a record.Figure 2 Initial data status+
- Run the explain command. Only a policy ID will be returned.
GET _opendistro/_ism/explain/data2 +{ + "data2" : { + "index.opendistro.index_state_management.policy_id" : "policy1" + } +}+Open Distro will execute an initialization process to fill the policy content in the record. The following figure shows the initialized data.
+Figure 3 Initialized data+
After the initialization, min_index_age in the policy will be copied.
++ The initialized index uses a copy of this policy. The policy update will not take effect on the index.
+
- After the policy is modified, call the change_policy API to update the policy.
POST _opendistro/_ism/change_policy/data1 +{ + "policy_id": "policy1" +}+
++ diff --git a/docs/css/umn/css_02_0120.html b/docs/css/umn/css_02_0120.html new file mode 100644 index 00000000..bb8fc994 --- /dev/null +++ b/docs/css/umn/css_02_0120.html @@ -0,0 +1,22 @@ + + +++Parent topic: Functions+Can I Restore a Deleted Cluster?
++Yes. You can use a snapshot stored in OBS to restore a cluster. A deleted cluster that has no snapshots in OBS cannot be restored. Exercise caution when deleting a cluster.
+To restore a deleted cluster, perform the following steps:
+- Log in to the CSS management console.
- In the navigation pane on the left, choose Clusters. On the displayed Clusters page, click Create Cluster in the upper right corner to create a cluster and enable the snapshot function. Set the OBS bucket and backup path to those of the cluster to be restored.
To restore a deleted cluster to an existing cluster, set the OBS bucket and backup path to those of the deleted cluster.
++ To restore a deleted cluster to a new cluster, ensure they are in the same region. The new cluster version must be the same as or later than that of the deleted cluster. The number of nodes in the new cluster must be greater than half of that in the deleted cluster. Otherwise, the cluster may fail to be restored.
+ - If the status of the new cluster changes to Available, click the cluster name to go to the Cluster Information page.
- In the navigation pane on the left, choose Cluster Snapshots.
In the snapshot management list, you can view the snapshot information of the deleted cluster. If no information is displayed, wait for several minutes and refresh the page.
+ - Locate the target snapshot and click Restore in the Operation column. The Restore page is displayed.
- On the Restore page, set restoration parameters.
Index: Enter the name of the index you want to restore. If you do not specify any index name, data of all indexes will be restored. The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?) are not allowed.
+Rename Pattern: Enter a regular expression. Indexes that match the regular expression are restored. The default value index_(.+) indicates restoring data of all indices. The value contains 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?,) are not allowed.
+Rename Replacement: Enter the index renaming rule. The default value restored_index_$1 indicates that restored_ is added in front of the names of all restored indexes. The value can contain 0 to 1,024 characters. Uppercase letters, spaces, and certain special characters (including "\<|>/?,) are not allowed. You can set Rename Replacement only if you have specified Rename Pattern.
+Cluster: Select the cluster that you want to restore. You can select the current cluster or others. However, you can only restore the snapshot to clusters whose status is Available. If the status of the current cluster is Unavailable, you cannot restore the snapshot to the current cluster. If you select another cluster and two or more indexes in the cluster have the same name, data of all indices with the same name as the name you specify will be overwritten. Therefore, exercise caution when you set the parameters.
+Figure 1 Restoring a snapshot+
- Click OK. If restoration succeeds, Task Status of the snapshot in the snapshot list will change to Restoration succeeded, and the index data is generated again according to the snapshot information.
++ diff --git a/docs/css/umn/css_02_0124.html b/docs/css/umn/css_02_0124.html new file mode 100644 index 00000000..7ec7a354 --- /dev/null +++ b/docs/css/umn/css_02_0124.html @@ -0,0 +1,11 @@ + + +++Parent topic: Functions+What Are the Impacts If an Elasticsearch Cluster Has Too Many Shards?
++- A large number of shards in a cluster slows down shard creation.
- If automatic index creation is enabled, slow index creation may cause a large number of write requests to be stacked in the memory or result in a cluster break down.
- If there are too many shards and you cannot properly monitor workloads, the number of records in a single shard may exceed the threshold, and write requests may be denied.
++ diff --git a/docs/css/umn/css_02_0125.html b/docs/css/umn/css_02_0125.html new file mode 100644 index 00000000..91fad38e --- /dev/null +++ b/docs/css/umn/css_02_0125.html @@ -0,0 +1,25 @@ + + +++Parent topic: Resource Usage and Change+How Do I Set the Default Maximum Number of Records Displayed on a Page for an Elasticsearch Cluster
+++Solution
- Method 1
Open Kibana and run the following commands on the Dev Tools page:
+PUT _all/_settings?preserve_existing=true +{ +"index.max_result_window" : "10000000" +}+ - Method 2
Run the following commands in the background:
+curl –XPUT 'http://localhost:9200/_all/_setting?preserve_existing=true'-d +{ +"index.max_result_window":"1000000" +}+
+ + This configuration consumes memory and CPU resources. Exercise caution when setting this parameter.
+++ diff --git a/docs/css/umn/css_02_0126.html b/docs/css/umn/css_02_0126.html new file mode 100644 index 00000000..46022774 --- /dev/null +++ b/docs/css/umn/css_02_0126.html @@ -0,0 +1,14 @@ + + +++Parent topic: Resource Usage and Change+Why Does the Disk Usage Increase After the delete_by_query Command Was Executed to Delete Data?
++Running the delete_by_query command can only add a deletion mark to the target data instead of really deleting it. When you search for data, all data is searched and the data with the deletion mark is filtered out.
+The space occupied by an index with the deletion mark will not be released immediately after you call the disk deletion API. The disk space is released only when the segment merge is performed next time.
+Querying the data with deletion mark occupies disk space. In this case, the disk usage increases when you run the disk deletion commands.
+ +++ diff --git a/docs/css/umn/css_02_0127.html b/docs/css/umn/css_02_0127.html new file mode 100644 index 00000000..88569fb1 --- /dev/null +++ b/docs/css/umn/css_02_0127.html @@ -0,0 +1,16 @@ + + +++Parent topic: Resource Usage and Change+Does the Value i of node.roles Indicate an Injest Node?
+++Function
If the value of node.roles of a client node is i, then is this client node an injest node?+- Are there coordinating only nodes in clusters? Are the client requests distributed to coordinating nodes?
- Are ingest nodes in the idle state when there are no ingest requests?
+Solution
If the value of node.roles of a client node is i, the ingest node mode is enabled.
+- The coordinating only nodes of Elasticsearch are called client nodes in CSS. If a cluster has no client nodes, client requests will be distributed to all nodes.
- An ingest node functions as a set of ELK for data conversion. If there is no ingest requests, ingest nodes are not in the idle state.
++ diff --git a/docs/css/umn/css_02_0128.html b/docs/css/umn/css_02_0128.html new file mode 100644 index 00000000..1b1f185c --- /dev/null +++ b/docs/css/umn/css_02_0128.html @@ -0,0 +1,16 @@ + + +++Parent topic: Functions+How Do I Convert the Format of a CER Security Certificate?
++The security certificate (CloudSearchService.cer) can be downloaded only for security clusters that have enabled HTTPS access. Most software supports certificates in the .pem or .jks format. You need to convert the format of the CSS security certificate.
+- Run the following command to convert the security certificate from .cer to .pem:
openssl x509 -inform der -in CloudSearchService.cer –out newname.pem+ - Run the following command to convert the security certificate from .cer to .jks:
keytool -import -alias newname -keystore ./truststore.jks -file ./CloudSearchService.cer+
In the preceding commands, newname indicates the user-defined certificate name.
+After the command is executed, set the certificate password and confirm the password as prompted. Securely store the password. It will be used for accessing the cluster.
+++ diff --git a/docs/css/umn/css_02_0130.html b/docs/css/umn/css_02_0130.html new file mode 100644 index 00000000..7d5bfb44 --- /dev/null +++ b/docs/css/umn/css_02_0130.html @@ -0,0 +1,25 @@ + + +++Parent topic: Clusters in Security Mode+How Do I Clear the Cache of a CSS Cluster?
++- Clear the fielddata
During aggregation and sorting, data are converted to the fielddata structure, which occupies a large amount of memory.
+- Run the following commands on Kibana to check the memory occupied by index fielddata:
DELETE /_search/scroll +{ +"scroll_id" : +"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==" +}+ - If the memory usage of fielddata is too high, you can run the following command to clear fielddata:
POST /test/_cache/clear?fielddata=true+
In the preceding command, test indicates the name of the index whose fielddata occupies a large amount of memory.
+ - Run the following commands on Kibana to check the memory occupied by index fielddata:
- Clear segments
The FST structure of each segment is loaded to the memory and will not be cleared. If the number of index segments is too large, the memory usage will be high. You are advised to periodically clear the segments.
+- Run the following command on Kibana to check the number of segments and their memory usage on each node:
GET /_cat/nodes?v&h=segments.count,segments.memory&s=segments.memory:desc
+ - If the memory usage of segments is too high, you can delete or disable unnecessary indexes, or periodically combine indexes that are not updated.
- Run the following command on Kibana to check the number of segments and their memory usage on each node:
- Clear the cache
Run the following command on Kibana to clear the cache:
+POST _cache/clear
+
++ diff --git a/docs/css/umn/css_02_0131.html b/docs/css/umn/css_02_0131.html new file mode 100644 index 00000000..a01b4245 --- /dev/null +++ b/docs/css/umn/css_02_0131.html @@ -0,0 +1,16 @@ + + +++Parent topic: Resource Usage and Change+The Average Memory Usage of an Elasticsearch Cluster Reaches 98%
+++Symptom
The cluster monitoring result shows that the average memory usage of a cluster is 98%. Does it affect cluster performance?
++Possible Cause
In an ES cluster, 50% of the memory is occupied by Elasticsearch and the other 50% is used by Lucene to cache files. It is normal that the average memory usage reaches 98%.
++Solution
You can monitor the cluster memory usage by checking the maximum JVM heap usage and average JVM heap usage.
+++ diff --git a/docs/css/umn/css_02_0132.html b/docs/css/umn/css_02_0132.html new file mode 100644 index 00000000..ae3fb719 --- /dev/null +++ b/docs/css/umn/css_02_0132.html @@ -0,0 +1,15 @@ + + +++Parent topic: Resource Usage and Change+How Do I Create a Type Under an Index in an Elasticsearch 7.x Cluster?
++In Elasticsearch 7.x and later versions, types cannot be created for indexes.
+If you need to use types, add include_type_name=true to the command. For example:
+PUT _template/urldialinfo_template?include_type_name=true
+After the command is executed, the following information is displayed:
+"#! Deprecation: [types removal] Specifying include_type_name in put index template requests is deprecated. The parameter will be removed in the next major version. "
+++ diff --git a/docs/css/umn/css_04_0001.html b/docs/css/umn/css_04_0001.html index 70fed5d2..af42ffed 100644 --- a/docs/css/umn/css_04_0001.html +++ b/docs/css/umn/css_04_0001.html @@ -1,23 +1,14 @@++Parent topic: Functions+CSS
-Cloud Search Service (CSS) is a fully managed, distributed search service that enables you to perform quick, real-time search. It is fully compatible with open-source Elasticsearch and provides users with structured and unstructured data search, statistical analysis, and reporting capabilities. CSS works in the way similar to a database.
-You can easily deploy CSS and quickly create clusters. With optimal configurations, CSS is O&M-free. CSS provides you with key metrics regarding the system, clusters, and query performance, freeing you to focus on business logic.
-For details about Elasticsearch, see the Elasticsearch Reference.
-Advantages
CSS has the following advantages:
-- Efficiency and ease of use
You can derive insights from terabyte-scale data in milliseconds. In addition, you can use its visualized data platform to easily analyze data.
- - Flexibility and scalability
You can request clusters and scale out a cluster online with zero service interruption.
- - Custom word dictionary
Custom word dictionaries are supported. You can modify the word dictionary without having to restart instances.
- - Easy O&M
CSS is fully-managed and out-of-the-box. You can start using it with a few clicks. Professionals are ready to assist you whenever you want.
- - Solid reliability
You can choose to trigger snapshots manually or periodically restore snapshots of clusters. You can restore snapshots of a cluster to another cluster to migrate cluster data.
-
-CSS
Cloud Search Service (CSS) is a fully hosted distributed search service based on Elasticsearch. You can use it for structured and unstructured data search, and use AI vectors for combine search, statistics, and reports. CSS is a fully managed cloud service of the ELK Stack and is compatible with open-source Elasticsearch, Kibana, and Cerebro.
+Elasticsearch is a distributed search engine that can be deployed in standalone or cluster mode. The heart of the ELK Stack, Elasticsearch clusters support multi-condition search, statistical analysis, and create visualized reports of structured and unstructured text. For details about Elasticsearch, see the Elasticsearch: The Definitive Guide.
+CSS can be automatically deployed, allowing you to quickly create Elasticsearch clusters. It provides the search engine optimization practices and does not require your O&M. Additionally, it has a robust monitoring system to present you key metrics, including clusters and query performance so that you can focus on the business logic.
diff --git a/docs/css/umn/css_04_0002.html b/docs/css/umn/css_04_0002.html index 90a6588d..ebd254cd 100644 --- a/docs/css/umn/css_04_0002.html +++ b/docs/css/umn/css_04_0002.html @@ -1,12 +1,15 @@ -Functions
CSS provides the following functions:
-- Professional cluster management
The management console allows you to securely manage and maintain clusters using a web browser.
-
- Robust monitoring system
The management console allows you to view the running status of created clusters via the dashboard and cluster list. You can obtain the current running status of clusters by viewing metrics.
-
- Support for Elasticsearch
Elasticsearch is a popular enterprise-grade Lucene-powered search server that provides distributed multi-user capabilities. CSS supports Elasticsearch and delivers multiple functions, including full-text search, structured search, analytics, aggregation, and highlighting.
+Functions
- Compatible with Elasticsearch
Freely use native Elasticsearch APIs and other software in the ecosystem, such as Beats and Kibana.
+ - Support various data sources
A few simple configurations can allow you to smoothly connect to multiple data sources, such as FTP, OBS, HBase, and Kafka. No extra coding is required.
+ - One-click operation
One-click cluster application, capacity expansion, and restart from small-scale testing to large-scale rollout
+ - User-defined snapshot policies
Trigger backup snapshots manually or configure an automated schedule.
- Compatible with Elasticsearch
Applicable Scenarios for Elasticsearch Clusters
-CSS Elasticsearch clusters are suitable to scenarios such as log analysis and site search.
-Log Analysis
You can perform O&M analysis and troubleshoot IT devices, and perform operation analytics based on service metrics.
-- Statistical analysis: Over 20 statistical analysis methods and nearly ten analytical dimensions are available.
- Real-time and efficient: You can get insights within seconds once new data is indexed.
- Visualized data: You can choose to display data in multiple ways, including tables, line charts, heat maps, and cloud maps.
Scenarios
+CSS can be used to build search boxes for websites and apps to improve user experience. You can also build a log analysis platform with it, facilitating data-driven O&M and business operations. CSS vector search can help you quickly build smart applications, such as AI-based image search, recommendation, and semantic search.
+-Site Search
CSS can be used to search for website content by keyword as well as search for and recommend commodities on e-commerce sites.
+- Real-time search: When site content is updated, you can find the updated content in your search within minutes, or even just seconds.
- Categorized statistics: You can apply search filters to sort products by category.
- Custom highlight style: You can define how the search results are highlighted.
Site Search
You can search website content by keyword as well or search for products on e-commerce sites with recommendations obtained.
-- Real-time search: When site content is updated, you can find the content in your search within minutes, or even just seconds.
- Categorized statistics: You can apply search filters to sort products by category, complete with statistical breakdowns.
- Custom highlight style: You can define how the search results are highlighted.
+All-Scenario Log Analysis
Analyze the logs of Elastic Load Balance (ELB), servers, containers, and applications. In CSS, the Kafka message buffer queue is used to balance loads in peak and off-peak hours. Logstash is used for data extract, transform and load (ETL). Elasticsearch retrieves and analyzes data. The analysis results are visualized by Kibana and presented to you.
+- High cost-effectiveness: CSS uses the Kunpeng computing power, separates cold and hot storage, and decouples computing and storage resources, achieving high performance and reducing costs by over 30%.
- Ease of use: Perform queries in a GUI editor. Easily create reports using drag-and-drop components.
- Powerful processing capability: CSS can import hundreds of terabytes of data per day, and can process petabytes of data.
Database Query Acceleration
CSS can be used to accelerate database queries. E-commerce and logistics companies have to respond to a huge number of concurrent order queries within a short period of time. Relational databases, although having good transaction atomicity, are weak in transaction processing, and can rely on CSS to enhance OLTP and OLAP capabilities.
+- High performance: Retrieve data from hundreds of millions of records within milliseconds. Text, time, numeric, and spatial data types are supported.
- High scalability: CSS can be scaled to have over 200 data nodes and over 1000 columns.
- Zero service interruption: The rolling restart and dual-copy mechanisms can avoid service interruption in case of specifications change or configuration update.
diff --git a/docs/css/umn/css_04_0004.html b/docs/css/umn/css_04_0004.html index 8f1920fe..5b6c956b 100644 --- a/docs/css/umn/css_04_0004.html +++ b/docs/css/umn/css_04_0004.html @@ -1,20 +1,58 @@Related Services
-This section describes the relationship between CSS and other services.
-- Virtual Private Cloud (VPC)
CSS clusters are created in the subnets of a VPC. VPCs provide a secure, isolated, and logical network environment for your clusters.
-
- Elastic Cloud Server (ECS)
In a CSS cluster, each node represents an ECS. When you create a cluster, ECSs are automatically created.
-
- Elastic Volume Service (EVS)
CSS uses EVS to store index data. When you create a cluster, EVSs are automatically created for cluster data storage.
- - Object Storage Service (OBS) -
- Cloud Eye
CSS uses Cloud Eye to monitor cluster metrics in real time. The supported CSS metrics include the disk usage and cluster health status. You can learn about the disk usage of the cluster based on the disk usage metric. You can learn about the health status of a cluster based on the cluster health status metric.
- - Cloud Trace Service (CTS)
With CTS, you can record operations associated with CSS for query, audit, and backtrack operations.
- - Key Management Service (KMS)
If disk encryption is enabled on CSS clusters, you need to obtain the key provided by KMS to encrypt and decrypt the disk data.
-
Figure 1 shows the relationships between CSS and other services.
+ + +
+Table 1 Relationships between CSS and other services Service
+Description
+Virtual Private Cloud (VPC)
+CSS clusters are created in the subnets of a VPC. VPCs provide a secure, isolated, and logical network environment for your clusters.
+Elastic Cloud Server (ECS)
+In a CSS cluster, each node represents an ECS. When you create a cluster, ECSs are automatically created.
+Elastic Volume Service (EVS)
+CSS uses EVS to store index data. When you create a cluster, EVSs are automatically created for cluster data storage.
+Object Storage Service (OBS)
+Snapshots of CSS clusters are stored in OBS buckets.
+Identity and Access Management (IAM)
+IAM authenticates access to CSS.
+Cloud Eye
+CSS uses Cloud Eye to monitor cluster metrics in real time. The supported CSS metrics include the disk usage and cluster health status. You can learn about the disk usage of the cluster based on the disk usage metric. You can learn about the health status of a cluster based on the cluster health status metric.
+Cloud Trace Service (CTS)
+With CTS, you can record operations associated with CSS for query, audit, and backtracking operations.
+Key Management Service (KMS)
+If disk encryption is enabled on CSS clusters, you need to obtain the key provided by KMS to encrypt and decrypt the disk data.
+diff --git a/docs/css/umn/css_04_0007.html b/docs/css/umn/css_04_0007.html index 8189faf1..975fe9d8 100644 --- a/docs/css/umn/css_04_0007.html +++ b/docs/css/umn/css_04_0007.html @@ -1,13 +1,14 @@ -Kibana
-Kibana is an open-source data analytics and visualization platform that works with Elasticsearch. You can use Kibana to search, view, and interact with data stored in Elasticsearch indices and to visualize your data in a variety of charts, tables, and maps.
-To learn more about Kibana, go to the Kibana official website: https://www.elastic.co/guide/en/kibana/current/index.html
-Accessing Kibana with Just a Few Clicks
CSS is integrated with Kibana. You can access Kibana with just a few clicks, without installing Kibana.
-Log in to the CSS management console. In the left navigation pane, click Clusters. On the displayed Clusters page, locate the row containing the target cluster and click Access Kibana in the Operation column.
+Product Components
+CSS supports Kibana and Cerebro.
+-Kibana
Kibana is an open-source data analytics and visualization platform that works with Elasticsearch. You can use Kibana to search for and view data stored in Elasticsearch indexes and display data in charts and maps. For details about Kibana, visit https://www.elastic.co/guide/en/kibana/current/index.html.
+By default, the Elasticsearch cluster of CSS provides the access channel to Kibana. You can quickly access Kibana without installing it. CSS is compatible with Kibana visualizations and Elasticsearch statistical and analysis capabilities.
+- Over 10 data presentation modes
- Nearly 20 data statistics methods
- Classification in various dimensions, such as time and tag
Kibana Functions
Kibana delivers visualization and Elasticsearch statistics and analysis functions. Kibana supports:
-- Over 10 data presentation modes
- Nearly 20 data statistics methods
- Classification in terms of various dimensions, such as time and tag
Cerebro
Cerebro is an open-source Elasticsearch web admin tool built using Scala, Play Framework, AngularJS, and Bootstrap. Cerebro allows you to manage clusters on a visualized page, such as executing REST requests, modifying Elasticsearch configurations, monitoring real-time disks, cluster loads, and memory usage.
+By default, the Elasticsearch cluster of CSS provides the access channel to Cerebro. You can quickly access Cerebro without installing it. CSS is fully compatible with the open-source Cerebro and adapts to the latest 0.8.4 version.
+- Elasticsearch visualized and real-time load monitoring
- Elasticsearch visualized data management
diff --git a/docs/css/umn/css_04_0010.html b/docs/css/umn/css_04_0010.html new file mode 100644 index 00000000..f19dbd24 --- /dev/null +++ b/docs/css/umn/css_04_0010.html @@ -0,0 +1,37 @@ + + +Advantages
++CSS has the following features and advantages.
++Efficient and Ease of Use
You can get insights from terabyte-scale data in milliseconds. In addition, you can use the visualized platform for data display and analysis.
++Flexible and Scalable
You can request resources as needed and perform capacity expansion online with zero service interruption.
++Easy O&M
CSS is a fully-managed, out-of-the-box service. You can start using it with several clicks, instead of managing clusters.
++Kernel Enhancement
Speed up data import, decouple storage and computing resources, isolate read and write requests, and take advantage of our high-performance vector search engine – all these at an affordable price.
++High Reliability
You can choose to trigger snapshots manually or on a periodic basis for backup and restore snapshots to the current or other clusters. Snapshots of a cluster can be restored to another cluster to implement cluster data migration.
+- Automatic backup using snapshots
CSS provides the backup function. You can enable the automatic backup function on the CSS management console and set the backup period based on the actual requirements.
+Automatic backup is to back up the index data of a cluster. Index backup is implemented by creating cluster snapshots. For backup of the first time, you are advised to back up all index data.
+CSS allows you to store the snapshot data of Elasticsearch instances to OBS, thereby achieving cross-region backup with the cross-region replication function of OBS.
+
+High Security
CSS ensures secure running of data and services from the following aspects:
+- Network isolation
The network is divided into two planes, service plane and management plane. The two planes are deployed and isolated physically to ensure the security of the service and management networks.
+- Service plane: refers to the network plane of the cluster. It provides service channels for users and delivers data definition, index, and search capabilities.
- Management plane: refers to the management console. It is used to manage CSS.
- VPC security groups or isolated networks ensure the security of hosts.
- Access control
- Using the network access control list (ACL), you can permit or deny the network traffic entering and exiting the subnets.
- Internal security infrastructure (including the network firewall, intrusion detection system, and protection system) can monitor all network traffic that enters or exits the VPC through the IPsec VPN.
- User authentication and index-level authentication are supported. CSS also supports interconnection with third-party user management systems.
- Data security
- In CSS, the multi-replica mechanism is used to ensure user data security.
- Communication between the client and server can be encrypted using SSL.
- Operation audit
Cloud Trace Service (CTS) can be used to perform auditing on key logs and operations.
+
+High Availability
To prevent data loss and minimize the cluster downtime in case of service interruption, CSS supports cross-AZ cluster deployment. When creating a cluster, you can select two or three AZs in the same region. The system will automatically allocate nodes to these AZs. If an AZ is faulty, the remaining AZs can still run properly, significantly enhancing cluster availability and improving service stability.
+++ diff --git a/docs/css/umn/css_04_0014.html b/docs/css/umn/css_04_0014.html new file mode 100644 index 00000000..e6b79feb --- /dev/null +++ b/docs/css/umn/css_04_0014.html @@ -0,0 +1,333 @@ + + +++Parent topic: Overview+Permissions Management
++If you need to assign different permissions to employees in your enterprise to access your CSS resources, IAM is a good choice for fine-grained permissions management. IAM provides identity authentication, permissions management, and access control, helping you secure access your resources.
+With IAM, you can use your account to create IAM users for your employees, and assign permissions to the users to control their access to specific resource types. For example, you may need to grant some software developers in your enterprise access to CSS resources but do not want them to be able to delete them or perform any high-risk operations. To this end, you can create IAM users for the software developers and grant them only the permissions required for using CSS resources.
+If you do not need to create IAM users, you can skip this section.
+IAM is a free service. You pay only for the resources in your account.
++Permissions Management
By default, new IAM users do not have any permissions assigned. You need to add the user to one or more groups, and apply permissions policies or roles to these groups. Users inherit permissions from the groups they are added to and can perform specified operations on cloud services based on these permissions.
+CSS is a project-level service deployed in specific physical regions. CSS permissions are assigned to users in specific regions and only take effect for these regions. If you want the permissions to take effect for all regions, you need to assign the permissions to the users in each region. When accessing CSS, the users need to switch to a region where they have been authorized to use cloud services.
+You can use roles and policies to grant users permissions.
+- Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. There are only a limited number of service-level roles for granting permissions to users. When using roles to grant permissions, you need to also assign other roles on which the permissions depend to take effect. Roles are not ideal for fine-grained authorization and secure access control.
- Policies are a type of fine-grained authorization mechanism that defines the permissions for performing operations on specific cloud resources under certain conditions. This mechanism allows for more flexible authorization. Policies allow you to meet requirements for more secure access control. For example, CSS administrators can grant CSS users only the permissions needed for managing a certain type of CSS.
Table 1 lists all the system roles supported by CSS. For example, some CSS roles are dependent on the roles of other services. When assigning CSS roles to users, you need to also assign dependent roles for the CSS permissions to take effect.
+ ++ +
+Table 1 System-defined roles and policies supported by CSS Role Name
+Description
+Dependency
+Elasticsearch Administrator
+CSS administrator
+Dependent on the Tenant Guest and Server Administrator roles.
+- Tenant Guest: A global role, which must be assigned in the global project.
- Server Administrator: A project-level role, which must be assigned in the same project.
+
+Table 2 Relationship between user permissions and roles Permission Type
+Description
+Type
+Required Role
+Permission 1
+Permissions:
+- Creating, deleting, and expanding CSS clusters
- Manually and automatically backing up CSS cluster data
- Restoring CSS cluster data
- Creating an IAM agency
- Creating an OBS bucket
- Creating a VPC and security group
- Kibana
- Customizing a word dictionary
System-defined role
+- Elasticsearch Administrator
- Server Administrator
- Tenant Guest
- VPC Administrator
- Security Administrator
- OBS Administrator
Permission 2
+Permissions:
+- Creating, deleting, and expanding CSS clusters
- Manually backing up CSS cluster data
- Restoring CSS cluster data
- Kibana
- Customizing a word dictionary
System-defined role
+- Elasticsearch Administrator
- Server Administrator
- Tenant Guest
Permission 3
+Permissions:
+- Viewing the cluster list
- Viewing the Overview page
- Kibana
System-defined role
+This permission is dependent on the Tenant Guest role,
+which must be assigned in the same project as Permission 3.
+Table 3 lists the common operations supported by each system permission of CSS. Please choose proper system policies according to this table.
+ ++
+Table 3 Common operations supported by each system-defined policy Operation
+CSS FullAccess
+CSS ReadOnlyAccess
+Elasticsearch Administrator
+Remarks
+Creating a cluster
+√
+x
+√
+-
+Querying a cluster list
+√
+√
+√
+-
+Querying cluster details
+√
+√
+√
+-
+Deleting a cluster
+√
+x
+√
+-
+Restarting a cluster
+√
+x
+√
+-
+Expanding cluster capacity
+√
+x
+√
+-
+Adding instances and expanding instance storage capacity
+√
+x
+√
+-
+Querying tags of a specified cluster
+√
+√
+√
+-
+Querying all tags
+√
+√
+√
+-
+Loading a custom word dictionary
+√
+x
+√
+Depends on OBS and IAM permissions
+Querying the status of a custom word dictionary
+√
+√
+√
+-
+Deleting a custom word dictionary
+√
+x
+√
+-
+Automatically setting basic configurations of a cluster snapshot
+√
+x
+√
+Depends on OBS and IAM permissions
+Modifying basic configurations of a cluster snapshot
+√
+x
+√
+Depends on OBS and IAM permissions
+Setting the automatic snapshot creation policy
+√
+x
+√
+-
+Querying the automatic snapshot creation policy
+√
+√
+√
+-
+Manually creating a snapshot
+√
+x
+√
+-
+Querying the snapshot list
+√
+√
+√
+-
+Restoring a snapshot
+√
+x
+√
+-
+Deleting a snapshot
+√
+x
+√
+-
+Disabling the snapshot function
+√
+x
+√
+-
+++ diff --git a/docs/css/umn/css_04_0019.html b/docs/css/umn/css_04_0019.html index 70cf7828..b052a183 100644 --- a/docs/css/umn/css_04_0019.html +++ b/docs/css/umn/css_04_0019.html @@ -1,67 +1,67 @@++Parent topic: Overview+Clusters in Security Mode
-Security mode is supported for Elasticsearch 7.1.1 and later versions. After you enable security mode, identity verification, authorization, and encryption are required.
-This section describes the security mode using Kibana as an example.
-- You can enable security mode only during cluster creation and not after the cluster is created.
-Key Terms
-Table 1 Key terms of security mode Term
+When creating an Elasticsearch cluster, you can enable the security mode for it. Identity authentication is required when users access a security cluster. You can also authorize and encrypt security clusters.
+Context
You can create clusters in multiple security modes. For details about the differences between security modes, see Table 1. +-Table 1 Cluster security modes Security Mode
Description
+Scenario
+Advantage
+Disadvantage
Permission
+Non-Security Mode
Single action, for example, creating an index (for example, indices:admin/create)
+Intranet services and test scenarios
+Simple. Easy to access.
+Poor security. Anyone can access such clusters.
Action group
+Security Mode + HTTP Protocol
A group of permissions. For example, the predefined SEARCH action group grants roles permissions to use _search and _msearchAPI.
+User permissions can be isolated, which is applicable to scenarios sensitive to cluster performance.
+Security authentication is required for accessing such clusters, which improves cluster security. Accessing a cluster through HTTP protocol can retain the high performance of the cluster.
+Cannot be accessed from the public network.
Role
+Security Mode + HTTPS Protocol
A role is a combination of permissions and action groups, including operation permissions on clusters, indices, documents, or fields.
+Scenarios that require high security and public network access.
Backend role
+Security authentication is required for accessing such clusters, which improves cluster security. HTTPS protocol allows public network to access such clusters.
(Optional) Other external roles from the backend such as LDAP/Active Directory
-User
-A user can send operation requests to the Elasticsearch cluster. The user has credentials such as username and password, zero or more backend roles, and zero or more custom attributes.
-Role mapping
-A user will be assigned a role after successful authentication. Role mapping is to map a role to a user (or a backend role). For example, the mapping from kibana_user (role) to jdoe (user) means that John Doe obtains all permissions of kibana_user after being authenticated by kibana_user. Similarly, the mapping from all_access (role) to admin (backend role) means that any user with the backend role admin (from the LDAP/Active Directory server) has all the permissions of role all_access after being authenticated. You can map each role to multiple users or backend roles.
+The performance of clusters using HTTPS is 20% lower than that of using HTTP.
+Identity Verification
After enabling the security mode, you need to log in to the cluster with the username and password that you set when you create the cluster. You can perform other operations after you log in successfully.
-Figure 1 Login for identity verification
+Identity Verification
To access a security cluster, you need to enter the username and password. The identity verification is required for the following two types of users:
+- Administrator: The default administrator username is admin, and the password is the one specified during cluster creation.
- Users: Enter the username and password created through Kibana.
Authorization
On the Kibana console, click Security to control user permissions in Elasticsearch clusters. You can configure hierarchical user permissions by cluster, index, document, and field.
You can add or delete users, and map users to different roles for permissions control.
-Figure 2 Configuring users+
Figure 1 Configuring users
You can use role mapping to configure roles and map a user's username, backend role, and host name to a role.
-Figure 3 Role mapping+
Figure 2 Role mapping
You can set permissions for each role to access clusters, indices and documents and assign Kibana tenants different roles.
-Figure 4 Configuring role permissions+
Figure 3 Configuring role permissions
You can set action groups, assign the groups to roles, and configure the roles' permission for accessing indices and documents.
-Figure 5 Configuring action groups+
Figure 4 Configuring action groups
You can view the parameters of authentication and authorization for the current cluster. You can also run the securityadmin command to modify the configuration.
-Figure 6 Viewing cluster parameters+
Figure 5 Viewing cluster parameters
You can also clear the security cache.
-Figure 7 Clearing the security cache+
Figure 6 Clearing the security cache
Encryption
When key data is transferred between nodes or over HTTP, SSL/TLS encryption is used to ensure data security.
You can perform the preceding functions on Kibana, using .yml files (not recommended), or by calling RESTful APIs. For more information about the security mode, see Security.
@@ -74,14 +74,7 @@- - \ No newline at end of file diff --git a/docs/css/umn/css_04_0023.html b/docs/css/umn/css_04_0023.html index b3e3fc55..5ab2a785 100644 --- a/docs/css/umn/css_04_0023.html +++ b/docs/css/umn/css_04_0023.html @@ -157,7 +157,7 @@-Parent topic: Overview+Parent topic: Creating and Accessing a Clusterdiff --git a/docs/css/umn/en-us_image_0000001474246364.png b/docs/css/umn/en-us_image_0000001474246364.png new file mode 100644 index 00000000..9fb55b6d Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474246364.png differ diff --git a/docs/css/umn/en-us_image_0000001474246372.png b/docs/css/umn/en-us_image_0000001474246372.png new file mode 100644 index 00000000..9fb55b6d Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474246372.png differ diff --git a/docs/css/umn/en-us_image_0000001474246376.png b/docs/css/umn/en-us_image_0000001474246376.png new file mode 100644 index 00000000..c9a03a3c Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474246376.png differ diff --git a/docs/css/umn/en-us_image_0000001474246380.png b/docs/css/umn/en-us_image_0000001474246380.png new file mode 100644 index 00000000..f392edbf Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474246380.png differ diff --git a/docs/css/umn/en-us_image_0000001474246392.png b/docs/css/umn/en-us_image_0000001474246392.png new file mode 100644 index 00000000..56df58a5 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474246392.png differ diff --git a/docs/css/umn/en-us_image_0000001474246400.png b/docs/css/umn/en-us_image_0000001474246400.png new file mode 100644 index 00000000..91325c03 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474246400.png differ diff --git a/docs/css/umn/en-us_image_0000001474246408.png b/docs/css/umn/en-us_image_0000001474246408.png new file mode 100644 index 00000000..fb1e28ac Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474246408.png differ diff --git a/docs/css/umn/en-us_image_0000001474405816.png b/docs/css/umn/en-us_image_0000001474405816.png new file mode 100644 index 00000000..62048891 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474405816.png differ diff --git a/docs/css/umn/en-us_image_0000001474406040.png b/docs/css/umn/en-us_image_0000001474406040.png new file mode 100644 index 00000000..e96ea96f Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474406040.png differ diff --git a/docs/css/umn/en-us_image_0000001474406048.png b/docs/css/umn/en-us_image_0000001474406048.png new file mode 100644 index 00000000..32379459 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474406048.png differ diff --git a/docs/css/umn/en-us_image_0000001474406052.png b/docs/css/umn/en-us_image_0000001474406052.png new file mode 100644 index 00000000..ddc6d5e2 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474406052.png differ diff --git a/docs/css/umn/en-us_image_0000001474406056.png b/docs/css/umn/en-us_image_0000001474406056.png new file mode 100644 index 00000000..3f1a98c1 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474406056.png differ diff --git a/docs/css/umn/en-us_image_0000001474406068.png b/docs/css/umn/en-us_image_0000001474406068.png new file mode 100644 index 00000000..3e4278ae Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474406068.png differ diff --git a/docs/css/umn/en-us_image_0000001474565996.png b/docs/css/umn/en-us_image_0000001474565996.png new file mode 100644 index 00000000..56df58a5 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474565996.png differ diff --git a/docs/css/umn/en-us_image_0000001474566000.png b/docs/css/umn/en-us_image_0000001474566000.png new file mode 100644 index 00000000..1c730028 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474566000.png differ diff --git a/docs/css/umn/en-us_image_0000001474566008.png b/docs/css/umn/en-us_image_0000001474566008.png new file mode 100644 index 00000000..ba79dd4e Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474566008.png differ diff --git a/docs/css/umn/en-us_image_0000001474566012.png b/docs/css/umn/en-us_image_0000001474566012.png new file mode 100644 index 00000000..60f73cc0 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474566012.png differ diff --git a/docs/css/umn/en-us_image_0000001474566028.png b/docs/css/umn/en-us_image_0000001474566028.png new file mode 100644 index 00000000..3906e389 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474566028.png differ diff --git a/docs/css/umn/en-us_image_0000001474566044.png b/docs/css/umn/en-us_image_0000001474566044.png new file mode 100644 index 00000000..793421eb Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474566044.png differ diff --git a/docs/css/umn/en-us_image_0000001474725640.png b/docs/css/umn/en-us_image_0000001474725640.png new file mode 100644 index 00000000..e64b9c8f Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474725640.png differ diff --git a/docs/css/umn/en-us_image_0000001474725816.png b/docs/css/umn/en-us_image_0000001474725816.png new file mode 100644 index 00000000..ba02d990 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474725816.png differ diff --git a/docs/css/umn/en-us_image_0000001474725836.png b/docs/css/umn/en-us_image_0000001474725836.png new file mode 100644 index 00000000..32379459 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474725836.png differ diff --git a/docs/css/umn/en-us_image_0000001474725844.png b/docs/css/umn/en-us_image_0000001474725844.png new file mode 100644 index 00000000..e2186310 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474725844.png differ diff --git a/docs/css/umn/en-us_image_0000001474725864.png b/docs/css/umn/en-us_image_0000001474725864.png new file mode 100644 index 00000000..382bac48 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474725864.png differ diff --git a/docs/css/umn/en-us_image_0000001474725872.png b/docs/css/umn/en-us_image_0000001474725872.png new file mode 100644 index 00000000..5729b517 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001474725872.png differ diff --git a/docs/css/umn/en-us_image_0000001476610606.png b/docs/css/umn/en-us_image_0000001476610606.png new file mode 100644 index 00000000..cab91422 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001476610606.png differ diff --git a/docs/css/umn/en-us_image_0000001476741030.png b/docs/css/umn/en-us_image_0000001476741030.png new file mode 100644 index 00000000..35ad1a9e Binary files /dev/null and b/docs/css/umn/en-us_image_0000001476741030.png differ diff --git a/docs/css/umn/en-us_image_0000001476817922.png b/docs/css/umn/en-us_image_0000001476817922.png new file mode 100644 index 00000000..d217cad5 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001476817922.png differ diff --git a/docs/css/umn/en-us_image_0000001476817926.png b/docs/css/umn/en-us_image_0000001476817926.png new file mode 100644 index 00000000..684fe9b0 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001476817926.png differ diff --git a/docs/css/umn/en-us_image_0000001476977566.png b/docs/css/umn/en-us_image_0000001476977566.png new file mode 100644 index 00000000..74b7c426 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001476977566.png differ diff --git a/docs/css/umn/en-us_image_0000001476977570.png b/docs/css/umn/en-us_image_0000001476977570.png new file mode 100644 index 00000000..14936022 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001476977570.png differ diff --git a/docs/css/umn/en-us_image_0000001477137550.png b/docs/css/umn/en-us_image_0000001477137550.png new file mode 100644 index 00000000..4d8d7e20 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001477137550.png differ diff --git a/docs/css/umn/en-us_image_0000001477137554.png b/docs/css/umn/en-us_image_0000001477137554.png new file mode 100644 index 00000000..3541cdd6 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001477137554.png differ diff --git a/docs/css/umn/en-us_image_0000001477137558.png b/docs/css/umn/en-us_image_0000001477137558.png new file mode 100644 index 00000000..aa77ecc9 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001477137558.png differ diff --git a/docs/css/umn/en-us_image_0000001477297366.png b/docs/css/umn/en-us_image_0000001477297366.png new file mode 100644 index 00000000..dd7e0575 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001477297366.png differ diff --git a/docs/css/umn/en-us_image_0000001477297370.png b/docs/css/umn/en-us_image_0000001477297370.png new file mode 100644 index 00000000..350e84c7 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001477297370.png differ diff --git a/docs/css/umn/en-us_image_0000001524766089.png b/docs/css/umn/en-us_image_0000001524766089.png new file mode 100644 index 00000000..55371cd3 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524766089.png differ diff --git a/docs/css/umn/en-us_image_0000001524766093.png b/docs/css/umn/en-us_image_0000001524766093.png new file mode 100644 index 00000000..f0381f98 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524766093.png differ diff --git a/docs/css/umn/en-us_image_0000001524766097.png b/docs/css/umn/en-us_image_0000001524766097.png new file mode 100644 index 00000000..0feaa972 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524766097.png differ diff --git a/docs/css/umn/en-us_image_0000001524766265.png b/docs/css/umn/en-us_image_0000001524766265.png new file mode 100644 index 00000000..ba02d990 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524766265.png differ diff --git a/docs/css/umn/en-us_image_0000001524766273.png b/docs/css/umn/en-us_image_0000001524766273.png new file mode 100644 index 00000000..8ea4540f Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524766273.png differ diff --git a/docs/css/umn/en-us_image_0000001524766281.png b/docs/css/umn/en-us_image_0000001524766281.png new file mode 100644 index 00000000..56df58a5 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524766281.png differ diff --git a/docs/css/umn/en-us_image_0000001524766285.png b/docs/css/umn/en-us_image_0000001524766285.png new file mode 100644 index 00000000..d403ee50 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524766285.png differ diff --git a/docs/css/umn/en-us_image_0000001524766289.png b/docs/css/umn/en-us_image_0000001524766289.png new file mode 100644 index 00000000..e48d2711 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524766289.png differ diff --git a/docs/css/umn/en-us_image_0000001524766301.png b/docs/css/umn/en-us_image_0000001524766301.png new file mode 100644 index 00000000..469f8a4c Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524766301.png differ diff --git a/docs/css/umn/en-us_image_0000001524766305.png b/docs/css/umn/en-us_image_0000001524766305.png new file mode 100644 index 00000000..8e8b091f Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524766305.png differ diff --git a/docs/css/umn/en-us_image_0000001524766309.png b/docs/css/umn/en-us_image_0000001524766309.png new file mode 100644 index 00000000..f55e57b8 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524766309.png differ diff --git a/docs/css/umn/en-us_image_0000001524766313.png b/docs/css/umn/en-us_image_0000001524766313.png new file mode 100644 index 00000000..9312c0e0 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524766313.png differ diff --git a/docs/css/umn/en-us_image_0000001524766321.png b/docs/css/umn/en-us_image_0000001524766321.png new file mode 100644 index 00000000..5f4a0a7e Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524766321.png differ diff --git a/docs/css/umn/en-us_image_0000001524925937.png b/docs/css/umn/en-us_image_0000001524925937.png new file mode 100644 index 00000000..a327fdc3 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524925937.png differ diff --git a/docs/css/umn/en-us_image_0000001524925945.png b/docs/css/umn/en-us_image_0000001524925945.png new file mode 100644 index 00000000..1b27c130 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524925945.png differ diff --git a/docs/css/umn/en-us_image_0000001524925949.png b/docs/css/umn/en-us_image_0000001524925949.png new file mode 100644 index 00000000..8f892b0b Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524925949.png differ diff --git a/docs/css/umn/en-us_image_0000001524925961.png b/docs/css/umn/en-us_image_0000001524925961.png new file mode 100644 index 00000000..32379459 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524925961.png differ diff --git a/docs/css/umn/en-us_image_0000001524925965.png b/docs/css/umn/en-us_image_0000001524925965.png new file mode 100644 index 00000000..9fb55b6d Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524925965.png differ diff --git a/docs/css/umn/en-us_image_0000001524925973.png b/docs/css/umn/en-us_image_0000001524925973.png new file mode 100644 index 00000000..c9a03a3c Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524925973.png differ diff --git a/docs/css/umn/en-us_image_0000001524925993.png b/docs/css/umn/en-us_image_0000001524925993.png new file mode 100644 index 00000000..daa0df30 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524925993.png differ diff --git a/docs/css/umn/en-us_image_0000001524926001.png b/docs/css/umn/en-us_image_0000001524926001.png new file mode 100644 index 00000000..1075b5af Binary files /dev/null and b/docs/css/umn/en-us_image_0000001524926001.png differ diff --git a/docs/css/umn/en-us_image_0000001525205649.png b/docs/css/umn/en-us_image_0000001525205649.png new file mode 100644 index 00000000..79776095 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525205649.png differ diff --git a/docs/css/umn/en-us_image_0000001525205841.png b/docs/css/umn/en-us_image_0000001525205841.png new file mode 100644 index 00000000..783ba8fd Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525205841.png differ diff --git a/docs/css/umn/en-us_image_0000001525205849.png b/docs/css/umn/en-us_image_0000001525205849.png new file mode 100644 index 00000000..2ebdb21e Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525205849.png differ diff --git a/docs/css/umn/en-us_image_0000001525205857.png b/docs/css/umn/en-us_image_0000001525205857.png new file mode 100644 index 00000000..32379459 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525205857.png differ diff --git a/docs/css/umn/en-us_image_0000001525205869.png b/docs/css/umn/en-us_image_0000001525205869.png new file mode 100644 index 00000000..f78b9bf7 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525205869.png differ diff --git a/docs/css/umn/en-us_image_0000001525205897.png b/docs/css/umn/en-us_image_0000001525205897.png new file mode 100644 index 00000000..865d633a Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525205897.png differ diff --git a/docs/css/umn/en-us_image_0000001525205901.png b/docs/css/umn/en-us_image_0000001525205901.png new file mode 100644 index 00000000..9fb55b6d Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525205901.png differ diff --git a/docs/css/umn/en-us_image_0000001525365801.png b/docs/css/umn/en-us_image_0000001525365801.png new file mode 100644 index 00000000..783ba8fd Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525365801.png differ diff --git a/docs/css/umn/en-us_image_0000001525365809.png b/docs/css/umn/en-us_image_0000001525365809.png new file mode 100644 index 00000000..56df58a5 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525365809.png differ diff --git a/docs/css/umn/en-us_image_0000001525365813.png b/docs/css/umn/en-us_image_0000001525365813.png new file mode 100644 index 00000000..aa77ecc9 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525365813.png differ diff --git a/docs/css/umn/en-us_image_0000001525365829.png b/docs/css/umn/en-us_image_0000001525365829.png new file mode 100644 index 00000000..32379459 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525365829.png differ diff --git a/docs/css/umn/en-us_image_0000001525365833.png b/docs/css/umn/en-us_image_0000001525365833.png new file mode 100644 index 00000000..b700e5c2 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525365833.png differ diff --git a/docs/css/umn/en-us_image_0000001525365837.png b/docs/css/umn/en-us_image_0000001525365837.png new file mode 100644 index 00000000..30232e54 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525365837.png differ diff --git a/docs/css/umn/en-us_image_0000001525365841.png b/docs/css/umn/en-us_image_0000001525365841.png new file mode 100644 index 00000000..ad99f79d Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525365841.png differ diff --git a/docs/css/umn/en-us_image_0000001525365845.png b/docs/css/umn/en-us_image_0000001525365845.png new file mode 100644 index 00000000..bcf72f7e Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525365845.png differ diff --git a/docs/css/umn/en-us_image_0000001525365849.png b/docs/css/umn/en-us_image_0000001525365849.png new file mode 100644 index 00000000..771ac425 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525365849.png differ diff --git a/docs/css/umn/en-us_image_0000001525365861.png b/docs/css/umn/en-us_image_0000001525365861.png new file mode 100644 index 00000000..2265cd02 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001525365861.png differ diff --git a/docs/css/umn/en-us_image_0000001526969785.png b/docs/css/umn/en-us_image_0000001526969785.png new file mode 100644 index 00000000..88c59b23 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001526969785.png differ diff --git a/docs/css/umn/en-us_image_0000001527777453.png b/docs/css/umn/en-us_image_0000001527777453.png new file mode 100644 index 00000000..1af49108 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001527777453.png differ diff --git a/docs/css/umn/en-us_image_0000001527937349.png b/docs/css/umn/en-us_image_0000001527937349.png new file mode 100644 index 00000000..fd99eb96 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001527937349.png differ diff --git a/docs/css/umn/en-us_image_0000001527937353.png b/docs/css/umn/en-us_image_0000001527937353.png new file mode 100644 index 00000000..1fca0e77 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001527937353.png differ diff --git a/docs/css/umn/en-us_image_0000001528097321.png b/docs/css/umn/en-us_image_0000001528097321.png new file mode 100644 index 00000000..785de5f7 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001528097321.png differ diff --git a/docs/css/umn/en-us_image_0000001528097325.png b/docs/css/umn/en-us_image_0000001528097325.png new file mode 100644 index 00000000..63cd3c18 Binary files /dev/null and b/docs/css/umn/en-us_image_0000001528097325.png differ diff --git a/docs/css/umn/public_sys-resources/icon-arrowdn.gif b/docs/css/umn/public_sys-resources/icon-arrowdn.gif index 84eec9be..37942803 100644 Binary files a/docs/css/umn/public_sys-resources/icon-arrowdn.gif and b/docs/css/umn/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/css/umn/public_sys-resources/icon-arrowrt.gif b/docs/css/umn/public_sys-resources/icon-arrowrt.gif index 39583d16..6aaaa11c 100644 Binary files a/docs/css/umn/public_sys-resources/icon-arrowrt.gif and b/docs/css/umn/public_sys-resources/icon-arrowrt.gif differ-Parent topic: Overview+Parent topic: Creating and Accessing a Cluster
- When creating a cluster, the number of nodes that can be added varies according to the node type. For details, see Table 1.
+
- Download a certificate on the Basic Information page of the cluster.
- Run the following command to import the data collected by Logstash to the cluster:
- Download a certificate on the Basic Information page of the cluster.
- Download a certificate on the Basic Information page of the cluster.
- Set host specifications of the cluster. -
- When creating a cluster, the number of nodes that can be added varies according to the node type. For details, see Table 1.
+
