elastic/elasticsearch

API to return global state from a snapshot

Open

#73,248 opened on May 19, 2021

View on GitHub
 (27 comments) (1 reaction) (0 assignees)Java (76,700 stars) (25,882 forks)batch import
:Distributed/Snapshot/Restore>enhancementTeam:Distributedgood first issue

Description

Snapshots contain global state (i.e. parts of the cluster metadata) but the only way you can see what exactly this contains is to restore the snapshot and overwrite the existing cluster state. There's no option to restore only part of the state (e.g. just a specific pipeline or template) nor to compare the state between different snapshots. This would be useful sometimes and would be relatively straightforward to implement.

Contributor guide

Tech stack
javarest api
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaElasticsearch pluginsREST API design
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Review the existing snapshot REST API implementation in Elasticsearch (e.g., RestSnapshotAction class). Look at how snapshot metadata is stored and retrieved. Propose a design for a new endpoint that returns global state from a snapshot without restoring it. Consider performance and security implications.