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 (25,882 forks)batch import
:Distributed/Snapshot/Restore>enhancementTeam:Distributedgood first issue

Repository metrics

Stars
 (76,700 stars)
PR merge metrics
 (Avg merge 2d 5h) (1,000 merged PRs in 30d)

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

Research direction
Examine the snapshot restore code path to understand how global state is read. Look at the existing SnapshotRestoreService and related classes. Design a new API endpoint that retrieves the global metadata from a snapshot file without triggering a full restore.
Tech stack
java
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaElasticsearchREST APIsnapshot/restore concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40