elastic / package-spec

EPR package specifications
Other
17 stars 70 forks source link

Missing a behavioral definition of routing_rules.yml #772

Open andrewkroh opened 2 months ago

andrewkroh commented 2 months ago

The package-spec definition of routing rules doesn't explain what happens to these rules. As a developer I need to know how these affect the data stream behavior. IMO one of these sections should be expanded to include this information to developers.

https://github.com/elastic/package-spec/blob/2758f3ed968961cbf8cd094269ea8bd9ad1875df/spec/integration/data_stream/routing_rules.spec.yml#L58

https://github.com/elastic/package-spec/blob/2758f3ed968961cbf8cd094269ea8bd9ad1875df/spec/integration/data_stream/routing_rules.spec.yml#L8

My suggestion is to include this information:

Each rule generates an Elasticsearch reroute processor that is injected into the data stream's default ingest pipeline. The reroute processors are added after the injected "custom" pipeline processors (e.g. global@custom, <data_stream.type>@custom, <data_stream.type>-<package_name>.integration@custom, <data_stream.type>-<data_stream.dataset>@custom) such that the user's customizations run before the reroute rules.

References: