Elasticsearch Repository

By Opster Team

Updated: Mar 10, 2024

| 1 min read

Overview

An Elasticsearch snapshot provides a backup mechanism that takes the current state and data in the cluster and saves it to a repository (read snapshot for more information). The backup process requires a repository to be created first. The repository needs to be registered using the _snapshot endpoint, and multiple repositories can be created per cluster. The following repository types are supported: 

Repository types

Repository typeConfiguration type
Shared file systemType: “fs”
S3Type : “s3”
HDFSType :“hdfs”
AzureType: “azure”
Google Cloud StorageType : “gcs”

Examples

To register an “fs” repository:

PUT _snapshot/my_repo_01
{
"type": "fs",
"settings": {
"location": "/mnt/my_repo_dir"
  }
}

Notes and good things to know

  • S3, HDFS, Azure and Google Cloud require a relevant plugin to be installed before it can be used for a snapshot.
  • The setting, path.repo: /mnt/my_repo_dir needs to be added to elasticsearch.yml on all the nodes if you are planning to use the repo type of file system. Otherwise, it will fail.
  • When using remote repositories, the network bandwidth and repository storage throughput should be high enough to complete the snapshot operations normally, otherwise you will end up with partial snapshots.

How helpful was this guide?

We are sorry that this post was not useful for you!

Let us improve this post!

Tell us how we can improve this post?


Related log errors to this ES concept


Index no longer part of any snapshots in the repository
Unable to delete snapshot file
Unable to delete global metadata file
Failed to delete metadata for index
Index blob is not valid x-content bytes
Failed to delete shard snapshot file
Failed to delete index blob during finalization
Failed to delete data blob during finalization
Failed to parse index file name
Failed to read index file
Could not find a readable index-N file in a non-empty shard snapshot directory
Failed to read commit point

< Page: 3 of 19 >