yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/css/umn/css_01_0298.html
zhengxiu 93d856d5c5 css umn 25.6.0 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: zhengxiu <zhengxiu@huawei.com>
Co-committed-by: zhengxiu <zhengxiu@huawei.com>
2025-11-25 11:34:43 +00:00

213 lines
41 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="EN-US_TOPIC_0000001992165625"></a><a name="EN-US_TOPIC_0000001992165625"></a>
<h1 class="topictitle1">Creating Snapshots to Back Up the Data of an OpenSearch Cluster</h1>
<div id="body0000001992165625"><p id="EN-US_TOPIC_0000001992165625__p147220271179">CSS allows you to use snapshots to back up and restore the data of an OpenSearch cluster. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's data. By restoring this snapshot, you can restore the cluster to a previous state. There are two ways to create snapshots: automatic and manual.</p>
<ul id="EN-US_TOPIC_0000001992165625__ul19402916172011"><li id="EN-US_TOPIC_0000001992165625__li18402121692017">Automatic snapshot creation: Snapshots are automatically created daily or weekly based on a preset time schedule, ensuring ongoing data protection. By configuring an automatic snapshot policy, you reduce manual operations while improving backup reliability and efficiency.</li><li id="EN-US_TOPIC_0000001992165625__li10402161652017">Manual snapshot creation: You create snapshots manually for special occasions, for example, prior to a high-risk operation (such as a cluster upgrade). This ensures you can restore data using snapshots in case anything should go wrong. Manual snapshots provide additional flexibility.</li></ul>
<div class="section" id="EN-US_TOPIC_0000001992165625__section1478210053012"><h4 class="sectiontitle">Impact on Billing</h4><p id="EN-US_TOPIC_0000001992165625__p21411143309">When you use snapshots for data backup, the generated snapshots are stored in OBS buckets, which will result in additional costs. For details, see section "Billing" in <em id="EN-US_TOPIC_0000001992165625__i4161165633113">Object Storage Service User Guide</em>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_section148904549202"><h4 class="sectiontitle">Constraints</h4><ul id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_ul84697516211"><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li1646918502114">Creating cluster snapshots will increase CPU load and disk I/O. To minimize impact on system performance, you are advised to schedule it to happen during off-peak hours.</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li1647095112116">When creating or restoring a snapshot, you can only perform certain operations, including accessing OpenSearch Dashboards, viewing metrics, and deleting other snapshots. However, you cannot perform the following operations: modifying configuration, restarting or deleting the cluster, deleting the snapshot that is being created or restored, 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="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li144702517217">When you create the first snapshot in a cluster, a full backup is performed on all data. Subsequent snapshots are all incremental, storing only the changes since the previous snapshot. Because each incremental snapshot relies on its predecessors, you must restore them in the correct sequence.</li><li id="EN-US_TOPIC_0000001992165625__li18487520163417">In a cluster where storage and compute are decoupled, an index that is both frozen and closed cannot be backed up.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_en-us_topic_0000001268314505_section914018211934"><h4 class="sectiontitle">Prerequisites</h4><ul id="EN-US_TOPIC_0000001992165625__ul134431538191914"><li id="EN-US_TOPIC_0000001992165625__li44431538201910">The OBS bucket used for storing cluster snapshots has been created. The OBS bucket must be in the same region as the target OpenSearch cluster, and the storage class must be <strong id="EN-US_TOPIC_0000001992165625__b1058010181453">Standard</strong> or <strong id="EN-US_TOPIC_0000001992165625__b145800183453">Warm</strong>.</li><li id="EN-US_TOPIC_0000001992165625__li2524154001917">The cluster status is <strong id="EN-US_TOPIC_0000001992165625__b1498432314455">Available</strong>.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001992165625__section17492163911395"><h4 class="sectiontitle">Enabling Cluster Snapshots</h4><ol id="EN-US_TOPIC_0000001992165625__ol340913417438"><li id="EN-US_TOPIC_0000001992165625__li1425943574317"><span id="EN-US_TOPIC_0000001992165625__ph1125913358434">Log in to the CSS management console.</span></li><li id="EN-US_TOPIC_0000001992165625__li3259435154320">In the navigation pane on the left, choose <span class="uicontrol" id="EN-US_TOPIC_0000001992165625__uicontrol1025933554318"><b>Clusters &gt; OpenSearch</b></span>.</li><li id="EN-US_TOPIC_0000001992165625__li625933524313">In the cluster list, click the name of the target cluster. The cluster information page is displayed.</li><li id="EN-US_TOPIC_0000001992165625__li102591935124312">Click the <strong id="EN-US_TOPIC_0000001992165625__b185840464993222">Cluster Snapshots</strong> tab, and check whether cluster snapshots are enabled.<ul id="EN-US_TOPIC_0000001992165625__ul1125983524312"><li id="EN-US_TOPIC_0000001992165625__li142592035154314">If they are enabled, skip this step.</li><li id="EN-US_TOPIC_0000001992165625__li425912355430">If they are disabled, go to the next step.</li></ul>
</li><li id="EN-US_TOPIC_0000001992165625__li17259123594314">On the <strong id="EN-US_TOPIC_0000001992165625__b165580056993222">Cluster Snapshots</strong> tab, click <strong id="EN-US_TOPIC_0000001992165625__b155454750693222">Enable Snapshot</strong>. In the displayed dialog box, configure the necessary settings.<div class="fignone" id="EN-US_TOPIC_0000001992165625__fig14305134055410"><span class="figcap"><b>Figure 1 </b>Enable Snapshot</span><br><span><img id="EN-US_TOPIC_0000001992165625__image33061340185414" src="figure/en-us_image_0000002412510977.png"></span></div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001992165625__table1624511262017" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Enabling cluster snapshots</caption><thead align="left"><tr id="EN-US_TOPIC_0000001992165625__row32458129201"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.2.5.4.2.3.1.1"><p id="EN-US_TOPIC_0000001992165625__p5245112112014">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.6.2.5.4.2.3.1.2"><p id="EN-US_TOPIC_0000001992165625__p924561252012">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001992165625__row14245161262012"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.5.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001992165625__p72452128204">OBS Bucket</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.5.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001992165625__p1624541215201">From the drop-down list, select an OBS bucket for storing snapshots.</p>
<p id="EN-US_TOPIC_0000001992165625__p172451112102011">If no OBS buckets meet your requirements, click <strong id="EN-US_TOPIC_0000001992165625__b141542819993222">Create Bucket</strong> to go to the OBS console and create one. For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual/obs/en-us_topic_0045853662.html" target="_blank" rel="noopener noreferrer">Creating a Bucket</a>.</p>
<p id="EN-US_TOPIC_0000001992165625__p3764424203511">To grant an IAM user access to an OBS bucket, you need to grant the <strong id="EN-US_TOPIC_0000001992165625__b73573471293222">GetBucketStoragePolicy</strong>, <strong id="EN-US_TOPIC_0000001992165625__b61579161593222">GetBucketLocation</strong>, <strong id="EN-US_TOPIC_0000001992165625__b138157347093222">ListBucket</strong>, and <strong id="EN-US_TOPIC_0000001992165625__b4833741993222">ListAllMyBuckets</strong> permissions to that user.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001992165625__row2246912112016"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.5.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001992165625__p20247111217206">Backup Path</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.5.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001992165625__p5247412102018">Snapshot storage path in the OBS bucket.</p>
<div class="p" id="EN-US_TOPIC_0000001992165625__p9247612122019">The backup path cannot:<ul id="EN-US_TOPIC_0000001992165625__ul424721222011"><li id="EN-US_TOPIC_0000001992165625__li142471712102016">Contain the following characters: <span class="parmvalue" id="EN-US_TOPIC_0000001992165625__parmvalue4247171210209"><b>\:*?"&lt;&gt;|'{}</b></span></li><li id="EN-US_TOPIC_0000001992165625__li1247512172019">Start with a slash (/).</li><li id="EN-US_TOPIC_0000001992165625__li1824771272019">Start or end with a period (.).</li><li id="EN-US_TOPIC_0000001992165625__li824717121201">Contain more than two consecutive slashes (/) or periods (.).</li><li id="EN-US_TOPIC_0000001992165625__li15247111292016">Exceed 512 characters.</li></ul>
</div>
<div class="caution" id="EN-US_TOPIC_0000001992165625__note11241123820"><span class="cautiontitle"> CAUTION: </span><div class="cautionbody"><p id="EN-US_TOPIC_0000001992165625__p5116417382">Only standard OBS storage can be used to store snapshots. Do not apply OBS lifecycle rules to the backup path.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001992165625__row1224711125204"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.5.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001992165625__p1624718128207">Maximum Backup Rate (per Second)</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.5.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001992165625__p156119814251">The parameter sets the maximum backup rate per node. When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual backup rate may not reach the configured value, as it depends on factors such as OBS performance and disk I/O.</p>
<div class="p" id="EN-US_TOPIC_0000001992165625__p261317818257"><strong id="EN-US_TOPIC_0000001992165625__b66136812256">Value format</strong>: number + unit<ul id="EN-US_TOPIC_0000001992165625__ul361348122514"><li id="EN-US_TOPIC_0000001992165625__li14613789251">Number range: 0–9999</li><li id="EN-US_TOPIC_0000001992165625__li56134812252">Unit: KB, MB, GB, TB, PB, or B</li></ul>
</div>
<p id="EN-US_TOPIC_0000001992165625__p1862298152513"><strong id="EN-US_TOPIC_0000001992165625__b198222355593222">Default value</strong>: 40 MB</p>
<p id="EN-US_TOPIC_0000001992165625__p96231481256">The value 0MB means there is no limit on how fast data is backed up to snapshots. An overly high backup rate may lead to excessive resource usage, which may impact cluster stability. Configure this parameter carefully to maintain optimal performance.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001992165625__row152471012172010"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.5.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001992165625__p1924821292016">Maximum Recovery Rate (per Second)</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.5.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_p11248412132012">The parameter sets the maximum recovery rate per node. When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual recovery rate may not reach the configured value, as it depends on factors such as OBS performance and disk I/O.</p>
<div class="p" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_p202481126205"><strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_b10652145318285">Value format</strong>: number + unit<ul id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_ul17248121262019"><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_li1524841282010">Number range: 0–9999</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_li1724818127204">Unit: KB, MB, GB, TB, PB, or B</li></ul>
</div>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_p5248151218202">The default value is 0MB, indicating no limit.</p>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_p12248161212010">An overly high recovery rate may lead to excessive resource usage, which may impact cluster stability. Configure this parameter carefully to maintain optimal performance.</p>
<div class="p" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_p3248141242016">For OpenSearch clusters, the recovery rate is also limited by the <span class="parmname" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_parmname15800238163313"><b>indices.recovery.max_bytes_per_sec</b></span> parameter.<ul id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_ul82488126205"><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_li624831213208">If <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_b28318617063031">Maximum Recovery Rate (per Second)</strong> is less than <span class="parmname" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_parmname101849150363031"><b>indices.recovery.max_bytes_per_sec</b></span>, the former takes effect.</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_li17249151212200">If <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_b136340841163031">Maximum Recovery Rate (per Second)</strong> is greater than <span class="parmname" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_parmname96203181063031"><b>indices.recovery.max_bytes_per_sec</b></span>, the latter takes effect.</li></ul>
</div>
<div class="note" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_note724916128204"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_en-us_topic_0000002259367421_ul584722891418"><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_en-us_topic_0000002259367421_li34132419147">To check the value of <span class="parmname" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_en-us_topic_0000002259367421_parmname335155191417"><b>indices.recovery.max_bytes_per_sec</b></span>, run the following command:<pre class="screen" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_en-us_topic_0000002259367421_screen52229245157">GET _cluster/settings</pre>
</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_en-us_topic_0000002259367421_li484712811413">To modify <span class="parmname" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_en-us_topic_0000002259367421_parmname111853470113"><b>indices.recovery.max_bytes_per_sec</b></span>, run the following command:<pre class="screen" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002271391397_en-us_topic_0000002259367421_screen33041356101115">PUT _cluster/settings
{
"transient": {
"indices.recovery.max_bytes_per_sec": "100mb"
}
}</pre>
</li></ul>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001992165625__row2249512122013"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.2.5.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001992165625__p4249111213206">IAM Agency</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.2.5.4.2.3.1.2 "><div class="p" id="EN-US_TOPIC_0000001992165625__p1224911262018">Select an IAM agency to grant the current account the permission to access and use OBS. To store snapshots to an OBS bucket, you must have the required OBS access permissions.<ul id="EN-US_TOPIC_0000001992165625__ul142491912172013"><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_li24411155132413">If you are configuring an agency for the first time, click <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_b5976258053247">Automatically Create IAM Agency</strong> to create <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_b187458051553247">css-obs-agency</strong>.</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_li544195515247">If there is an IAM agency automatically created earlier, you can click <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_b99661991253247">One-click authorization</strong> to have the OBS Administrator permissions deleted automatically, and have the following custom policies added automatically instead to implement more refined permissions control.<pre class="screen" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_screen1144145514247">"obs:bucket:GetBucketLocation",
"obs:object:GetObjectVersion",
"obs:object:GetObject",
"obs:object:DeleteObject",
"obs:bucket:HeadBucket",
"obs:bucket:GetBucketStoragePolicy",
"obs:object:DeleteObjectVersion",
"obs:bucket:ListBucketVersions",
"obs:bucket:ListBucket",
"obs:object:PutObject"</pre>
</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_li1144165516246">When OBS buckets use SSE-KMS encryption, the IAM agency must be granted KMS permissions. You can click <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_b29906333953247">Automatically Create IAM Agency</strong> and <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_b25885174953247">One-click authorization</strong> to have the following custom policies created automatically.<pre class="screen" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_screen544117553245">"kms:cmk:create",
"kms:dek:create",
"kms:cmk:get",
"kms:dek:decrypt",
"kms:cmk:list"</pre>
</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_li13441155542414">To use <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_b121154083353247">Automatically Create IAM Agency</strong> and <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_b198014404253247">One-click authorization</strong>, the following minimum permissions are required:<pre class="screen" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_screen9442555102417">"iam:agencies:listAgencies",
"iam:roles:listRoles",
"iam:agencies:getAgency",
"iam:agencies:createAgency",
"iam:permissions:listRolesForAgency",
"iam:permissions:grantRoleToAgency",
"iam:permissions:listRolesForAgencyOnProject",
"iam:permissions:revokeRoleFromAgency",
"iam:roles:createRole"</pre>
</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_li84422554243">To use an IAM agency, the following minimum permissions are required:<pre class="screen" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000002287474002_screen1844215558248">"iam:agencies:listAgencies",
"iam:agencies:getAgency",
"iam:permissions:listRolesForAgencyOnProject",
"iam:permissions:listRolesForAgency"</pre>
</li></ul>
</div>
<div class="warning" id="EN-US_TOPIC_0000001992165625__note5252151292015"><span class="warningtitle"> WARNING: </span><div class="warningbody"><p id="EN-US_TOPIC_0000001992165625__p62526129207">The agency name can contain only letters (case-sensitive), digits, underscores (_), and hyphens (-). Otherwise, the backup will fail.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="p" id="EN-US_TOPIC_0000001992165625__p16891145013">Determine whether to enable automatic snapshot creation based on service needs.<ul id="EN-US_TOPIC_0000001992165625__ul599721816516"><li id="EN-US_TOPIC_0000001992165625__li19971818145116">To enable it, select <span class="parmname" id="EN-US_TOPIC_0000001992165625__parmname176141388501"><b>Automatic Snapshot Creation</b></span>, and configure necessary settings by referring to <a href="#EN-US_TOPIC_0000001992165625__section14478975593">Configuring Automatic Snapshot Creation</a>.</li><li id="EN-US_TOPIC_0000001992165625__li10997518155117">To disable it, unselect <span class="parmname" id="EN-US_TOPIC_0000001992165625__parmname144711287511"><b>Automatic Snapshot Creation</b></span>, in which case, you will need to manually create snapshots.</li></ul>
</div>
</li><li id="EN-US_TOPIC_0000001992165625__li12631490446">Click <strong id="EN-US_TOPIC_0000001992165625__b15824690493222">OK</strong> to enable cluster snapshots.<p id="EN-US_TOPIC_0000001992165625__p87672010542">The configuration information will be displayed on the <strong id="EN-US_TOPIC_0000001992165625__b164083768993222">Cluster Snapshots</strong> tab.</p>
</li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001992165625__section14478975593"><a name="EN-US_TOPIC_0000001992165625__section14478975593"></a><a name="section14478975593"></a><h4 class="sectiontitle">Configuring Automatic Snapshot Creation</h4><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p143011434135919">You can enable automatic snapshot creation after cluster snapshots are already enabled.</p>
<ol id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_ol122341117110"><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li1857692717">On the <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b124031342301">Cluster Snapshots</strong> tab, click <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b113761128103311">Modify Settings</strong>. In the displayed dialog box, select <span class="parmname" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_parmname530314587331"><b>Automatic Snapshot Creation</b></span>, and configure necessary settings.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_table91225181518" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Configuring automatic snapshot creation</caption><thead align="left"><tr id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_row1011625191511"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.1.4.2.3.1.1"><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p1811525121519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.7.3.1.4.2.3.1.2"><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p2112512158">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_row171825111519"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p14115255151">Snapshot Name Prefix</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p4429231171318">A snapshot name consists of the snapshot name prefix and timestamp, for example, <em id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_i148866464051030">snapshot-1566921603720</em>.</p>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p1242910313132">The snapshot name prefix can contain 1 to 32 characters. It must start with a lowercase letter, and it can only contain lowercase letters, digits, hyphens (-), and underscores (_).</p>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p12429143151315">The default value is <span class="parmvalue" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_parmvalue194291331111314"><b>snapshot</b></span>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_row15192514158"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p1612025111513">Time Zone</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p9429193191314">Select a time zone for the backup start time.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_row17242512153"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p152162501517">Backup Start Time</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p10430133111136">Specify the start time of auto backup.</p>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p13430163141318">Select a value from the drop-down list. The interval can be <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b105794024251030">Daily</strong>, <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b89060068351030">Hourly</strong>, or weekly (by selecting a specific day of the week), and the backup time can be set to any hour from 00:00 to 23:00 (full hours only).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_row32825161517"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p13352531517">Retained Snapshots</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.1.4.2.3.1.2 "><div class="p" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p14430531171319">Number of automatic snapshots to be retained. The value ranges from 1 to 90. The system automatically deletes excess snapshots every half hour. (The expiration deletion policy applies only to the snapshots that were automatically created at the same frequency as the current automatic snapshot creation policy.)<div class="note" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_note743019315133"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p843113161318">If the snapshot creation interval is short or if the data size of indexes is large, the number of automatic snapshots retained may not reach the value set using this parameter.</p>
</div></div>
</div>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_row1434257151"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.1.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p10392541510">Index</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.1.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p13385194911715">Specify the name of the index to be backed up.</p>
<ul id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_ul1015742972113"><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li161575297217">You can back up a specified index. To specify multiple indexes, use commas (,) to separate them, for example, <span class="parmvalue" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_parmvalue12353922141716"><b>index1,index2,index3</b></span>.</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li615713290213">You can use an asterisk (*) to match multiple indexes. For example, <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b145485225451030">index*</strong> indicates that all indexes with the prefix <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b58309802251030">index</strong> will be backed up.</li></ul>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p380820422014">If you do not specify this parameter, all indexes in the cluster are backed up by default.</p>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p109754458199">The index name can contain 0 to 1024 characters. It cannot contain spaces, uppercase letters, or special characters <span class="parmvalue" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_parmvalue103525161511"><b>"\&lt;|&gt;/?</b></span></p>
<div class="note" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_note43725191515"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p15316252155">You can run the <b><span class="cmdname" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_cmdname124192561519">GET /_cat/indices</span></b> command to query the names of all indexes in the cluster.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li89961818334">Click <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b955003517380">OK</strong> to enable automatic snapshot creation.<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p1251616221872">After automatic snapshot creation is enabled, the <span class="parmname" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_parmname35881942134211"><b>Automatic Snapshot Creation</b></span> parameter in the <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b1729415264314">Cluster Snapshots</strong> area is shown as <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b1820962910438">Enabled</strong>.</p>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p0854943115619">Snapshots automatically created according to the snapshot policy as well as those manually created are displayed in the cluster snapshot task list.</p>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p111981745153214">When the snapshot status changes to <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b9335101968">Available</strong>, the snapshot is created. If snapshot creation fails, click on the right of the snapshot list to view the number of failed tasks and learn the failure causes. A maximum of 20 failed tasks can be displayed. When the snapshot function is disabled or the cluster is deleted, the failure records are also cleared.</p>
</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li5979817203015">Check whether data is successfully backed up.<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p119635103017"><a name="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li5979817203015"></a><a name="en-us_topic_0000001965497077_li5979817203015"></a>In the cluster snapshot task list, click the snapshot name. The <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b8657343478">View Details</strong> dialog box is displayed. Check the shards and indexes that have been backed up to see if the backup is successful.</p>
</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li481495016614">To disable automatic snapshot creation, click <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b87771601732">Modify Settings</strong>. In the displayed dialog box, deselect <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b77776010317">Automatic Snapshot Creation</strong>, and click <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b157779017314">OK</strong>. In the displayed dialog box, choose whether to delete snapshots created automatically. Then click <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b477813019319">OK</strong> to disable automatic snapshot creation.<div class="caution" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_note1244020581214"><span class="cautiontitle"><img src="public_sys-resources/caution_3.0-en-us.png"> </span><div class="cautionbody"><ul id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_ul116543484519"><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li176553414458">When disabling automatic snapshot creation, if you select <span class="parmname" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_parmname4237201611465"><b>Delete snapshots created automatically</b></span>, only existing snapshots will be deleted. Snapshots that are being created will still be created.</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li66858177423">If automatic snapshot creation is disabled without deleting automatically created snapshots, all such snapshots in the cluster cannot be manually deleted later once automatic snapshot creation is enabled again. Instead, they can only be deleted by the system based on the snapshot lifecycle policy. For example, if <span class="parmname" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_parmname203516624411"><b>Retained Snapshots</b></span> is set to <span class="parmvalue" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_parmvalue56521998448"><b>10</b></span> in the policy, the system automatically deletes excess snapshots (oldest first) on the next half hour when the number of existing snapshots exceeds this limit.</li></ul>
</div></div>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p0798890136">After automatic snapshot creation is disabled, the <span class="parmname" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_parmname145231638131616"><b>Automatic Snapshot Creation</b></span> parameter in the <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b18524153861618">Cluster Snapshots</strong> area is shown as <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b25241438131619">Disabled</strong>.</p>
</li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001992165625__section1313673920455"><a name="EN-US_TOPIC_0000001992165625__section1313673920455"></a><a name="section1313673920455"></a><h4 class="sectiontitle">Manually Creating a Snapshot</h4><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p181627275231">When snapshots are enabled for a cluster, you can manually create snapshots for it.</p>
<ol id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_ol154371937240"><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li543710311242">Under <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b58169051251030">Cluster Snapshot Tasks</strong>, click <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b113747444251030">Manually Create Snapshot</strong>. In the displayed dialog box, configure the snapshot policy.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_table63211245172515" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters for manually creating a snapshot</caption><thead align="left"><tr id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_row73211345182515"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.8.3.1.3.2.3.1.1"><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p1932154572514">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.8.3.1.3.2.3.1.2"><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p103219453254">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_row93211450250"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.8.3.1.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p032124582518">Snapshot Name</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.8.3.1.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p1948615542718">Set the snapshot name. Unlike automatically created snapshots, manually created snapshots do not have time information automatically added to their names.</p>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p193218453253">The value can contain 4 to 64 characters and must start with a letter. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_row132184517252"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.8.3.1.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p3321174512252">Index</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.8.3.1.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p1564118208278">Specify the name of the index to be backed up.</p>
<ul id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_ul764172052718"><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li5641122013271">You can back up a specified index. When specifying multiple indexes, use commas (,) to separate them, for example, <span class="parmvalue" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_parmvalue12200115991813"><b>index1,index2,index3</b></span>.</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li1864182092713">You can use an asterisk (*) to match multiple indexes. For example, <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b18945014141918">index*</strong> indicates that all indexes with the prefix <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b49451514151914">index</strong> will be backed up.</li></ul>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p126411520132717">If you do not specify this parameter, all indexes in the cluster are backed up by default.</p>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p156411920172711">The index name can contain 0 to 1024 characters. It cannot contain spaces, uppercase letters, or special characters <span class="parmvalue" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_parmvalue16918428161914"><b>"\&lt;|&gt;/?</b></span></p>
<div class="note" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_note1364118203279"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p176411220152716">You can run the <b><span class="cmdname" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_cmdname3641162013275">GET /_cat/indices</span></b> command to query the names of all indexes in the cluster.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_row53223451254"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.8.3.1.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p18322184552512">Snapshot Description</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.8.3.1.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p548701517292">Add a snapshot description.</p>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p13322194522517">The value contains 0 to 256 characters and cannot contain special characters <span class="parmvalue" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_parmvalue552052218597"><b>!&lt;&gt;=&amp;\"'</b></span></p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li9184554152511">Click <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b26732007051030">OK</strong> to start creating snapshots.<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p5483175245718">Snapshots manually created as well as those automatically created according to the snapshot policy are displayed in the cluster snapshot task list.</p>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p114879428373">When the snapshot status changes to <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b33050225918">Available</strong>, the snapshot is created. If snapshot creation fails, click on the right of the snapshot list to view the number of failed tasks and learn the failure causes. A maximum of 20 failed tasks can be displayed. When the snapshot function is disabled or the cluster is deleted, the failure records are also cleared.</p>
</li><li id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li1924919117314">Check whether data is successfully backed up.<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p8249141118316"><a name="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_li1924919117314"></a><a name="en-us_topic_0000001965497077_li1924919117314"></a>In the cluster snapshot task list, click the snapshot name. The <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b32711647993">View Details</strong> dialog box is displayed. Check the shards and indexes that have been backed up to see if the backup is successful.</p>
</li></ol>
</div>
<div class="section" id="EN-US_TOPIC_0000001992165625__section13364123105815"><h4 class="sectiontitle">Disabling Cluster Snapshots</h4><p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p15687123914472">If you no longer need the cluster snapshot function, you can disable it to reclaim storage resources.</p>
<p id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_p132433711">On the <strong id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_b207471412283">Cluster Snapshots</strong> page, click <span class="uicontrol" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_uicontrol1363232220018"><b>Disable Snapshot</b></span>. In the displayed dialog box, click <span class="uicontrol" id="EN-US_TOPIC_0000001992165625__en-us_topic_0000001965497077_uicontrol187316213112"><b>OK</b></span>. Disabling cluster snapshots does not automatically delete existing snapshots. Instead, you need to manually delete them on the OBS console.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0297.html">Backing up and Restoring the Data of an OpenSearch Cluster</a></div>
</div>
</div>
View Git Blame Copy Permalink