generated from amazon-archives/__template_Custom
-
Notifications
You must be signed in to change notification settings - Fork 130
[Feature] Supporting Exclusion pattern in index pattern in ISM #1509
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
bowenlan-amzn
merged 11 commits into
opensearch-project:main
from
Tarun-kishore:feature/exclusion-pattern-support
Nov 17, 2025
Merged
[Feature] Supporting Exclusion pattern in index pattern in ISM #1509
bowenlan-amzn
merged 11 commits into
opensearch-project:main
from
Tarun-kishore:feature/exclusion-pattern-support
Nov 17, 2025
+308
−6
Conversation
This file contains hidden or 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
Signed-off-by: Tarun-kishore <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1509 +/- ##
==========================================
+ Coverage 76.08% 76.15% +0.07%
==========================================
Files 375 375
Lines 17542 17565 +23
Branches 2401 2409 +8
==========================================
+ Hits 13346 13377 +31
+ Misses 2951 2947 -4
+ Partials 1245 1241 -4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: Tarun-kishore <[email protected]>
Signed-off-by: Tarun-kishore <[email protected]>
bowenlan-amzn
previously approved these changes
Oct 16, 2025
Member
bowenlan-amzn
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
src/main/kotlin/org/opensearch/indexmanagement/indexstatemanagement/ISMTemplateService.kt
Outdated
Show resolved
Hide resolved
…ement/ISMTemplateService.kt Co-authored-by: bowenlan-amzn <[email protected]> Signed-off-by: Tarun Kishore <[email protected]>
Signed-off-by: Tarun-kishore <[email protected]>
Signed-off-by: Tarun-kishore <[email protected]>
Signed-off-by: Tarun-kishore <[email protected]>
shiv0408
reviewed
Nov 13, 2025
...tlin/org/opensearch/indexmanagement/indexstatemanagement/resthandler/ISMTemplateRestAPIIT.kt
Show resolved
Hide resolved
Signed-off-by: Tarun-kishore <[email protected]>
bowenlan-amzn
approved these changes
Nov 17, 2025
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.
Description
This PR implements support for exclusion patterns in ISM template index patterns using the
-prefix, similar to OpenSearch's native index pattern matching. This allows users to define broad inclusion patterns while excluding specific indices from automatic ISM policy management.Key Changes:
matchesIndexPatterns()function inManagedIndexCoordinatorthat separates inclusion and exclusion patterns, ensuring indices are only managed if they match an inclusion pattern and don't match any exclusion patternvalidateFormat()inISMTemplateServiceto accept and validate exclusion patterns (patterns prefixed with-)findMatchingPolicy()to use the new exclusion-aware matching logicExample Usage:
{ "ism_template": { "index_patterns": ["logs-*", "-logs-test-*", "-logs-*-debug"], "priority": 100 } }This configuration will:
logs-production-001,logs-staging-001logs-test-001,logs-production-debugBenefits:
GET /logs-*,-logs-test-*/_search)Testing Demonstration
Step 1: Create Policy with Exclusion Patterns
Created an ISM policy with mixed inclusion and exclusion patterns:
{ "policy": { "description": "testing exclude change", "default_state": "noop", "states": [ { "name": "noop", "actions": [], "transitions": [] } ], "ism_template": { "index_patterns": ["test-1*", "-test-12*", "test-3*", "-test-34*"], "priority": 100 } } }Step 2: Create Test Indices
Created four test indices to verify the exclusion behavior:
test-10- Should be managed (matchestest-1*, not excluded)test-12- Should NOT be managed (matches exclusion-test-12*)test-30- Should be managed (matchestest-3*, not excluded)test-34- Should NOT be managed (matches exclusion-test-34*)Step 3: Verify with ISM Explain API
After coordinator processing, the ISM Explain API confirms the expected behavior:
test-10test_exclusion_policytest-12test-30test_exclusion_policytest-34Related Issues
Resolves #375
Check List
--signoff.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.