Skip to content

Conversation

@rabbitstack
Copy link
Owner

What is the purpose of this PR / why it is needed?

Historically, the file.name/image.name/registry.key.name filter fields were used to yield the full file
path, image path, or registry key respectively. However, a better way to convey that the referenced field
is actually returning a fully-qualified path is to introduce a new set of fields. As a side effect, the
previous fields return the base file/image/key names.

All rules referencing file.name/image.name/registry.key.name are adapted to use the new *.path fields. This effectively leads to a breaking change, that's why all affected rules minimum engine version is bumped.

What type of change does this PR introduce?


Uncomment one or more /kind <> lines:

/kind feature (non-breaking change which adds functionality)

/kind bug-fix (non-breaking change which fixes an issue)

/kind refactor (non-breaking change that restructures the code, while not changing the original functionality)

/kind breaking (fix or feature that would cause existing functionality to not work as expected

/kind cleanup

/kind improvement

/kind design

/kind documentation

/kind other (change that doesn't pertain to any of the above categories)

Any specific area of the project related to this PR?


Uncomment one or more /area <> lines:

/area instrumentation

/area telemetry

/area rule-engine

/area filters

/area yara

/area event

/area captures

/area alertsenders

/area outputs

/area rules

/area filaments

/area config

/area cli

/area tests

/area ci

/area build

/area docs

/area deps

/area other

Special notes for the reviewer


Does this PR introduce a user-facing change?


Yes, hence the set of new filter fields need to be reflected in the docs.

Historically, the file.name/image.name/registry.key.name filter fields were used to yield the full file
path, image path, or registry key respectively. However, a better way to convey the referenced field
is actually returning a fully-qualified path is to introduce a new set of fields. As a side effect, the
previous fields return the base file/image/key names.
Historically, the file.name/image.name/registry.key.name filter fields were used to yield the full file
path, image path, or registry key respectively. However, a better way to convey the referenced field
is actually returning a fully-qualified path is to introduce a new set of fields. As a side effect, the
previous fields return the base file/image/key names.
All rules referencing file.name/image.name/registry.key.name are adapted to use the new *.path fields. This effectively leads to a breaking change, that's why all
affected rules minimum engine version is bumped.
@rabbitstack rabbitstack force-pushed the make-path-filter-fields-consistent branch from 4275d3a to 335a1a4 Compare December 20, 2024 15:31
@rabbitstack rabbitstack merged commit 0799c5e into master Dec 20, 2024
6 checks passed
@rabbitstack rabbitstack deleted the make-path-filter-fields-consistent branch December 20, 2024 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants