doc-exports/docs/css/umn/css_01_0268.html

<a name="css_01_0268"></a><a name="css_01_0268"></a>

<h1 class="topictitle1">Manually Creating a Snapshot</h1>
<div id="body0000001633220693"><p id="css_01_0268__p26653521013">You can manually create a snapshot at any time to back up all data or data of specified indexes.</p>
<div class="section" id="css_01_0268__en-us_topic_0000001268314505_section914018211934"><h4 class="sectiontitle">Prerequisites</h4><p id="css_01_0268__en-us_topic_0000001583460750_en-us_topic_0000001268314505_p1353111291039">To use the function of creating or restoring snapshots, the account or IAM user logging in to the <span id="css_01_0268__en-us_topic_0000001583460750_en-us_topic_0000001268314505_text04041051811">CSS</span> management console must have both of the following permissions:</p>
<ul id="css_01_0268__en-us_topic_0000001583460750_en-us_topic_0000001268314505_ul10364413962"><li id="css_01_0268__en-us_topic_0000001583460750_en-us_topic_0000001268314505_li111102134120"><span class="parmname" id="css_01_0268__parmname4361015182614"><b>Tenant Administrator</b></span> for project <span class="parmname" id="css_01_0268__parmname1336131562617"><b>OBS</b></span> in region <span class="parmname" id="css_01_0268__parmname336191516265"><b>Global service</b></span></li><li id="css_01_0268__en-us_topic_0000001583460750_en-us_topic_0000001268314505_li754585517113"><span class="parmname" id="css_01_0268__en-us_topic_0000001268314505_parmname748916545244"><b>CSS Administrator</b></span> in the current region</li></ul>
</div>
<div class="section" id="css_01_0268__section20964104020216"><h4 class="sectiontitle">Precautions</h4><ul id="css_01_0268__ul143903500217"><li id="css_01_0268__li15298132432411">When creating a backup for the first time, you are advised to back up data of all indexes.</li><li id="css_01_0268__li93901550162116">Cluster snapshots will increase the CPU usage and disk I/O. You are advised to take cluster snapshots during off-peak hours.</li><li id="css_01_0268__li639013505215">Before creating a snapshot, you need to perform basic configurations, including configuring the OBS bucket for storing snapshots and IAM agency used for security authentication.</li><li id="css_01_0268__li9391205072111">If there are available snapshots in the snapshot list when you configure the OBS bucket for storing cluster snapshots for the first time, you cannot change the bucket for snapshots that are subsequently created automatically or manually. Exercise caution when you configure the OBS bucket.</li><li id="css_01_0268__li6391135019212">If snapshots have been stored in the OBS bucket, the OBS bucket cannot be changed. You can disable the snapshot function, enable the snapshot function, and specify a new OBS bucket. After you disable the snapshot function, you cannot use previously created snapshots to restore the cluster.</li><li id="css_01_0268__li17391195018213">If a cluster is in the <span class="parmname" id="css_01_0268__parmname1769007186105029"><b>Unavailable</b></span> status, you can use the cluster snapshot function only to restore clusters and view existing snapshot information.</li><li id="css_01_0268__li16391850122111">During backup and restoration of a cluster, you can perform only certain operations, including scaling out, accessing Kibana, viewing metric, and deleting other snapshots of clusters. However, you cannot perform the following operations: restarting or deleting the cluster, deleting a snapshot that is in the <strong id="css_01_0268__b701734168105549">Creating</strong> or <strong id="css_01_0268__b1097640953105549">Restoring</strong> status, and creating or restoring another snapshot. If a snapshot is being created or restored for a cluster, any automatic snapshot creation task initiated for the cluster will be canceled.</li><li id="css_01_0268__li139145018212">The first snapshot of a cluster is a full snapshot, and subsequent snapshots are incremental snapshots. CSS snapshot files depend on each other.</li></ul>
</div>
<div class="section" id="css_01_0268__en-us_topic_0000001268314505_section43906502025"><h4 class="sectiontitle">Manually Creating a Snapshot</h4><ol id="css_01_0268__en-us_topic_0000001268314505_ol1597157201819"><li id="css_01_0268__en-us_topic_0000001268314505_li928020151910">In the <span id="css_01_0268__en-us_topic_0000001268314505_text1042214281316">CSS</span> navigation pane on the left, click <span class="parmname" id="css_01_0268__parmname1266219324533"><b>Clusters</b></span>.</li><li id="css_01_0268__en-us_topic_0000001268314505_li12822019195">On the <span class="wintitle" id="css_01_0268__wintitle852557125914"><b>Clusters</b></span> page that is displayed, click the name of the target cluster. In the navigation pane on the left, choose <strong id="css_01_0268__b17731925141311">Cluster Snapshots</strong>.</li><li id="css_01_0268__en-us_topic_0000001268314505_li05161823125719">On the displayed <span class="wintitle" id="css_01_0268__wintitle16362141635915"><b>Cluster Snapshots</b></span> page, click the icon to the right of <span class="parmname" id="css_01_0268__parmname836221665918"><b>Cluster Snapshot</b></span> to enable the cluster snapshot function.</li><li id="css_01_0268__en-us_topic_0000001268314505_li1371711473">Enable the cluster snapshot function. OBS buckets and IAM agencies are automatically created by <span id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_text179756247419">CSS</span> to store snapshots. The automatically created OBS bucket and IAM agency are displayed on the page. You can also click <span><img id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_image268774812456" src="en-us_image_0000001714802137.png"></span> on the right of <strong id="css_01_0268__b15527112111164">Basic Configuration</strong> to edit the configuration. To ensure the security of snapshot data, you can select a key to encrypt the snapshot.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_table109611127114919" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Cluster snapshot parameter</caption><thead align="left"><tr id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_row74671830133417"><th align="left" class="cellrowborder" valign="top" width="16.900000000000002%" id="mcps1.3.4.2.4.4.2.3.1.1"><p id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_p2467330133420">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="83.1%" id="mcps1.3.4.2.4.4.2.3.1.2"><p id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_p5467103013416">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_row1646743016348"><td class="cellrowborder" valign="top" width="16.900000000000002%" headers="mcps1.3.4.2.4.4.2.3.1.1 "><p id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_p5467163016341">OBS Bucket</p>
</td>
<td class="cellrowborder" valign="top" width="83.1%" headers="mcps1.3.4.2.4.4.2.3.1.2 "><p id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_p2046713013344">Select an OBS bucket for storing snapshots from the drop-down list box. You can also click <strong id="css_01_0268__b12327276078284">Create Bucket</strong> on the right to create an OBS bucket. 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="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_p169581927104917">The created or existing OBS bucket must meet the following requirements:</p>
<ul id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_ul196015276499"><li id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_li1496042724916"><span class="parmname" id="css_01_0268__parmname129079509982810"><b>Storage Class</b></span> is <span class="parmvalue" id="css_01_0268__parmvalue29139067782810"><b>Standard</b></span> or <strong id="css_01_0268__b78135109482810">Warm</strong>.</li></ul>
</td>
</tr>
<tr id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_row94671530153410"><td class="cellrowborder" valign="top" width="16.900000000000002%" headers="mcps1.3.4.2.4.4.2.3.1.1 "><p id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_p13467330103415">IAM Agency</p>
</td>
<td class="cellrowborder" valign="top" width="83.1%" headers="mcps1.3.4.2.4.4.2.3.1.2 "><p id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_p194671630143411">IAM agency authorized by the current account for <span id="css_01_0268__text124012506183123">CSS</span> to access or maintain data stored in OBS You can also click <strong id="css_01_0268__b8982178483130">Create IAM Agency</strong> on the right to create an IAM agency. For details, see <a href="https://docs.otc.t-systems.com/en-us/usermanual/iam/en-us_topic_0046613147.html" target="_blank" rel="noopener noreferrer">Creating an Agency</a>.</p>
<p id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_p15960122764916">The created or existing IAM agency must meet the following requirements:</p>
<ul id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_ul29611827194917"><li id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_li1896011275492"><span class="parmname" id="css_01_0268__parmname75359739483137"><b>Agency Type</b></span> must be <span class="parmvalue" id="css_01_0268__parmvalue197399277983137"><b>Cloud service</b></span>.</li><li id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_li696032784920">Set <strong id="css_01_0268__b144696815085957">Cloud Service</strong> to <strong id="css_01_0268__b29986481085957">CSS</strong>.</li><li id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_li7961182754916">The agency must have the <span class="parmname" id="css_01_0268__parmname1619689365900"><b>Tenant Administrator</b></span> permission for the <strong id="css_01_0268__b1060104649900">OBS(S3)</strong> project in <strong id="css_01_0268__b1943410303900">OBS(S3)</strong>.</li></ul>
</td>
</tr>
<tr id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_row14801105514545"><td class="cellrowborder" valign="top" width="16.900000000000002%" headers="mcps1.3.4.2.4.4.2.3.1.1 "><p id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_p1380215514540">Snapshot Encryption</p>
</td>
<td class="cellrowborder" valign="top" width="83.1%" headers="mcps1.3.4.2.4.4.2.3.1.2 "><p id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_p2080235545418">Indicates whether to enable the snapshot encryption function. Enabling the snapshot encryption function ensures the security of your snapshot data.</p>
<p id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_p05501493581">After the snapshot encryption function is enabled, select a key from the <strong id="css_01_0268__b13030627918267">Key Name</strong> drop-down list. If no key is available, click <strong id="css_01_0268__b10196058888267">Create/View Key</strong> to switch to the KMS management console to create or modify a key. For details, see <a href="https://docs.otc.t-systems.com/key-management-service/umn/user_guide/key_management/creating_a_key.html" target="_blank" rel="noopener noreferrer">Creating a CMK</a>.</p>
<ul id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_ul1167151205917"><li id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_li156751185916">You cannot use default master keys whose aliases end with <strong id="css_01_0268__b9019678183215">/default</strong> in KMS to encrypt snapshots.</li><li id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_li13682119597">If a snapshot has been stored in the OBS bucket, you cannot modify the parameters used for encrypting the snapshot.</li><li id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_li18686114593">If the key used for encryption is in the <span class="parmname" id="css_01_0268__parmname71742087383234"><b>Pending deletion</b></span> or <span class="parmname" id="css_01_0268__parmname207095429783234"><b>disable</b></span> status, you cannot perform backup and restoration operations on the cluster. Specifically, you cannot create new snapshots for the cluster, or use existing snapshots to restore clusters. In this case, switch to the KMS management console and change the status of the target key to <strong id="css_01_0268__b144152556983240">enable</strong> so that backup and restore operations are allowed on the cluster.</li><li id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_en-us_topic_0000001268594549_li1068310595">If you delete the key used for encryption, you cannot perform backup and restore operations on the cluster. In addition, you cannot restore the deleted key. Therefore, exercise caution when deleting a key. If the key is deleted or is in the <span class="parmname" id="css_01_0268__parmname195900759483256"><b>Pending deletion</b></span> or <span class="parmname" id="css_01_0268__parmname89298994983256"><b>disable</b></span> state, automatic snapshot creation is allowed based on the configured snapshot policy. However, all automatic snapshot creation tasks will fail, and the failed tasks are displayed in the failed task list in the <strong id="css_01_0268__b138969385783256">Failed Tasks</strong> dialog box. In such scenario, you are advised to disable the automatic snapshot creation function.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="fignone" id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_fig5965112764919"><span class="figcap"><b>Figure 1 </b>Edit Basic configuration</span><br><span><img id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_image1143918271686" src="en-us_image_0000001667002358.png"></span></div>
</li><li id="css_01_0268__en-us_topic_0000001268314505_li328516081910">After basic configurations are completed, click <strong id="css_01_0268__b986996974112159">Create</strong>.<ul id="css_01_0268__en-us_topic_0000001268314505_ul186887875617"><li id="css_01_0268__en-us_topic_0000001268314505_li143570341602"><strong id="css_01_0268__b1039204923112159">Name</strong> indicates the name of the manually created snapshot, which can contain 4 to 64 characters and must start with a lowercase letter. Only lowercase letters, digits, hyphens (-), and underscores (_) are allowed. For snapshots you create manually, you can specify the snapshot name. The system will not automatically add the time information to the snapshot name.</li><li id="css_01_0268__en-us_topic_0000001268314505_li126881280561"><strong id="css_01_0268__b1969363101917">Index</strong>: Enter an index name. You can select an index for backup. Use commas (,) to separate multiple indexes. Uppercase letters, spaces, and the following special characters are not allowed: "\&lt;|&gt;/? If you do not specify this parameter, data of all indexes in the cluster is backed up by default. You can use the asterisk (<span class="parmname" id="css_01_0268__parmname11757337191910"><b>*</b></span>) to back up data of certain indexes. For example, if you enter <strong id="css_01_0268__b167576374195">index*</strong>, then data of indexes with the name prefix of <strong id="css_01_0268__b4757183711196">index</strong> will be backed up.<p id="css_01_0268__en-us_topic_0000001268314505_en-us_topic_0000001268314505_p7407254171620">Run the <strong id="css_01_0268__b02231329152120">GET /_cat/indices</strong> command in Kibana to query the names of all indexes in the cluster.l</p>
</li><li id="css_01_0268__en-us_topic_0000001268314505_li86881810563"><span class="parmname" id="css_01_0268__en-us_topic_0000001268314505_parmname8688118135615"><b>Description</b></span>: indicates the description of the created snapshot. The value contains 0 to 256 characters, and certain special characters (<span class="parmname" id="css_01_0268__en-us_topic_0000001268314505_parmname126615563541"><b>&lt;&gt;</b></span>) are not allowed.</li></ul>
<div class="fignone" id="css_01_0268__en-us_topic_0000001268314505_fig78421105010"><span class="figcap"><b>Figure 2 </b>Create snapshot</span><br><span><img id="css_01_0268__en-us_topic_0000001268314505_image1054884585019" src="en-us_image_0000001714922221.png"></span></div>
</li><li id="css_01_0268__en-us_topic_0000001268314505_li162011519182916">Click <span class="uicontrol" id="css_01_0268__en-us_topic_0000001268314505_uicontrol7843111020355"><b>OK</b></span>.<p id="css_01_0268__en-us_topic_0000001268314505_p522415013344">After the snapshot is created, it will be displayed in the snapshot list. The status <strong id="css_01_0268__b75221824111617">Available</strong> indicates that the snapshot is created successfully. along with manually created snapshots. You can distinguish them by the <strong id="css_01_0268__b16495142711613">Snapshot Type</strong> setting. In the upper right corner of the snapshot list, enter the keyword of the snapshot name or snapshot ID to search for the desired snapshots.</p>
</li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_01_0269.html">Index Backup and Restoration</a></div>
</div>
</div>