Disallow explicitly requesting system indices in snapshots #81235
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit changes SnapshotsService to throw an error when a system index is explicitly requested, rather than silently dropping it, and adds a test to verify that behavior.
gwbrown
added
>non-issue
:Distributed/Snapshot/Restore
gwbrown
requested review from
williamrandolph,
original-brownbear and
jrodewig
|
Pinging @elastic/es-distributed (Team:Distributed) |
jrodewig
approved these changes
Dec 2, 2021
jrodewig
reviewed
Dec 2, 2021
Comment on lines
320
to
321
| "system indices [{}] were explicitly requested, but snapshots should use the " | ||
| + "[include_global_state] or [feature_states] parameters to control inclusion of system indices", |
There was a problem hiding this comment.
Not a blocker, but we may want to mention the indices parameter here. Right now, it can be a little unclear where the error is coming from. I'd suggest something like:
The [indices] parameter includes system indices [{}]. To include system indices in a snapshot, use the [include_global_state] or [feature_states] parameters instead.
It'd be great if we could somehow surface this error for SLM policies too (either at policy creation/update or execution), but that's likely outside of scope here.
There was a problem hiding this comment.
I opened an issue for detecting this in SLM policies at #81319.
I'll make the wording change to the message, thanks!
williamrandolph
approved these changes
Dec 2, 2021
gwbrown
changed the title
gwbrown
added
auto-backport-and-merge
gwbrown
added a commit
to gwbrown/elasticsearch
that referenced
this pull request
Dec 4, 2021
…1235) This commit changes SnapshotsService to throw an error when a system index is explicitly requested, rather than silently dropping it, and adds a test to verify that behavior. Note that *only* system indices requested by full name return an error, requesting e.g. `"indices": ".geo*"` (which would normally resolve to `.geoip_databases`) does not include its system index and does not error, but requesting `"indices": ".geoip_databases"` *will* return an error. Follow-up to elastic#79670 --- This should have been part of the original change - I thought we had already done this, but @jrodewig pointed out to me that it silently dropped system indices instead.
💚 Backport successful
|
elasticsearchmachine
pushed a commit
that referenced
this pull request
Dec 4, 2021
…81346) This commit changes SnapshotsService to throw an error when a system index is explicitly requested, rather than silently dropping it, and adds a test to verify that behavior. Note that *only* system indices requested by full name return an error, requesting e.g. `"indices": ".geo*"` (which would normally resolve to `.geoip_databases`) does not include its system index and does not error, but requesting `"indices": ".geoip_databases"` *will* return an error. Follow-up to #79670 --- This should have been part of the original change - I thought we had already done this, but @jrodewig pointed out to me that it silently dropped system indices instead.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit changes SnapshotsService to throw an error when a
system index is explicitly requested, rather than silently
dropping it, and adds a test to verify that behavior.
Note that only system indices requested by full name return
an error, requesting e.g.
"indices": ".geo*"(which would normally resolve to.geoip_databases) does not include its system index and does noterror, but requesting
"indices": ".geoip_databases"will returnan error.
Follow-up to #79670
This should have been part of the original change - I thought we had already done this, but @jrodewig pointed out to me that it silently dropped system indices instead.