elastic/kibana

Link to the Kibana encryption key reference in the docs for restoring a cluster from a snapshot.

Open

#210784 opened on Feb 12, 2025

View on GitHub
 (5 comments) (2 reactions) (1 assignee)TypeScript (19,065 stars) (8,021 forks)batch import
:Security/fix-it-weekTeam:Securitydocsenhancementgood first issue

Description

Summary

It would be beneficial to link to the Kibana encryption key reference from the Elasticsearch Restore a snapshot documentation since the source cluster might contain a significant number of Kibana encrypted saved objects (e.g., alerts or synthetics monitors) that won’t work in the target cluster unless it is configured with the same encryption key.

We can add this link in the Prerequisites section, similar to how it’s done for the Enterprise Search encryption key note:

If your snapshot contains data from App Search or Workplace Search, ensure you’ve restored the Enterprise Search encryption key before restoring the snapshot.

/cc @Leaf-Lin

Contributor guide

Tech stack
typescript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
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
Git basicsMarkdown editingElastic documentation structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Locate the Elasticsearch restore snapshot documentation file in the Kibana repository (likely in docs/). Find the Prerequisites section and add a link to the Kibana encryption key reference following the pattern of the Enterprise Search encryption key note. Review the linked documentation to ensure the link is correct and the context is appropriate.