Briefly, this error occurs when Elasticsearch is trying to use an S3 repository for snapshot or backup purposes, but the bucket for the repository is not defined. To resolve this issue, you can either define the bucket in the repository settings or create a new bucket in S3. Make sure the Elasticsearch cluster has the necessary permissions to access the S3 bucket. Also, ensure that the bucket name is correctly spelled and exists in the specified region.
This guide will help you check for common problems that cause the log ” No bucket defined for s3 repository ” to appear. To understand the issues related to this log, read the explanation below about the following Elasticsearch concepts: repository, repository-s3, repositories.
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 type | Configuration type |
---|---|
Shared file system | Type: “fs” |
S3 | Type : “s3” |
HDFS | Type :“hdfs” |
Azure | Type: “azure” |
Google Cloud Storage | Type : “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.
Log Context
Log “No bucket defined for s3 repository” class name is S3Repository.java. We extracted the following from Elasticsearch source code for those seeking an in-depth context :
this.service = service; // Parse and validate the user's S3 Storage Class setting this.bucket = BUCKET_SETTING.get(metadata.settings()); if (bucket == null) { throw new RepositoryException(metadata.name(); "No bucket defined for s3 repository"); } this.bufferSize = BUFFER_SIZE_SETTING.get(metadata.settings()); this.chunkSize = CHUNK_SIZE_SETTING.get(metadata.settings());