Commit fd9180a
[Fleet] Support data_stream.type variable in simplified policy API (elastic#269895)
## Summary
Closes elastic#266321
The simplified package policy API did not support `data_stream.type` as
an overridable variable. Input-only packages define a default data
stream type in their manifest (for example, `metrics`), but there was no
way to override it via the simplified API — any attempt threw a
`Variable not found` error because the variable was not synthesised into
the policy's stream vars. This blocked elastic-package policy tests that
rely on the simplified API to set a non-default `data_stream.type`.
This PR adds full support for `data_stream.type` as a top-level variable
in input-only package policies, following the same pattern as
`data_stream.dataset` and `use_apm`.
### What changed
**`policy_template.ts`**
- Adds `DATA_STREAM_TYPE_VAR` — a synthetic `RegistryVarsEntry`
definition for `data_stream.type`.
- Adds `addDataStreamTypeVarIfNotPresent` and
`shouldIncludeDataStreamTypeVar` helpers, mirroring the existing dataset
helpers.
- `getNormalizedDataStreams` now injects the synthetic
`data_stream.type` var into every input-only stream's vars (with the
package's default type as the default value), unless the policy template
declares `dynamic_signal_types: true` — in which case the type is
resolved at runtime and the var is intentionally omitted.
**`simplified_package_policy_helper.ts`**
- Adds `syncDataStreamTypeFromVar`: iterates all streams and, when
`stream.vars['data_stream.type'].value` differs from
`stream.data_stream.type`, updates the field in place. This is what
makes the compiled agent YAML and index template lookup use the
user-supplied type rather than the package default.
- `simplifiedPackagePolicytoNewPackagePolicy` calls
`syncDataStreamTypeFromVar` before returning, so the returned
`NewPackagePolicy` is consistent.
**`package_policy.ts` (server)**
- Calls `syncDataStreamTypeFromVar` before `preflightCheckPackagePolicy`
in both `create()` and `bulkCreate()`, covering the direct Fleet API
path in addition to the simplified API.
**`package_policies_to_agent_permissions.ts`**
- When computing index permissions, reads
`stream.vars['data_stream.type'].value` first and falls back to
`stream.data_stream.type`. This ensures the correct index prefix
(`logs-*` vs `metrics-*`) is granted when the type has been overridden.
**Rejection for `dynamic_signal_types` packages**
Packages with `dynamic_signal_types: true` (for example, OTel collector)
do not get the `data_stream.type` var injected. Because the var is
absent from `varsRecord`, `assignVariables` throws a
`PackagePolicyValidationError` if a caller attempts to set it,
preventing misuse.
### Testing
- Unit tests added and updated in `policy_template.test.ts`,
`simplified_package_policy_helper.test.ts`, and
`package_policies_to_agent_permissions.test.ts`.
- Manually validated end-to-end using the test fixture from
[elastic/elastic-package#3509](https://github.com/elastic/elastic-package/pull/3509/changes#diff-d01b43d83cadd491f2e69dca24265787b53b9513812615389d30bbb63c7b9664)
with the `policy_api_format` workaround removed from the test
configuration. The downloaded agent policy correctly showed
`data_stream.type: logs` in the stream and `logs-*-*` in the index
permissions.
---
### Checklist
- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This was checked for breaking HTTP API changes, and any breaking
changes have been approved by the breaking-change committee. The
`release_note:breaking` label should be applied in these situations.
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] The PR description includes the appropriate Release Notes section,
and the correct `release_note:*` label is applied per the
[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
- [ ] Review the [backport
guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing)
and apply applicable `backport:*` labels.
### Identify risks
- **Immutable type after creation** — like `data_stream.dataset`, the
`data_stream.type` var is immutable once the policy is saved. An attempt
to update it is rejected with a validation error (existing guard in
`package_policy.ts`). Low risk; consistent with existing dataset
immutability.
- **Input-only packages only** — the synthetic var is only injected for
`type: input` packages. Composable integration packages are unaffected.
- [ ] [See some risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx)
### Release note
```
Fleet now supports overriding `data_stream.type` via the simplified package policy API for input-only packages. Setting this variable routes collected data to a different Elasticsearch index prefix (e.g. `logs-*` instead of `metrics-*`) and grants the appropriate index permissions to the agent.
```1 parent dd46233 commit fd9180a
15 files changed
Lines changed: 565 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
20 | | - | |
21 | 20 | | |
22 | 21 | | |
23 | 22 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
87 | 87 | | |
88 | 88 | | |
89 | 89 | | |
| 90 | + | |
90 | 91 | | |
| 92 | + | |
91 | 93 | | |
92 | 94 | | |
93 | 95 | | |
| |||
Lines changed: 6 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
| 30 | + | |
30 | 31 | | |
31 | 32 | | |
| 33 | + | |
32 | 34 | | |
33 | 35 | | |
34 | 36 | | |
| |||
47 | 49 | | |
48 | 50 | | |
49 | 51 | | |
| 52 | + | |
50 | 53 | | |
51 | 54 | | |
52 | 55 | | |
53 | 56 | | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
54 | 60 | | |
55 | 61 | | |
56 | 62 | | |
| |||
Lines changed: 26 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
| 8 | + | |
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| |||
51 | 51 | | |
52 | 52 | | |
53 | 53 | | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
Lines changed: 29 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
| 11 | + | |
10 | 12 | | |
11 | 13 | | |
12 | 14 | | |
| |||
118 | 120 | | |
119 | 121 | | |
120 | 122 | | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
Lines changed: 132 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
| 33 | + | |
| 34 | + | |
33 | 35 | | |
34 | 36 | | |
35 | 37 | | |
| |||
198 | 200 | | |
199 | 201 | | |
200 | 202 | | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
201 | 251 | | |
202 | 252 | | |
203 | 253 | | |
| |||
324 | 374 | | |
325 | 375 | | |
326 | 376 | | |
327 | | - | |
| 377 | + | |
| 378 | + | |
| 379 | + | |
| 380 | + | |
| 381 | + | |
| 382 | + | |
| 383 | + | |
| 384 | + | |
| 385 | + | |
| 386 | + | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
| 396 | + | |
| 397 | + | |
| 398 | + | |
| 399 | + | |
| 400 | + | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
| 406 | + | |
| 407 | + | |
| 408 | + | |
| 409 | + | |
| 410 | + | |
| 411 | + | |
| 412 | + | |
| 413 | + | |
| 414 | + | |
| 415 | + | |
| 416 | + | |
| 417 | + | |
| 418 | + | |
| 419 | + | |
| 420 | + | |
| 421 | + | |
| 422 | + | |
| 423 | + | |
| 424 | + | |
| 425 | + | |
| 426 | + | |
| 427 | + | |
| 428 | + | |
| 429 | + | |
| 430 | + | |
| 431 | + | |
| 432 | + | |
| 433 | + | |
| 434 | + | |
| 435 | + | |
| 436 | + | |
| 437 | + | |
| 438 | + | |
| 439 | + | |
| 440 | + | |
| 441 | + | |
| 442 | + | |
| 443 | + | |
| 444 | + | |
| 445 | + | |
| 446 | + | |
| 447 | + | |
| 448 | + | |
| 449 | + | |
| 450 | + | |
| 451 | + | |
| 452 | + | |
| 453 | + | |
| 454 | + | |
| 455 | + | |
| 456 | + | |
| 457 | + | |
| 458 | + | |
328 | 459 | | |
329 | 460 | | |
330 | 461 | | |
| |||
Lines changed: 39 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
12 | 13 | | |
13 | 14 | | |
14 | 15 | | |
| |||
43 | 44 | | |
44 | 45 | | |
45 | 46 | | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
46 | 62 | | |
47 | 63 | | |
48 | 64 | | |
| |||
202 | 218 | | |
203 | 219 | | |
204 | 220 | | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
205 | 224 | | |
206 | 225 | | |
207 | 226 | | |
| |||
288 | 307 | | |
289 | 308 | | |
290 | 309 | | |
| 310 | + | |
| 311 | + | |
| 312 | + | |
| 313 | + | |
| 314 | + | |
| 315 | + | |
| 316 | + | |
| 317 | + | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
| 328 | + | |
| 329 | + | |
291 | 330 | | |
292 | 331 | | |
293 | 332 | | |
| |||
0 commit comments