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

…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 <[email protected]>
elastic · Nov 21, 2021 · c1a5cee · c1a5cee
1 parent d0b58bb
commit c1a5cee
Show file tree

Hide file tree

Showing 13 changed files with 77 additions and 68 deletions.
diff --git a/x-pack/plugins/fleet/common/constants/epm.ts b/x-pack/plugins/fleet/common/constants/epm.ts
@@ -32,6 +32,13 @@ export const STANDALONE_RUN_INSTRUCTIONS = './elastic-agent install';
 removable, but it doesn't install by default. Following the table, it needs to
 be in `unremovablePackages` and in `autoUpdatePackages`, but not in
 `defaultPackages`.
+
+
+We also define "auto upgrade policies" packages below. These are packages that are considered "stack-aligned"
+and require policies to be auto-upgraded in order to properly function. Commonly, packages that ship custom policy
+editor UI's in the Kibana codebase will be included in this set of packages to avoid backwards-compatibility concerns
+in their custom policy editor implementations.
+
 */
 
 export const unremovablePackages = [
@@ -49,6 +56,8 @@ export const autoUpdatePackages = [
   FLEET_SYNTHETICS_PACKAGE,
 ];
 
+export const autoUpgradePoliciesPackages = [FLEET_APM_PACKAGE, FLEET_SYNTHETICS_PACKAGE];
+
 export const agentAssetTypes = {
   Input: 'input',
 } as const;

diff --git a/x-pack/plugins/fleet/common/constants/preconfiguration.ts b/x-pack/plugins/fleet/common/constants/preconfiguration.ts
@@ -5,6 +5,8 @@
  * 2.0.
  */
 
+import { uniqBy } from 'lodash';
+
 import type { PreconfiguredAgentPolicy } from '../types';
 
 import {
@@ -13,6 +15,7 @@ import {
   FLEET_SERVER_PACKAGE,
   autoUpdatePackages,
   monitoringTypes,
+  autoUpgradePoliciesPackages,
 } from './epm';
 
 export const PRECONFIGURATION_DELETION_RECORD_SAVED_OBJECT_TYPE =
@@ -72,6 +75,18 @@ export const AUTO_UPDATE_PACKAGES = autoUpdatePackages.map((name) => ({
   version: PRECONFIGURATION_LATEST_KEYWORD,
 }));
 
+// These packages default to `keep_policies_up_to_date: true` and don't allow users to opt out
+export const AUTO_UPGRADE_POLICIES_PACKAGES = autoUpgradePoliciesPackages.map((name) => ({
+  name,
+  version: PRECONFIGURATION_LATEST_KEYWORD,
+}));
+
+// Controls whether the `Keep Policies up to date` setting is exposed to the user
+export const KEEP_POLICIES_UP_TO_DATE_PACKAGES = uniqBy(
+  [...AUTO_UPGRADE_POLICIES_PACKAGES, ...DEFAULT_PACKAGES, ...AUTO_UPDATE_PACKAGES],
+  ({ name }) => name
+);
+
 export interface PreconfigurationError {
   package?: { name: string; version: string };
   agentPolicy?: { name: string };

diff --git a/x-pack/plugins/fleet/common/types/models/epm.ts b/x-pack/plugins/fleet/common/types/models/epm.ts
@@ -402,7 +402,7 @@ export interface Installation extends SavedObjectAttributes {
   install_version: string;
   install_started_at: string;
   install_source: InstallSource;
-  keep_policies_up_to_date: boolean;
+  keep_policies_up_to_date?: boolean;
 }
 
 export interface PackageUsageStats {

diff --git a/...s/integrations/sections/epm/screens/detail/components/keep_policies_up_to_date_switch.tsx b/...s/integrations/sections/epm/screens/detail/components/keep_policies_up_to_date_switch.tsx
@@ -12,11 +12,13 @@ import { EuiSwitch, EuiSpacer, EuiText, EuiFlexGroup, EuiFlexItem, EuiIcon } fro
 
 interface Props {
   checked: boolean;
+  disabled?: boolean;
   onChange: () => void;
 }
 
 export const KeepPoliciesUpToDateSwitch: React.FunctionComponent<Props> = ({
   checked,
+  disabled = false,
   onChange,
 }) => (
   <>
@@ -27,6 +29,7 @@ export const KeepPoliciesUpToDateSwitch: React.FunctionComponent<Props> = ({
       )}
       checked={checked}
       onChange={onChange}
+      disabled={disabled}
     />
     <EuiSpacer size="s" />
     <EuiText color="subdued" size="xs">
@@ -35,10 +38,17 @@ export const KeepPoliciesUpToDateSwitch: React.FunctionComponent<Props> = ({
           <EuiIcon type="iInCircle" />
         </EuiFlexItem>
         <EuiFlexItem grow={false}>
-          <FormattedMessage
-            id="xpack.fleet.integrations.settings.keepIntegrationPoliciesUpToDateDescription"
-            defaultMessage="When enabled, Fleet will attempt to upgrade and deploy integration policies automatically"
-          />
+          {disabled ? (
+            <FormattedMessage
+              id="xpack.fleet.integrations.settings.keepIntegrationPoliciesUpToDateDisabledDescription"
+              defaultMessage="This integration requires Fleet to automatically upgrade its integration policies"
+            />
+          ) : (
+            <FormattedMessage
+              id="xpack.fleet.integrations.settings.keepIntegrationPoliciesUpToDateDescription"
+              defaultMessage="When enabled, Fleet will attempt to upgrade and deploy integration policies automatically"
+            />
+          )}
         </EuiFlexItem>
       </EuiFlexGroup>
     </EuiText>

diff --git a/.../fleet/public/applications/integrations/sections/epm/screens/detail/settings/settings.tsx b/.../fleet/public/applications/integrations/sections/epm/screens/detail/settings/settings.tsx
@@ -9,7 +9,6 @@ import React, { memo, useCallback, useEffect, useMemo, useState } from 'react';
 import styled from 'styled-components';
 import { FormattedMessage } from '@kbn/i18n/react';
 import semverLt from 'semver/functions/lt';
-import { uniq } from 'lodash';
 
 import {
   EuiCallOut,
@@ -35,8 +34,8 @@ import {
 } from '../../../../../hooks';
 import {
   PACKAGE_POLICY_SAVED_OBJECT_TYPE,
-  AUTO_UPDATE_PACKAGES,
-  DEFAULT_PACKAGES,
+  KEEP_POLICIES_UP_TO_DATE_PACKAGES,
+  AUTO_UPGRADE_POLICIES_PACKAGES,
 } from '../../../../../constants';
 
 import { KeepPoliciesUpToDateSwitch } from '../components';
@@ -107,11 +106,11 @@ export const SettingsPage: React.FC<Props> = memo(({ packageInfo }: Props) => {
   const { notifications } = useStartServices();
 
   const shouldShowKeepPoliciesUpToDateSwitch = useMemo(() => {
-    const packages = [...DEFAULT_PACKAGES, ...AUTO_UPDATE_PACKAGES];
-
-    const packageNames = uniq(packages.map((pkg) => pkg.name));
+    return KEEP_POLICIES_UP_TO_DATE_PACKAGES.some((pkg) => pkg.name === name);
+  }, [name]);
 
-    return packageNames.includes(name);
+  const isShowKeepPoliciesUpToDateSwitchDisabled = useMemo(() => {
+    return AUTO_UPGRADE_POLICIES_PACKAGES.some((pkg) => pkg.name === name);
   }, [name]);
 
   const [keepPoliciesUpToDateSwitchValue, setKeepPoliciesUpToDateSwitchValue] = useState<boolean>(
@@ -274,6 +273,7 @@ export const SettingsPage: React.FC<Props> = memo(({ packageInfo }: Props) => {
                   <KeepPoliciesUpToDateSwitch
                     checked={keepPoliciesUpToDateSwitchValue}
                     onChange={handleKeepPoliciesUpToDateSwitchChange}
+                    disabled={isShowKeepPoliciesUpToDateSwitchDisabled}
                   />
                   <EuiSpacer size="l" />
                 </>

diff --git a/x-pack/plugins/fleet/public/constants/index.ts b/x-pack/plugins/fleet/public/constants/index.ts
@@ -21,6 +21,8 @@ export {
   // Preconfiguration
   AUTO_UPDATE_PACKAGES,
   DEFAULT_PACKAGES,
+  KEEP_POLICIES_UP_TO_DATE_PACKAGES,
+  AUTO_UPGRADE_POLICIES_PACKAGES,
 } from '../../common/constants';
 
 export * from './page_paths';

diff --git a/x-pack/plugins/fleet/server/saved_objects/index.ts b/x-pack/plugins/fleet/server/saved_objects/index.ts
@@ -35,7 +35,7 @@ import {
 import { migratePackagePolicyToV7140, migrateInstallationToV7140 } from './migrations/to_v7_14_0';
 import { migratePackagePolicyToV7150 } from './migrations/to_v7_15_0';
 import { migrateInstallationToV7160, migratePackagePolicyToV7160 } from './migrations/to_v7_16_0';
-import { migrateOutputToV800 } from './migrations/to_v8_0_0';
+import { migrateInstallationToV800, migrateOutputToV800 } from './migrations/to_v8_0_0';
 
 /*
  * Saved object types and mappings
@@ -255,6 +255,7 @@ const getSavedObjectTypes = (
       '7.14.0': migrateInstallationToV7140,
       '7.14.1': migrateInstallationToV7140,
       '7.16.0': migrateInstallationToV7160,
+      '8.0.0': migrateInstallationToV800,
     },
   },
   [ASSETS_SAVED_OBJECT_TYPE]: {

diff --git a/x-pack/plugins/fleet/server/saved_objects/migrations/to_v8_0_0.ts b/x-pack/plugins/fleet/server/saved_objects/migrations/to_v8_0_0.ts
@@ -7,8 +7,8 @@
 
 import type { SavedObjectMigrationFn } from 'kibana/server';
 
-import type { Output } from '../../../common';
-import {} from '../../../common';
+import type { Installation, Output } from '../../../common';
+import { AUTO_UPGRADE_POLICIES_PACKAGES } from '../../../common';
 
 export const migrateOutputToV800: SavedObjectMigrationFn<Output, Output> = (
   outputDoc,
@@ -20,3 +20,20 @@ export const migrateOutputToV800: SavedObjectMigrationFn<Output, Output> = (
 
   return outputDoc;
 };
+
+export const migrateInstallationToV800: SavedObjectMigrationFn<Installation, Installation> = (
+  installationDoc,
+  migrationContext
+) => {
+  const updatedInstallationDoc = installationDoc;
+
+  const shouldKeepPoliciesUpToDate = AUTO_UPGRADE_POLICIES_PACKAGES.some(
+    (pkg) => pkg.name === updatedInstallationDoc.attributes.name
+  );
+
+  if (shouldKeepPoliciesUpToDate) {
+    updatedInstallationDoc.attributes.keep_policies_up_to_date = true;
+  }
+
+  return updatedInstallationDoc;
+};
diff --git a/x-pack/plugins/fleet/server/services/epm/packages/install.ts b/x-pack/plugins/fleet/server/services/epm/packages/install.ts
@@ -18,7 +18,7 @@ import type {
   InstallablePackage,
   InstallSource,
 } from '../../../../common';
-import { DEFAULT_PACKAGES } from '../../../../common';
+import { AUTO_UPGRADE_POLICIES_PACKAGES } from '../../../../common';
 import {
   IngestManagerError,
   PackageOperationNotSupportedError,
@@ -534,11 +534,14 @@ 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(
+  // For "stack-aligned" packages, default the `keep_policies_up_to_date` setting to true. For all other
+  // packages, default it to undefined. Use undefined rather than false to allow us to differentiate
+  // between "unset" and "user explicitly disabled".
+  const defaultKeepPoliciesUpToDate = AUTO_UPGRADE_POLICIES_PACKAGES.some(
     ({ name }) => name === packageInfo.name
-  );
+  )
+    ? true
+    : undefined;
 
   const created = await savedObjectsClient.create<Installation>(
     PACKAGES_SAVED_OBJECT_TYPE,

diff --git a/x-pack/plugins/fleet/server/services/managed_package_policies.test.ts b/x-pack/plugins/fleet/server/services/managed_package_policies.test.ts
@@ -8,7 +8,6 @@
 import { elasticsearchServiceMock, savedObjectsClientMock } from 'src/core/server/mocks';
 
 import type { Installation, PackageInfo } from '../../common';
-import { AUTO_UPDATE_PACKAGES } from '../../common';
 
 import { shouldUpgradePolicies, upgradeManagedPackagePolicies } from './managed_package_policies';
 import { packagePolicyService } from './package_policy';
@@ -227,50 +226,6 @@ describe('upgradeManagedPackagePolicies', () => {
 });
 
 describe('shouldUpgradePolicies', () => {
-  describe('package is marked as AUTO_UPDATE', () => {
-    describe('keep_policies_up_to_date is true', () => {
-      it('returns false', () => {
-        const packageInfo = {
-          version: '1.0.0',
-          keepPoliciesUpToDate: true,
-          name: AUTO_UPDATE_PACKAGES[0].name,
-        };
-
-        const installedPackage = {
-          version: '1.0.0',
-        };
-
-        const result = shouldUpgradePolicies(
-          packageInfo as PackageInfo,
-          installedPackage as Installation
-        );
-
-        expect(result).toBe(false);
-      });
-    });
-
-    describe('keep_policies_up_to_date is false', () => {
-      it('returns false', () => {
-        const packageInfo = {
-          version: '1.0.0',
-          keepPoliciesUpToDate: false,
-          name: AUTO_UPDATE_PACKAGES[0].name,
-        };
-
-        const installedPackage = {
-          version: '1.0.0',
-        };
-
-        const result = shouldUpgradePolicies(
-          packageInfo as PackageInfo,
-          installedPackage as Installation
-        );
-
-        expect(result).toBe(false);
-      });
-    });
-  });
-
   describe('package policy is up-to-date', () => {
     describe('keep_policies_up_to_date is true', () => {
       it('returns false', () => {

diff --git a/x-pack/test/fleet_api_integration/apis/epm/__snapshots__/install_by_upload.snap b/x-pack/test/fleet_api_integration/apis/epm/__snapshots__/install_by_upload.snap
diff --git a/x-pack/test/fleet_api_integration/apis/epm/install_remove_assets.ts b/x-pack/test/fleet_api_integration/apis/epm/install_remove_assets.ts
@@ -673,7 +673,6 @@ const expectAssetsInstalled = ({
       install_status: 'installed',
       install_started_at: res.attributes.install_started_at,
       install_source: 'registry',
-      keep_policies_up_to_date: false,
     });
   });
 };
diff --git a/x-pack/test/fleet_api_integration/apis/epm/update_assets.ts b/x-pack/test/fleet_api_integration/apis/epm/update_assets.ts
@@ -462,7 +462,6 @@ export default function (providerContext: FtrProviderContext) {
         install_status: 'installed',
         install_started_at: res.attributes.install_started_at,
         install_source: 'registry',
-        keep_policies_up_to_date: false,
       });
     });
   });