[Internal]: Document the Automatic Migration embedding model setting (xpack.securitySolution.siemRuleMigrations.elserInferenceId)

Open Beginner friendly
#9,520 4 comments 1 reaction 0 assignees View on GitHub

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

Feature: Security General Team:SKI triaged
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_id of the elser_embedding semantic_text field in
    .kibana-siem-rule-migrations-integrations and .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-elastic inference endpoint.
  • If ELSER over EIS is not available, ELSER is deployed on ML nodes instead, through the
    .elser-2-elasticsearch inference endpoint.

What to document:

  1. Add the setting to the Security Solution settings reference
    (docs/reference/configuration-reference/security-solution-settings.yml in elastic/kibana).
  2. 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:

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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from elastic/docs-content

All issues in elastic/docs-content

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.