diff --git a/config.example.yaml b/config.example.yaml index 433719a..dac5eac 100644 --- a/config.example.yaml +++ b/config.example.yaml @@ -125,7 +125,7 @@ pipeline: # # - "/etc/dfe-transform-vrl/transforms/02_enrich.vrl" # # - "/etc/dfe-transform-vrl/transforms/03_filter.vrl" -# --- OPTIONAL: bundled DFE 2.1 filebeat-compat pipeline (INTERIM) ------------ +# --- OPTIONAL: bundled filebeat-compat pipeline (LEGACY, DFE/XDR 2.0 and 2.1) - # Pre-canned pure-VRL port of the DFE 2.1 filebeat templates (Cisco Meraki / # IOS / Umbrella). Being replaced by dfe-transform-elastic - see # pipelines/filebeat/README.md before adopting. The stock image ships no diff --git a/docs/internals.md b/docs/internals.md index c186245..2c80e0c 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -74,8 +74,7 @@ carries no filebeat-specific code, and the integration tests cases in `tests/fixtures/filebeat/cases.yaml`, which double as a full-engine workload. -INTERIM: elastic compatibility is being replaced by `dfe-transform-elastic` -(Rust-native). Wiring, routing behaviour, known limitations, and +LEGACY: it keeps DFE/XDR 2.0 and 2.1 filebeat feeds working, takes no new modules, and new feeds use `dfe-transform-elastic`. Wiring, routing behaviour, known limitations, and regeneration tooling (`scripts/filebeat/`) are documented in [pipelines/filebeat/README.md](../pipelines/filebeat/README.md). diff --git a/pipelines/filebeat/README.md b/pipelines/filebeat/README.md index b02bee3..20a0704 100644 --- a/pipelines/filebeat/README.md +++ b/pipelines/filebeat/README.md @@ -1,15 +1,12 @@ -# Bundled pipeline: filebeat-compat (INTERIM) +# Bundled pipeline: filebeat-compat (LEGACY) -A pre-canned, opt-in VRL pipeline that keeps DFE 2.1 filebeat feeds working +A pre-canned, opt-in VRL pipeline that keeps DFE/XDR 2.0 and 2.1 filebeat feeds working on dfe-transform-vrl. It is pure VRL plus one CSV enrichment table - no binary capability, no config surface. Use it if you want it, ignore it if you do not. It also doubles as an integration test workload for the engine (`tests/integration/filebeat_pipeline.rs`). -> **INTERIM.** Elastic compatibility is being replaced by -> `dfe-transform-elastic` (Rust-native). New integrations should NOT -> build on this pipeline, and existing DFE 2.1 filebeat feeds should -> plan to migrate to dfe-transform-elastic. +> **LEGACY.** Backwards compatibility for DFE/XDR 2.0 and 2.1 filebeat feeds, frozen at the three Cisco modules below. It takes no new modules, fetches nothing from Elastic at build, test or run time, and is regenerated only from our own DFE 2.1 templates. New feeds use `dfe-transform-elastic`, and 2.0 and 2.1 feeds should plan to move there. ## What it covers diff --git a/pipelines/filebeat/filebeat.vrl b/pipelines/filebeat/filebeat.vrl index d463c96..4fa62da 100644 --- a/pipelines/filebeat/filebeat.vrl +++ b/pipelines/filebeat/filebeat.vrl @@ -1,5 +1,5 @@ ############################################################################## -# dfe-transform-vrl bundled pipeline: filebeat-compat -- INTERIM +# dfe-transform-vrl bundled pipeline: filebeat-compat -- LEGACY # # Single-file port of the DFE 2.1 Vector filebeat transform templates # (dfe-vector-templates src/core_templates 14x family): @@ -16,10 +16,9 @@ # umbrella templates differed only in the hardcoded .log.file.path seed; # they collapse to one body driven by the detected log type. # -# INTERIM: this pipeline keeps DFE 2.1 filebeat feeds working on -# dfe-transform-vrl. Elastic compatibility is being replaced by -# dfe-transform-elastic (Rust-native, currently in beta); new integrations -# should NOT build on this file. +# LEGACY: backwards compatibility for DFE/XDR 2.0 and 2.1 filebeat feeds +# on dfe-transform-vrl, frozen at these three modules. New feeds use +# dfe-transform-elastic. # # Deliberate departures from the 2.1 templates: # - geoip enrichment is NOT ported: dfe-loader owns geoip enrichment in diff --git a/scripts/filebeat/prologue.vrl b/scripts/filebeat/prologue.vrl index 062065d..5d1d547 100644 --- a/scripts/filebeat/prologue.vrl +++ b/scripts/filebeat/prologue.vrl @@ -1,5 +1,5 @@ ############################################################################## -# dfe-transform-vrl bundled pipeline: filebeat-compat -- INTERIM +# dfe-transform-vrl bundled pipeline: filebeat-compat -- LEGACY # # Single-file port of the DFE 2.1 Vector filebeat transform templates # (dfe-vector-templates src/core_templates 14x family): @@ -16,10 +16,9 @@ # umbrella templates differed only in the hardcoded .log.file.path seed; # they collapse to one body driven by the detected log type. # -# INTERIM: this pipeline keeps DFE 2.1 filebeat feeds working on -# dfe-transform-vrl. Elastic compatibility is being replaced by -# dfe-transform-elastic (Rust-native, currently in beta); new integrations -# should NOT build on this file. +# LEGACY: backwards compatibility for DFE/XDR 2.0 and 2.1 filebeat feeds +# on dfe-transform-vrl, frozen at these three modules. New feeds use +# dfe-transform-elastic. # # Deliberate departures from the 2.1 templates: # - geoip enrichment is NOT ported: dfe-loader owns geoip enrichment in