Snapshot

Available in VPC

In the Snapshot menu, you can create a snapshot in which the configuration, settings, and data of a cluster are recorded and store it in Object Storage of NAVER Cloud Platform. Also, you can set snapshot scheduling to auto-create snapshots periodically.

Snapshot interface

The following is the basic description of the Snapshot menu for using the Search Engine Service.

Set API authentication key

In order to create a snapshot, you need to set the API authentication key to approach Object Storage first and install the Object Storage plugin (s3-repository).

• Cluster created before July 23, 2021: Object Storage plugin is installed at the same time as setting the API authentication key.
• Cluster created after July 23, 2021: Object Storage plugin is installed automatically when a cluster is created.

The following shows how to set or change the API authentication key.

1. In the VPC environment on the NAVER Cloud Platform console, navigate to > Services > Big Data & Analytics > Search Engine Service.
2. Click the Snapshot menu.
3. Click to select the cluster to create an authentication key for and click [Set API authentication key].
4. When the API authentication key setup popup appears, enter the Access key ID and Secret key of the API authentication key and click [OK].
   • In order to change the set API authentication key, click [Change] and enter the API authentication key information to use.
   • As for the clusters created before July 23, 2021, the Object Storage plugin is installed at the same time as setting the API authentication key.
5. Click [OK].

Manage snapshots

You can set or disable snapshot scheduling that creates snapshots for clusters or create snapshots periodically.

• Create snapshots
• Set snapshot scheduling
• Disable snapshot scheduling

Create snapshots

The following describes how to create a snapshot.

1. In the VPC environment on the NAVER Cloud Platform console, navigate to > Services > Big Data & Analytics > Search Engine Service.
2. Click the Snapshot menu.
3. Click the cluster to create a snapshot for and click [Manage snapshots].
4. Click Create snapshots.
5. When the snapshot creation popup appears, select the bucket to store the snapshot in and enter the snapshot name.
   • You cannot select locked buckets.
   • In order to select buckets for which access control is set, you need to allow access of all nodes.
   • If you set the API authentication key for a sub account, you can store snapshots only to buckets with the Change/writeObject permission in Object Storage.
6. Click [OK].
   • Snapshot files are stored in the folder named as 'cluster name-cluster code.'
   • You can check the progress of snapshot creation in the [Snapshot creation history] tab.

Set snapshot scheduling

You can create and store snapshots at the desired time by setting snapshot scheduling.

The following shows how to set snapshot scheduling.

1. In the VPC environment on the NAVER Cloud Platform console, navigate to > Services > Big Data & Analytics > Search Engine Service.
2. Click the Snapshot menu.
3. Click the cluster to set the snapshot scheduling for and click [Manage snapshots].
4. Click Set snapshot scheduling.
5. When the snapshot scheduling setup popup appears, enter the setting information and click [OK].
   • Bucket: Select the Object Storage bucket to store the snapshot in.
   • Snapshot name: Enter the name of the snapshot to be created.
     • To avoid duplicate snapshot names, the snapshot name is saved as 'snapshot name-creation date-time.' (Example: my-scheduling-2022-0303-1200)
   • Snapshot creation time setting: Set to create snapshots at the set time every day or on a particular day of the week.
6. Click [OK].
   • This creates snapshot files for all indexes the first time when a snapshot is created. And when snapshots are created in the same bucket afterwards, they are stored incrementally.

Disable snapshot scheduling

The following shows how to disable the set snapshot scheduling.

1. In the VPC environment on the NAVER Cloud Platform console, navigate to > Services > Big Data & Analytics > Search Engine Service.
2. Click the Snapshot menu.
3. Click and select the cluster to disable the snapshot scheduling setting and click [Manage snapshots].
4. Click Disable snapshot scheduling.
5. When the disabling snapshot scheduling popup appears, click [Disable settings].
6. Click [OK].

Check snapshot creation history

The following shows how to check the snapshot creation history.

1. In the VPC environment on the NAVER Cloud Platform console, navigate to > Services > Big Data & Analytics > Search Engine Service.
2. Click the Snapshot menu.
3. Click the target cluster and click the [Snapshot creation history] tab.
4. Check the creation history and information of the cluster.
   • Cluster name: Name of the cluster.
   • Task date and time: Date and time of the snapshot creation task that has been set.
   • Task history: History of the snapshot creation task.
   • Execution time: The time spent in task execution.
   • Target bucket: Name of the bucket that has been set to store the snapshot.
   • Note: When snapshot creation is failed, click the [View logs] button to see failure logs.
     • When failure logs do not appear, you can check the detailed cause of failure in Kibana or OpenSearch Dashboards (see Identify the cause of failed creation of snapshots).

Check snapshot scheduling setting history

The following shows how to check the snapshot scheduling setting history.

1. In the VPC environment on the NAVER Cloud Platform console, navigate to > Services > Big Data & Analytics > Search Engine Service.
2. Click the Snapshot menu.
3. Click the target cluster and click the [Snapshot scheduling setting history] tab.
4. Check the setting history and information of the cluster.
   • Set time: Time set for snapshot scheduling.
   • Set/Disable: Snapshot scheduling setting status.
   • Target bucket: Name of the bucket that has been set to store the snapshot.
   • Snapshot name: Name of the snapshot that has been set.
     • To avoid duplicate snapshot names, the snapshot name is saved as 'snapshot name-creation date-time.' (Example: my-scheduling-2022-0303-1200)
   • Day of task: Day of the week for the snapshot creation task that has been set.
   • Time of task: Time of snapshot creation task that has been set.

Check snapshot files

The following shows how to check snapshot files stored in the Object Storage bucket.

1. In the VPC environment on the NAVER Cloud Platform console, navigate to > Services > Storage > Object Storage.
2. Click the Bucket Management menu.
3. Click the bucket in which the snapshots are stored from the bucket list.
4. Double-click the folder with the name 'cluster name in which snapshots are created-cluster code.'
5. Check the files related to stored snapshot.