Skip to content

Add documentation for restoring Alerting from a snapshot - #13445

Open
sharathkanaka wants to merge 2 commits into
opensearch-project:mainfrom
sharathkanaka:alerting-restore-docs
Open

sharathkanaka wants to merge 2 commits into
opensearch-project:mainfrom
sharathkanaka:alerting-restore-docs

Conversation

@sharathkanaka

Copy link
Copy Markdown
Contributor

Description

Adds a page on restoring Alerting from a snapshot, for example, onto another cluster. With the 3.10 alerting and security changes below, monitors continue to run after their indexes are restored, and a REST admin can restore them.

  • New page _observing-your-data/alerting/restore.md: which Alerting indexes to restore, the settings and roles to match on the new cluster first, the restore steps, restoring monitor sharing, and how document-level monitors continue after a restore.
  • Alerting settings: the .opendistro-alerting-config row links to the new page.
  • System indexes: adds .opensearch-alerting-finding* to the Alerting row and .opendistro-alerting-config-sharing to the Security plugin row.

Related code changes:

Issues Resolved

N/A

Version

3.10

Frontend features

N/A

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Sharath Kanaka <sharatcr@amazon.com>
@github-actions

github-actions Bot commented Nov 2, 2026

Copy link
Copy Markdown

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference).

@github-actions github-actions Bot added the Tech review PR: Tech review in progress label Nov 2, 2026
@sharathkanaka

Copy link
Copy Markdown
Contributor Author

The general snapshot restore page (who can restore system indexes and the plugins.security.system_indices.restore.indices setting) comes in a follow-up PR. Step 1 links to that page.

@kolchfa-aws kolchfa-aws added Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes v3.10.0 and removed Tech review PR: Tech review in progress labels Nov 2, 2026
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

@kolchfa-aws kolchfa-aws left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @sharathkanaka! Doc review complete. I added the setting description, a verification step, rewrote for clarity, and reorganized the content so there's no duplication. Please review when you get a chance.

@kolchfa-aws kolchfa-aws added Awaiting response Done but waiting to merge PR: The work is done and ready to merge and removed Doc review PR: Doc review in progress labels Nov 3, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Awaiting response Done but waiting to merge PR: The work is done and ready to merge release-notes PR: Include this PR in the automated release notes v3.10.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants