[Fleet] Add "managed" and integration name tags to Saved Objects installed by EPM

[joshdover]

In #110660 we added support for installing tags defined by packages, however the main use case we have for tags is for adding a standard set of tags to all Saved Objects we install from packages. In this case, it makes more sense for the Fleet EPM code to handle defining these tags rather than needing to require every package to define them and keep them in sync.

The goal of this change is to help users:

• Know that "managed" assets were installed by Fleet and edits to these objects may be lost
• Understand where the assets installed by Fleet came from
• Filter and find assets for a specific integration package

In the first phase, we want to focus on adding the tags first for visibility and explore future enhancements such as preventing users from editing "managed" assets in a later phase.

Proposal

• Add a "Managed" tag to all supported Saved Object types installed from packages
  • This is consistent with the tag displayed in the Stack Management UI for managed Elasticsearch assets
• Add a tag with the integration's name to all supported Saved Object types installed from packages
  • We should probably use the pretty human-readable name and not the package id
• Use #FFFFFF (white) as the tag colors for now. In the future we could allow packages to define a custom color for their tag.

Example screenshot of how this would look for the assets in the System package:

Implementation notes

• In order to support renames of packages without creating duplicate tags, we should derive the tags underlying id from the package id, but then use the human readable name as the tag's name.

[elasticmachine]

Pinging @elastic/fleet (Team:Fleet)

[joshdover]

@mostlyjason do we have this enhancement prioritized anywhere? I think it's a fairly low effort change that would benefit customers for both finding assets and giving them a hint at which ones should not be edited directly.

[jen-huang]

@joshdover I agree that this looks low effort, I'll include it as a candidate for 8.3.

[joshdover]

@akshay-saraswat do you have any feedback on the tag naming or color as specified in the proposal above?

[akshay-saraswat]

I think it's ok to move ahead with the Package name and white color if it is distinguishable as a tag with white page color too. Once we have this in UI, it will be easier for us to collect customer feedback and iterate over it with package-specific colors.

[alexfrancoeur]

👋 just curious, do we have a target release yet for tags in integrations?

[jen-huang]

@alexfrancoeur 8.3 is the goal

[jen-huang]

I did some investigation and found that the saved objects tagging client is not available server-side, I filed #130748 for that. Marking this issue as blocked until that is resolved.

[ghost]

Hi Team,

We have re-validated this feature on latest 8.4.0 BC3 Kibana Cloud Environment and found that it's working fine.

We had below observations:

• Creating/Deleting tags under Stack Management > Tags page
• Assigning Saved Objects
• Viewing tags under Saved Objects
• Viewing tags under Dashboards
• Sorting and filtering on all above pages

Build details:

Version: 8.4.0-BC3
Build: 55281
Commit: e42c547d7ab545472fd978383c2c43fa203a5b06

Further, we have an open issue related to this feature reported at #138591

Query

Could you please confirm if two editing options are expected under Stack Management > Tags page:

• From edit icon
• From Actions > Edit X tag

Screen Recording:

Tags.-.Elastic.-.Google.Chrome.2022-08-12.14-22-56.mp4

Please let us know if we are missing any scenario.

Thanks!

[ghost]

Hi @juliaElastic,

We have re-validated this feature on latest 8.5.0 SNAPSHOT Kibana Staging Environment and found that it's working fine.

We had below observations:

• Creating a policy and automatic tags such as Managed, System and Elastic Agent are created on Tags page
• Tag is created on adding new integration namely Apache HTTP Server and linked to the Apache package's assets on Tags page.
• System/Apache assets have Managed and System/Apache tags on the Saved Objects and Dashboards page
• Count of saved objects of Managed tag gets updated/increased on adding an Integration.
• Automatic Tags have a white background
• Automatic Tags have no description
• Sorting and filtering on all above pages. Note: The tags column isn't sortable as per "Unable find saved objects" error is shown on sorting of Tags on 'Saved Objects' page #138591 (comment)
• Deleting tags

Build details:

Version: 8.5.0 SNAPSHOT
Build: 55998
Commit: 01ecbd48f3657327cb5375b54195cd07bfc4027f

Query

Steps to follow:

• Create a new policy, say Policy1
• Notice, Managed, System and Elastic Agent tags will be automatically created and they have the package's assets linked to them as saved objects on the Stack Management > Tags page
• Delete the above tags
• Delete the existing policy
• Create the new policy, say Policy2

Current Observation: We are not able to see automatic tags such as Managed, System and Elastic Agent on Tags page. Is this the expected behavior?

Could you please confirm whether the automatic tags such as Managed, System and Elastic Agent will be created or not on the Tags page.

Please let us know if we are missing any scenario.

Thanks!

[juliaElastic]

@prachigupta-qasource The tags are created at package install time.
In the scenario you mentioned, the tags are not recreated on adding a new integration policy, and that is expected.
The tags should be recreated on package reinstall.

[ghost]

Hi @juliaElastic,

We have re-validated the scenario shared by you on latest 8.5.0 SNAPSHOT Kibana Staging Environment and found that it's working fine.

Build details:

Version: 8.5.0 SNAPSHOT
Build: 56060
Commit: 2c5fae2037b138f09231770ef19f0b11c0325c01

Below are the observations:

Scenario 1:

• Create a policy, say Policy 1
• Add 'Windows' integration
• Navigate to Stack Management > Tags page
• Delete the 'Windows' integration tag
• Delete the above policy
• Navigate to Integrations > Installed Integrations
• Click on 'Windows' integration
• Go to Settings page
• Click on 'Uninstall Windows'
• Create a new policy, say Policy 2
• Add 'Windows' integration
• 'Windows' Integration Tag is shown on Stack Management > Tags page

Tags.-.Elastic.-.Google.Chrome.2022-09-08.17-28-23.mp4

Scenario 2:

• Create a policy
• Add 'Windows' integration
• Navigate to Stack Management > Tags page
• Delete the 'Windows' integration tag.
• Navigate to Integrations > Installed Integrations
• Click on 'Windows' integration
• Go to Settings page
• Click on 'Reinstall Windows'
• 'Windows' Integration Tag is shown on Stack Management > Tags page

new_windows_policy.-.Agent.policies.-.Fleet.-.Elastic.-.Google.Chrome.2022-09-08.17-24-07.mp4

Please let us know if we are missing any scenario.

Thanks!

[ghost]

Hi @juliaElastic ,

We have created below 07 test cases for this feature under our Fleet Test Suite:

• [C167966]: Validate that Managed, System and Elastic Agent tags are created on creating a policy and they have the package's assets linked to them as saved objects on Stack Management > Tags page
• [C167967]: Validate that System assets have the Managed and System tags shown on the Saved Objects and Dashboards page
• [C167968]: Validate that on adding another integration e.g. Apache HTTP Server, the tag "Apache HTTP Server" is created and linked to the Apache package's assets.
• [C167969]: Verify that the Apache assets also have the existing Managed tag assigned to them on the Saved Objects and Dashboards page.
• [C167970]: Validate the count of saved objects of Managed tag gets updated/increased on adding an Integration
• [C167971]: Validate that Managed, System and Elastic Agent tags have a white background on the Tags, Saved Objects and Dashboards page
• [C167972]: Validate that ‘Description’ is by default empty for the tags created on adding integrations on the Stack Management > Tags page

Please review the test cases and let us know if we are missing anything.

Thanks!

[ghost]

Hi Team,

We have executed 07 testcases for this feature under our Fleet Test run at Fleet 8.5.0-BC2 Feature test plan.

Below are the observations:

• Passed: 04
• Failed: 03 due to bug [Fleet]: 'Tags' label is not shown on the Dashboards page #142554

Build details:

Version: 8.5.0 BC2
Build: 56806
Commit: dc769f45a5a6dafb0a8c8f0c0cabcced4df45e11

Thanks!