Elasticsearch OpenSearch Repository

By Opster Team

Updated: Mar 30, 2023

| 1 min read

In addition to reading this guide, we recommend you run the Elasticsearch Health Check-Up. It will detect issues and improve your Elasticsearch performance by analyzing your shard sizes, threadpools, memory, snapshots, disk watermarks and more.

The Elasticsearch Check-Up is free and requires no installation.

Before you begin reading this guide, we recommend you run the OpenSearch Error Check-Up which analyzes 2 JSON files to detect errors.

To review your snapshot operations and repository settings, you can try AutoOps for OpenSearch. AutoOps offers a range of automated features to help optimize your OpenSearch settings and streamline management tasks.

 

Overview

An OpenSearch 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 opensearch.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?


Analyze your cluster & get personalized recommendations

Skip to content