-
Notifications
You must be signed in to change notification settings - Fork 8.2k
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
[Security Solution] RulesManagementClient refactoring. Part 1 #180128
Labels
8.15 candidate
Feature:Rule Management
Security Solution Detection Rule Management
refactoring
Team:Detection Rule Management
Security Detection Rule Management Team
Team:Detections and Resp
Security Detection Response Team
Team: SecuritySolution
Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.
v8.15.0
Comments
jpdjere
added
triage_needed
Feature:Detection Rules
Anything related to Security Solution's Detection Rules
Team:Detections and Resp
Security Detection Response Team
Team: SecuritySolution
Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.
Team:Detection Rule Management
Security Detection Rule Management Team
labels
Apr 5, 2024
Pinging @elastic/security-solution (Team: SecuritySolution) |
Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management) |
Pinging @elastic/security-detections-response (Team:Detections and Resp) |
banderror
changed the title
[Security Solution] Refactor rule management utilities behind a new abstraction of
[Security Solution] Refactor rule management utilities behind a new abstraction of Apr 17, 2024
RuleManagementClient
RuleManagementClient
(DRAFT)
jpdjere
changed the title
[Security Solution] Refactor rule management utilities behind a new abstraction of
[Security Solution] Refactor rule management utilities behind a new abstraction of Apr 18, 2024
RuleManagementClient
(DRAFT)RuleManagementClient
This was referenced Apr 18, 2024
Closed
banderror
added
refactoring
Feature:Rule Management
Security Solution Detection Rule Management
8.15 candidate
v8.15.0
and removed
triage_needed
Feature:Detection Rules
Anything related to Security Solution's Detection Rules
labels
May 12, 2024
2 tasks
xcrzx
added a commit
that referenced
this issue
May 28, 2024
…ation (#182802) **Partially addresses: #180128 ## Summary - Creates `RulesManagementClient`, which centralizes CRUD utilites for rules, at `x-pack/plugins/security_solution/server/lib/detection_engine/rule_management/logic/crud/rules_management_client.ts` - Move ML Auth validation from endpoints to the new client utils. - Adds client to `SecuritySolution` API requests context. - Deletes `createRules`, `deletesRules`,`updateRules` and `patchRules` utils and replaces them with new client methods. - **Testing**: - Creates individual test files for each "public" method of the RulesManagementClient. - Creates importable mock of the client ## To-Do: - Replace `readRules` method for a new public method within the API (left out of this PR to keep scope and size manageable) ## Flaky Test Runner - [FTR Exceptions - ESS](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6080) 🟢 - [FTR Exceptions - Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6081) 🟢 - [FTR - Prebuilt Rules - Bundled Prebuilt Rules Package - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6083) 🟢 - [FTR - Prebuilt Rules - Large Prebuilt Rules Package - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6084) 🟢 - [FTR - Prebuilt Rules - Management - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6085) 🟢 - [FTR - Prebuilt Rules - Update Prebuilt Rules Package - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6085) 🟢 - [FTR - Rules Management - Rule Bulk Actions - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6087) 🟢 - [FTR - Rules Management - Rule Creation - Basic License Essentials Tier - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6088) 🟢 - [FTR - Rules Management - Rule Creation - Trial License Complete Tier - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6089) 🟢 - [FTR - Rules Management - Rule Deletion - Basic License Essentials Tier - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6090) (name is wrong in the FTR UI, but runs the correct tests) 🟢 - [FTR - Rules Management - Rule Deletion - Trial License Complete Tier - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6091) 🟢 - [FTR - Rules Management - Rule Import and Export - Basic License Essentials Tier - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6092) 🟢 - [FTR - Rules Management - Rule Import and Export - Trial License Complete Tier - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6093) 🟢 - [FTR - Rules Management - Rule Patch - Basic License Essentials Tier - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6095) 🟢 - [FTR - Rules Management - Rule Patch - Trial License Complete Tier - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6096) 🟢 - [FTR - Rules Management - Rule Update - Basic License Essentials Tier - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6097) 🟢 - [FTR - Rules Management - Rule Update - Trial License Complete Tier - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6098) 🟢 - [Cypress - Security Solution Rule Management - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6099) 🟢 - [Cypress - Security Solution Rule Management - Prebuilt Rules - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6100) 🟢 - [Cypress - Security Solution Detection Engine - Exceptions - ESS and Serverless](https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/6101) 🟢 ### Checklist Delete any items that are not applicable to this PR. - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed --------- Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Dmitrii Shevchenko <[email protected]>
17 tasks
I've listed all remaining work in this follow-up ticket: #184364. |
banderror
changed the title
[Security Solution] Refactor rule management utilities behind a new abstraction of
[Security Solution] RulesManagementClient refactoring. Part 1
May 30, 2024
RuleManagementClient
14 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
8.15 candidate
Feature:Rule Management
Security Solution Detection Rule Management
refactoring
Team:Detection Rule Management
Security Detection Rule Management Team
Team:Detections and Resp
Security Detection Response Team
Team: SecuritySolution
Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.
v8.15.0
Epics: https://github.com/elastic/security-team/issues/1974 (internal), #174168
rule_source
field together withimmutable
#180141Summary
As part of the preparatory changes for Prebuilt Rules Customization Milestone 3, we want to refactor rule management CRUD utilities into a new abstraction with tentative name
RuleManagementClient
.Currently, the CRUD utilities that our endpoints use suffer from the problem of tightly coupled logic, which leads them to having unnecessary complex interfaces and logic in order to handle all the different use cases for which they are used.
We aim for the new abstraction to deliver two main improvements:
createRules
utility is used for creating custom rules, importing rules and upgrading rules. Instead, create specific utilities for each use case.Background
kibana/x-pack/plugins/security_solution/docs/rfcs/detection_response/prebuilt_rules_customization.md
Lines 402 to 425 in 07706fd
The text was updated successfully, but these errors were encountered: