removing dis from zuul.yaml

Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Co-authored-by: lizaoxu <lizaoxu@huawei.com>
Co-committed-by: lizaoxu <lizaoxu@huawei.com>

docs/css/umn/css_01_0009.html

@@ -0,0 +1,37 @@
+<a name="css_01_0009"></a><a name="css_01_0009"></a>
+
+<h1 class="topictitle1">Managing Elasticsearch Clusters</h1>
+<div id="body1503460464688"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0415.html">Viewing Elasticsearch Cluster Information</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0417.html">Creating Users for an Elasticsearch Cluster and Granting Cluster Access</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0075.html">Setting Tags for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0080.html">Configuring Default Parameters in the .yml Configuration File of an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0058.html">Binding an Elasticsearch Cluster to an Enterprise Project</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0418.html">Changing the Node Specifications of an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0156.html">Replacing Specified Nodes for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0158.html">Changing the Security Mode of an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0201.html">Switching AZs for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0060.html">Managing Failed Tasks for Elasticsearch Clusters</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0014.html">Restarting an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0015.html">Deleting an Elasticsearch Cluster</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0207.html">Using Elasticsearch for Data Search</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0014.html

@@ -0,0 +1,80 @@
+<a name="css_01_0014"></a><a name="css_01_0014"></a>
+
+<h1 class="topictitle1">Restarting an Elasticsearch Cluster</h1>
+<div id="body1503460464688"><p id="css_01_0014__en-us_topic_0000001223594400_p16296586613">If an Elasticsearch cluster has stopped working, you can try to recover it by restarting it. Two restart options are available: quick restart and rolling restart. You are advised to perform the restart during off-peak hours.</p>
+<div class="section" id="css_01_0014__section1838035769"><h4 class="sectiontitle">Constraints</h4><ul id="css_01_0014__ul14426204917714"><li id="css_01_0014__li1842618498719">Avoid restarting a cluster during peak hours, as doing so may impact data integrity and service availability.</li><li id="css_01_0014__li343322916811">During a quick restart, the cluster is unavailable for the entire duration of the restart.</li><li id="css_01_0014__li484614381083">Rolling restart is supported only for clusters with three or more nodes, including the master node, client node, and cold data nodes. During a rolling restart, only the nodes that are being restarted are unavailable. When the cluster stores a large amount of data, the restart may take a long time.</li></ul>
+</div>
+<div class="section" id="css_01_0014__en-us_topic_0000001223594400_section5511250184611"><h4 class="sectiontitle">Prerequisites</h4><ul id="css_01_0014__en-us_topic_0000001223594400_ul1188663672716"><li id="css_01_0014__en-us_topic_0000001223594400_li158861636162718">The cluster you want to restart is not frozen and has no task in progress.</li><li id="css_01_0014__en-us_topic_0000001223594400_li19886193642716">The cluster is available and is not processing any service requests, such as importing and searching for data. Otherwise, data loss may occur during a cluster restart.</li></ul>
+</div>
+<div class="section" id="css_01_0014__en-us_topic_0000001223594400_section144817324321"><h4 class="sectiontitle">Quick Restart</h4><ol id="css_01_0014__en-us_topic_0000001223594400_ol59716110339"><li id="css_01_0014__en-us_topic_0000001223594400_li93271911152510">Log in to the <span id="css_01_0014__text831239281111613">CSS</span> management console.</li><li id="css_01_0014__li18952123014383">In the navigation pane on the left, expand <strong id="css_01_0014__b1162093215217">Clusters</strong> and select a cluster type. A cluster list is displayed.</li><li id="css_01_0014__en-us_topic_0000001223594400_li163277114258">Locate the target cluster and click <strong id="css_01_0014__b249272313226">More</strong> &gt; <strong id="css_01_0014__b17493132322217">Restart</strong> in the <strong id="css_01_0014__b17493102312219">Operation</strong> column.</li><li id="css_01_0014__en-us_topic_0000001223594400_li2820155185915">On the <strong id="css_01_0014__b123844719229">Restart Cluster</strong> page, set parameters.
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0014__table99255327161" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Configuring a quick restart</caption><thead align="left"><tr id="css_01_0014__row129252325165"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.2.4.2.2.3.1.1"><p id="css_01_0014__p18925143231613">Parameter</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.4.2.4.2.2.3.1.2"><p id="css_01_0014__p1792533216161">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="css_01_0014__row1092503218166"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.4.2.2.3.1.1 "><p id="css_01_0014__p1692513219164">Restart Mode</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.4.2.2.3.1.2 "><p id="css_01_0014__p15925132131611">Select <strong id="css_01_0014__b7505115392315">Quick Restart</strong>.</p>
+<div class="note" id="css_01_0014__note6933516161810"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_01_0014__p16933131617188">The cluster will be unavailable for the entire duration of a quick restart.</p>
+</div></div>
+</td>
+</tr>
+<tr id="css_01_0014__row2925132201619"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.4.2.2.3.1.1 "><p id="css_01_0014__p16925103216169">Operation Role</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.4.2.2.3.1.2 "><p id="css_01_0014__p3925732101619">Select <strong id="css_01_0014__b256117594492">Node type</strong> or <strong id="css_01_0014__b144373563495">Node name</strong>.</p>
+<ul id="css_01_0014__ul1129517818203"><li id="css_01_0014__li32951786203"><strong id="css_01_0014__b5449230155010">Node type</strong>: You can select multiple node types to restart them at the same time.</li><li id="css_01_0014__li1229510811209"><strong id="css_01_0014__b135142056135012">Node name</strong>: You can restart only one node at a time.</li></ul>
+</td>
+</tr>
+<tr id="css_01_0014__row15925193211620"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.4.2.2.3.1.1 "><p id="css_01_0014__p59251932191614">Operation Value</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.4.2.2.3.1.2 "><p id="css_01_0014__p392573218161">Select one or more node types or a node name, depending on the setting of <strong id="css_01_0014__b1481054155717">Operation Role</strong>.</p>
+<p id="css_01_0014__p15771142052317">Values for <strong id="css_01_0014__b723511313214">Node type</strong>:</p>
+<ul id="css_01_0014__css_01_0151_en-us_topic_0000001285669680_ul12497123683"><li id="css_01_0014__css_01_0151_en-us_topic_0000001285669680_li64981323284"><strong id="css_01_0014__b31982840711534">ess</strong>: data node</li><li id="css_01_0014__css_01_0151_en-us_topic_0000001285669680_li6498112311818"><strong id="css_01_0014__b50414626311534">ess-master</strong>: master node</li><li id="css_01_0014__css_01_0151_en-us_topic_0000001285669680_li114982231584"><strong id="css_01_0014__b95168469611534">ess-client</strong>: client node</li><li id="css_01_0014__css_01_0151_en-us_topic_0000001285669680_li64984238813"><strong id="css_01_0014__b172546262911534">ess-cold</strong>: cold data node</li></ul>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</li><li id="css_01_0014__li198531756182412">Click OK to start the restart task.<p id="css_01_0014__p6463155732410"><a name="css_01_0014__li198531756182412"></a><a name="li198531756182412"></a>Refresh the page and check the cluster status. During the restart, the cluster status is <span class="parmvalue" id="css_01_0014__parmvalue21998578011534"><b><span id="css_01_0014__text196523526011534">Processing</span></b></span>, and the task status is <span class="parmvalue" id="css_01_0014__parmvalue213227894811534"><b>Restarting</b></span>. When the cluster status changes to <strong id="css_01_0014__b1130313613316">Available</strong>, the cluster has restarted successfully.</p>
+</li></ol>
+</div>
+<div class="section" id="css_01_0014__en-us_topic_0000001223594400_section1533564513219"><h4 class="sectiontitle">Rolling Restart</h4><ol id="css_01_0014__en-us_topic_0000001223594400_ol14670132413362"><li id="css_01_0014__en-us_topic_0000001223594400_li176702024193612">Log in to the <span id="css_01_0014__text1903035677111613">CSS</span> management console.</li><li id="css_01_0014__li1551955943712">In the navigation pane on the left, expand <strong id="css_01_0014__b6754152411313">Clusters</strong> and select a cluster type. A cluster list is displayed.</li><li id="css_01_0014__en-us_topic_0000001223594400_li1067012453614">Locate the target cluster and click <strong id="css_01_0014__b1599729437">More</strong> &gt; <strong id="css_01_0014__b115997293316">Restart</strong> in the <strong id="css_01_0014__b1459962915318">Operation</strong> column.</li><li id="css_01_0014__en-us_topic_0000001223594400_li39318693">On the <strong id="css_01_0014__b9512133412315">Restart Cluster</strong> page, set parameters.
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0014__table17811171742817" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Configuring a rolling restart</caption><thead align="left"><tr id="css_01_0014__row1181131718286"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.2.4.2.2.3.1.1"><p id="css_01_0014__p1781116176289">Parameter</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.5.2.4.2.2.3.1.2"><p id="css_01_0014__p15811217152814">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="css_01_0014__row1381120174286"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.4.2.2.3.1.1 "><p id="css_01_0014__p381111179281">Restart Mode</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.4.2.2.3.1.2 "><p id="css_01_0014__p198113174287">Select <strong id="css_01_0014__b064301214416">Rolling Restart</strong>.</p>
+<div class="note" id="css_01_0014__note148111217142817"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="css_01_0014__ul119432033173118"><li id="css_01_0014__li14943143313118">Rolling restart is supported only for clusters with three or more nodes, including the master node, client node, and cold data nodes.</li><li id="css_01_0014__li199431433193112">During a rolling restart, the nodes of a cluster are restarted one at time. This may take a long time if the cluster has a large number of indexes.</li></ul>
+</div></div>
+</td>
+</tr>
+<tr id="css_01_0014__row28112017182813"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.4.2.2.3.1.1 "><p id="css_01_0014__p12812111772813">Operation Role</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.4.2.2.3.1.2 "><p id="css_01_0014__p0812017132817">Only <strong id="css_01_0014__b250952911149">Node type</strong> is supported. You can select multiple node types to restart them at the same time.</p>
+</td>
+</tr>
+<tr id="css_01_0014__row168127175289"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.4.2.2.3.1.1 "><p id="css_01_0014__p68121317102817">Operation Value</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.5.2.4.2.2.3.1.2 "><p id="css_01_0014__p19812417102814">Select node types for the restart.</p>
+<p id="css_01_0014__p20812317162816">Values for <strong id="css_01_0014__b15382123810154">Node type</strong>:</p>
+<ul id="css_01_0014__ul381271718280"><li id="css_01_0014__li0812101714287"><strong id="css_01_0014__b17820184014158">ess</strong>: data node</li><li id="css_01_0014__li1481215173282"><strong id="css_01_0014__b660944310151">ess-master</strong>: master node</li><li id="css_01_0014__li1181241711281"><strong id="css_01_0014__b78521225111534">ess-client</strong>: client node</li><li id="css_01_0014__li481220178283"><strong id="css_01_0014__b40279453911534">ess-cold</strong>: cold data node</li></ul>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</li><li id="css_01_0014__li2037573512356">Click OK to start the restart task.<p id="css_01_0014__p18375535133519"><a name="css_01_0014__li2037573512356"></a><a name="li2037573512356"></a>Refresh the page and check the cluster status. During the restart, the cluster status is <span class="parmvalue" id="css_01_0014__parmvalue38659524152"><b><span id="css_01_0014__text12864135217154">Processing</span></b></span>, and the task status is <span class="parmvalue" id="css_01_0014__parmvalue1086575218152"><b>Restarting</b></span>. When the cluster status changes to <strong id="css_01_0014__b867125631516">Available</strong>, the cluster has restarted successfully.</p>
+</li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0009.html">Managing Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0015.html

@@ -0,0 +1,15 @@
+<a name="css_01_0015"></a><a name="css_01_0015"></a>
+
+<h1 class="topictitle1">Deleting an Elasticsearch Cluster</h1>
+<div id="body1503460464688"><p id="css_01_0015__en-us_topic_0000001268594553_p1219762501">You can delete clusters that you no longer need.</p>
+<div class="section" id="css_01_0015__section6834143742917"><h4 class="sectiontitle">Constraints</h4><ul id="css_01_0015__en-us_topic_0000001268594553_ul3613184185219"><li id="css_01_0015__en-us_topic_0000001268594553_li1461319413523">Deleting a cluster will clear all its data. Exercise caution.</li><li id="css_01_0015__en-us_topic_0000001268594553_li1980118281592">A cluster that has no snapshots created for it cannot be restored once it is deleted. The snapshots of the cluster stored in OBS, if any, will not be deleted with the cluster. You can restore a deleted cluster using its snapshots stored in the OBS bucket.</li><li id="css_01_0015__li9728758142317">For a cluster for which the VPCEP service has been enabled, deleting the cluster may not delete the VPC endpoint associated with the cluster if the current account does not have the necessary VPCEP permissions. For details about the VPCEP permissions, see section "Permissions" in <em id="css_01_0015__i64101029124318">VPC Endpoint User Guide</em>.</li></ul>
+</div>
+<div class="section" id="css_01_0015__en-us_topic_0000001268594553_section175418313575"><h4 class="sectiontitle">Deleting a Cluster</h4><ol id="css_01_0015__en-us_topic_0000001268594553_ol20161122142614"><li id="css_01_0015__en-us_topic_0000001268594553_li11622242616">Log in to the <span id="css_01_0015__text68166500111614">CSS</span> management console.</li><li id="css_01_0015__en-us_topic_0000001268594553_li1180413314595">In the navigation tree on the left, select a cluster type. The cluster list page is displayed.</li><li id="css_01_0015__en-us_topic_0000001268594553_li9160224260">Locate the target cluster and click <strong id="css_01_0015__en-us_topic_0000001268594553_b3863134022819">More</strong> &gt; <strong id="css_01_0015__en-us_topic_0000001268594553_b4464114252818">Delete</strong> in the <strong id="css_01_0015__en-us_topic_0000001268594553_b1698111072819">Operation</strong> column.</li><li id="css_01_0015__en-us_topic_0000001268594553_li21622222619">In the displayed dialog box, manually type in <strong id="css_01_0015__b12173151714287">DELETE</strong>, and click <span class="uicontrol" id="css_01_0015__uicontrol3955167898125"><b>OK</b></span>.</li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0009.html">Managing Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0045.html

@@ -0,0 +1,23 @@
+<a name="css_01_0045"></a><a name="css_01_0045"></a>
+
+<h1 class="topictitle1">Importing Data to an Elasticsearch Cluster</h1>
+<div id="body1504584479327"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0394.html">Different Ways to Import Data to an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0048.html">Using In-house Built Logstash to Import Data to Elasticsearch</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0024.html">Using Open Source Elasticsearch APIs to Import Data to Elasticsearch</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0396.html">Using CDM to Import Data to Elasticsearch</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0397.html">Enhancing the Data Import Performance of Elasticsearch Clusters</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0207.html">Using Elasticsearch for Data Search</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0058.html

@@ -0,0 +1,18 @@
+<a name="css_01_0058"></a><a name="css_01_0058"></a>
+
+<h1 class="topictitle1">Binding an Elasticsearch Cluster to an Enterprise Project</h1>
+<div id="body1547448423138"><p id="css_01_0058__en-us_topic_0000001268594561_p17448200144115">You can create enterprise projects based on your organizational structure. Then you can manage resources across different regions by enterprise project, add users and user groups to enterprise projects, and grant different permissions to the users and user groups. This section describes how to bind a CSS cluster to an enterprise project and how to modify an enterprise project.</p>
+<div class="section" id="css_01_0058__en-us_topic_0000001268594561_section149801923192910"><h4 class="sectiontitle">Prerequisites</h4><p id="css_01_0058__en-us_topic_0000001268594561_p166501928172918">Before binding an enterprise project, you have created an enterprise project.</p>
+</div>
+<div class="section" id="css_01_0058__en-us_topic_0000001268594561_section57873201918"><h4 class="sectiontitle">Binding an Enterprise Project</h4><p id="css_01_0058__en-us_topic_0000001268594561_p2210251391">When creating a cluster, you can bind an existing enterprise project to the cluster, or click <strong id="css_01_0058__b359216131512">View Enterprise Project</strong> to go to the enterprise project management console and create a new project or view existing projects.</p>
+</div>
+<div class="section" id="css_01_0058__en-us_topic_0000001268594561_section2120201511011"><h4 class="sectiontitle">Modifying an Enterprise Project</h4><p id="css_01_0058__en-us_topic_0000001268594561_p7438234131011">For a cluster that has been created, you can modify its enterprise project based on the site requirements.</p>
+<ol id="css_01_0058__en-us_topic_0000001268594561_ol1947141411194"><li id="css_01_0058__en-us_topic_0000001268594561_li8101103316318">Log in to the CSS management console.</li><li id="css_01_0058__en-us_topic_0000001268594561_li6302956053">In the navigation pane on the left, select a cluster type. The cluster management page is displayed.</li><li id="css_01_0058__en-us_topic_0000001268594561_li8302155619516">In the cluster list on the displayed page, click the target cluster name to switch to the <strong id="css_01_0058__en-us_topic_0000001268594561_b655595516369">Cluster Information</strong> page.</li><li id="css_01_0058__en-us_topic_0000001268594561_li4230112181920">On the <span class="uicontrol" id="css_01_0058__en-us_topic_0000001268594561_uicontrol1144519117472"><b>Cluster Information</b></span> page, click the enterprise project name on the right of <span class="uicontrol" id="css_01_0058__en-us_topic_0000001268594561_uicontrol12693632149"><b>Enterprise Project</b></span>. The project management page is displayed.</li><li id="css_01_0058__en-us_topic_0000001268594561_li1669213196206">On the <span class="uicontrol" id="css_01_0058__en-us_topic_0000001268594561_uicontrol4510247182817"><b>Resources</b></span> tab page, select the region of the current cluster, and select <strong id="css_01_0058__b988412014713">CSS</strong> for <strong id="css_01_0058__b75453276475">Service</strong>. In this case, the corresponding CSS cluster is displayed in the resource list.</li><li id="css_01_0058__en-us_topic_0000001268594561_li78671469217">Select the cluster whose enterprise project you want to modify and click <span class="uicontrol" id="css_01_0058__en-us_topic_0000001268594561_uicontrol5366101511813"><b>Remove</b></span>.</li><li id="css_01_0058__en-us_topic_0000001268594561_li19166117162317">On the <span class="wintitle" id="css_01_0058__en-us_topic_0000001268594561_wintitle1516933271819"><b>Remove Resource</b></span> page, specify <span class="parmname" id="css_01_0058__en-us_topic_0000001268594561_parmname1674851311229"><b>Mode</b></span> and select <span class="parmname" id="css_01_0058__en-us_topic_0000001268594561_parmname1365814264018"><b>Destination Enterprise Project</b></span>, and click <span class="uicontrol" id="css_01_0058__en-us_topic_0000001268594561_uicontrol199034303020"><b>OK</b></span>.</li><li id="css_01_0058__en-us_topic_0000001268594561_li599664183618">After the resource is removed, you can view the modified enterprise project information on the <strong id="css_01_0058__en-us_topic_0000001268594561_b119217384210">Clusters</strong> page.</li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0009.html">Managing Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0060.html

@@ -0,0 +1,88 @@
+<a name="css_01_0060"></a><a name="css_01_0060"></a>
+
+<h1 class="topictitle1">Managing Failed Tasks for Elasticsearch Clusters</h1>
+<div id="body1551949933089"><p id="css_01_0060__en-us_topic_0000001268594529_p8060118">In the <strong id="css_01_0060__en-us_topic_0000001268594529_b17876132011117">Failed Tasks</strong> 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.</p>
+<div class="section" id="css_01_0060__en-us_topic_0000001268594529_section1393913131117"><h4 class="sectiontitle">Viewing Failed Tasks</h4><ol id="css_01_0060__en-us_topic_0000001268594529_ol47861611101112"><li id="css_01_0060__en-us_topic_0000001268594529_li11622242616">Log in to the <span id="css_01_0060__text219732339111612">CSS</span> management console.</li><li id="css_01_0060__en-us_topic_0000001268594529_li9160224260">Click <span class="uicontrol" id="css_01_0060__en-us_topic_0000001268594529_uicontrol181612228265"><b>Clusters</b></span> to switch to the <strong id="css_01_0060__en-us_topic_0000001268594529_b1867018334565">Clusters</strong> page. Click the digit next to <strong id="css_01_0060__en-us_topic_0000001268594529_b3305185125714">Failed Tasks</strong> to switch to the <strong id="css_01_0060__en-us_topic_0000001268594529_b143225195814">Failed Tasks</strong> dialog box.<div class="fignone" id="css_01_0060__en-us_topic_0000001268594529_fig9871436121212"><span class="figcap"><b>Figure 1 </b>Clicking the digit next to Failed Tasks</span><br><span><img id="css_01_0060__en-us_topic_0000001268594529_image273203201211" src="en-us_image_0000001938218564.png"></span></div>
+</li><li id="css_01_0060__en-us_topic_0000001268594529_li20774101315127">In the <span class="wintitle" id="css_01_0060__en-us_topic_0000001268594529_wintitle1966611331973"><b>Failed Tasks</b></span> dialog box, view all failed tasks of the current account. The following information about the failed tasks is displayed: <span class="parmname" id="css_01_0060__en-us_topic_0000001268594529_parmname731134883416"><b>Name/ID</b></span>, <span class="parmname" id="css_01_0060__en-us_topic_0000001268594529_parmname186392053143412"><b>Task Status</b></span>, and <span class="parmname" id="css_01_0060__en-us_topic_0000001268594529_parmname9729165663420"><b>Failure Time</b></span>.</li><li id="css_01_0060__en-us_topic_0000001268594529_li1372895910228">Click the question mark in the <strong id="css_01_0060__en-us_topic_0000001268594529_b09881747205910">Task Status</strong> 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 <a href="#css_01_0060__en-us_topic_0000001268594529_section155001521193312">Error Code</a>.<div class="fignone" id="css_01_0060__en-us_topic_0000001268594529_fig85418382253"><span class="figcap"><b>Figure 2 </b>Viewing the failure cause of a task</span><br><span><img id="css_01_0060__en-us_topic_0000001268594529_image1590019713599" src="en-us_image_0000001965416917.png"></span></div>
+</li></ol>
+</div>
+<div class="section" id="css_01_0060__en-us_topic_0000001268594529_section82881811133120"><h4 class="sectiontitle">Deleting a Failed Task</h4><p id="css_01_0060__en-us_topic_0000001268594529_p28053248314">You can delete one or all failed tasks at a time.</p>
+<ul id="css_01_0060__en-us_topic_0000001268594529_ul432662312313"><li id="css_01_0060__en-us_topic_0000001268594529_li15326723173111">To delete a failed task, perform the following operations: Locate the row that contains the target task and click <span class="uicontrol" id="css_01_0060__en-us_topic_0000001268594529_uicontrol148121620193317"><b>Delete</b></span> in the <strong id="css_01_0060__en-us_topic_0000001268594529_b191281311428">Operation</strong> column. In the displayed dialog box, confirm the task you want to delete and click <span class="uicontrol" id="css_01_0060__en-us_topic_0000001268594529_uicontrol1933113257334"><b>Yes</b></span>.</li><li id="css_01_0060__en-us_topic_0000001268594529_li33151127173319">To delete all failed tasks, perform the following operations: In the <span class="wintitle" id="css_01_0060__en-us_topic_0000001268594529_wintitle4538332105018"><b>Failed Tasks</b></span> dialog box, click <span class="uicontrol" id="css_01_0060__en-us_topic_0000001268594529_uicontrol323703312351"><b>Delete All</b></span>. In the displayed dialog box, confirm the information about all failed tasks and click <span class="uicontrol" id="css_01_0060__en-us_topic_0000001268594529_uicontrol18326203013516"><b>Yes</b></span>.</li></ul>
+<div class="fignone" id="css_01_0060__en-us_topic_0000001268594529_fig1419120710386"><span class="figcap"><b>Figure 3 </b>Deleting a failed task</span><br><span><img id="css_01_0060__en-us_topic_0000001268594529_image549413524592" src="en-us_image_0000001938377924.png"></span></div>
+</div>
+<div class="section" id="css_01_0060__en-us_topic_0000001268594529_section155001521193312"><a name="css_01_0060__en-us_topic_0000001268594529_section155001521193312"></a><a name="en-us_topic_0000001268594529_section155001521193312"></a><h4 class="sectiontitle">Error Code</h4>
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0060__en-us_topic_0000001268594529_table16751996354" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Failure causes</caption><thead align="left"><tr id="css_01_0060__en-us_topic_0000001268594529_row376129113519"><th align="left" class="cellrowborder" valign="top" width="14.111411141114111%" id="mcps1.3.4.2.2.4.1.1"><p id="css_01_0060__en-us_topic_0000001268594529_p19760913357">Error Code</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="55.23552355235524%" id="mcps1.3.4.2.2.4.1.2"><p id="css_01_0060__en-us_topic_0000001268594529_p147612903518">Failure Cause</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="30.653065306530653%" id="mcps1.3.4.2.2.4.1.3"><p id="css_01_0060__en-us_topic_0000001268594529_p14768953516">Solution</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="css_01_0060__en-us_topic_0000001268594529_row6761895353"><td class="cellrowborder" valign="top" width="14.111411141114111%" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p776189183515">CSS.6000</p>
+</td>
+<td class="cellrowborder" valign="top" width="55.23552355235524%" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p187669193511">Failed to create the cluster because of an internal error. Please try again later. If the problem persists, contact customer service.</p>
+</td>
+<td class="cellrowborder" rowspan="7" valign="top" width="30.653065306530653%" headers="mcps1.3.4.2.2.4.1.3 "><p id="css_01_0060__en-us_topic_0000001268594529_p1637191311276">Please try again later or contact customer service.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row47649143514"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p1576697352">CSS.6001</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p77659123520">Failed to scale out the cluster because of an internal error. Please try again later. If the problem persists, contact customer service.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row187619910350"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p16765915350">CSS.6002</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p187619903516">Failed to restart the cluster because of an internal error. Please try again later. If the problem persists, contact customer service.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row14425154151017"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p242564121017">CSS.6003</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p7426104201017">Failed to restore the cluster because of an internal error. Please try again later. If the problem persists, contact customer service.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row24264471015"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p194264418104">CSS.6004</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p242694121018">Failed to create the node because of ECS exceptions (<em id="css_01_0060__en-us_topic_0000001268594529_i62088384145">&lt;ECS error code&gt;</em>). Please try again later. If the problem persists, contact customer service.</p>
+<div class="note" id="css_01_0060__en-us_topic_0000001268594529_note07226420147"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_01_0060__en-us_topic_0000001268594529_p1072324216145"><em id="css_01_0060__en-us_topic_0000001268594529_i1543285813142">&lt;ECS error code&gt;</em> indicates the error information reported by ECS. For details about the cause and solution, see <a href="https://docs.otc.t-systems.com/en-us/api/ecs/en-us_topic_0022067717.html" target="_blank" rel="noopener noreferrer">ECS Error Code Description</a>.</p>
+</div></div>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row144265410104"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p1942618413108">CSS.6005</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p154263461017">Failed to initialize the service because of an internal error. Please try again later. If the problem persists, contact customer service.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row10480192161116"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p12480202121111">CSS.6007</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p4480102191117">Failed to create the snapshot because of an internal error. Please try again later. If the problem persists, contact customer service.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row1448012191118"><td class="cellrowborder" valign="top" width="14.111411141114111%" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p124817211119">CSS.6008</p>
+</td>
+<td class="cellrowborder" valign="top" width="55.23552355235524%" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p8481421171113">Failed to create the snapshot because the OBS bucket you select does not exist or has been deleted.</p>
+</td>
+<td class="cellrowborder" rowspan="3" valign="top" width="30.653065306530653%" headers="mcps1.3.4.2.2.4.1.3 "><p id="css_01_0060__en-us_topic_0000001268594529_p2075718196277">Modify the OBS bucket.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row7481721141112"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p134819217111">CSS.6009</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p1148192161110">Failed to restore the snapshot because the OBS bucket you select does not exist or has been deleted.</p>
+</td>
+</tr>
+<tr id="css_01_0060__en-us_topic_0000001268594529_row1770913013172"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.1 "><p id="css_01_0060__en-us_topic_0000001268594529_p16709501175">CSS.6010</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.4.1.2 "><p id="css_01_0060__en-us_topic_0000001268594529_p87094071710">Failed to restore the snapshot because the OBS object does not exist or has been deleted.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0009.html">Managing Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0070.html

@@ -0,0 +1,11 @@
+<a name="css_01_0070"></a><a name="css_01_0070"></a>
+
+<h1 class="topictitle1">CSS Service Permission Management</h1>
+<div id="body1558407759825"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0072.html">Creating IAM Users and Granting Them Permissions to Use CSS</a></strong><br>
+</li>
+</ul>
+</div>
+

docs/css/umn/css_01_0072.html

@@ -0,0 +1,94 @@
+<a name="css_01_0072"></a><a name="css_01_0072"></a>
+
+<h1 class="topictitle1">Creating IAM Users and Granting Them Permissions to Use CSS</h1>
+<div id="body1558407759825"><p id="css_01_0072__p198079372297">You can use <a href="https://docs.otc.t-systems.com/usermanual/iam/iam_01_0026.html" target="_blank" rel="noopener noreferrer">Identity and Access Management (IAM)</a> for fine-grained permissions control for CSS. With IAM, you can:</p>
+<ul id="css_01_0072__ul1848820457453"><li id="css_01_0072__li348974516454">Create IAM users for employees based on your enterprise's organizational structure. Each IAM user has their own identity credentials for accessing CSS resources.</li><li id="css_01_0072__li11681126173515">Grant users only the permissions required to perform a given task based on their job responsibilities.</li><li id="css_01_0072__li12185165313915">Entrust an account or a cloud service to perform efficient O&amp;M on your CSS resources.</li></ul>
+<p id="css_01_0072__p14662743155318">If your account does not require individual IAM users, you may skip this section.</p>
+<p id="css_01_0072__p158501603165">This section describes the procedure for granting permissions.</p>
+<div class="section" id="css_01_0072__en-us_topic_0000001223594424_section17110143884619"><h4 class="sectiontitle">Prerequisites</h4><p id="css_01_0072__en-us_topic_0000001223594424_p148607912478">You know what permissions to assign to which users. CSS supports administrator permissions and read-only permissions. For details, see Permissions Management.</p>
+</div>
+<div class="section" id="css_01_0072__en-us_topic_0000001223594424_section85262192392"><h4 class="sectiontitle">Process Flow</h4><div class="fignone" id="css_01_0072__en-us_topic_0000001223594424_fig342064620244"><span class="figcap"><b>Figure 1 </b>Process of granting CSS permissions</span><br><span><img id="css_01_0072__en-us_topic_0000001223594424_image237123492418" src="en-us_image_0000001938218776.png"></span></div>
+<ol id="css_01_0072__ol20958137181713"><li id="css_01_0072__li109582711173"><a name="css_01_0072__li109582711173"></a><a name="li109582711173"></a><a href="https://docs.otc.t-systems.com/usermanual/iam/iam_01_0030.html" target="_blank" rel="noopener noreferrer">Create a user group and assign permissions</a>.<p id="css_01_0072__en-us_topic_0000001223594424_p10577919163914">Create a user group on the IAM console, and assign the <strong id="css_01_0072__b1383745710419">CSS ReadOnlyAccess</strong> permission to the group.</p>
+</li><li id="css_01_0072__li29581574177"><a href="https://docs.otc.t-systems.com/usermanual/iam/iam_01_0031.html" target="_blank" rel="noopener noreferrer">Create an IAM user and add it to a user group</a>.<p id="css_01_0072__en-us_topic_0000001223594424_p357781916392">Create a user on the IAM console and add it to the user group created in <a href="#css_01_0072__li109582711173">1</a>.</p>
+<p id="css_01_0072__p16681531173416">By adding a user to a user group, you assign all the permissions that this user group has to that user. All users in a group have the same permissions.</p>
+</li><li id="css_01_0072__li695812781716"><a href="https://docs.otc.t-systems.com/usermanual/iam/iam_01_0032.html" target="_blank" rel="noopener noreferrer">Log in</a> and verify permissions.<p id="css_01_0072__en-us_topic_0000001223594424_p20577191943913">Log in to the console as the created user, switch to the authorized region, and verify the permissions.</p>
+<ul id="css_01_0072__en-us_topic_0000001489537442_ul1692751312242"><li id="css_01_0072__en-us_topic_0000001489537442_li205729227246">Choose <strong id="css_01_0072__b387918591516">Service List</strong> &gt; <strong id="css_01_0072__b68791551513">Cloud Search Service</strong>. Then click <strong id="css_01_0072__b1687914511151">Create Cluster</strong> on the CSS console. If the cluster cannot be purchased (assuming that the current permissions include only <strong id="css_01_0072__b98791558151">CSS ReadOnlyAccess</strong>), the <strong id="css_01_0072__b10879185131517">CSS ReadOnlyAccess</strong> policy has already taken effect.</li><li id="css_01_0072__en-us_topic_0000001489537442_li1857212212418">Choose any other service from <strong id="css_01_0072__b1943182197">Service List</strong>. (Assume that the current policy contains only <strong id="css_01_0072__b159443212920">CSS ReadOnlyAccess</strong>.) If a message appears indicating insufficient permissions to access the service, the <strong id="css_01_0072__b6944162995">CSS ReadOnlyAccess</strong> policy has already taken effect.</li></ul>
+</li></ol>
+</div>
+<div class="section" id="css_01_0072__section841205645419"><h4 class="sectiontitle">Examples of CSS Custom Policies</h4><p id="css_01_0072__en-us_topic_0000001223754348_p8060118">Custom policies can be created to supplement the system-defined policies of CSS. For the actions supported for custom policies, see section "Permissions Policies and Supported Actions" in the <em id="css_01_0072__i19933111411336">Cloud Search Service API Reference</em>.</p>
+<p id="css_01_0072__en-us_topic_0000001223754348_p18119246101411">You can create custom policies in either of the following ways:</p>
+<ul id="css_01_0072__en-us_topic_0000001223754348_ul611914619143"><li id="css_01_0072__en-us_topic_0000001223754348_li51194467143">Visual editor: Select cloud services, actions, resources, and request conditions. This does not require knowledge of policy syntax.</li><li id="css_01_0072__en-us_topic_0000001223754348_li1012004631418">JSON: Create a JSON policy or edit an existing one.</li></ul>
+<p id="css_01_0072__en-us_topic_0000001223754348_p1761612181719">For details about how to create custom policies, see <a href="https://docs.otc.t-systems.com/identity-access-management/umn/user_guide/permissions/creating_a_custom_policy.html" target="_blank" rel="noopener noreferrer">Creating a Custom Policy</a>. The following provides examples of custom CSS policies.</p>
+<div class="note" id="css_01_0072__en-us_topic_0000001223754348_note185014141059"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="css_01_0072__en-us_topic_0000001223754348_p05121415516">the IAM permissions and data plane cluster permissions of CSS are managed separately. To enhance data-plane security, you need to use the security mode.</p>
+<p id="css_01_0072__en-us_topic_0000001223754348_p1133419718221">To let an IAM user access an OBS bucket, you need to grant the <strong id="css_01_0072__b529410230351">GetBucketStoragePolicy</strong>, <strong id="css_01_0072__b18294142343518">GetBucketLocation</strong>, <strong id="css_01_0072__b72941723123510">ListBucket</strong>, and <strong id="css_01_0072__b129542303514">ListAllMyBuckets</strong> permissions to the user.</p>
+</div></div>
+<ul id="css_01_0072__ul441171719011"><li id="css_01_0072__li10411017405">Example 1: Allowing users to create CSS clusters<pre class="screen" id="css_01_0072__en-us_topic_0000001223754348_screen152401381336">{
+    "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"
+        }
+    ]
+}</pre>
+</li><li id="css_01_0072__li1565118196013">Example 2: Denying cluster deletion<p id="css_01_0072__en-us_topic_0000001223754348_p330217517918"><a name="css_01_0072__li1565118196013"></a><a name="li1565118196013"></a>A policy with only <strong id="css_01_0072__b126831140653219">Deny</strong> permissions must be used in conjunction with other policies for it to take effect. If the permissions assigned to a user contain both <strong id="css_01_0072__b60815964053219">Allow</strong> and <strong id="css_01_0072__b60718635253219">Deny</strong>, the <strong id="css_01_0072__b198200705253219">Deny</strong> permissions take precedence over the <strong id="css_01_0072__b133336928253219">Allow</strong> permissions.</p>
+<p id="css_01_0072__en-us_topic_0000001223754348_p153024511596">The following method can be used if you need to assign permissions of the <strong id="css_01_0072__b247647353219">CSS Admin</strong> 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:</p>
+<pre class="screen" id="css_01_0072__en-us_topic_0000001223754348_screen16334701457">{ 
+      "Version": "1.1", 
+      "Statement": [ 
+            { 
+    "Effect": "Deny", 
+                  "Action": [ 
+                        "css:cluster:delete"
+                  ] 
+            } 
+      ] 
+}</pre>
+</li><li id="css_01_0072__li15457145317114">Example 3: Defining permissions for multiple services in a policy<p id="css_01_0072__p64652053519"><a name="css_01_0072__li15457145317114"></a><a name="li15457145317114"></a>A custom policy can contain the actions of multiple services that are of the global or project-level type. Example of a policy containing multiple actions:</p>
+<pre class="screen" id="css_01_0072__screen846510539118">{
+    "Version": "1.1",
+    "Statement": [
+        {
+            "Action": [
+                "ecs:cloudServers:resize",
+                "ecs:cloudServers:delete",
+                "ecs:cloudServers:delete",
+                "css:cluster:restart",
+                "css:*:get*",
+                "css:*:list*"
+            ],
+            "Effect": "Allow"
+        }
+    ]
+}</pre>
+</li></ul>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0070.html">CSS Service Permission Management</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0075.html

@@ -0,0 +1,27 @@
+<a name="css_01_0075"></a><a name="css_01_0075"></a>
+
+<h1 class="topictitle1">Setting Tags for an Elasticsearch Cluster</h1>
+<div id="body1567234141579"><p id="css_01_0075__en-us_topic_0000001223914384_p14723132511302">Tags are cluster identifiers. Adding tags to clusters can help you identify and manage your cluster resources.</p>
+<p id="css_01_0075__en-us_topic_0000001223914384_p1572313257306">You can add tags to a cluster when creating the cluster or add them on the details page of the created cluster.</p>
+<div class="section" id="css_01_0075__section269604132115"><h4 class="sectiontitle">Constraints</h4><p id="css_01_0075__p164761938589">You can create a maximum of 20 tags for a CSS cluster.</p>
+</div>
+<div class="section" id="css_01_0075__en-us_topic_0000001223914384_section13713355214"><h4 class="sectiontitle">Managing Tags</h4><p id="css_01_0075__p061991095910">In CSS, you can add, delete, modify, and query cluster tags.</p>
+<ol id="css_01_0075__en-us_topic_0000001223914384_ol7898184161913"><li id="css_01_0075__en-us_topic_0000001223914384_li1898640199">Log in to the <span id="css_01_0075__text44437119011166">CSS</span> management console.</li><li id="css_01_0075__en-us_topic_0000001223914384_li41893017190">On the <strong id="css_01_0075__en-us_topic_0000001223914384_b842352706161126">Clusters</strong> page, click the name of a cluster for which you want to manage tags.<p id="css_01_0075__en-us_topic_0000001223914384_p1585919328472">The <strong id="css_01_0075__en-us_topic_0000001223914384_b690453641219">Basic Information</strong> page is displayed.</p>
+</li><li id="css_01_0075__en-us_topic_0000001223914384_li162741326144816">In the navigation pane on the left, choose the <strong id="css_01_0075__en-us_topic_0000001223914384_b15461977273">Tags</strong> tab. You can add, modify, or delete tags.<ul id="css_01_0075__en-us_topic_0000001223914384_ul11171525155511"><li id="css_01_0075__en-us_topic_0000001223914384_li61610259555">View<p id="css_01_0075__en-us_topic_0000001223914384_p3163256557"><a name="css_01_0075__en-us_topic_0000001223914384_li61610259555"></a><a name="en-us_topic_0000001223914384_li61610259555"></a>On the <strong id="css_01_0075__en-us_topic_0000001223914384_b842352706161835">Tags</strong> page, you can view details about tags of the cluster, including the number of tags and the key and value of each tag.</p>
+</li><li id="css_01_0075__en-us_topic_0000001223914384_li1016182514559">Add<p id="css_01_0075__en-us_topic_0000001223914384_p1416152519553"><a name="css_01_0075__en-us_topic_0000001223914384_li1016182514559"></a><a name="en-us_topic_0000001223914384_li1016182514559"></a>Click <strong id="css_01_0075__b1327217298172">Edit Tag</strong> in the upper left corner. In the displayed dialog box, click <strong id="css_01_0075__b166325345172">Add Tag</strong>, enter the tag key and value, and click <strong id="css_01_0075__b7588210191715">OK</strong>.</p>
+</li><li id="css_01_0075__en-us_topic_0000001223914384_li31672515510">Modify<p id="css_01_0075__en-us_topic_0000001223914384_p1116725125510"><a name="css_01_0075__en-us_topic_0000001223914384_li31672515510"></a><a name="en-us_topic_0000001223914384_li31672515510"></a>Click <strong id="css_01_0075__b14951740191713">Edit Tag</strong> in the upper left corner. In the displayed dialog box, modify the key and value of a tag, and click <strong id="css_01_0075__b1951194041713">OK</strong>.</p>
+</li><li id="css_01_0075__en-us_topic_0000001223914384_li17166257551">Delete<p id="css_01_0075__en-us_topic_0000001223914384_p101610256555"><a name="css_01_0075__en-us_topic_0000001223914384_li17166257551"></a><a name="en-us_topic_0000001223914384_li17166257551"></a>Click <strong id="css_01_0075__b649117161817">Edit Tag</strong> in the upper left corner. In the displayed dialog box, click <strong id="css_01_0075__b1355615380183">Delete</strong> in the row that contains a tag, and click <strong id="css_01_0075__b44961781812">OK</strong>.</p>
+</li></ul>
+</li></ol>
+</div>
+<div class="section" id="css_01_0075__en-us_topic_0000001223914384_section9523193414234"><h4 class="sectiontitle">Searching for Clusters by Tag</h4><ol id="css_01_0075__en-us_topic_0000001223914384_ol580535210235"><li id="css_01_0075__en-us_topic_0000001223914384_li208055521238">Log in to the <span id="css_01_0075__text152243906711166">CSS</span> management console.</li><li id="css_01_0075__en-us_topic_0000001223914384_li5704921102415">On the <strong id="css_01_0075__b1610465375317">Clusters</strong> page, click the search box above the cluster list and select tag keys and values to search for clusters.<p id="css_01_0075__en-us_topic_0000001223914384_p13576585515">You can select a tag key or tag value from their drop-down lists. The system returns a list of clusters that exactly match the tag key or tag value. If you enter multiple tags, the cluster that meets requirements of all the tags will be filtered.</p>
+<p id="css_01_0075__en-us_topic_0000001223914384_p19175450115918">You can add a maximum of 10 tags at one time.</p>
+</li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0009.html">Managing Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0076.html

@@ -0,0 +1,58 @@
+<a name="css_01_0076"></a><a name="css_01_0076"></a>
+
+<h1 class="topictitle1">Configuring Public Network Access for an Elasticsearch Cluster</h1>
+<div id="body1568692028995"><p id="css_01_0076__p12915914145514">Public network access is supported only when <strong id="css_01_0076__b1588043919442">Security Mode</strong> and <strong id="css_01_0076__b1588003910445">HTTPS Access</strong> are enabled for a cluster. When <strong id="css_01_0076__b45047151456">Public IP Address</strong> is enabled, a public IP address is automatically assigned, which will enable access to the security cluster from the public network. Additionally, you can configure access control from the public network by IP addresses or IP address ranges.</p>
+<p id="css_01_0076__en-us_topic_0000001223434404_p8060118">To enable public network access for Elasticsearch or OpenSearch clusters, a shared load balancer is typically used for load balancing. If your workloads require quicker access, you are advised to use a dedicated load balancer to connect to your clusters. For details about its configuration, see <a href="css_01_0413.html">Configuring a Dedicated Load Balancer for an Elasticsearch Cluster</a>.</p>
+<div class="section" id="css_01_0076__section0594164011518"><h4 class="sectiontitle">Constraints</h4><ul id="css_01_0076__ul16345551125110"><li id="css_01_0076__li2034510517515">Enabling public network access for a CSS cluster may incur some fees, as it will need to use EIP and bandwidth resources.</li><li id="css_01_0076__li11702172312528">The security mode can be enabled only for Elasticsearch 6.5.4 clusters or later and OpenSearch clusters.</li><li id="css_01_0076__li11530152413476">Public network access and the VPC Endpoint service share a load balancer. If you configure a whitelist for public network access, and because this whitelist is deployed to the shared load balancer, it will control not only access from the public network, but also access using private IP addresses through VPCEP. In this case, you need to add IP address <strong id="css_01_0076__b2474121113146">198.19.128.0/17</strong> to the public network access whitelist to allow traffic through VPCEP.</li></ul>
+</div>
+<div class="section" id="css_01_0076__en-us_topic_0000001223434408_section1638913302523"><h4 class="sectiontitle">Configuring Public Network Access</h4><ol id="css_01_0076__en-us_topic_0000001223434408_ol1346120407506"><li id="css_01_0076__en-us_topic_0000001223434408_li154611240175011">Log in to the <span id="css_01_0076__text21595321510">CSS</span> management console.</li><li id="css_01_0076__en-us_topic_0000001223434408_li10902641195015">On the <strong id="css_01_0076__b2267115594811">Create Cluster</strong> page, enable <strong id="css_01_0076__b18111194135518">Security Mode</strong>. Set the administrator password and enable HTTPS access.</li><li id="css_01_0076__en-us_topic_0000001223434408_li0180112411579">Select <strong id="css_01_0076__b52176551438">Automatically assign</strong> for <strong id="css_01_0076__b3673111514416">Public IP Address</strong> and set related parameters.
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0076__en-us_topic_0000001223434408_table138801874019" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Public network access parameters</caption><thead align="left"><tr id="css_01_0076__en-us_topic_0000001223434408_row1888010718010"><th align="left" class="cellrowborder" valign="top" width="23.830000000000002%" id="mcps1.3.4.2.3.3.2.3.1.1"><p id="css_01_0076__en-us_topic_0000001223434408_p28805717017">Parameter</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="76.17%" id="mcps1.3.4.2.3.3.2.3.1.2"><p id="css_01_0076__en-us_topic_0000001223434408_p78801371205">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="css_01_0076__en-us_topic_0000001223434408_row17880271203"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.4.2.3.3.2.3.1.1 "><p id="css_01_0076__en-us_topic_0000001223434408_p38801710019">Bandwidth</p>
+</td>
+<td class="cellrowborder" valign="top" width="76.17%" headers="mcps1.3.4.2.3.3.2.3.1.2 "><p id="css_01_0076__en-us_topic_0000001223434408_p98801171002">Bandwidth for accessing Kibana with the public IP address</p>
+</td>
+</tr>
+<tr id="css_01_0076__en-us_topic_0000001223434408_row18880197202"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.4.2.3.3.2.3.1.1 "><p id="css_01_0076__en-us_topic_0000001223434408_p108801179017">Access Control</p>
+</td>
+<td class="cellrowborder" valign="top" width="76.17%" headers="mcps1.3.4.2.3.3.2.3.1.2 "><p id="css_01_0076__en-us_topic_0000001223434408_p168801175012">If you disable this function, all IP addresses can access the cluster through the public IP address. If you enable access control, only IP addresses in the whitelist can access the cluster through the public IP address.</p>
+</td>
+</tr>
+<tr id="css_01_0076__en-us_topic_0000001223434408_row2088013718014"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.4.2.3.3.2.3.1.1 "><p id="css_01_0076__en-us_topic_0000001223434408_p20880127602">Whitelist</p>
+</td>
+<td class="cellrowborder" valign="top" width="76.17%" headers="mcps1.3.4.2.3.3.2.3.1.2 "><p id="css_01_0076__en-us_topic_0000001223434408_p9880275012">IP address or IP address range allowed to access a cluster. Use commas (,) to separate multiple addresses. This parameter can be configured only when <strong id="css_01_0076__b36731595374">Access Control</strong> is enabled.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</li></ol>
+</div>
+<div class="section" id="css_01_0076__en-us_topic_0000001223434408_section18851031541"><h4 class="sectiontitle">Configuring Public Network Access for an Existing Cluster</h4><p id="css_01_0076__en-us_topic_0000001223434408_p2871748088">You can configure, modify, view the public network access of, or disassociate the public IP address from a cluster.</p>
+<ol id="css_01_0076__en-us_topic_0000001223434408_ol179019266146"><li id="css_01_0076__en-us_topic_0000001223434408_li7625635121410">Log in to the <span id="css_01_0076__text186221420182">CSS</span> management console.</li><li id="css_01_0076__en-us_topic_0000001223434408_li106254357143">On the <span class="wintitle" id="css_01_0076__wintitle803835227104550"><b>Clusters</b></span> page, click the name of the target cluster. On the <strong id="css_01_0076__b472203816382">Basic Information</strong> page that is displayed, manage the public network access configurations.<ul id="css_01_0076__en-us_topic_0000001223434408_ul2615124316115"><li id="css_01_0076__en-us_topic_0000001223434408_li86151943141116">Configuring public network access<p id="css_01_0076__en-us_topic_0000001223434408_p16141643121114"><a name="css_01_0076__en-us_topic_0000001223434408_li86151943141116"></a><a name="en-us_topic_0000001223434408_li86151943141116"></a>If you enabled HTTPS but did not configure the public network access during security cluster creation, you can configure it on the <strong id="css_01_0076__b1992163710402">Basic Information</strong> page after configuring the cluster.</p>
+<p id="css_01_0076__en-us_topic_0000001223434408_p10615104331113">Click <strong id="css_01_0076__b10111186185514">Associate</strong> next to <strong id="css_01_0076__b46841030115517">Public IP Address</strong>, set the access bandwidth, and click <strong id="css_01_0076__b5241046185514">OK</strong>.</p>
+<p id="css_01_0076__en-us_topic_0000001223434408_p2615144321117">If the association fails, wait for a few minutes and try again.</p>
+</li><li id="css_01_0076__en-us_topic_0000001223434408_li196151143111114">Modifying public network access<p id="css_01_0076__en-us_topic_0000001223434408_p17615154381118"><a name="css_01_0076__en-us_topic_0000001223434408_li196151143111114"></a><a name="en-us_topic_0000001223434408_li196151143111114"></a>For a cluster for which you have configured public network access, you can click <strong id="css_01_0076__b07989296279">Edit</strong> next to <strong id="css_01_0076__b132681411315">Bandwidth</strong> to modify the bandwidth, or you can click <strong id="css_01_0076__b6143152183112">Set</strong> next to <strong id="css_01_0076__b269183912312">Access Control</strong> to set the access control function and the whitelist for access.</p>
+</li><li id="css_01_0076__en-us_topic_0000001223434408_li1361516431116">Checking public network access settings<p id="css_01_0076__en-us_topic_0000001223434408_p3615184381118"><a name="css_01_0076__en-us_topic_0000001223434408_li1361516431116"></a><a name="en-us_topic_0000001223434408_li1361516431116"></a>On the <strong id="css_01_0076__b1771565534414">Basic Information</strong> page, you can see the public IP address associated with the current cluster.</p>
+</li><li id="css_01_0076__en-us_topic_0000001223434408_li106151143201118">Disassociating a public IP address from a cluster<p id="css_01_0076__en-us_topic_0000001223434408_p146155436110"><a name="css_01_0076__en-us_topic_0000001223434408_li106151143201118"></a><a name="en-us_topic_0000001223434408_li106151143201118"></a>To disassociate a public IP address, click <strong id="css_01_0076__b615153014719">Disassociate</strong> next to <strong id="css_01_0076__b189482040154714">Public IP Address</strong>.</p>
+<div class="note" id="css_01_0076__note2033753713445"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="css_01_0076__p4337153794412">After the public IP address is disassociated, the cluster can no longer be accessed through this IP address. If you disable public network access for a cluster and then re-enable it, the public IP address for accessing the cluster may change. Exercise caution.</p>
+</div></div>
+</li></ul>
+</li></ol>
+</div>
+<div class="section" id="css_01_0076__en-us_topic_0000001223434408_section2022235142517"><h4 class="sectiontitle">Accessing a Cluster Through the Public IP Address</h4><p id="css_01_0076__en-us_topic_0000001223434408_p5950195234910">After configuring the public IP address, you can use it to access the cluster.</p>
+<div class="p" id="css_01_0076__en-us_topic_0000001223434408_p1243345415167">For example, if the public IP address is <span class="parmname" id="css_01_0076__en-us_topic_0000001223434408_parmname15981543155911"><b>10.62.179.32</b></span> and the port number is <span class="parmname" id="css_01_0076__en-us_topic_0000001223434408_parmname189821543115912"><b>9200</b></span>, run the following cURL command to view indexes in the cluster.<pre class="screen" id="css_01_0076__en-us_topic_0000001223434408_screen85820524178">curl -u username:password -k 'https://10.62.179.32:9200/_cat/indices'</pre>
+</div>
+<p id="css_01_0076__p7424193312575">where, <strong id="css_01_0076__b223485632013">username</strong> and <strong id="css_01_0076__b916781213">password</strong> indicate the username and password of the HTTPS-enabled security-mode cluster.</p>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0411.html">Configuring Networking for an Elasticsearch Cluster</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0079.html

@@ -0,0 +1,61 @@
+<a name="css_01_0079"></a><a name="css_01_0079"></a>
+
+<h1 class="topictitle1">Switching Between Hot and Cold Storage for an Elasticsearch Cluster</h1>
+<div id="body1571802008014"><p id="css_01_0079__p14682101612475">In an Elasticsearch cluster that has cold data nodes, index data can switch between cold and hot storage. This helps optimize storage costs and improve query performance.</p>
+<p id="css_01_0079__p194428135409">Hot/cold storage switchover is about allocating data to different types of data nodes in terms of their performance and costs based on how frequent data is expected to be accessed. Hot data nodes store real-time data that is frequently updated and queried. Typically, they use high-performance hardware (such as SSDs) to ensure fast read/write and retrieval. Cold data nodes store historical data that is seldom accessed. Typically, cold data nodes use lower-cost hardware to store data.</p>
+<div class="section" id="css_01_0079__section3941175283710"><h4 class="sectiontitle">How It Works</h4><div class="fignone" id="css_01_0079__fig9508151610273"><span class="figcap"><b>Figure 1 </b>How cold/hot storage switchover works</span><br><span><img id="css_01_0079__image1550941602716" src="en-us_image_0000001950125554.png"></span></div>
+<p id="css_01_0079__p14807112010193">When a cluster is created, cold data nodes are tagged <strong id="css_01_0079__b40095380735210">cold</strong> for cold storage, whereas regular data nodes are tagged <strong id="css_01_0079__b48580247635210">hot</strong> for hot storage. Within a cluster, you can configure to have the less frequently accessed data of specified indexes stored on cold data nodes. Compared with regular data nodes, cold data nodes offer lower query performance, but also lower storage costs. Regular data nodes will be tagged <strong id="css_01_0079__b198480916635246">hot</strong> only when there are cold data nodes.</p>
+<p id="css_01_0079__p871982116300">You can scale cold data nodes by adding or reducing nodes or their storage capacity. For details, see <a href="css_01_0414.html">Scaling an Elasticsearch Cluster</a>.</p>
+</div>
+<div class="section" id="css_01_0079__section128711933171818"><h4 class="sectiontitle">Constraints</h4><p id="css_01_0079__p1315063920182">Only clusters that have cold data nodes support switchover between cold and hot data storage. Cold data nodes can be enabled only when a cluster is created. You cannot enable cold data nodes for an existing cluster. If your cluster does not have cold data nodes but you want to cut storage costs, you can try using storage-compute decoupling. For details, see <a href="css_01_0405.html">Configuring Storage-Compute Decoupling for an Elasticsearch Cluster</a>.</p>
+</div>
+<div class="section" id="css_01_0079__en-us_topic_0000001223754344_section298814466206"><h4 class="sectiontitle">Switching Over Between Hot and Cold Storage</h4><ol id="css_01_0079__ol0195634910"><li id="css_01_0079__li15432465615">Log in to the CSS management console.</li><li id="css_01_0079__li23815221002">Check whether cold data nodes are enabled in a cluster.<div class="p" id="css_01_0079__p115342319010"><a name="css_01_0079__li23815221002"></a><a name="li23815221002"></a>On the <strong id="css_01_0079__b157638558016">Clusters</strong> page, select the cluster that you want to enable storage-compute decoupling, click the cluster name to go to the cluster information page. In the <strong id="css_01_0079__b186917472037">Node</strong> area, check whether there is information about cold data nodes.<div class="fignone" id="css_01_0079__fig81121516319"><span class="figcap"><b>Figure 2 </b>Cold data node information</span><br><span><img id="css_01_0079__image10112459316" src="en-us_image_0000001980467905.png"></span></div>
+<ul id="css_01_0079__ul105612352503"><li id="css_01_0079__li15561163517504">If there is information about cold data nodes, the cluster has cold data nodes. Go to the next step.</li><li id="css_01_0079__li256193514503">Otherwise, the cluster does not have cold data nodes, in which case, you cannot switch between cold and hot data storage.</li></ul>
+</div>
+</li><li id="css_01_0079__li074333625616">Click <strong id="css_01_0079__b79961651173313">Access Kibana</strong> in the <strong id="css_01_0079__b16642555173312">Operation</strong> column to log in to the Kibana console.</li><li id="css_01_0079__li107432036155613">Click <strong id="css_01_0079__b36339126932434">Dev Tools</strong> in the navigation tree on the left.</li><li id="css_01_0079__li169591910135014">On the Kibana page, set an index template to store index data to cold or hot data nodes.<p id="css_01_0079__p19579945714"><a name="css_01_0079__li169591910135014"></a><a name="li169591910135014"></a>For example, run the following command to set a template to store indexes that start with <strong id="css_01_0079__b553761413386">myindex</strong> to cold data nodes:</p>
+<ul id="css_01_0079__en-us_topic_0000001223754344_ul1672811231355"><li id="css_01_0079__en-us_topic_0000001223754344_li197281423651">For an Elasticsearch cluster whose version is earlier than 6.x:<pre class="screen" id="css_01_0079__en-us_topic_0000001223754344_screen1349715413531">PUT _template/test
+{
+    "order": 1,
+    "template": "myindex*",
+    "settings": {
+        "index": {
+            "refresh_interval": "30s",
+            "number_of_shards": "3",
+            "number_of_replicas": "1",
+            "routing.allocation.require.box_type": "cold"
+        }
+    }
+}</pre>
+</li><li id="css_01_0079__en-us_topic_0000001223754344_li162832403514">For an Elasticsearch cluster whose version is 6.x or later:<pre class="screen" id="css_01_0079__en-us_topic_0000001223754344_screen263614110017">PUT _template/test
+{
+  "order": 1,
+  "index_patterns": "myindex*",
+  "settings": {
+    "refresh_interval": "30s",
+    "number_of_shards": "3",
+    "number_of_replicas": "1",
+    "routing.allocation.require.box_type": "cold"
+  }
+}</pre>
+</li></ul>
+<p id="css_01_0079__p393561016361">Or you can simply specify cold or hot storage for existing indexes.</p>
+<div class="p" id="css_01_0079__p18935810183617">For example, run the following command store index <span class="parmvalue" id="css_01_0079__parmvalue12836185983510"><b>myindex</b></span> to cold data nodes:<pre class="screen" id="css_01_0079__screen683665913511">PUT <em id="css_01_0079__i383695920358">myindex</em>/_settings   
+ { 
+        "index.routing.allocation.require.box_type": "<em id="css_01_0079__i158369593357">cold</em>"
+    }</pre>
+</div>
+<p id="css_01_0079__p1393541073616"><span class="parmvalue" id="css_01_0079__parmvalue983685993513"><b>myindex</b></span> indicates the index name. You can change <span class="parmvalue" id="css_01_0079__parmvalue17837144143712"><b>cold</b></span> to <span class="parmvalue" id="css_01_0079__parmvalue14261726103712"><b>hot</b></span> if you need hot storage.</p>
+</li><li id="css_01_0079__li2360144491218">When necessary, run the following command to cancel cold or hot storage configuration. After that, index data will be randomly and evenly distributed across cold and hot data nodes.<pre class="screen" id="css_01_0079__en-us_topic_0000001223754344_screen63401826247">PUT <em id="css_01_0079__i1517061583518">myindex</em>/_settings    
+{
+        "index.routing.allocation.require.box_type": null
+    }</pre>
+<p id="css_01_0079__p188041718201617"><span class="parmvalue" id="css_01_0079__parmvalue1477041410457"><b>myindex</b></span> indicates the index name.</p>
+</li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0111.html">Enhancing Search Capabilities for Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0091.html

@@ -0,0 +1,19 @@
+<a name="css_01_0091"></a><a name="css_01_0091"></a>
+
+<h1 class="topictitle1">Managing Index Policies for an Elasticsearch Cluster</h1>
+<div id="body1605181560420"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0419.html">Creating and Managing Index Policies for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0420.html">Automating Index Rollover in an Elasticsearch Cluster Through Index Lifecycle Management</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0421.html">Decoupling Index Storage and Compute in an Elasticsearch Cluster Through Index Lifecycle Management</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0207.html">Using Elasticsearch for Data Search</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0111.html

@@ -0,0 +1,33 @@
+<a name="css_01_0111"></a><a name="css_01_0111"></a>
+
+<h1 class="topictitle1">Enhancing Search Capabilities for Elasticsearch Clusters</h1>
+<div id="body0000001080859855"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0400.html">Search Enhancement Features for Elasticsearch Clusters</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0117.html">Configuring Vector Search for Elasticsearch Clusters</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0405.html">Configuring Storage-Compute Decoupling for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0406.html">Configuring Flow Control 2.0 for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0407.html">Configuring Flow Control 1.0 for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0408.html">Configuring Large Query Isolation for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0409.html">Configuring Enhanced Aggregation for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0410.html">Configuring Read/Write Splitting Between Two Elasticsearch Clusters</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0079.html">Switching Between Hot and Cold Storage for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0249.html">Configuring an Index Recycle Bin for an Elasticsearch Cluster</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0207.html">Using Elasticsearch for Data Search</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0117.html

@@ -0,0 +1,29 @@
+<a name="css_01_0117"></a><a name="css_01_0117"></a>
+
+<h1 class="topictitle1">Configuring Vector Search for Elasticsearch Clusters</h1>
+<div id="body0000001080985987"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0118.html">About Vector Search</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0121.html">Creating Vector Indexes in an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0123.html">Using Vector Indexes for Data Search in an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0401.html">Using a Vector Index with Nested Fields</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0126.html">Optimizing the Write and Query Performance of Vector Search</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0130.html">Managing the Vector Index Cache</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0129.html">Client Code Sample for Vector Search (Python)</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0402.html">Client Code Sample for Vector Search (Java)</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0111.html">Enhancing Search Capabilities for Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0118.html

@@ -0,0 +1,86 @@
+<a name="css_01_0118"></a><a name="css_01_0118"></a>
+
+<h1 class="topictitle1">About Vector Search</h1>
+<div id="body0000001081670505"><p id="css_01_0118__en-us_topic_0000001223594448_p443014484225">Unstructured data, such as images, videos, and language corpora, is converted into vectors, which are searched based on similarity using either an exact or approximate nearest neighbors algorithm.</p>
+<div class="section" id="css_01_0118__en-us_topic_0000001223594448_section45446533237"><h4 class="sectiontitle">How It Works</h4><p id="css_01_0118__en-us_topic_0000001223594448_p1892712312611">Vector search works in a way similar to traditional search. To improve vector search performance, we need to:</p>
+<ul id="css_01_0118__en-us_topic_0000001223594448_ul18466630152615"><li id="css_01_0118__en-us_topic_0000001223594448_li1466530102616"><strong id="css_01_0118__en-us_topic_0000001223594448_b9200126114717">Narrow down the matched scope</strong><p id="css_01_0118__en-us_topic_0000001223594448_p109274234263">Similar to traditional text search, vector search use indexes to accelerate the search instead of going through all data. Traditional text search uses inverted indexes to filter out irrelevant documents, whereas vector search creates indexes for vectors to bypass irrelevant vectors, narrowing down the search scope.</p>
+</li><li id="css_01_0118__en-us_topic_0000001223594448_li148363592612"><strong id="css_01_0118__en-us_topic_0000001223594448_b1729973134720">Reduce the complexity of calculating a single vector</strong><p id="css_01_0118__en-us_topic_0000001223594448_p1892715234266">The vector search method can quantize and approximate high dimensional vectors first. By doing this, a smaller and more relevant dataset can be obtained. Then more sophisticated algorithms are applied to this smaller dataset to perform computation and sorting. This way, complex computation is performed on only part of the vectors, and efficiency is improved.</p>
+</li></ul>
+<p id="css_01_0118__en-us_topic_0000001223594448_p4672653151113">Vector search means to retrieve the k-nearest neighbors (KNN) to the query vector in a given vector data set by using a specific measurement method. Generally, CSS only focuses on Approximate Nearest Neighbor (ANN), because a KNN search requires excessive computational resources.</p>
+</div>
+<div class="section" id="css_01_0118__en-us_topic_0000001223594448_section1682114111274"><h4 class="sectiontitle">Vector Search in CSS</h4><p id="css_01_0118__en-us_topic_0000001223594448_p368234122719">The CSS vector search engine integrates a variety of vector indexes, such as brute-force search, Hierarchical Navigable Small World (HNSW) graphs, product quantization, and IVF-HNSW. It also supports multiple similarity calculation methods, such as Euclidean, inner product, cosine, and Hamming. The recall rate and retrieval performance of the engine are better than those of open-source engines. It can meet the requirements for high performance, high precision, low costs, and multi-modal computation.</p>
+<p id="css_01_0118__en-us_topic_0000001223594448_p3682194119271">The search engine also supports all the capabilities of the native Elasticsearch, including distribution, multi-replica, error recovery, snapshot, and permission control. The engine is compatible with the native Elasticsearch ecosystem, including the cluster monitoring tool Cerebro, the visualization tool Kibana, and the real-time data ingestion tool Logstash. Several client languages, such as Python, Java, Go, and C++, are supported.</p>
+</div>
+<div class="section" id="css_01_0118__en-us_topic_0000001223594448_section15508103014206"><h4 class="sectiontitle">Constraints</h4><ul id="css_01_0118__en-us_topic_0000001223594448_ul13628842142018"><li id="css_01_0118__li0239191816816">The built-in CSS vector search engine is available for Elasticsearch 7.6.2 and 7.10.2 clusters only.</li><li id="css_01_0118__en-us_topic_0000001223594448_li1462834282015">The vector search plug-in performs in-memory computing and requires more memory than common indexes do. You are advised to use memory-optimized compute specifications.</li></ul>
+</div>
+<div class="section" id="css_01_0118__section18221195417136"><a name="css_01_0118__section18221195417136"></a><a name="section18221195417136"></a><h4 class="sectiontitle">Cluster Node Specifications Selection for Vector Search</h4><p id="css_01_0118__en-us_topic_0000001261909812_p2804352104215">Off-heap memory is used for index construction and query in vector search. Therefore, the required cluster capacity is related to the index type and off-heap memory size. You can estimate the off-heap memory required by full indexing to select the appropriate cluster specifications. Due to high memory usage of vector search, CSS disables the vector search plug-in by default for clusters whose memory is 8 GB or less.</p>
+<div class="p" id="css_01_0118__en-us_topic_0000001261909812_p1216235123617">There are different methods for estimating the size of off-heap memory required by different types of indexes. The calculation formulas are as follows:<ul id="css_01_0118__en-us_topic_0000001261909812_ul1626234143110"><li id="css_01_0118__en-us_topic_0000001261909812_li122610343315"><strong id="css_01_0118__b2042219402161">GRAPH index</strong><p id="css_01_0118__p3907152119169"><span id="css_01_0118__ph174514153911">mem_needs = (dim x dim_size + neighbors x 4) x num + delta</span></p>
+<div class="note" id="css_01_0118__en-us_topic_0000001261909812_note264165903915"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="css_01_0118__en-us_topic_0000001261909812_p1164155923917">If you need to update indexes in real time, consider the off-heap memory overhead required for vector index construction and automatic merge. The actual size of required <strong id="css_01_0118__b1788741085413">mem_needs</strong> is at least 1.5 to 2 times of the original estimation.</p>
+</div></div>
+</li><li id="css_01_0118__en-us_topic_0000001261909812_li4981114418312"><strong id="css_01_0118__en-us_topic_0000001261909812_b11437195014419">PQ index</strong><p id="css_01_0118__p25749308240">mem_needs = frag_num x frag_size x num + delta</p>
+</li><li id="css_01_0118__en-us_topic_0000001261909812_li85212188414"><strong id="css_01_0118__en-us_topic_0000001261909812_b16836553134119">FLAT and IVF indexes</strong><p id="css_01_0118__p1318663214249">mem_needs = dim x dim_size x num + delta</p>
+</li></ul>
+
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0118__en-us_topic_0000001261909812_table1875348443" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_01_0118__en-us_topic_0000001261909812_row276174134419"><th align="left" class="cellrowborder" valign="top" width="28.89%" id="mcps1.3.5.3.2.2.3.1.1"><p id="css_01_0118__en-us_topic_0000001261909812_p1876841448">Parameter</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="71.11%" id="mcps1.3.5.3.2.2.3.1.2"><p id="css_01_0118__en-us_topic_0000001261909812_p14761464413">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="css_01_0118__en-us_topic_0000001261909812_row107613413445"><td class="cellrowborder" valign="top" width="28.89%" headers="mcps1.3.5.3.2.2.3.1.1 "><p id="css_01_0118__en-us_topic_0000001261909812_p0761943444">dim</p>
+</td>
+<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.5.3.2.2.3.1.2 "><p id="css_01_0118__en-us_topic_0000001261909812_p27614484419">Vector dimensionality</p>
+</td>
+</tr>
+<tr id="css_01_0118__en-us_topic_0000001261909812_row47616484416"><td class="cellrowborder" valign="top" width="28.89%" headers="mcps1.3.5.3.2.2.3.1.1 "><p id="css_01_0118__en-us_topic_0000001261909812_p15767474413">neighbors</p>
+</td>
+<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.5.3.2.2.3.1.2 "><p id="css_01_0118__en-us_topic_0000001261909812_p187644154418">Number of neighbors of a graph node. The default value is <strong id="css_01_0118__b116222947734835">64</strong>.</p>
+</td>
+</tr>
+<tr id="css_01_0118__en-us_topic_0000001261909812_row197616434417"><td class="cellrowborder" valign="top" width="28.89%" headers="mcps1.3.5.3.2.2.3.1.1 "><p id="css_01_0118__en-us_topic_0000001261909812_p6763411446">dim_size</p>
+</td>
+<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.5.3.2.2.3.1.2 "><p id="css_01_0118__en-us_topic_0000001261909812_p16769444420">Number of bytes required by each dimension. The default value is four bytes in the float type.</p>
+</td>
+</tr>
+<tr id="css_01_0118__en-us_topic_0000001261909812_row6764416440"><td class="cellrowborder" valign="top" width="28.89%" headers="mcps1.3.5.3.2.2.3.1.1 "><p id="css_01_0118__en-us_topic_0000001261909812_p18765444414">num</p>
+</td>
+<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.5.3.2.2.3.1.2 "><p id="css_01_0118__en-us_topic_0000001261909812_p6761845447">Total number of vectors</p>
+</td>
+</tr>
+<tr id="css_01_0118__en-us_topic_0000001261909812_row97613454416"><td class="cellrowborder" valign="top" width="28.89%" headers="mcps1.3.5.3.2.2.3.1.1 "><p id="css_01_0118__en-us_topic_0000001261909812_p137611413447">delta</p>
+</td>
+<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.5.3.2.2.3.1.2 "><p id="css_01_0118__en-us_topic_0000001261909812_p157613464410">Metadata size. This parameter can be left blank.</p>
+</td>
+</tr>
+<tr id="css_01_0118__en-us_topic_0000001261909812_row27612424419"><td class="cellrowborder" valign="top" width="28.89%" headers="mcps1.3.5.3.2.2.3.1.1 "><p id="css_01_0118__en-us_topic_0000001261909812_p076144114413">frag_num</p>
+</td>
+<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.5.3.2.2.3.1.2 "><p id="css_01_0118__en-us_topic_0000001261909812_p276114154418">Number of vector segments during quantization and coding. If this parameter is not specified when an index is created, the value is determined by vector dimensionality <span class="parmname" id="css_01_0118__en-us_topic_0000001261909812_parmname32491715164713"><b>dim</b></span>.</p>
+<pre class="screen" id="css_01_0118__en-us_topic_0000001261909812_screen28239236473">if dim &lt;= 256: 
+  frag_num = dim / 4
+elif dim &lt;= 512: 
+  frag_num = dim / 8
+else :
+  frag_num = 64</pre>
+</td>
+</tr>
+<tr id="css_01_0118__en-us_topic_0000001261909812_row187684104410"><td class="cellrowborder" valign="top" width="28.89%" headers="mcps1.3.5.3.2.2.3.1.1 "><p id="css_01_0118__en-us_topic_0000001261909812_p776846446">frag_size</p>
+</td>
+<td class="cellrowborder" valign="top" width="71.11%" headers="mcps1.3.5.3.2.2.3.1.2 "><p id="css_01_0118__en-us_topic_0000001261909812_p87604154416">Size of the center point during quantization and coding. The default value is 1.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<p id="css_01_0118__en-us_topic_0000001261909812_p19203914115119">These calculation methods can estimate the size of off-heap memory required by a complete vector index. To determine cluster specifications, you also need to consider the heap memory overhead of each node.</p>
+<p id="css_01_0118__en-us_topic_0000001261909812_p53134525012">Heap memory allocation policy: The size of the heap memory of each node is half of the node physical memory, and the maximum size is <strong id="css_01_0118__b107546537334835">31 GB</strong>.</p>
+<p id="css_01_0118__en-us_topic_0000001261909812_p16313452502">For example, if you create a Graph index for the SIFT10M dataset, with <span class="parmname" id="css_01_0118__en-us_topic_0000001261909812_parmname1113013488515"><b>dim</b></span> set to <span class="parmvalue" id="css_01_0118__en-us_topic_0000001261909812_parmvalue13734161255216"><b>128</b></span>, <span class="parmname" id="css_01_0118__en-us_topic_0000001261909812_parmname8379010185210"><b>dim_size</b></span> to <span class="parmvalue" id="css_01_0118__en-us_topic_0000001261909812_parmvalue1197581115311"><b>4</b></span>, <span class="parmname" id="css_01_0118__en-us_topic_0000001261909812_parmname2411772538"><b>neighbors</b></span> to the default value <span class="parmvalue" id="css_01_0118__en-us_topic_0000001261909812_parmvalue11371171312536"><b>64</b></span>, and <span class="parmname" id="css_01_0118__en-us_topic_0000001261909812_parmname1086192219533"><b>num</b></span> to <span class="parmvalue" id="css_01_0118__en-us_topic_0000001261909812_parmvalue978262955317"><b>10 million</b></span>, the off-heap memory required by the Graph index is around 7.5 GB. Calculation formula: <span class="parmvalue" id="css_01_0118__parmvalue6249757174112"><b>mem_needs = (128 x 4 + 64 x 4) x 10000000 ≈ 7.5</b></span>.</p>
+<p id="css_01_0118__en-us_topic_0000001261909812_p531317519506">Considering the overhead of heap memory, a single server with <strong id="css_01_0118__b552412312592">8 vCPUs</strong> and <strong id="css_01_0118__b2571330334835">16 GB memory</strong> is recommended. If real-time write or update is required, you need to apply for larger memory.</p>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0117.html">Configuring Vector Search for Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0126.html

@@ -0,0 +1,42 @@
+<a name="css_01_0126"></a><a name="css_01_0126"></a>
+
+<h1 class="topictitle1">Optimizing the Write and Query Performance of Vector Search</h1>
+<div id="body0000001262069744"><div class="section" id="css_01_0126__en-us_topic_0000001262069744_section186411329173012"><h4 class="sectiontitle">Optimizing Write Performance</h4><ul id="css_01_0126__en-us_topic_0000001262069744_ul09461057164113"><li id="css_01_0126__en-us_topic_0000001262069744_li189761389357">To reduce the cost of backup, disable the backup function before data import and enable it afterwards.</li><li id="css_01_0126__en-us_topic_0000001262069744_li27411942123713">Set <span class="parmname" id="css_01_0126__en-us_topic_0000001262069744_parmname877971815344"><b>refresh_interval</b></span> to <strong id="css_01_0126__en-us_topic_0000001262069744_b1176015317388">120s</strong> or a larger value. Larger segments can reduce the vector index build overhead caused by merging.</li><li id="css_01_0126__en-us_topic_0000001262069744_li1053491484012">Increase the value of <span class="parmname" id="css_01_0126__en-us_topic_0000001262069744_parmname18272105316343"><b>native.vector.index_threads</b></span> (the default value is <strong id="css_01_0126__en-us_topic_0000001262069744_b11648194418458">4</strong>) to increase the number of threads for vector index build.<pre class="screen" id="css_01_0126__en-us_topic_0000001262069744_screen28631532420">PUT _cluster/settings
+{
+  "persistent": {
+    "native.vector.index_threads": 8
+  }
+}</pre>
+</li></ul>
+</div>
+<div class="section" id="css_01_0126__en-us_topic_0000001262069744_section527113518302"><h4 class="sectiontitle">Optimizing Query Performance</h4><ul id="css_01_0126__en-us_topic_0000001262069744_ul1388130134412"><li id="css_01_0126__en-us_topic_0000001262069744_li1456725974318">After importing data in batches, you can run the <strong id="css_01_0126__en-us_topic_0000001262069744_b168089591364">forcemerge</strong> command to improve the query efficiency.<pre class="screen" id="css_01_0126__en-us_topic_0000001262069744_screen3998132772116">POST index_name/_forcemerge?max_num_segments=1</pre>
+</li></ul>
+<ul id="css_01_0126__en-us_topic_0000001262069744_ul269911532210"><li id="css_01_0126__en-us_topic_0000001262069744_li56213018222">If the off-heap memory required by the vector index exceeds the circuit breaker limit, index entry swap-in and swap-out occur, which affects the query performance. In this case, you can increase the circuit breaker threshold of off-heap memory.<pre class="screen" id="css_01_0126__en-us_topic_0000001262069744_screen9611125582411">PUT _cluster/settings
+{
+  "persistent": {
+    "native.cache.circuit_breaker.cpu.limit": "75%"
+  }
+}</pre>
+</li><li id="css_01_0126__li148341156892">To fetch a small number of fields that support doc values, such as keywords and numerical fields, use the docvalue_fields parameter to specify the fields you want to fetch. This helps to reduce overhead during the fetch phase.<pre class="screen" id="css_01_0126__en-us_topic_0000001268154489_screen1466920229569">POST my_index/_search
+{
+  "size": 2,
+  "stored_fields": ["_none_"], 
+  "docvalue_fields": ["my_label"],
+  "query": {
+    "vector": {
+      "my_vector": {
+        "vector": [1, 1],
+        "topk": 2
+      }
+    }
+  }
+}</pre>
+</li></ul>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0117.html">Configuring Vector Search for Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0130.html

@@ -0,0 +1,19 @@
+<a name="css_01_0130"></a><a name="css_01_0130"></a>
+
+<h1 class="topictitle1">Managing the Vector Index Cache</h1>
+<div id="body0000001200234616"><p id="css_01_0130__en-us_topic_0000001268154549_p9773716335">The vector search engine is developed in C++ and uses off-heap memory. You can use the following APIs to manage the index cache.</p>
+<ul id="css_01_0130__en-us_topic_0000001268154549_ul4779753312"><li id="css_01_0130__en-us_topic_0000001268154549_li6770717336"><strong id="css_01_0130__en-us_topic_0000001268154549_b1919783612367">View cache statistics.</strong><pre class="screen" id="css_01_0130__en-us_topic_0000001268154549_screen16934641315">GET /_vector/stats</pre>
+<p id="css_01_0130__en-us_topic_0000001268154549_p1977210351817">In the implementation of the vector plug-in, the vector index is the same as other types of Lucene indexes. Each segment constructs and stores an index file. During query, the index file is loaded to the non-heap memory. The plug-in uses the cache mechanism to manage the non-heap memory. You can use this API to query the non-heap memory usage, number of cache hits, and number of loading times.</p>
+</li><li id="css_01_0130__en-us_topic_0000001268154549_li295515542292"><strong id="css_01_0130__en-us_topic_0000001268154549_b136281519203916">Preload the vector index.</strong><pre class="screen" id="css_01_0130__en-us_topic_0000001268154549_screen3693164910305">PUT /_vector/warmup/{index_name}</pre>
+<p id="css_01_0130__en-us_topic_0000001268154549_p28561843163016">You can use this API to preload the vector index specified by <strong id="css_01_0130__en-us_topic_0000001268154549_b612616506486">index_name</strong> to the off-heap memory for query.</p>
+</li><li id="css_01_0130__en-us_topic_0000001268154549_li1477147103311"><strong id="css_01_0130__en-us_topic_0000001268154549_b12737115474510">Clear the cache.</strong><pre class="screen" id="css_01_0130__en-us_topic_0000001268154549_screen62573551112">PUT /_vector/clear/cache </pre>
+<pre class="screen" id="css_01_0130__en-us_topic_0000001268154549_screen178541841152315">PUT /_vector/clear/cache/index_name</pre>
+<p id="css_01_0130__en-us_topic_0000001268154549_p1170584816113">The caching mechanism limits the non-heap memory usage when vector indexes are used. When the total index size exceeds the cache size limit, index entry swap-in and swap-out occur, which affects the query performance. You can use this API to clear unnecessary index cache to ensure the query performance of hot data indexes.</p>
+</li></ul>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0117.html">Configuring Vector Search for Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0155.html

@@ -0,0 +1,55 @@
+<a name="css_01_0155"></a><a name="css_01_0155"></a>
+
+<h1 class="topictitle1">Using Cloud Eye to Monitor Elasticsearch Clusters</h1>
+<div id="body0000001263429532"><p id="css_01_0155__en-us_topic_0000001263429532_p978417177594">With <span id="css_01_0155__en-us_topic_0000001263429532_text7993159015">CSS</span>, you can use Cloud Eye to monitor created clusters. After configuring the cluster monitoring, you can log in to the Cloud Eye management console to view cluster metrics. For details about Cloud Eye, see the <a href="https://docs.otc.t-systems.com/en-us/usermanual/ces/ces_07_0001.html" target="_blank" rel="noopener noreferrer">Cloud Eye User Guide</a>.</p>
+<p id="css_01_0155__en-us_topic_0000001263429532_p1049333316218">The procedure for configuring cluster monitoring:</p>
+<ol id="css_01_0155__en-us_topic_0000001263429532_ol18531155235311"><li id="css_01_0155__en-us_topic_0000001263429532_li85311952105311"><a href="#css_01_0155__en-us_topic_0000001263429532_section15621114112420">Creating Alarm Rules</a>: 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.</li><li id="css_01_0155__en-us_topic_0000001263429532_li25311252185310"><a href="#css_01_0155__en-us_topic_0000001263429532_section1136460963">Configuring Monitoring Metrics</a>: Configure monitoring metrics for a cluster or a node in the cluster.</li><li id="css_01_0155__en-us_topic_0000001263429532_li953165275310"><a href="#css_01_0155__section19225545132518">Viewing Cluster Monitoring Information</a>: View the statistics of the monitoring metrics in specific periods.</li></ol>
+<div class="section" id="css_01_0155__en-us_topic_0000001263429532_section93561128195816"><h4 class="sectiontitle">Recommended Monitoring Metrics</h4><ul id="css_01_0155__en-us_topic_0000001263429532_ul95103285119"><li id="css_01_0155__li88239295317">For routine monitoring of a cluster, you are advised to focus on disk usage and cluster health status.</li><li id="css_01_0155__en-us_topic_0000001263429532_li13510152841118">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.</li><li id="css_01_0155__en-us_topic_0000001263429532_li1451042821116">Cluster write and search latency and throughput. You are advised to configure the following monitoring metrics: average index latency, average index rate, average search latency, and average QPS.</li><li id="css_01_0155__en-us_topic_0000001263429532_li1551022861115">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.</li></ul>
+</div>
+<div class="section" id="css_01_0155__en-us_topic_0000001263429532_section1839919421279"><h4 class="sectiontitle">Prerequisites</h4><ul id="css_01_0155__en-us_topic_0000001263429532_ul53371598273"><li id="css_01_0155__en-us_topic_0000001263429532_li167406482618">The cluster is in the <strong id="css_01_0155__en-us_topic_0000001263429532_b396114042119">Available</strong> or <strong id="css_01_0155__en-us_topic_0000001263429532_b13564184213213">Processing</strong> status.</li><li id="css_01_0155__en-us_topic_0000001263429532_li168813194715">The cluster has been running properly for more than 10 minutes.</li></ul>
+</div>
+<div class="section" id="css_01_0155__en-us_topic_0000001263429532_section15621114112420"><a name="css_01_0155__en-us_topic_0000001263429532_section15621114112420"></a><a name="en-us_topic_0000001263429532_section15621114112420"></a><h4 class="sectiontitle">Creating Alarm Rules</h4><ol id="css_01_0155__en-us_topic_0000001263429532_ol373518361145"><li id="css_01_0155__en-us_topic_0000001263429532_li1173513611411">Log in to the Cloud Eye console.</li><li id="css_01_0155__en-us_topic_0000001263429532_li17735636141417">In the navigation pane on the left, choose <strong id="css_01_0155__en-us_topic_0000001263429532_b202086538232">Alarm Management</strong> &gt; <strong id="css_01_0155__en-us_topic_0000001263429532_b15264558162320">Alarm Rules</strong>.</li><li id="css_01_0155__en-us_topic_0000001263429532_li12905188145814">In the <strong id="css_01_0155__b2403154173610">Resource Type</strong> column, select Cloud Search Service to filter alarm rules.<p id="css_01_0155__en-us_topic_0000001263429532_p3293151085811">If no alarm rules are available, create one by referring to section "Creating an Alarm Rule". <a href="#css_01_0155__en-us_topic_0000001263429532_table15676621164617">Table 1</a> describes the key parameters. For more parameters, customize them as needed.</p>
+
+<div class="tablenoborder"><a name="css_01_0155__en-us_topic_0000001263429532_table15676621164617"></a><a name="en-us_topic_0000001263429532_table15676621164617"></a><table cellpadding="4" cellspacing="0" summary="" id="css_01_0155__en-us_topic_0000001263429532_table15676621164617" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Alarm rule configuration parameters</caption><thead align="left"><tr id="css_01_0155__en-us_topic_0000001263429532_row867782112464"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.2.3.3.2.3.1.1"><p id="css_01_0155__en-us_topic_0000001263429532_p1167742194617">Parameter</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.6.2.3.3.2.3.1.2"><p id="css_01_0155__en-us_topic_0000001263429532_p36771121194612">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="css_01_0155__row834914584416"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.3.3.2.3.1.1 "><p id="css_01_0155__p334965819417">Alarm Type</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.3.3.2.3.1.2 "><p id="css_01_0155__p3349185817411">Select <strong id="css_01_0155__b104366641511490">Metric</strong>.</p>
+</td>
+</tr>
+<tr id="css_01_0155__en-us_topic_0000001263429532_row567711212464"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.3.3.2.3.1.1 "><p id="css_01_0155__en-us_topic_0000001263429532_p467719215465">Cloud Service</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.3.3.2.3.1.2 "><p id="css_01_0155__en-us_topic_0000001263429532_p1369144575118">Select <strong id="css_01_0155__en-us_topic_0000001263429532_b14411124143310">Cloud Search Service</strong>.</p>
+</td>
+</tr>
+<tr id="css_01_0155__row543395313148"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.3.3.2.3.1.1 "><p id="css_01_0155__p1343365314147">Resource Layer</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.3.3.2.3.1.2 "><p id="css_01_0155__p9433353111417">Select the layer by which you are going to configure alarm rules.</p>
+<ul id="css_01_0155__ul1069794714166"><li id="css_01_0155__li2697247121618"><span class="parmvalue" id="css_01_0155__parmvalue1736292011713"><b>CSS Clusters</b></span>: Alarm rules are specified by cluster.</li><li id="css_01_0155__li1569744715167"><span class="parmvalue" id="css_01_0155__parmvalue10313132711175"><b>CSS Clusters - CSS Instances</b></span>: Alarm rules are specified by node in a cluster.</li></ul>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</li></ol>
+</div>
+<div class="section" id="css_01_0155__en-us_topic_0000001263429532_section1136460963"><a name="css_01_0155__en-us_topic_0000001263429532_section1136460963"></a><a name="en-us_topic_0000001263429532_section1136460963"></a><h4 class="sectiontitle">Configuring Monitoring Metrics</h4><ol id="css_01_0155__en-us_topic_0000001263429532_ol101061030154514"><li id="css_01_0155__en-us_topic_0000001263429532_li181062306458">Create a monitoring panel by referring to section "Creating a Dashboard". If an available monitoring panel has been created, skip this step.</li><li id="css_01_0155__en-us_topic_0000001263429532_li97271346171712">Add CSS monitoring graphs by referring to section "Adding a Graph".</li></ol>
+</div>
+<div class="section" id="css_01_0155__section19225545132518"><a name="css_01_0155__section19225545132518"></a><a name="section19225545132518"></a><h4 class="sectiontitle">Viewing Cluster Monitoring Information</h4><p id="css_01_0155__p77725592323">In the cluster list, check the monitoring information of clusters and cluster nodes.</p>
+<ol id="css_01_0155__ol15225545132515"><li id="css_01_0155__li02268455258">Log in to the CSS management console.</li><li id="css_01_0155__li1319605114128">In the navigation pane on the left, choose <span class="uicontrol" id="css_01_0155__uicontrol128422116341"><b>Clusters</b></span>, and click a cluster type to go to the cluster list.</li><li id="css_01_0155__li11196851201217">In the cluster list, select a cluster and click <strong id="css_01_0155__b159962031193620">View Metric</strong> in the <strong id="css_01_0155__b229220288361">Operation</strong> column to check the metrics of the cluster and cluster nodes.<div class="fignone" id="css_01_0155__fig7656523153714"><span class="figcap"><b>Figure 1 </b>Viewing metrics</span><br><span><img id="css_01_0155__image126562023103718" src="en-us_image_0000002005921800.png"></span></div>
+<ul id="css_01_0155__ul19811113155316"><li id="css_01_0155__li18981151335315">Click the <strong id="css_01_0155__b117532125263">Instances</strong> tab to check cluster metrics.<ul id="css_01_0155__ul1469482412545"><li id="css_01_0155__li1155541813535"><strong id="css_01_0155__b9412133918288">Instances</strong>: Select a cluster to check its metrics. The current cluster is selected by default. Multiple clusters can be selected so that you may compare between them.</li><li id="css_01_0155__li118601514514">You can also set monitoring periods so that you can compare metrics between different periods for the same cluster.</li><li id="css_01_0155__li10715931044">Add Graph Group: You can add a custom group in addition to the default group. When you move the pointer over a group name on the left, the icons for changing the group name and deleting the group are displayed on the right. You can modify the group.</li><li id="css_01_0155__li1525216437618">Select Metric: In the displayed <strong id="css_01_0155__b1220019246438">Select Metric</strong> dialog box, set <span class="parmvalue" id="css_01_0155__parmvalue677245413710"><b>All Metrics</b></span> and <span class="parmvalue" id="css_01_0155__parmvalue1708195714715"><b>Top N Metrics</b></span>.</li></ul>
+</li><li id="css_01_0155__li119811513175310">Click the <span class="wintitle" id="css_01_0155__wintitle6531104365118"><b>CSS Instances</b></span> tab to check the metrics of cluster nodes. Only the node monitoring information of the first cluster selected on the <strong id="css_01_0155__b145111104713">Instances</strong> tab is displayed.<ul id="css_01_0155__ul751811311893"><li id="css_01_0155__li207131627096">CSS Instances: Select the cluster nodes whose metrics and information you want to check. By default, the first node of the current cluster is selected. Multiple nodes can be selected so that you may compare between them.</li><li id="css_01_0155__li197131279918">You can also set monitoring periods so that you can compare metrics between different periods for the same cluster.</li><li id="css_01_0155__li1871314273919">Add Graph Group: You can add a custom group in addition to the default group. When you move the pointer over a group name on the left, the icons for changing the group name and deleting the group are displayed on the right. You can modify the group.</li><li id="css_01_0155__li1271310271199">Select Metric: In the displayed <strong id="css_01_0155__b1965012215499">Select Metric</strong> dialog box, set <span class="parmvalue" id="css_01_0155__parmvalue06511327492"><b>All Metrics</b></span>.</li></ul>
+</li></ul>
+</li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0426.html">Configuring Elasticsearch Cluster Monitoring</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0156.html

@@ -0,0 +1,38 @@
+<a name="css_01_0156"></a><a name="css_01_0156"></a>
+
+<h1 class="topictitle1">Replacing Specified Nodes for an Elasticsearch Cluster</h1>
+<div id="body0000001409938353"><p id="css_01_0156__en-us_topic_0000001409938353_p8317945113417">If a node in a cluster becomes faulty, you can create a new node with the same specifications to replace it. Before the replacement of a specified node, the data of that node will be migrated away in advance and will not be lost.</p>
+<div class="section" id="css_01_0156__en-us_topic_0000001409938353_section11686944145218"><h4 class="sectiontitle">Prerequisites</h4><ul id="css_01_0156__ul103921544131416"><li id="css_01_0156__li5392114451413">The target cluster is available and has no tasks in progress.</li><li id="css_01_0156__li439264421416">All mission-critical data has been backed up before a node replacement. This is to prevent data loss.</li></ul>
+</div>
+<div class="section" id="css_01_0156__en-us_topic_0000001409938353_section5877144684418"><h4 class="sectiontitle">Constraints</h4><ul id="css_01_0156__en-us_topic_0000001409938353_ul18993228352"><li id="css_01_0156__en-us_topic_0000001409938353_li11245124113516">Only one node can be replaced at a time.</li><li id="css_01_0156__en-us_topic_0000001409938353_li10476104102517">The ID, IP address, specifications, and AZ of the new node will be the same as those of the original one.</li><li id="css_01_0156__en-us_topic_0000001409938353_li1054749143812">The configurations you modified manually will not be retained after node replacement. For example, if you have manually added a return route to the original node, you need to add it to the new node again after the node replacement is complete.</li><li id="css_01_0156__en-us_topic_0000001409938353_li45901437173914">If the node you want to replace is a data node or cold data node, pay attention to the following precautions:<ul id="css_01_0156__ul5985822192717"><li id="css_01_0156__li99856225277">Before a data node or cold data node is replaced, its data needs to be migrated to other nodes. To ensure data security, ensure the maximum total of replicas and primary shards of an index is smaller than the total number of data nodes plus cold data nodes in the cluster. The time it takes to replace the node depends on how fast the data can be migrated.</li><li id="css_01_0156__li09855226277">Clusters whose version is earlier than 7.6.2 cannot have closed indexes. Otherwise, their data nodes or cold data nodes cannot be replaced.</li><li id="css_01_0156__li15985522182714">The AZ of the node to be replaced must have two or more data nodes or cold data nodes.</li><li id="css_01_0156__li119856228277">If the cluster where a data node or cold data node needs to be replaced does not have a master node, the total number of available data nodes and cold data nodes in the cluster must be at least 3.</li><li id="css_01_0156__li1598518225273">If it is a master or client node that needs to be replaced, the precautions above do not apply.</li><li id="css_01_0156__li798562215271">The precautions above do not apply if you are replacing a faulty node, regardless of its type. Faulty nodes are not included in <strong id="css_01_0156__en-us_topic_0000001409938353_b03206484715">_cat/nodes</strong>.</li></ul>
+</li></ul>
+</div>
+<div class="section" id="css_01_0156__en-us_topic_0000001409938353_section1177713055318"><h4 class="sectiontitle">Replacing a Specified Node</h4><ol id="css_01_0156__en-us_topic_0000001409938353_ol373518361145"><li id="css_01_0156__en-us_topic_0000001409938353_li1173513611411">Log in to the <span id="css_01_0156__text22674578511168">CSS</span> management console.</li><li id="css_01_0156__li108716541501">In the navigation pane, choose a cluster type. The cluster management page is displayed.</li><li id="css_01_0156__en-us_topic_0000001285669680_li17735636141417">Choose <strong id="css_01_0156__b16650145112220">More</strong> &gt; <strong id="css_01_0156__b665010452223">Modify Configuration</strong> in the <strong id="css_01_0156__b126501745162217">Operation</strong> column of the target cluster. The <strong id="css_01_0156__b13650114515226">Modify Configuration</strong> page is displayed.</li><li id="css_01_0156__en-us_topic_0000001409938353_li239201117417">On the <strong id="css_01_0156__en-us_topic_0000001409938353_b45216189206">Modify Configuration</strong> page, click the <strong id="css_01_0156__en-us_topic_0000001409938353_b1274515314246">Replace Node</strong> tab.</li><li id="css_01_0156__en-us_topic_0000001409938353_li13735736141416">On the <strong id="css_01_0156__b156597317113">Replace Node</strong> tab, set the parameters as needed.
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0156__table83571651113411" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Replacing a specified node</caption><thead align="left"><tr id="css_01_0156__css_01_0153_row1712711404176"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.2.5.2.2.3.1.1"><p id="css_01_0156__css_01_0153_p15127124014172">Parameter</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.4.2.5.2.2.3.1.2"><p id="css_01_0156__css_01_0153_p1712704016171">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="css_01_0156__row1494233611582"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.5.2.2.3.1.1 "><p id="css_01_0156__p694319361584">Whether to perform data migration</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.5.2.2.3.1.2 "><p id="css_01_0156__p182791714019">Selecting this option means data migration will be performed. If the target node has disabled indexes or has indexes that have no replicas, this option must be selected.</p>
+</td>
+</tr>
+<tr id="css_01_0156__css_01_0153_row161270402176"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.5.2.2.3.1.1 "><p id="css_01_0156__css_01_0153_p171871929151813">Node Type</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.5.2.2.3.1.2 "><p id="css_01_0156__css_01_0153_p1718622920180">Expand the node type that needs be changed to show all nodes under it. Select the nodes you want to replace.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</li><li id="css_01_0156__li1959718313436">Click <span class="uicontrol" id="css_01_0156__uicontrol256313716438"><b>Submit</b></span>.</li><li id="css_01_0156__en-us_topic_0000001409938353_li13737436141418">Click <span class="uicontrol" id="css_01_0156__en-us_topic_0000001409938353_uicontrol129914517343"><b>Back to Cluster List</b></span> to switch to the <strong id="css_01_0156__en-us_topic_0000001409938353_b599215173420">Clusters</strong> page. The <strong id="css_01_0156__en-us_topic_0000001409938353_b181637590404">Task Status</strong> is <strong id="css_01_0156__en-us_topic_0000001409938353_b104298220414">Replacing nodes</strong>. When <strong id="css_01_0156__en-us_topic_0000001409938353_b185807491597">Cluster Status</strong> changes to <strong id="css_01_0156__en-us_topic_0000001409938353_b161271038154119">Available</strong>, the node has been successfully replaced.</li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0009.html">Managing Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0201.html

@@ -0,0 +1,60 @@
+<a name="css_01_0201"></a><a name="css_01_0201"></a>
+
+<h1 class="topictitle1">Switching AZs for an Elasticsearch Cluster</h1>
+<div id="body0000001438549444"><p id="css_01_0201__en-us_topic_0000001438549444_p67196974819">CSS supports cross-AZ deployment. By switching AZs for a cluster, you can obtain more resources for the cluster or improve cluster availability.</p>
+<div class="section" id="css_01_0201__en-us_topic_0000001438549444_section10297162614176"><h4 class="sectiontitle">Scenarios</h4><div class="p" id="css_01_0201__en-us_topic_0000001438549444_p184312303171">You can <strong id="css_01_0201__en-us_topic_0000001438549444_b12888619193013">Add AZ</strong> or <strong id="css_01_0201__en-us_topic_0000001438549444_b17504133310308">Migrate AZ</strong>.<ul id="css_01_0201__en-us_topic_0000001438549444_ul04225613559"><li id="css_01_0201__en-us_topic_0000001438549444_li1642135611554"><strong id="css_01_0201__en-us_topic_0000001438549444_b1421516153117">Add AZ</strong>: Add one or two AZs to a single-AZ cluster, or add an AZ to a dual-AZ cluster to improve cluster availability.</li><li id="css_01_0201__en-us_topic_0000001438549444_li288110413110"><strong id="css_01_0201__en-us_topic_0000001438549444_b470415993115">Migrate AZ</strong>: Completely migrate data from the current AZ to another AZ that has sufficient resources.</li></ul>
+</div>
+</div>
+<div class="section" id="css_01_0201__en-us_topic_0000001438549444_section1365527171510"><h4 class="sectiontitle">Prerequisites</h4><ul id="css_01_0201__en-us_topic_0000001438549444_ul172371330165312"><li id="css_01_0201__en-us_topic_0000001438549444_li82377301531">Ensure that an AZ with sufficient resources exists.</li><li id="css_01_0201__en-us_topic_0000001438549444_li823715308536">The target cluster is available and has no tasks in progress.</li><li id="css_01_0201__en-us_topic_0000001438549444_li85953013613">Make sure that no non-standard operations have been performed in the cluster. If you have made non-standard modifications, such as modifying return routes, system parameters, and Kibana configurations, these modifications will be lost after the AZ change and your services may be affected.</li><li id="css_01_0201__li19561436102820">All mission-critical data has been backed up before an AZ switchover. This is to prevent data loss.</li></ul>
+</div>
+<div class="section" id="css_01_0201__en-us_topic_0000001438549444_section5831519171516"><h4 class="sectiontitle">Constraints</h4><ul id="css_01_0201__en-us_topic_0000001438549444_ul11656830101213"><li id="css_01_0201__en-us_topic_0000001438549444_li18656830171214">To ensure service continuity, the total number of data nodes and cold data nodes in a cluster must be greater than or equal to 3.</li><li id="css_01_0201__en-us_topic_0000001438549444_li11171172161312">During the change, nodes are brought offline one by one and then new nodes are created. Ensure that the disk capacity of other nodes can store all the data of the node after a single node is brought offline.</li><li id="css_01_0201__en-us_topic_0000001438549444_li116931237141317">To prevent backup allocation failures after a node is brought offline during the change, ensure that the maximum number of primary and standby index shards of an index can be allocated to the remaining data nodes and cold data nodes. That is, the maximum number of primary and standby shards of an index plus 1 is less than or equal to the total number of data nodes and cold data nodes in the current cluster.</li><li id="css_01_0201__en-us_topic_0000001438549444_li2553635174511">Before a change completes, some nodes may have been moved to a new AZ. In this case, the AZs before and after the change are both displayed. After the change succeeds, the new AZs and their nodes will be displayed properly.</li><li id="css_01_0201__en-us_topic_0000001438549444_li14591175318713">When adding AZs, the current AZ must be retained in the change. When adding one or two AZs to a single-AZ cluster, you must change AZs for all nodes at the same time. When adding an AZ to a dual-AZ cluster, you can change AZs for a single type of nodes or all nodes in a cluster at a time. For example, in a cluster using the dual-AZ architecture, you can use the three-AZ architecture for master nodes alone. During HA modification, the nodes with the smallest configurations are modified to rebuild the cluster. After the HA modification is complete, the YML configuration of the nodes that are not modified is also updated. You need to restart the cluster to make the modification take effect.</li><li id="css_01_0201__en-us_topic_0000001438549444_li18603846193211">When migrating an AZ, you can select only one target AZ. You can migrate AZs for a single type of nodes or all nodes in a cluster at a time. For example, in a cluster with two AZs, you can migrate the AZ of the master node to the other AZ. After adding AZs, you need to restart the cluster to make the modification take effect.</li></ul>
+</div>
+<div class="section" id="css_01_0201__en-us_topic_0000001438549444_section8588923151510"><h4 class="sectiontitle">Changing AZs</h4><ol id="css_01_0201__en-us_topic_0000001438549444_ol373518361145"><li id="css_01_0201__en-us_topic_0000001438549444_li1173513611411">Log in to the <span id="css_01_0201__text1381901006111611">CSS</span> management console.</li><li id="css_01_0201__li108716541501">In the navigation pane, choose a cluster type. The cluster management page is displayed.</li><li id="css_01_0201__en-us_topic_0000001285669680_li17735636141417">Choose <strong id="css_01_0201__b1217203162318">More</strong> &gt; <strong id="css_01_0201__b421812312239">Modify Configuration</strong> in the <strong id="css_01_0201__b12218133182316">Operation</strong> column of the target cluster. The <strong id="css_01_0201__b1621819362319">Modify Configuration</strong> page is displayed.</li><li id="css_01_0201__en-us_topic_0000001438549444_li239201117417">Click the <span class="uicontrol" id="css_01_0201__en-us_topic_0000001438549444_uicontrol163971144111"><b>Change AZ</b></span> tab.</li><li id="css_01_0201__en-us_topic_0000001438549444_li13735736141416">On the <strong id="css_01_0201__en-us_topic_0000001438549444_b1571097157">Change AZ</strong> page, set parameters.
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0201__en-us_topic_0000001438549444_table1436065715216" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters for changing AZs</caption><thead align="left"><tr id="css_01_0201__en-us_topic_0000001438549444_row1636125711210"><th align="left" class="cellrowborder" valign="top" width="18.12%" id="mcps1.3.5.2.5.2.2.3.1.1"><p id="css_01_0201__en-us_topic_0000001438549444_p173613573215">Parameter</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="81.88%" id="mcps1.3.5.2.5.2.2.3.1.2"><p id="css_01_0201__en-us_topic_0000001438549444_p123616570215">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="css_01_0201__en-us_topic_0000001438549444_row106621836114213"><td class="cellrowborder" valign="top" width="18.12%" headers="mcps1.3.5.2.5.2.2.3.1.1 "><p id="css_01_0201__en-us_topic_0000001438549444_p1666233624218">Operation Type</p>
+</td>
+<td class="cellrowborder" valign="top" width="81.88%" headers="mcps1.3.5.2.5.2.2.3.1.2 "><ul id="css_01_0201__en-us_topic_0000001438549444_ul1772564194319"><li id="css_01_0201__en-us_topic_0000001438549444_li12725184174318"><strong id="css_01_0201__en-us_topic_0000001438549444_b642915457368">Add AZ</strong>: Add one or two AZs to a single-AZ cluster, or add an AZ to a dual-AZ cluster.<p id="css_01_0201__p132361721175712">During HA modification, the nodes with the smallest configurations are modified to rebuild the cluster. After the HA modification is complete, the YML configuration of the nodes that are not modified is also updated. You need to restart the cluster to make the modification take effect.</p>
+</li><li id="css_01_0201__en-us_topic_0000001438549444_li272524134318"><strong id="css_01_0201__en-us_topic_0000001438549444_b12993154203619">Migrate AZ</strong>: Migrate data from one AZ to another.<p id="css_01_0201__p16991183318579">After adding AZs, you need to restart the cluster to make the modification take effect.</p>
+</li></ul>
+</td>
+</tr>
+<tr id="css_01_0201__en-us_topic_0000001438549444_row1569612332424"><td class="cellrowborder" valign="top" width="18.12%" headers="mcps1.3.5.2.5.2.2.3.1.1 "><p id="css_01_0201__en-us_topic_0000001438549444_p36961330424">Node Type</p>
+</td>
+<td class="cellrowborder" valign="top" width="81.88%" headers="mcps1.3.5.2.5.2.2.3.1.2 "><p id="css_01_0201__en-us_topic_0000001438549444_p14390154111211">Select a type of node or <strong id="css_01_0201__en-us_topic_0000001438549444_b2784104612616">All nodes</strong> to change their AZ.</p>
+<div class="note" id="css_01_0201__en-us_topic_0000001438549444_note1560811371616"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_01_0201__en-us_topic_0000001438549444_p460919315161">When adding one or two AZs to a single-AZ cluster, you can only select <span class="parmvalue" id="css_01_0201__en-us_topic_0000001438549444_parmvalue158611889167"><b>All nodes</b></span> to change AZs for all nodes at a time.</p>
+</div></div>
+</td>
+</tr>
+<tr id="css_01_0201__en-us_topic_0000001438549444_row066111219312"><td class="cellrowborder" valign="top" width="18.12%" headers="mcps1.3.5.2.5.2.2.3.1.1 "><p id="css_01_0201__en-us_topic_0000001438549444_p17661612137">Current AZ</p>
+</td>
+<td class="cellrowborder" valign="top" width="81.88%" headers="mcps1.3.5.2.5.2.2.3.1.2 "><p id="css_01_0201__en-us_topic_0000001438549444_p14662122036">Current AZ of a cluster</p>
+</td>
+</tr>
+<tr id="css_01_0201__en-us_topic_0000001438549444_row1871942062614"><td class="cellrowborder" valign="top" width="18.12%" headers="mcps1.3.5.2.5.2.2.3.1.1 "><p id="css_01_0201__en-us_topic_0000001438549444_p107204205267">Target AZ</p>
+</td>
+<td class="cellrowborder" valign="top" width="81.88%" headers="mcps1.3.5.2.5.2.2.3.1.2 "><p id="css_01_0201__en-us_topic_0000001438549444_p13720152017261">Target AZ.</p>
+<ul id="css_01_0201__en-us_topic_0000001438549444_ul10115145774016"><li id="css_01_0201__en-us_topic_0000001438549444_li311525712402"><strong id="css_01_0201__en-us_topic_0000001438549444_b457965844110">Add AZ</strong>: Select up to three AZs, which must include all your current AZs.</li><li id="css_01_0201__en-us_topic_0000001438549444_li191151757124016"><strong id="css_01_0201__en-us_topic_0000001438549444_b13401104010435">Migrate AZ</strong>: Select only one target AZ, which cannot be your current AZ.</li></ul>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+</li><li id="css_01_0201__en-us_topic_0000001438549444_li637205501913">Click <strong id="css_01_0201__en-us_topic_0000001438549444_b1062811591016">Submit</strong>. Determine whether to check for the backup of all indexes and click <strong id="css_01_0201__en-us_topic_0000001438549444_b311899101013">OK</strong> to start the change.</li><li id="css_01_0201__en-us_topic_0000001438549444_li14901712161314">The current AZ change task is displayed in the task list. If the task status is <strong id="css_01_0201__en-us_topic_0000001438549444_b64861024174715">Running</strong>, expand the task list and click <strong id="css_01_0201__en-us_topic_0000001438549444_b20639114918">View Progress</strong> to view the progress details.<p id="css_01_0201__en-us_topic_0000001438549444_p12331182821816">If the task status is <strong id="css_01_0201__en-us_topic_0000001438549444_b1528612274476">Failed</strong>, you can retry or terminate the task.</p>
+<ul id="css_01_0201__en-us_topic_0000001438549444_ul19302183602014"><li id="css_01_0201__en-us_topic_0000001438549444_li4302123614202">Retry a task: Click <span class="uicontrol" id="css_01_0201__en-us_topic_0000001438549444_uicontrol13302163611200"><b>Retry</b></span> in the <strong id="css_01_0201__en-us_topic_0000001438549444_b125101530154919">Operation</strong> column of a task.</li><li id="css_01_0201__en-us_topic_0000001438549444_li123027366201">Terminate a task: Click <span class="uicontrol" id="css_01_0201__en-us_topic_0000001438549444_uicontrol1330215365208"><b>Terminate</b></span> in the <strong id="css_01_0201__en-us_topic_0000001438549444_b83938304503">Operation</strong> column of a task.<p id="css_01_0201__p420902271616">If the AZ of the original node is not changed after the task is terminated, you can recover the node by referring to <a href="css_01_0156.html">Replacing Specified Nodes for an Elasticsearch Cluster</a>.</p>
+<div class="note" id="css_01_0201__note8901012115516"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="css_01_0201__p39011219551">If the AZ of some nodes has been changed and the AZ form of the cluster has changed, stopping the switchover task may make the delivery of the previous switchover request fail. Exercise caution when stopping the switchover task.</p>
+</div></div>
+</li></ul>
+</li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0009.html">Managing Elasticsearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0207.html

@@ -0,0 +1,40 @@
+<a name="css_01_0207"></a><a name="css_01_0207"></a>
+
+<h1 class="topictitle1">Using Elasticsearch for Data Search</h1>
+<div id="body0000001504911882"><p id="css_01_0207__p8060118"></p>
+</div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0378.html">Procedure for Using Elasticsearch</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0379.html">Elasticsearch Cluster Planning Suggestions</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0380.html">Creating an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0210.html">Accessing Elasticsearch Clusters</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0045.html">Importing Data to an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0398.html">Searching Data in an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0111.html">Enhancing Search Capabilities for Elasticsearch Clusters</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0411.html">Configuring Networking for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0269.html">Backing up and Restoring the Data of an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0414.html">Scaling an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0186.html">Upgrading the Version of an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0009.html">Managing Elasticsearch Clusters</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0091.html">Managing Index Policies for an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0422.html">Elasticsearch Cluster Monitoring and Log Management</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0050.html">Viewing Elasticsearch Cluster Audit Logs</a></strong><br>
+</li>
+</ul>
+</div>
+

docs/css/umn/css_01_0210.html

@@ -0,0 +1,35 @@
+<a name="css_01_0210"></a><a name="css_01_0210"></a>
+
+
+  <h1 class="topictitle1">Accessing Elasticsearch Clusters</h1>
+
+  <div id="body0000001555591537"><p id="css_01_0210__p8060118"></p>
+</div>
+
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0381.html">Elasticsearch Cluster Access Methods</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0382.html">Logging In to an Elasticsearch Cluster Using Kibana</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0383.html">Logging In to an Elasticsearch Cluster Through Cerebro</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0384.html">Accessing an Elasticsearch Cluster Using cURL Commands</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0385.html">Accessing an Elasticsearch Cluster Using Java</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0390.html">Accessing an Elasticsearch Cluster Using Python</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0391.html">Accessing an Elasticsearch Cluster Through the MRS Hive Client</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0392.html">Accessing an Elasticsearch Cluster Using Go</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0393.html">Accessing an Elasticsearch Cluster Using LDAP</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0207.html">Using Elasticsearch for Data Search</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0266.html

@@ -0,0 +1,64 @@
+<a name="css_01_0266"></a><a name="css_01_0266"></a>
+
+<h1 class="topictitle1">Restoring the Data of an Elasticsearch Cluster Using a Snapshot</h1>
+<div id="body0000001583300810"><p id="css_01_0266__en-us_topic_0000001268314505_li276715741117p0">Restore the data captured by a cluster snapshot to the current cluster or another eligible cluster.</p>
+<div class="section" id="css_01_0266__section79171215132210"><h4 class="sectiontitle">Constraints</h4><ul id="css_01_0266__en-us_topic_0000001268314505_ul537343941414"><li id="css_01_0266__en-us_topic_0000001268314505_li187671653184018">Cluster snapshots will increase CPU usage and disk I/O. You are advised to take cluster snapshots during off-peak hours.</li><li id="css_01_0266__en-us_topic_0000001268314505_li17941828132019">If a cluster is in the <span class="parmname" id="css_01_0266__parmname81961837154011"><b>Unavailable</b></span> state, you can use the cluster snapshot function only to restore the cluster or view snapshot information.</li><li id="css_01_0266__en-us_topic_0000001268314505_li19928141414179">While you are creating a snapshot for a cluster or restoring it using one, you can perform certain operations, including scaling out the cluster (except when the cluster is the destination of a restoration operation), accessing Kibana, viewing metrics, and deleting other snapshots. However, you cannot perform the following operations: restarting or deleting the cluster, deleting a snapshot that is in the <strong id="css_01_0266__css_01_0267_b1784545517509">Creating</strong> or <strong id="css_01_0266__css_01_0267_b8845175517504">Restoring</strong> state, and creating or restoring another snapshot. While a snapshot is being created or restored for a cluster, any automatic snapshot creation task initiated for that cluster will be canceled.</li><li id="css_01_0266__en-us_topic_0000001268314505_li21323231302">Cluster data cannot be queried during snapshot restoration.</li><li id="css_01_0266__en-us_topic_0000001268314505_li61869019106">The destination and source clusters must have the same shards.</li><li id="css_01_0266__en-us_topic_0000001268314505_li116421184317">The version of the destination cluster must be the same as or later than that of the source cluster.</li></ul>
+</div>
+<div class="section" id="css_01_0266__section207841017172319"><h4 class="sectiontitle">Prerequisites</h4><ul id="css_01_0266__ul1470516593284"><li id="css_01_0266__li129143033815">The snapshot list contains snapshots whose <strong id="css_01_0266__b101641456437">Snapshot Status</strong> is <strong id="css_01_0266__b085013485439">Available</strong>. Storing snapshots in an OBS bucket may incur additional fees. For details, see section "Billing Overview" in <em id="css_01_0266__i201851812185717">OBS User Guide</em>.</li></ul>
+</div>
+<div class="section" id="css_01_0266__en-us_topic_0000001268314505_section16538152014387"><h4 class="sectiontitle">Restoring Data</h4><ol id="css_01_0266__en-us_topic_0000001268314505_ol842420532406"><li id="css_01_0266__li158485575103">Log in to the CSS management console.</li><li id="css_01_0266__en-us_topic_0000001268314505_li928020151910">On the <span class="wintitle" id="css_01_0266__css_01_0267_en-us_topic_0000001268314505_wintitle145601009549"><b>Clusters</b></span> page, click the name of the target cluster. In the navigation pane on the left, choose <strong id="css_01_0266__css_01_0267_b17731925141311">Cluster Snapshots</strong>.</li><li id="css_01_0266__en-us_topic_0000001268314505_li16424353174016">In the <strong id="css_01_0266__b1506770612112155">Snapshots</strong> area, locate the row that contains the snapshot you want to restore and click <span class="uicontrol" id="css_01_0266__uicontrol1176334612112155"><b>Restore</b></span> in the <span class="parmname" id="css_01_0266__parmname869257988112155"><b>Operation</b></span> column.</li><li id="css_01_0266__en-us_topic_0000001268314505_li115316101430">On the <strong id="css_01_0266__b713244478112155">Restore</strong> page, set restoration parameters.
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0266__table125132619300" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Restoration settings</caption><thead align="left"><tr id="css_01_0266__row195242693014"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.2.4.2.2.3.1.1"><p id="css_01_0266__p145210263309">Parameter</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.4.2.4.2.2.3.1.2"><p id="css_01_0266__p95232614309">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="css_01_0266__row552162612306"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.4.2.2.3.1.1 "><p id="css_01_0266__p3521126123019">Index</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.4.2.2.3.1.2 "><p id="css_01_0266__p14529267301">Specify the name of the index you want to restore.</p>
+<p id="css_01_0266__p885364485710">Constraints:</p>
+<ul id="css_01_0266__ul14857204485715"><li id="css_01_0266__li1457495018578">The value is a string of 0 to 1024 characters that cannot contain uppercase letters, spaces, or the following special characters: <span class="parmvalue" id="css_01_0266__parmvalue88078315118"><b>"\&lt;|&gt;/?</b></span>.</li><li id="css_01_0266__li14815175595713">When restoring an index whose name is prefixed with <strong id="css_01_0266__b1596625814110">.kibana</strong>, the index name must be specified.</li><li id="css_01_0266__li1481518555579">The <strong id="css_01_0266__b56871981928">.opendistro_security</strong> index cannot be restored.</li></ul>
+<p id="css_01_0266__p159122024165811">Value range:</p>
+<ul id="css_01_0266__ul357110392584"><li id="css_01_0266__li12865124185813">You can use an asterisk (*) to match multiple indexes. For example, <strong id="css_01_0266__b107465311723">index*</strong> indicates that all indexes with the prefix <strong id="css_01_0266__b1774618315211">index</strong> will be restored. When an asterisk (*) is used for index matching, the <strong id="css_01_0266__b6979115315311">.opendistro_security</strong> index and any system indexes whose name is prefixed with <strong id="css_01_0266__b76571923142">.kibana</strong> are filtered out by default.</li><li id="css_01_0266__li9865134135820">You can restore indexes by specifying their names, for example, <span class="parmvalue" id="css_01_0266__parmvalue148652041165817"><b>index1,index2,index3</b></span>.</li></ul>
+<p id="css_01_0266__p1935114112596">Default value:</p>
+<p id="css_01_0266__p714954175910">By default, this parameter is left blank. That is, no index name is specified, and all indexes will be restored.</p>
+</td>
+</tr>
+<tr id="css_01_0266__row115242613308"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.4.2.2.3.1.1 "><p id="css_01_0266__p145222614305">Rename Pattern</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.4.2.2.3.1.2 "><p id="css_01_0266__p185212693011">Index name matching rule. Enter a regular expression. Indexes that match the regular expression will be restored. The default value <span class="parmvalue" id="css_01_0266__parmvalue1483212953120"><b>index_(.+)</b></span> indicates all indexes. The value is a string of 0 to 1024 characters that cannot contain uppercase letters, spaces, or the following special characters: <span class="parmvalue" id="css_01_0266__parmvalue16684173114513"><b>"\&lt;|&gt;/?,</b></span>.</p>
+<div class="note" id="css_01_0266__note849419163219"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_01_0266__p154991918323">The <span class="parmname" id="css_01_0266__parmname12472130213378"><b>Rename Pattern</b></span> and <span class="parmname" id="css_01_0266__parmname9618277293378"><b>Rename Replacement</b></span> take effect only when they are both configured at the same time.</p>
+</div></div>
+</td>
+</tr>
+<tr id="css_01_0266__row175219263308"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.4.2.2.3.1.1 "><p id="css_01_0266__p115212266303">Rename Replacement</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.4.2.2.3.1.2 "><p id="css_01_0266__p11521426113012">Rule for index renaming. The default value <span class="parmvalue" id="css_01_0266__parmvalue1380539963378"><b>restored_index_$1</b></span> indicates that <span class="parmvalue" id="css_01_0266__parmvalue627685363378"><b>restored_</b></span> will be added to the beginning of the names of all restored indexes. The value is a string of 0 to 1024 characters that cannot contain uppercase letters, spaces, or the following special characters: <span class="parmvalue" id="css_01_0266__parmvalue0954937165613"><b>"\&lt;|&gt;/?,</b></span>.</p>
+<div class="note" id="css_01_0266__note72451520103217"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="css_01_0266__p12451420113220">The <span class="parmname" id="css_01_0266__parmname165063235213"><b>Rename Pattern</b></span> and <span class="parmname" id="css_01_0266__parmname965012324524"><b>Rename Replacement</b></span> take effect only when they are both configured at the same time.</p>
+</div></div>
+</td>
+</tr>
+<tr id="css_01_0266__row45219268302"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.2.4.2.2.3.1.1 "><p id="css_01_0266__p19522264302">Cluster</p>
+</td>
+<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.4.2.4.2.2.3.1.2 "><p id="css_01_0266__p2065111428326">Select the cluster where you want to restore the data to. You can select the current cluster or another.</p>
+<ul id="css_01_0266__ul19225330115414"><li id="css_01_0266__li0225173095417">You must specify a cluster whose status is <span class="parmname" id="css_01_0266__parmname10174206013378"><b>Available</b></span>. If the status of the current cluster is <span class="parmname" id="css_01_0266__parmname1101508913378"><b>Unavailable</b></span>, you cannot restore the snapshot to the current cluster.</li><li id="css_01_0266__li222543015413">When you choose to restore data to another cluster, make sure the target cluster has the same or later version than the current cluster, and that the two clusters are in the same region. After a frozen index is restored using a snapshot, the index is stored on the local node and is read-only by default. To make it writable, run the following command to configure the index:<pre class="screen" id="css_01_0266__screen151451928165410">PUT <em id="css_01_0266__i14601158155420">index_name</em>/_settings
+{
+  "index.blocks.write": null
+}</pre>
+</li><li id="css_01_0266__li722563012541">If the destination cluster has same-name indexes as the source cluster, data in these indexes will be overwritten. Exercise caution when performing this operation.</li></ul>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="fignone" id="css_01_0266__en-us_topic_0000001268314505_fig128071912118"><span class="figcap"><b>Figure 1 </b>Restoring a snapshot</span><br><span><img id="css_01_0266__en-us_topic_0000001268314505_image1343149208" src="en-us_image_0000001938218888.png"></span></div>
+</li><li id="css_01_0266__en-us_topic_0000001268314505_li14267162211412">Click <span class="uicontrol" id="css_01_0266__en-us_topic_0000001268314505_uicontrol2604112619101"><b>OK</b></span>. If restoration succeeds, <span class="parmname" id="css_01_0266__parmname11512337914"><b>Task Status</b></span> of the snapshot in the snapshot list will change to <span class="parmvalue" id="css_01_0266__parmvalue1551123318916"><b>Restoration succeeded</b></span>, and the data of indexes is generated according to the snapshot information.<div class="fignone" id="css_01_0266__en-us_topic_0000001268314505_fig25181595119"><span class="figcap"><b>Figure 2 </b>Successful restoration</span><br><span><img id="css_01_0266__en-us_topic_0000001268314505_image168371133144215" src="en-us_image_0000001938378264.png"></span></div>
+</li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0269.html">Backing up and Restoring the Data of an Elasticsearch Cluster</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0269.html

@@ -0,0 +1,19 @@
+<a name="css_01_0269"></a><a name="css_01_0269"></a>
+
+<h1 class="topictitle1">Backing up and Restoring the Data of an Elasticsearch Cluster</h1>
+<div id="body0000001633221741"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0267.html">Creating a Snapshot to Back Up the Data of an Elasticsearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0266.html">Restoring the Data of an Elasticsearch Cluster Using a Snapshot</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0271.html">Deleting an Elasticsearch Cluster Snapshot</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0207.html">Using Elasticsearch for Data Search</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0271.html

@@ -0,0 +1,17 @@
+<a name="css_01_0271"></a><a name="css_01_0271"></a>
+
+<h1 class="topictitle1">Deleting an Elasticsearch Cluster Snapshot</h1>
+<div id="body0000001583146906"><p id="css_01_0271__p1665913299357">If you no longer need a snapshot, delete it to reclaim storage space.</p>
+<p id="css_01_0271__p920673518366">If automatic snapshot creation is enabled, snapshots that are automatically created cannot be deleted manually. Instead, the system automatically deletes these snapshots on the half hour after the time specified by <span class="parmname" id="css_01_0271__en-us_topic_0000001268314505_parmname17631453101219"><b>Retention Period (days)</b></span> elapses.</p>
+<p id="css_01_0271__p1383554643510">If you disable automatic snapshot creation while retaining the automatically created snapshots, then you can manually delete these snapshots later. If you do not manually delete the automatically created snapshots but later enable automatic snapshot creation again, then all these snapshots (with <span class="parmname" id="css_01_0271__parmname4125100393371"><b>Snapshot Type</b></span> set to <strong id="css_01_0271__b1645962223371">Automated</strong> in the snapshot list of the cluster) can only be automatically deleted by the system.</p>
+<div class="note" id="css_01_0271__en-us_topic_0000001268314505_note1891143715433"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="css_01_0271__en-us_topic_0000001268314505_p8918371438">After a snapshot is deleted, its data cannot be restored. Exercise caution.</p>
+</div></div>
+<div class="section" id="css_01_0271__section189377243820"><h4 class="sectiontitle">Manually Deleting a Snapshot</h4><ol id="css_01_0271__en-us_topic_0000001268314505_ol14193131411435"><li id="css_01_0271__li158485575103">Log in to the CSS management console.</li><li id="css_01_0271__en-us_topic_0000001268314505_li928020151910">On the <span class="wintitle" id="css_01_0271__css_01_0267_en-us_topic_0000001268314505_wintitle145601009549"><b>Clusters</b></span> page, click the name of the target cluster. In the navigation pane on the left, choose <strong id="css_01_0271__css_01_0267_b17731925141311">Cluster Snapshots</strong>.</li><li id="css_01_0271__en-us_topic_0000001268314505_li82303564491">In the snapshot list, locate the snapshot you want to delete.</li><li id="css_01_0271__en-us_topic_0000001268314505_li319341419439">Click <strong id="css_01_0271__b1634928769112145">Delete</strong> in the <strong id="css_01_0271__b1147644748112145">Operation</strong> column. In the displayed dialog box, confirm the snapshot information, manually type in <strong id="css_01_0271__b12173151714287">DELETE</strong>, and click <strong id="css_01_0271__b1169702719112145">OK</strong>.</li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0269.html">Backing up and Restoring the Data of an Elasticsearch Cluster</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0273.html

@@ -0,0 +1,40 @@
+<a name="css_01_0273"></a><a name="css_01_0273"></a>
+
+<h1 class="topictitle1">Using OpenSearch for Data Search</h1>
+<div id="body0000001633949601"><p id="css_01_0273__p8060118"></p>
+</div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0438.html">Procedure for Using OpenSearch</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0439.html">OpenSearch Cluster Planning Suggestions</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0275.html">Creating an OpenSearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0288.html">Accessing an OpenSearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0453.html">Importing Data to an OpenSearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0459.html">Searching Data in an OpenSearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0462.html">Enhancing Search Capabilities for OpenSearch Clusters</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0475.html">Configuring Networking for an OpenSearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0479.html">Backing up and Restoring the Data of an OpenSearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0483.html">Scaling an OpenSearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0186_0.html">Upgrading the Version of an OpenSearch Cluster</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0486.html">Managing OpenSearch Clusters</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0501.html">Managing Index Policies for OpenSearch Clusters</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0504.html">OpenSearch Cluster Monitoring and Log Management</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0509.html">Viewing OpenSearch Cluster Audit Logs</a></strong><br>
+</li>
+</ul>
+</div>
+

docs/css/umn/css_01_0288.html

@@ -0,0 +1,24 @@
+<a name="css_01_0288"></a><a name="css_01_0288"></a>
+
+<h1 class="topictitle1">Accessing an OpenSearch Cluster</h1>
+<div id="body0000001583669892"><p id="css_01_0288__p8060118"></p>
+</div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="css_01_0440.html">OpenSearch Cluster Access Methods</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0441.html">Logging In to an OpenSearch Cluster Using OpenSearch Dashboards</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0442.html">Logging In to an OpenSearch Cluster Through Cerebro</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0443.html">Accessing an OpenSearch Cluster Using cURL Commands</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="css_01_0452.html">Accessing an OpenSearch Cluster Using LDAP</a></strong><br>
+</li>
+</ul>
+
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0273.html">Using OpenSearch for Data Search</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0319.html

@@ -0,0 +1,43 @@
+<a name="css_01_0319"></a><a name="css_01_0319"></a>
+
+<h1 class="topictitle1">Creating and Managing OpenSearch Index Policies</h1>
+<div id="body8662426"><p id="css_01_0319__p17682103664518">This topic describes how to create and manage index lifecycle policies for OpenSearch clusters.</p>
+<div class="section" id="css_01_0319__section570781916170"><h4 class="sectiontitle">Context</h4><p id="css_01_0319__p9627569502">Index State Management (ISM) of OpenSearch is a plugin that allows you to automate periodic, administrative operations on indexes by triggering them based on changes in the index age, index size, or number of documents. With ISM, you can define custom policies to automate index rollovers and deletion, thus optimizing cluster search performance or cutting storage costs. The procedure for using ISM is as follows:</p>
+<ol id="css_01_0319__ol182015215117"><li id="css_01_0319__li202010218518"><a href="#css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_section779154094817">Creating an Index Lifecycle Policy</a>: Create an index lifecycle policy on OpenSearch Dashboards.</li><li id="css_01_0319__li695231615510"><a href="#css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_section11451321182815">Associating Indexes with a Lifecycle Policy</a>: Associate indexes with a lifecycle policy.</li><li id="css_01_0319__li148518914513"><a href="#css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_section87941257192">Managing Index Policies</a>: Modify, retry, and change index lifecycle policies.</li></ol>
+<p id="css_01_0319__p18766571223">For more information about ISM, see <a href="https://opendistro.github.io/for-elasticsearch-docs/docs/im/ism/" target="_blank" rel="noopener noreferrer">Index State Management</a>.</p>
+<p id="css_01_0319__p284113182719"><a href="css_01_0502.html">Automating Index Rollover in an OpenSearch Cluster Through Index Lifecycle Management</a> describes a common use case for index lifecycle policies.</p>
+</div>
+<div class="section" id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_section779154094817"><a name="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_section779154094817"></a><a name="en-us_topic_0000001477739392_en-us_topic_0000001268154473_section779154094817"></a><h4 class="sectiontitle">Creating an Index Lifecycle Policy</h4><ol id="css_01_0319__ol109311171818"><li id="css_01_0319__li8872182414613">Log in to the CSS management console.</li><li id="css_01_0319__li106698311811">Choose <strong id="css_01_0319__b159523148507">Clusters</strong> &gt; <strong id="css_01_0319__b8410918185011">OpenSearch</strong>, find the cluster that you want to log in to, and click <span class="parmvalue" id="css_01_0319__parmvalue0816375498"><b>Access Kibana</b></span> in the <strong id="css_01_0319__b1981614794910">Operation</strong> column.</li><li id="css_01_0319__li8978162804611">Log in to OpenSearch Dashboards, and choose <span class="wintitle" id="css_01_0319__wintitle203432518508"><b>Index Management</b></span> on the left. The index management page is displayed.</li><li id="css_01_0319__li11840140714">Click <strong id="css_01_0319__b1967165945017">Create policy</strong> to create an index policy. In the <strong id="css_01_0319__b53667313512">Configuration method</strong> dialog box, select <strong id="css_01_0319__b93661738518">JSON editor</strong> and click <strong id="css_01_0319__b1536673125119">Continue</strong>. The page for creating an index policy is displayed.<ul id="css_01_0319__ul226466194715"><li id="css_01_0319__li12459122884713"><span class="parmname" id="css_01_0319__parmname1102005413"><b>Policy ID</b></span>: use a custom policy name. </li><li id="css_01_0319__li426586144717"><span class="parmname" id="css_01_0319__parmname108321546544"><b>Define policy</b></span>: define a custom policy based on the reference example provided.<div class="fignone" id="css_01_0319__fig151344549115"><span class="figcap"><b>Figure 1 </b>Configuring a policy</span><br><span><img id="css_01_0319__image1013414545115" src="en-us_image_0000001999761193.png"></span></div>
+</li></ul>
+</li><li id="css_01_0319__li46811119210">Click <strong id="css_01_0319__b9434173695211">Create</strong>.</li></ol>
+</div>
+<div class="section" id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_section11451321182815"><a name="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_section11451321182815"></a><a name="en-us_topic_0000001477739392_en-us_topic_0000001268154473_section11451321182815"></a><h4 class="sectiontitle">Associating Indexes with a Lifecycle Policy</h4><p id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_p85771435104818">You can bind a policy to one or more indexes, or associate a policy with an index template, so that the policy will be applied to all indexes created using this index template.</p>
+<ul id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_ul14378105912527"><li id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_li6378185910526"><strong id="css_01_0319__b3259501141">Method 1: OpenSearch Dashboards CLI</strong><p id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_p193161652175311">On the <span class="uicontrol" id="css_01_0319__uicontrol1472842691517"><b>Dev Tools</b></span> page of the <strong id="css_01_0319__b772815269152">OpenSearch Dashboards</strong>, run the following command to associate a policy ID with an index template:</p>
+<pre class="screen" id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_screen25651257165413">PUT _template/<em id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_i2566165715544">&lt;template_name&gt;</em><strong id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_b1756635712545"> </strong>
+{
+    "index_patterns": ["index_name-*"],
+    "settings": {
+        "opendistro.index_state_management.policy_id": "<em id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_i13566185719549">policy_id</em>"
+    }
+}</pre>
+<ul id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_ul2017887556"><li id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_li5171383553"><em id="css_01_0319__i188401528163120"><strong id="css_01_0319__b1283915282318">&lt;template_name&gt;</strong></em>: Replace it with the name of a created index template.</li><li id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_li161711813558"><em id="css_01_0319__i18657431143112"><strong id="css_01_0319__b0656431183113">policy_id</strong></em>: Replace it with a custom policy ID.</li></ul>
+<p id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_p14340164895514">For details about how to create an index template, see <a href="https://opendistro.github.io/for-elasticsearch-docs/docs/elasticsearch/index-templates/#create-template" target="_blank" rel="noopener noreferrer">Index Templates</a>.</p>
+</li><li id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_li1055631185314"><strong id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_b1185763914517">Method 2: OpenSearch Dashboards Console</strong><ol id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_ol1325191810517"><li id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_li625119181453">On the <span class="wintitle" id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_wintitle23824172612"><b>Index Management</b></span> page of the <strong id="css_01_0319__b1912917455324">OpenSearch Dashboards</strong>, choose <strong id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_b12511018252">Indices</strong>.<div class="fignone" id="css_01_0319__fig144927440118"><span class="figcap"><b>Figure 2 </b>Choosing Indices</span><br><span><img id="css_01_0319__image53009336117" src="en-us_image_0000001965497185.png"></span></div>
+</li><li id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_li1925216184512">In the <strong id="css_01_0319__b1484814218339">Indices</strong> list, select one or more indexes to which you want to bind a policy.</li><li id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_li125212181054">Click <strong id="css_01_0319__b166851312175412">Apply policy</strong> in the upper right corner. In the displayed dialog box, select a policy ID.<div class="fignone" id="css_01_0319__fig1493917576136"><span class="figcap"><b>Figure 3 </b>Apply policy</span><br><span><img id="css_01_0319__image1398894241310" src="en-us_image_0000001938218604.png"></span></div>
+<div class="fignone" id="css_01_0319__fig2986201519175"><span class="figcap"><b>Figure 4 </b>Selecting a policy</span><br><span><img id="css_01_0319__image1298610152174" src="en-us_image_0000001963261856.png"></span></div>
+</li><li id="css_01_0319__li669961645919">Click <strong id="css_01_0319__b1645616913384">Apply</strong>.<p id="css_01_0319__p15699151665919">After you bind a policy to an index, ISM creates a job that runs every 5 minutes by default to execute the policy, check criteria, and change index states.</p>
+</li></ol>
+</li></ul>
+</div>
+<div class="section" id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_section87941257192"><a name="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_section87941257192"></a><a name="en-us_topic_0000001477739392_en-us_topic_0000001268154473_section87941257192"></a><h4 class="sectiontitle">Managing Index Policies</h4><ol id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_ol15110119124"><li id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_li4512211151214">On the <strong id="css_01_0319__b38351615124220">Index Management</strong> page of the OpenSearch Dashboards, choose <strong id="css_01_0319__b14685839174215">Managed Indices</strong>.<p id="css_01_0319__p10946547193112">The displayed page shows index policies configured for the current cluster.</p>
+</li><li id="css_01_0319__li158123449312">Manage policies in the index policy list.<ul id="css_01_0319__ul9908193411329"><li id="css_01_0319__li590823415323">For a policy whose status is abnormal, click <strong id="css_01_0319__b871416304516">Retry policy</strong>.</li><li id="css_01_0319__li15527184110338">To update a policy for an index, select the associated index, and click <strong id="css_01_0319__b1586415412304">Change policy</strong>. After the policy is updated, click <strong id="css_01_0319__b28641354133019">Change</strong> to apply the new policy.</li><li id="css_01_0319__li34482542391">To remove a policy from an index, select the index, and click <strong id="css_01_0319__b25571550162915">Remove policy</strong>. In the displayed dialog box, click <strong id="css_01_0319__b9558195012294">Remove</strong>.</li></ul>
+</li></ol>
+<p id="css_01_0319__en-us_topic_0000001477739392_en-us_topic_0000001268154473_p1509136183817">For details, see <a href="https://opendistro.github.io/for-elasticsearch-docs/docs/im/ism/" target="_blank" rel="noopener noreferrer">Index State Management</a>.</p>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0501.html">Managing Index Policies for OpenSearch Clusters</a></div>
+</div>
+</div>
+

docs/css/umn/css_01_0329.html

@@ -0,0 +1,74 @@
+<a name="css_01_0329"></a><a name="css_01_0329"></a>
+
+<h1 class="topictitle1">Creating Users for an OpenSearch Cluster and Granting Cluster Access</h1>
+<div id="body8662426"><p id="css_01_0329__p17682103664518">CSS limits access to security-mode clusters to authorized users only. When creating a security-mode cluster, an administrator account must be created. This administrator account can use OpenSearch Dashboards to add new users for the cluster and grant them the required permissions.</p>
+<div class="section" id="css_01_0329__section14743123515531"><h4 class="sectiontitle">Context</h4><p id="css_01_0329__p13262512159">CSS uses the opendistro_security plug-in to provide security cluster capabilities. The opendistro_security plug-in is built based on the RBAC model. RBAC involves three core concepts: user, action, and role. RBAC simplifies the relationship between users and actions, simplifies permission management, and facilitates permission expansion and maintenance. The following figure shows the relationship between the three.</p>
+<div class="fignone" id="css_01_0329__fig17424102121615"><span class="figcap"><b>Figure 1 </b>User, action, and role</span><br><span><img id="css_01_0329__image1422725243218" src="en-us_image_0000001963190104.png"></span></div>
+
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_table1130152932111" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters for creating and authorizing a user on OpenSearch Dashboards</caption><thead align="left"><tr id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_row913192910216"><th align="left" class="cellrowborder" valign="top" width="19.759999999999998%" id="mcps1.3.2.4.2.3.1.1"><p id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_p11131129172116">Parameter</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="80.24%" id="mcps1.3.2.4.2.3.1.2"><p id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_p613112916211">Description</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_row4131629172119"><td class="cellrowborder" valign="top" width="19.759999999999998%" headers="mcps1.3.2.4.2.3.1.1 "><p id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_p169320115226">Permission</p>
+</td>
+<td class="cellrowborder" valign="top" width="80.24%" headers="mcps1.3.2.4.2.3.1.2 "><p id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_p1193210115228">A single permission, for example, creating an index (for example, <strong id="css_01_0329__b114492720428">indices:admin/create</strong>).</p>
+</td>
+</tr>
+<tr id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_row1513182932110"><td class="cellrowborder" valign="top" width="19.759999999999998%" headers="mcps1.3.2.4.2.3.1.1 "><p id="css_01_0329__p2730113274814">Action group</p>
+</td>
+<td class="cellrowborder" valign="top" width="80.24%" headers="mcps1.3.2.4.2.3.1.2 "><p id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_p1093216119229">An action group is a group of permissions. For example, the predefined <strong id="css_01_0329__b14987453191812">SEARCH</strong> action group grants roles permissions to use <strong id="css_01_0329__b149871253191818">_search</strong> and <strong id="css_01_0329__b119881253121818">_msearchAPI</strong>.</p>
+</td>
+</tr>
+<tr id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_row1313115297218"><td class="cellrowborder" valign="top" width="19.759999999999998%" headers="mcps1.3.2.4.2.3.1.1 "><p id="css_01_0329__p133421830164820">Role</p>
+</td>
+<td class="cellrowborder" valign="top" width="80.24%" headers="mcps1.3.2.4.2.3.1.2 "><p id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_p18932711152220">A role is a combination of permissions or action groups, including operation permissions on clusters, indexes, documents, or fields.</p>
+</td>
+</tr>
+<tr id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_row1413182914217"><td class="cellrowborder" valign="top" width="19.759999999999998%" headers="mcps1.3.2.4.2.3.1.1 "><p id="css_01_0329__p2696326114814">User</p>
+</td>
+<td class="cellrowborder" valign="top" width="80.24%" headers="mcps1.3.2.4.2.3.1.2 "><p id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_p093351115224">A user can send operation requests to an OpenSearch cluster. The user has credentials such as username and password, and zero or multiple backend roles and custom attributes.</p>
+</td>
+</tr>
+<tr id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_row6131829112117"><td class="cellrowborder" valign="top" width="19.759999999999998%" headers="mcps1.3.2.4.2.3.1.1 "><p id="css_01_0329__p136582364811">Role mapping</p>
+</td>
+<td class="cellrowborder" valign="top" width="80.24%" headers="mcps1.3.2.4.2.3.1.2 "><p id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_p10933171182210">A user will be assigned a role after successful authentication. Role mapping means to map a role to a user (or a backend role). For example, the mapping from <strong id="css_01_0329__b2023771394319">kibana_user</strong> (role) to <strong id="css_01_0329__b7238713104310">jdoe</strong> (user) means that John Doe obtains all permissions of <strong id="css_01_0329__b42381013104316">kibana_user</strong> after being authenticated by <strong id="css_01_0329__b1223801317437">kibana_user</strong>. Similarly, the mapping from <strong id="css_01_0329__b167081758152612">all_access</strong> (role) to <strong id="css_01_0329__b47091158112619">admin</strong> (backend role) means that any user with the backend role <strong id="css_01_0329__b1671010589261">admin</strong> (from the LDAP/Active Directory server) has all the permissions of role <strong id="css_01_0329__b10710958162613">all_access</strong> after being authenticated. You can map each role to multiple users or backend roles.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+<p id="css_01_0329__p1770883133318">On OpenSearch Dashboards, you can configure user permissions on the OpenSearch cluster under <strong id="css_01_0329__b455304334416">Security</strong> to implement fine-grained access control at four levels: cluster, index, document, and field.</p>
+<p id="css_01_0329__p1884939342">Users can be added or deleted for a cluster, and mapped to roles. This way, you assign roles to users.</p>
+<p id="css_01_0329__p456112285323">With role mapping, you can configure the members of each role and assign roles to users based on usernames, backend roles, and host names. For each role, you can configure cluster, index, and document access permissions, as well as the permission to use OpenSearch Dashboards.</p>
+<p id="css_01_0329__p185614287325">For more about security configuration for a security-mode cluster and the detailed guide, see the official OpenSearch document <a href="https://opendistro.github.io/for-elasticsearch-docs/docs/security/" target="_blank" rel="noopener noreferrer">About Security in OpenSearch</a>.</p>
+</div>
+<div class="section" id="css_01_0329__section72681840185618"><h4 class="sectiontitle">Constraints</h4><p id="css_01_0329__p16490174215503">You can customize the username, role name, and tenant name in the <strong id="css_01_0329__b17299028182620">OpenSearch Dashboards</strong>.</p>
+</div>
+<div class="section" id="css_01_0329__en-us_topic_0000001528379273_en-us_topic_0000001223434440_section12163507442"><h4 class="sectiontitle">Creating a User and Granting Permissions</h4><ol id="css_01_0329__ol1068888105119"><li id="css_01_0329__li46882825113"><span>Log in to the OpenSearch Dashboards.</span><p><ol type="a" id="css_01_0329__ol146186208523"><li id="css_01_0329__li19618112013520">Log in to the CSS management console.</li><li id="css_01_0329__li17698202175313">In the navigation pane, choose <strong id="css_01_0329__b5633657122620">Clusters</strong> &gt; <strong id="css_01_0329__b863455732620">OpenSearch</strong>.</li><li id="css_01_0329__li797714715317">Choose <strong id="css_01_0329__b1324313262917">Clusters</strong> in the navigation pane. On the <span class="uicontrol" id="css_01_0329__uicontrol42436212914"><b>Clusters</b></span> page, locate the target cluster and click <span class="uicontrol" id="css_01_0329__uicontrol172433212916"><b>Access Kibana</b></span> in the <strong id="css_01_0329__b1624402152916">Operation</strong> column.</li><li id="css_01_0329__li1520983912521">Enter the administrator username and password to log in to the OpenSearch Dashboards.<ul id="css_01_0329__ul1374935705111"><li id="css_01_0329__li874925725116">Username: <strong id="css_01_0329__b1736013155503">admin</strong> (default administrator account name)</li><li id="css_01_0329__li674905795114">Password: Enter the administrator password you set when creating the cluster in security mode.<div class="fignone" id="css_01_0329__fig37491657115112"><span class="figcap"><b>Figure 2 </b>Logging in to OpenSearch</span><br><span><img id="css_01_0329__image6610153603713" src="en-us_image_0000001938378000.png"></span></div>
+</li></ul>
+</li></ol>
+</p></li><li id="css_01_0329__li1135162925115"><span>Creating a user.</span><p><ol type="a" id="css_01_0329__ol11749151913567"><li id="css_01_0329__li1643913311569">On the <strong id="css_01_0329__b158711634121014">OpenSearch Dashboards</strong> page, choose <span class="uicontrol" id="css_01_0329__uicontrol44399315561"><b>Security</b></span>. The <strong id="css_01_0329__b92751642153216">Security</strong> page is displayed.<div class="fignone" id="css_01_0329__fig199111740135616"><span class="figcap"><b>Figure 3 </b>Going to the Security page</span><br><span><img id="css_01_0329__image89119406565" src="en-us_image_0000001965417001.png"></span></div>
+</li><li id="css_01_0329__li1991114015566">Choose <span class="uicontrol" id="css_01_0329__uicontrol195889417167"><b>Internal users</b></span> on the left. The user creation page is displayed.<div class="fignone" id="css_01_0329__fig962416241208"><span class="figcap"><b>Figure 4 </b>Creating a user</span><br><span><img id="css_01_0329__image197931550135918" src="en-us_image_0000001965416993.png"></span></div>
+</li><li id="css_01_0329__li10128204619594">Click <span class="uicontrol" id="css_01_0329__uicontrol357810286163"><b>Create internal user</b></span>. The user information configuration page is displayed.</li><li id="css_01_0329__li135915321345">In the <span class="uicontrol" id="css_01_0329__uicontrol679135714161"><b>Credentials</b></span> area, enter the username and password.<div class="fignone" id="css_01_0329__fig185229441813"><span class="figcap"><b>Figure 5 </b>Entering the username and password</span><br><span><img id="css_01_0329__image109723718616" src="en-us_image_0000001965497221.png"></span></div>
+</li><li id="css_01_0329__li834016289520">Click <span class="uicontrol" id="css_01_0329__uicontrol1237654511159"><b>Create</b></span>. After the user is created, it is displayed in the user list.<div class="fignone" id="css_01_0329__fig6803417387"><span class="figcap"><b>Figure 6 </b>User information</span><br><span><img id="css_01_0329__image12729141883" src="en-us_image_0000001965497225.png"></span></div>
+</li></ol>
+</p></li><li id="css_01_0329__li3498151425619"><span>Create a role and grant permissions to the role.</span><p><ol type="a" id="css_01_0329__ol550032114123"><li id="css_01_0329__li2190145912112">Select <span class="uicontrol" id="css_01_0329__uicontrol19190205911114"><b>Roles</b></span> from the <span class="uicontrol" id="css_01_0329__uicontrol1819025931110"><b>Security</b></span> drop-down list box.</li><li id="css_01_0329__li105009210125">On the <span class="uicontrol" id="css_01_0329__uicontrol176501443168"><b>Roles</b></span> page, click <span class="uicontrol" id="css_01_0329__uicontrol663619611712"><b>Create role</b></span>. The role creation page is displayed.</li><li id="css_01_0329__li16234145210132">In the <span class="uicontrol" id="css_01_0329__uicontrol17241171712"><b>Name</b></span> area, set the role name.<div class="fignone" id="css_01_0329__fig32601740191415"><span class="figcap"><b>Figure 7 </b>Setting a role name</span><br><span><img id="css_01_0329__image159901834141410" src="en-us_image_0000001938218636.png"></span></div>
+</li><li id="css_01_0329__li177392931414">On the <span class="uicontrol" id="css_01_0329__uicontrol1391516416154"><b>Cluster Permissions</b></span> page, set the cluster permission. Set cluster permissions based on service requirements. If this parameter is not specified for a role, the role has no cluster-level permissions.<div class="fignone" id="css_01_0329__fig123901559176"><span class="figcap"><b>Figure 8 </b>Assigning cluster-level permissions</span><br><span><img id="css_01_0329__image12249171151716" src="en-us_image_0000001938377996.png"></span></div>
+</li><li id="css_01_0329__li15981349189">In the <span class="uicontrol" id="css_01_0329__uicontrol1998743188"><b>Index Permissions</b></span> area, set the index permission.<div class="fignone" id="css_01_0329__fig75714326205"><span class="figcap"><b>Figure 9 </b>Setting index permissions</span><br><span><img id="css_01_0329__image1576324207" src="en-us_image_0000001938218644.png"></span></div>
+</li><li id="css_01_0329__li185793217207">On the <strong id="css_01_0329__b11411814123817">Tenant Permissions</strong> page, set role permissions.<div class="fignone" id="css_01_0329__fig19985195582216"><span class="figcap"><b>Figure 10 </b>Role permissions</span><br><span><img id="css_01_0329__image5537144312221" src="en-us_image_0000001938218648.png"></span></div>
+<p id="css_01_0329__p1346385502314">After the setting is complete, you can view the created role on the <span class="uicontrol" id="css_01_0329__uicontrol7446132920171"><b>Roles</b></span> page.</p>
+</li></ol>
+</p></li><li id="css_01_0329__li131909597110"><span>Map a user with a role to bind them.</span><p><ol type="a" id="css_01_0329__ol191901459141112"><li id="css_01_0329__li201901590118">Select <span class="uicontrol" id="css_01_0329__uicontrol125511013203712"><b>Roles</b></span> from the <span class="uicontrol" id="css_01_0329__uicontrol65521713183712"><b>Security</b></span> drop-down list box.</li><li id="css_01_0329__li1484144152815">On the <span class="uicontrol" id="css_01_0329__uicontrol584054742811"><b>Roles</b></span> page, select the role to be mapped. The role mapping page is displayed.<p id="css_01_0329__p1614212299302"><span><img id="css_01_0329__image971510297308" src="en-us_image_0000001938218640.png"></span></p>
+</li><li id="css_01_0329__li14368151116295">On the <span class="uicontrol" id="css_01_0329__uicontrol1994203819171"><b>Mapped users</b></span> tab page, click <span class="uicontrol" id="css_01_0329__uicontrol55131743161712"><b>Map users</b></span> and select the user to be mapped from the <strong id="css_01_0329__b711471318404">users</strong> drop-down list box.<p id="css_01_0329__p124900017321"><span><img id="css_01_0329__image1749410193213" src="en-us_image_0000001965497217.png"></span></p>
+</li><li id="css_01_0329__li1366321319562">Click <strong id="css_01_0329__b664411894013">Map</strong>.</li><li id="css_01_0329__li106481633155610">After the configuration is complete, you can check whether the configuration has taken effect in OpenSearch Dashboards.</li></ol>
+</p></li></ol>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0486.html">Managing OpenSearch Clusters</a></div>
+</div>
+</div>
+