Snapshot

Available in VPC

You can create a Snapshot that records the configuration, settings, and data of the cluster and save it in the Object Storage of NAVER Cloud Platform. Also, you can set up snapshot schedules to automatically create snapshots periodically.

Snapshot page

The basic description of the Snapshot menu for using the Search Engine Service is as follows:

Set API authentication key

You must first set the API authentication key for Object Storage access and install the Object Storage Plugin (s3-repository) to create a snapshot.

• Clusters created before July 23, 2021: Install the Object Storage Plugin at the same time as setting the API authentication key
• Clusters created on or after July 23, 2021: Automatically install the Object Storage Plugin when creating a cluster

The following is how to set or change the API authentication key:

1. From the NAVER Cloud Platform console, click the Services > Big Data & Analytics > Search Engine Service menus, in that order.
2. Click the Snapshot menu.
3. Click to select the cluster for which you want to set an authentication key, and then click the [Set API authentication key] button.
4. When the Set API authentication key pop-up window appears, enter the Access Key ID and Secret Key of the API authentication key, and then click the [OK] button.
   • To change the set API authentication key, click the [Change] button and enter the API authentication key information to use.
   • For clusters created before July 23, 2021, the Object Storage Plugin is installed at the same time as the authentication key is set.
5. Click the [OK] button.

Manage Snapshot

You can create snapshots of a cluster, or set or remove Snapshot schedules, which automatically create snapshots periodically.

• Create snapshot
• Set snapshot schedules
• Remove snapshot schedules

Create snapshot

The following describes how to create a snapshot.

1. From the NAVER Cloud Platform console, click the Services > Big Data & Analytics > Search Engine Service menus, in that order.
2. Click the Snapshot menu.
3. Click the cluster for which you want to create a snapshot, and then click the [Manage snapshot] button.
4. Click Create snapshot.
5. When the Create snapshot pop-up window appears, select the bucket where you want to save the snapshot and enter the Snapshot name.
   • You cannot select locked buckets.
   • You can select to allow access from all nodes in the case of a bucket with an access control set.
   • If you set an API authentication key for the sub account, you can save snapshots only to buckets with Change/writeObject permissions in the Object Storage.
6. Click the [OK] button.
   • The snapshot file is saved in a folder with the folder name, cluster name-cluster code.
   • You can check the snapshot creation progress in the [Snapshot creation history] tab.

Set snapshot schedules

You can set snapshot schedules to create and save snapshots at any desired time.

The following describes how to set snapshot schedules:

1. From the NAVER Cloud Platform console, click the Services > Big Data & Analytics > Search Engine Service menus, in that order.
2. Click the Snapshot menu.
3. Click the cluster for which you want to set snapshot schedules, and then click the [Manage snapshot] button.
4. Click Set snapshot schedules.
5. When the set snapshot schedules pop-up window appears, enter the setting information, and then click the [OK] button.
   • Bucket: select an Object Storage bucket to save snapshots
   • Snapshot name: enter a name for the snapshot to be created
     • To prevent duplicate snapshot names, they are saved as snapshot name-creation date-time (<example> my-scheduling-2022-0303-1200).
   • Snapshot setting time: set to create snapshots every day or at a specific time on a specific day of the week
6. Click the [OK] button.
   • When a snapshot is first created, a snapshot file is created for all indexes, and is saved incrementally when a snapshot is created in the same bucket thereafter.

Remove snapshot schedules

The following describes how to remove set snapshot schedules:

1. From the NAVER Cloud Platform console, click the Services > Big Data & Analytics > Search Engine Service menus, in that order.
2. Click the Snapshot menu.
3. Click the cluster for which you want to remove set Snapshot schedules, and then click the [Manage snapshot] button.
4. Click Remove snapshot schedules.
5. When the remove snapshot schedules pop-up window appears, click the [Remove] button.
6. Click the [OK] button.

Check snapshot creation history

The following describes how to check the snapshot creation history.

1. From the NAVER Cloud Platform console, click the Services > Big Data & Analytics > Search Engine Service menus, in that order.
2. Click the Snapshot menu.
3. Click the target cluster and click the [Snapshot creation history] tab.
4. Check the creation history and information.
   • Cluster name: name of the cluster
   • Job date: date and time of the snapshot creation job set up
   • Job history: snapshot creation job history
   • Execution time: time spent performing the job
   • Target bucket: name of the bucket that the created snapshot was saved to
   • Remarks: if the snapshot creation fails, click the [View log] button to check the failure log
     • If the failure log does not appear, you can check the detailed cause in Kibana or OpenSearch Dashboards (refer to Check the cause of the snapshot creation failure).

Check snapshot schedules settings history

The following describes how to check the snapshot schedules settings history:

1. From the NAVER Cloud Platform console, click the Services > Big Data & Analytics > Search Engine Service menus, in that order.
2. Click the Snapshot menu.
3. Click the target cluster, and then click the [Snapshot schedules settings history] tab.
4. Check the setting history and information.
   • Scheduled date: time when snapshot schedules were set up
   • Set/Remove: status of snapshot schedules settings
   • Target bucket: name of the bucket set up to save a snapshot
   • Snapshot name: name of the snapshot set up
     • To prevent duplicate snapshot names, they are saved as snapshot name-creation date-time (<example> my-scheduling-2022-0303-1200).
   • Scheduled day: the day of the week that the scheduled snapshot is created
   • Scheduled time: the time that the scheduled snapshot is created

Check snapshot files

The following describes how to check the snapshot files saved in the Object Storage bucket:

1. In the NAVER Cloud Platform console, click the Services > Storage > Object Storage menus, in that order.
2. Click the Bucket Management menu.
3. In the bucket list, click the bucket where you saved the snapshot.
4. Double-click the folder with the folder name, the name of the cluster where the snapshot was created-cluster code.
5. Check the saved snapshot related files.