[Internal]: Document the Automatic Migration embedding model setting (xpack.securitySolution.siemRuleMigrations.elserInferenceId)
Maintainers usually reply within 2 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- yaml
- Domain
- documentation
Research direction
Start with docs/reference/configuration-reference/security-solution-settings.yml and the Automatic Migration page named in the issue. Read the resolver file to confirm the documented defaults: ELSER over EIS when available, otherwise ELSER on ML nodes. Add the setting and explain its rule migration scope and defaults in both places; done when users can find the override and understand the fallback.
Written by the indexing model from the issue text.
Description
Description
What: Automatic Migration (rules) uses an inference endpoint to generate embeddings
for integrations and Elastic prebuilt rules. This done to match rules being migrated to Elastic's prebuilt rules and finding appropriate integrations for Custom translations.
Users can override that endpoint in kibana.yml, but the setting is not documented anywhere:
## ELSER over EIS
xpack.securitySolution.siemRuleMigrations.elserInferenceId: .elser-2-elastic
Behavior (from code):
- Type: string, optional.
- Sets the
inference_idof theelser_embeddingsemantic_textfield in
.kibana-siem-rule-migrations-integrationsand.kibana-siem-rule-migrations-prebuiltrules. - Affects rule migrations only. Dashboard migrations do not use it.
Defaults:
- By default, Automatic Migration uses ELSER over the Elastic Inference Service (EIS),
through the.elser-2-elasticinference endpoint. - If ELSER over EIS is not available, ELSER is deployed on ML nodes instead, through the
.elser-2-elasticsearchinference endpoint.
What to document:
- Add the setting to the Security Solution settings reference
(docs/reference/configuration-reference/security-solution-settings.ymlin elastic/kibana). - Mention it on the Automatic Migration page (requirements or FAQ), and explain the
defaults described above.
Why: Users who need a specific inference endpoint currently have no way to
discover this setting.
Resources
- Config schema:
x-pack/solutions/security/plugins/security_solution/server/config.ts(siemRuleMigrations.elserInferenceId) - Default resolution:
x-pack/solutions/security/plugins/security_solution/server/lib/siem_migrations/rules/data/utils/resolve_elser_inference_id.ts - Field mappings:
x-pack/solutions/security/plugins/security_solution/server/lib/siem_migrations/rules/data/field_maps.ts - Earlier settings audit: elastic/kibana#296426
- Page to update: https://www.elastic.co/docs/solutions/security/get-started/automatic-migration
Related ELSER docs:
- ELSER model: https://www.elastic.co/docs/explore-analyze/machine-learning/nlp/ml-nlp-elser
- Elastic Inference Service (EIS): https://www.elastic.co/docs/explore-analyze/elastic-inference/eis
- EIS for ECE, ECK, and self-managed clusters: https://www.elastic.co/docs/explore-analyze/elastic-inference/connect-self-managed-cluster-to-eis
- Create an ELSER inference endpoint (API): https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-elser
Which deployment methods does this change impact?
Unknown
Feature differences
No response
What Elastic Stack release is this request related to?
N/A
Serverless release
No response
Collaboration model
We expect to collaborate on the first draft
Point of contact.
Main contact: @logeekal
Stakeholders: @cthulhusec
- Dominant language
- No language data
- Stars
- 50
- Forks
- 269
- Avg merge
- 4d 6h
- Merged PRs (30d)
- 241
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from elastic/docs-content
-
Team:Admin triaged
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
elastic/docs-content#9532 · 1 comment · 1 reaction ·
Maintainers usually reply within 2 days
-
source:web Team:SKI triaged
Difficulty 1/5 Under an hour Newbie friendliness 85/100
elastic/docs-content#9508 · 1 comment · 1 reaction ·
Maintainers usually reply within 2 days
-
Team:SKI triaged
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
elastic/docs-content#9493 · 1 comment · 1 reaction ·
Maintainers usually reply within 2 days
-
Preview generated workflows as a graph or YAML in Agent ChatPossibly taken @nastasha-solomon claimed this 1 day ago. OpenFeature: Workflows Team:SKI triaged
Difficulty 1/5 Under an hour Newbie friendliness 85/100
elastic/docs-content#9463 · 1 comment · 1 reaction · 1 assignee ·
Maintainers usually reply within 2 days
-
[Alerting V2] Get ES|QL help and recommended queries in the rule query sandboxPossibly taken @nastasha-solomon claimed this 3 days ago. Openalerting-v2 Team:SKI triaged
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
elastic/docs-content#9428 · 1 comment · 1 reaction · 1 assignee ·
Maintainers usually reply within 2 days
All issues in elastic/docs-content
Similar issues
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 89/100
Maintainers usually reply within 1 day
-
sync-en
Difficulty 1/5 Under an hour Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
Area/Connector module/solace Priority/Low Type/Docs
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
ballerina-platform/ballerina-library#9850 ·
Maintainers usually reply within 1 day
-
needs-triage
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
gke-labs/kube-agents#6620 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
EveryInc/compound-engineering-plugin#2091 ·
Maintainers usually reply within 1 day