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

Aperta Adatta ai principianti
#9,520 4 commenti 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
yaml
Ambito
documentation

Direzione di ricerca

Inizia da docs/reference/configuration-reference/security-solution-settings.yml e dalla pagina sulla migrazione automatica menzionata nell’issue. Leggi il file del resolver per confermare i valori predefiniti documentati: ELSER prima di EIS quando disponibile, altrimenti ELSER sui nodi ML. Aggiungi l’impostazione in entrambi i punti e spiega lì il suo ambito nella migrazione delle regole e i valori predefiniti; il lavoro è completato quando gli utenti possono trovare l’opzione di override e comprendere il fallback.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
Nessun dato sulla lingua
Stelle
50
Fork
269
Merge medio
4g 6h
PR unite (30g)
241

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di elastic/docs-content

Tutte le issue di elastic/docs-content

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.