[Fleet] Add support for policy_templates_behavior field to manage policy templates defined in packages are shown
#198145
Assignees
Labels
Team:Fleet
Team label for Observability Data Collection Fleet team
Comments
mrodm
added
the
Team:Fleet
|
Pinging @elastic/fleet (Team:Fleet) |
7 tasks
mrodm
added a commit
that referenced
this issue
Nov 19, 2024
…icy_templates_behavior` field (#200605) ## Summary Closes #198145 Add support to filter the tiles shown in the integrations UI as well as the packages shown in the global search provider depending on the `policy_templates_behaviour` field introduced in elastic/package-spec#802. If this new field is not present in the package manifest, the same behavior is kept. Therefore, it is shown a tile for the package itself plus a tile for each policy template defined in the manifest. Tested using a custom Elastic Package Registry with some packages defining this new `policy_templates_behavior` via the key: ```yaml xpack.fleet.registryUrl: http://localhost:8080 ``` ### Screenshots Checked option "Elastic Agent only" in the integrations UI to avoid tutorials based on Beats. Example with `azure_metrics` package in the Integrations UI: - `policy_templates_behavior: all`  - `policy_templates_behavior: combined_policy`  - `policy_templates_behavior: individual_policies`  Example in the Global Search with `azure_metrics` package and `combined policy` behavior:  ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] 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/packages/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_node:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ]
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this issue
Nov 19, 2024
…icy_templates_behavior` field (elastic#200605) ## Summary Closes elastic#198145 Add support to filter the tiles shown in the integrations UI as well as the packages shown in the global search provider depending on the `policy_templates_behaviour` field introduced in elastic/package-spec#802. If this new field is not present in the package manifest, the same behavior is kept. Therefore, it is shown a tile for the package itself plus a tile for each policy template defined in the manifest. Tested using a custom Elastic Package Registry with some packages defining this new `policy_templates_behavior` via the key: ```yaml xpack.fleet.registryUrl: http://localhost:8080 ``` ### Screenshots Checked option "Elastic Agent only" in the integrations UI to avoid tutorials based on Beats. Example with `azure_metrics` package in the Integrations UI: - `policy_templates_behavior: all`  - `policy_templates_behavior: combined_policy`  - `policy_templates_behavior: individual_policies`  Example in the Global Search with `azure_metrics` package and `combined policy` behavior:  ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] 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/packages/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_node:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] (cherry picked from commit 8352b86)
paulinashakirova
pushed a commit
to paulinashakirova/kibana
that referenced
this issue
Nov 26, 2024
…icy_templates_behavior` field (elastic#200605) ## Summary Closes elastic#198145 Add support to filter the tiles shown in the integrations UI as well as the packages shown in the global search provider depending on the `policy_templates_behaviour` field introduced in elastic/package-spec#802. If this new field is not present in the package manifest, the same behavior is kept. Therefore, it is shown a tile for the package itself plus a tile for each policy template defined in the manifest. Tested using a custom Elastic Package Registry with some packages defining this new `policy_templates_behavior` via the key: ```yaml xpack.fleet.registryUrl: http://localhost:8080 ``` ### Screenshots Checked option "Elastic Agent only" in the integrations UI to avoid tutorials based on Beats. Example with `azure_metrics` package in the Integrations UI: - `policy_templates_behavior: all`  - `policy_templates_behavior: combined_policy`  - `policy_templates_behavior: individual_policies`  Example in the Global Search with `azure_metrics` package and `combined policy` behavior:  ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] 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/packages/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_node:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ]
CAWilson94
pushed a commit
to CAWilson94/kibana
that referenced
this issue
Dec 12, 2024
…icy_templates_behavior` field (elastic#200605) ## Summary Closes elastic#198145 Add support to filter the tiles shown in the integrations UI as well as the packages shown in the global search provider depending on the `policy_templates_behaviour` field introduced in elastic/package-spec#802. If this new field is not present in the package manifest, the same behavior is kept. Therefore, it is shown a tile for the package itself plus a tile for each policy template defined in the manifest. Tested using a custom Elastic Package Registry with some packages defining this new `policy_templates_behavior` via the key: ```yaml xpack.fleet.registryUrl: http://localhost:8080 ``` ### Screenshots Checked option "Elastic Agent only" in the integrations UI to avoid tutorials based on Beats. Example with `azure_metrics` package in the Integrations UI: - `policy_templates_behavior: all`  - `policy_templates_behavior: combined_policy`  - `policy_templates_behavior: individual_policies`  Example in the Global Search with `azure_metrics` package and `combined policy` behavior:  ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] 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/packages/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_node:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ]
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Relates elastic/package-spec#802
Relates elastic/package-registry#1243
A new
policy_templates_behaviorfield has been added into the spec (in the package manifest filemanifest.yml) elastic/package-spec#802.The aim of this new field is to indicate how policy templates should behaved when the package defines more than policy template. This key could have three different values defined in:
https://github.com/elastic/package-spec/blob/cc5282374a5d062497bf0517d77a449d7176a35e/spec/integration/manifest.spec.yml#L367-L375
It would be needed to add support of this new field in Fleet to allow developers to set in their packages how they want to show their policy templates cards.
There are some examples of packages that could leverage that field (e.g.
elastic_connectors,kubernetes...) in elastic/package-spec#802This new field is also going to be available as part of the search and package API responses from Elastic Package Registry (elastic/package-registry#1243)
The text was updated successfully, but these errors were encountered: