[Fleet] Update logic for "Keep policies up to date" defaults in 8.0 #119126

kpollich · 2021-11-19T01:58:27Z

Summary

Introduces two new constants that control the functionality around our keep_policies_up_to_date field:

KEEP_POLICIES_UP_TO_DATE_PACKAGES - controls packages on which we allow users to configure keep_policies_up_to_date via the integration settings UI
AUTO_UPGRADE_POLICIES_PACKAGES - list of packages for which we default keep_policies_up_to_date to true, and do not allow users to opt out.

Previously, we applied a default of true to all DEFAULT_PACKAGES, but in reality, the only packages that are required to opt into this behavior are APM and Synthetics - which we consider "stack-aligned" due to shipping custom policy editor UI's with Kibana. So, in this PR we've added a migration to set keep_policies_up_to_date: true for these two packages. Previously supplied values for default packages will remain in place, and the migration only touches AUTO_UPGRADE_POLICIES_PACKAGES.

To summarize:

Packages	`keep_policies_up_date` default	UI behavior
APM, Synthetics	true	Setting is shown, but disabled
Default + auto update packages (e.g. `system`, `fleet_server`)	undefined	Setting is shown and enabled
All other packages	undefined	Setting is not shown

For historical context around "stack aligned package upgrades", see these issues:

In 7.16, we pared down the implementation here to avoid breakages. With 8.0 as the target for this change, it seems appropriate that we ease our concerns for breaking changes.

For some additional context, our initial plan around this functionality was to push the "auto-upgrade policies" opt-in out into the package spec via this change proposal: elastic/package-spec#244. However, it seems after some thorough and helpful conversations with members of the ecosystem team, we won't land on exactly the functionality we initially specced out. Things are still in flight here, so for the time being we've elected to unblock ourselves and continue relying on our hardcoded package lists to support automatic policy upgrades for our various managed packages.

With this PR the list of "managed" packages in 8.0 will be

system
elastic_agent
fleet_server
endpoint
apm
synthetics

Related issues

Eventual "bundled" functionality around stack-aligned packages: [Fleet] Add support for bundling Stack-version aligned packages with Kibana #112095
Removing default packages altogether: [Fleet] Remove default integrations #108456

Testing Instructions

Installation Path

Install the apm integration

Verify that the "Keep Policies up to date" switch defaults to the "enabled" setting

Upgrade Path

On a 7.16 instance, navigate directly to <kibana>/integrations/detail/apm-0.4.0/overview and add the apm integration

Once the integration is added, verify that the "keep policies up to date" switch is in the "disabled" setting

Upgrade the 7.16 instance to 8.0+ and verify the setting has switched to the "enabled" position w/ a disabled input, and that the apm integration policy has been upgraded

elasticmachine · 2021-11-19T01:58:29Z

Pinging @elastic/fleet (Team:Fleet)

kpollich · 2021-11-19T02:08:32Z

x-pack/plugins/fleet/server/services/epm/packages/install.ts

@@ -534,9 +534,9 @@ export async function createInstallation(options: {
  const removable = !isUnremovablePackage(pkgName);
  const toSaveESIndexPatterns = generateESIndexPatterns(packageInfo.data_streams);

-  // For default packages, default the `keep_policies_up_to_date` setting to true. For all other
-  // package, default it to false.
-  const defaultKeepPoliciesUpToDate = DEFAULT_PACKAGES.some(


The original intent here should have been to leave keep_policies_up_to_date set to undefined unless it was explicitly set by the user, but this code introduced in #116993 sets the default value to false instead for any non-default package that's installed.

Because we explicitly set this to false during installation for any non-default package, we can't reliably honor user settings during our migration.

For example, if a user installed apm on their 7.16 Kibana instance, the installation SO would have keep_policies_up_to_date: false. So, we have to make a choice in this PR whether we should discard any user-provided value for keep_policies_up_to_date on managed policies and simply set them all globally to true.

To close the loop here, I spoke with Josh offline and got a few pieces of direction here.

The only packages that must have their policies upgraded are APM and Synthetics

We shouldn't automatically opt system into keeping policies up to date, because it's widely used and could cause rollout/performance issues in environments with many agents

With those two things in mind, I elected to make the changes detailed in my previous comment.

criamico

Tested locally, LGTM

nchaulet · 2021-11-19T15:23:34Z

x-pack/plugins/fleet/common/constants/preconfiguration.ts

@@ -72,6 +72,8 @@ export const AUTO_UPDATE_PACKAGES = autoUpdatePackages.map((name) => ({
  version: PRECONFIGURATION_LATEST_KEYWORD,
 }));

+export const MANAGED_PACKAGES = [...DEFAULT_PACKAGES, ...AUTO_UPDATE_PACKAGES];


I found the naming kind of confusing we already use the managed term for the preconfigured policy (Probably a bad naming) but what about a more explicit name here like KEEP_POLICIES_UP_TO_DATE_PACKAGES

kpollich · 2021-11-19T16:59:22Z

I pushed up 7a444a4 which makes a few changes to our logic here

The only packages that are opted into automatic policy upgrades are now APM and Synthetics. This set is captured in a new AUTO_UPGRADE_POLICIES_PACKAGES constant
The "Keep integration policies up to date" switch is now disabled for packages that appear in AUTO_UPGRADE_POLICIES_PACKAGES
Packages that allow the keep_policies_up_to_date switch to appear at all are now captured in a better named KEEP_POLICIES_UP_TO_DATE_PACKAGES constant - cc @nchaulet

kpollich · 2021-11-19T18:52:14Z

@elasticmachine merge upstream

nchaulet

Thanks for changing the naming and all the comments make things a lot more better 🚀

kibana-ci · 2021-11-20T04:48:24Z

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`fleet`	1127	1130	+3

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`fleet`	630.8KB	631.0KB	+270.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`fleet`	104.7KB	105.2KB	+433.0B

Unknown metric groups

API count

id	before	after	diff
`fleet`	1229	1232	+3

History

💔 Build #8110 failed 4a8ff98
💔 Build #8083 failed c25851a
💔 Build #8074 failed 7a444a4
💚 Build #7870 succeeded 8f7aa92

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @kpollich

…lastic#119126) * Auto-upgrade policies for all managed packages by default * Fixing unused import in test * Add migration to installation list * Update naming + disable input for APM + Synthetics * Remove unused import + add message for disabled policy update settingg * Fix failing tests Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

kibanamachine · 2021-11-21T18:21:53Z

💚 Backport successful

Status	Branch	Result
✅	8.0

This backport PR will be merged automatically after passing CI.

…119126) (#119270) * Auto-upgrade policies for all managed packages by default * Fixing unused import in test * Add migration to installation list * Update naming + disable input for APM + Synthetics * Remove unused import + add message for disabled policy update settingg * Fix failing tests Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Kyle Pollich <kyle.pollich@elastic.co>

…119126) * Auto-upgrade policies for all managed packages by default * Fixing unused import in test * Add migration to installation list * Update naming + disable input for APM + Synthetics * Remove unused import + add message for disabled policy update settingg * Fix failing tests Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

…lastic#119126) * Auto-upgrade policies for all managed packages by default * Fixing unused import in test * Add migration to installation list * Update naming + disable input for APM + Synthetics * Remove unused import + add message for disabled policy update settingg * Fix failing tests Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

kpollich added 3 commits November 18, 2021 14:04

Auto-upgrade policies for all managed packages by default

5d27402

Fixing unused import in test

040bf25

Add migration to installation list

8f7aa92

kpollich added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team auto-backport Deprecated - use backport:version if exact versions are needed v8.1.0 labels Nov 19, 2021

kpollich requested a review from joshdover November 19, 2021 01:58

kpollich requested a review from a team as a code owner November 19, 2021 01:58

kpollich self-assigned this Nov 19, 2021

kpollich commented Nov 19, 2021

View reviewed changes

criamico approved these changes Nov 19, 2021

View reviewed changes

nchaulet reviewed Nov 19, 2021

View reviewed changes

Update naming + disable input for APM + Synthetics

7a444a4

kpollich changed the title ~~[Fleet] Auto-upgrade policies for all managed packages by default~~ [Fleet] Update logic for "Keep policies up to date" defaults in 8.0 Nov 19, 2021

Remove unused import + add message for disabled policy update settingg

c25851a

Merge branch 'main' into upgrade-managed-policies

4a8ff98

nchaulet approved these changes Nov 19, 2021

View reviewed changes

Fix failing tests

47590a2

kpollich merged commit c1a5cee into elastic:main Nov 21, 2021

kpollich deleted the upgrade-managed-policies branch November 21, 2021 18:18

kibanamachine mentioned this pull request Nov 21, 2021

[8.0] [Fleet] Update logic for "Keep policies up to date" defaults in 8.0 (#119126) #119270

Merged

kpollich mentioned this pull request Nov 23, 2021

[Fleet] Initiate Fleet setup on boot #111858

Closed

10 tasks

kpollich mentioned this pull request Dec 1, 2021

[Question]: Conflicts under integration upgrade related to APM integration. #120059

Closed

eyalkraft mentioned this pull request Jun 13, 2022

[Discuss] Opt in the Cloud Security Posture integration package for automatic upgrades on Kibana upgrades #134247

Closed

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fleet] Update logic for "Keep policies up to date" defaults in 8.0 #119126

[Fleet] Update logic for "Keep policies up to date" defaults in 8.0 #119126

kpollich commented Nov 19, 2021 •

edited

Loading

elasticmachine commented Nov 19, 2021

kpollich Nov 19, 2021

kpollich Nov 19, 2021 •

edited

Loading

criamico left a comment

nchaulet Nov 19, 2021

kpollich commented Nov 19, 2021

kpollich commented Nov 19, 2021

nchaulet left a comment

kibana-ci commented Nov 20, 2021

API count

kibanamachine commented Nov 21, 2021

[Fleet] Update logic for "Keep policies up to date" defaults in 8.0 #119126

[Fleet] Update logic for "Keep policies up to date" defaults in 8.0 #119126

Conversation

kpollich commented Nov 19, 2021 • edited Loading

Summary

Testing Instructions

Installation Path

Upgrade Path

elasticmachine commented Nov 19, 2021

kpollich Nov 19, 2021

Choose a reason for hiding this comment

kpollich Nov 19, 2021 • edited Loading

Choose a reason for hiding this comment

criamico left a comment

Choose a reason for hiding this comment

nchaulet Nov 19, 2021

Choose a reason for hiding this comment

kpollich commented Nov 19, 2021

kpollich commented Nov 19, 2021

nchaulet left a comment

Choose a reason for hiding this comment

kibana-ci commented Nov 20, 2021

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

Page load bundle

API count

History

kibanamachine commented Nov 21, 2021

💚 Backport successful

kpollich commented Nov 19, 2021 •

edited

Loading

kpollich Nov 19, 2021 •

edited

Loading