[Fleet] Allow to skipDatastreamRollover from preconfiguration (#173766)

elastic · Dec 21, 2023 · e51a3f9 · e51a3f9
1 parent 85df7c9
commit e51a3f9
Show file tree

Hide file tree

Showing 5 changed files with 79 additions and 34 deletions.
diff --git a/x-pack/plugins/fleet/common/types/models/preconfiguration.ts b/x-pack/plugins/fleet/common/types/models/preconfiguration.ts
@@ -35,6 +35,7 @@ export interface PreconfiguredAgentPolicy extends Omit<NewAgentPolicy, 'namespac
 
 export interface PreconfiguredPackage extends Omit<PackagePolicyPackage, 'title'> {
   prerelease?: boolean;
+  skipDataStreamRollover?: boolean;
 }
 
 export interface PreconfiguredOutput extends Omit<Output, 'config_yaml'> {

diff --git a/x-pack/plugins/fleet/server/services/epm/packages/bulk_install_packages.ts b/x-pack/plugins/fleet/server/services/epm/packages/bulk_install_packages.ts
@@ -19,7 +19,10 @@ import type { BulkInstallResponse, IBulkInstallPackageError } from './install';
 
 interface BulkInstallPackagesParams {
   savedObjectsClient: SavedObjectsClientContract;
-  packagesToInstall: Array<string | { name: string; version?: string; prerelease?: boolean }>;
+  packagesToInstall: Array<
+    | string
+    | { name: string; version?: string; prerelease?: boolean; skipDataStreamRollover?: boolean }
+  >;
   esClient: ElasticsearchClient;
   force?: boolean;
   spaceId: string;
@@ -48,10 +51,18 @@ export async function bulkInstallPackages({
           name: pkgRes.name,
           version: pkgRes.version,
           prerelease: undefined,
+          skipDataStreamRollover: undefined,
         }));
       }
       if (pkg.version !== undefined) {
-        return Promise.resolve(pkg as { name: string; version: string; prerelease?: boolean });
+        return Promise.resolve(
+          pkg as {
+            name: string;
+            version: string;
+            prerelease?: boolean;
+            skipDataStreamRollover?: boolean;
+          }
+        );
       }
 
       return Registry.fetchFindLatestPackageOrThrow(pkg.name, {
@@ -60,6 +71,7 @@ export async function bulkInstallPackages({
         name: pkgRes.name,
         version: pkgRes.version,
         prerelease: pkg.prerelease,
+        skipDataStreamRollover: pkg.skipDataStreamRollover,
       }));
     })
   );
@@ -114,6 +126,7 @@ export async function bulkInstallPackages({
         force,
         prerelease: prerelease || ('prerelease' in pkgKeyProps && pkgKeyProps.prerelease),
         authorizationHeader,
+        skipDataStreamRollover: pkgKeyProps.skipDataStreamRollover,
       });
 
       if (installResult.error) {

diff --git a/x-pack/plugins/fleet/server/services/preconfiguration.test.ts b/x-pack/plugins/fleet/server/services/preconfiguration.test.ts
@@ -30,7 +30,7 @@ import {
 } from './preconfiguration';
 import { packagePolicyService } from './package_policy';
 import { getBundledPackages } from './epm/packages/bundled_packages';
-import type { InstallPackageParams } from './epm/packages/install';
+import { installPackage, type InstallPackageParams } from './epm/packages/install';
 
 jest.mock('./agent_policy_update');
 jest.mock('./output');
@@ -144,44 +144,46 @@ jest.mock('./epm/registry', () => ({
 }));
 
 jest.mock('./epm/packages/install', () => ({
-  async installPackage(args: InstallPackageParams): Promise<InstallResult | undefined> {
-    if (args.installSource === 'registry') {
-      const [pkgName, pkgVersion] = args.pkgkey.split('-');
-      const installError = mockInstallPackageErrors.get(pkgName);
-      if (installError) {
+  installPackage: jest.fn(
+    async (args: InstallPackageParams): Promise<InstallResult | undefined> => {
+      if (args.installSource === 'registry') {
+        const [pkgName, pkgVersion] = args.pkgkey.split('-');
+        const installError = mockInstallPackageErrors.get(pkgName);
+        if (installError) {
+          return {
+            error: new Error(installError),
+            installType: 'install',
+            installSource: 'registry',
+          };
+        }
+
+        const installedPackage = mockInstalledPackages.get(pkgName);
+        if (installedPackage) {
+          if (installedPackage.version === pkgVersion) return installedPackage;
+        }
+
+        const packageInstallation = { name: pkgName, version: pkgVersion, title: pkgName };
+        mockInstalledPackages.set(pkgName, packageInstallation);
+
         return {
-          error: new Error(installError),
+          status: 'installed',
           installType: 'install',
           installSource: 'registry',
         };
-      }
-
-      const installedPackage = mockInstalledPackages.get(pkgName);
-      if (installedPackage) {
-        if (installedPackage.version === pkgVersion) return installedPackage;
-      }
+      } else if (args.installSource === 'upload') {
+        const { archiveBuffer } = args;
 
-      const packageInstallation = { name: pkgName, version: pkgVersion, title: pkgName };
-      mockInstalledPackages.set(pkgName, packageInstallation);
+        // Treat the buffer value passed in tests as the package's name for simplicity
+        const pkgName = archiveBuffer.toString('utf8');
 
-      return {
-        status: 'installed',
-        installType: 'install',
-        installSource: 'registry',
-      };
-    } else if (args.installSource === 'upload') {
-      const { archiveBuffer } = args;
-
-      // Treat the buffer value passed in tests as the package's name for simplicity
-      const pkgName = archiveBuffer.toString('utf8');
-
-      // Just install every bundled package at version '1.0.0'
-      const packageInstallation = { name: pkgName, version: '1.0.0', title: pkgName };
-      mockInstalledPackages.set(pkgName, packageInstallation);
+        // Just install every bundled package at version '1.0.0'
+        const packageInstallation = { name: pkgName, version: '1.0.0', title: pkgName };
+        mockInstalledPackages.set(pkgName, packageInstallation);
 
-      return { status: 'installed', installType: 'install', installSource: 'upload' };
+        return { status: 'installed', installType: 'install', installSource: 'upload' };
+      }
     }
-  },
+  ),
   ensurePackagesCompletedInstall() {
     return [];
   },
@@ -395,6 +397,30 @@ describe('policy preconfiguration', () => {
       expect(nonFatalErrors.length).toBe(0);
     });
 
+    it('should pass skipDatastreamRollover flag if configured', async () => {
+      const soClient = getPutPreconfiguredPackagesMock();
+      const esClient = elasticsearchServiceMock.createClusterClient().asInternalUser;
+
+      const { policies, packages, nonFatalErrors } = await ensurePreconfiguredPackagesAndPolicies(
+        soClient,
+        esClient,
+        [] as PreconfiguredAgentPolicy[],
+        [{ name: 'test_package', version: 'latest', skipDataStreamRollover: true }],
+        mockDefaultOutput,
+        mockDefaultDownloadService,
+        DEFAULT_SPACE_ID
+      );
+
+      expect(policies.length).toEqual(0);
+      expect(packages).toEqual(expect.arrayContaining(['test_package-1.0.0']));
+      expect(nonFatalErrors.length).toBe(0);
+      expect(jest.mocked(installPackage)).toBeCalledWith(
+        expect.objectContaining({
+          skipDataStreamRollover: true,
+        })
+      );
+    });
+
     it('should not add new package policy to existing non managed policies', async () => {
       const soClient = getPutPreconfiguredPackagesMock();
       const esClient = elasticsearchServiceMock.createClusterClient().asInternalUser;

diff --git a/x-pack/plugins/fleet/server/services/preconfiguration.ts b/x-pack/plugins/fleet/server/services/preconfiguration.ts
@@ -81,7 +81,11 @@ export async function ensurePreconfiguredPackagesAndPolicies(
 
   const packagesToInstall = packages.map((pkg) =>
     pkg.version === PRECONFIGURATION_LATEST_KEYWORD
-      ? { name: pkg.name, prerelease: pkg.prerelease }
+      ? {
+          name: pkg.name,
+          prerelease: pkg.prerelease,
+          skipDataStreamRollover: pkg.skipDataStreamRollover,
+        }
       : pkg
   );
 

diff --git a/x-pack/plugins/fleet/server/types/models/preconfiguration.ts b/x-pack/plugins/fleet/server/types/models/preconfiguration.ts
@@ -45,6 +45,7 @@ export const PreconfiguredPackagesSchema = schema.arrayOf(
       },
     }),
     prerelease: schema.maybe(schema.boolean()),
+    skipDataStreamRollover: schema.maybe(schema.boolean()),
   }),
   {
     defaultValue: [],
-Original file line number
+Diff line change
@@ Expand Up / @@ -45,6 +45,7 @@ export const PreconfiguredPackagesSchema = schema.arrayOf( @@
           },
         }),
         prerelease: schema.maybe(schema.boolean()),
+        skipDataStreamRollover: schema.maybe(schema.boolean()),
       }),
       {
         defaultValue: [],
@@ Expand Down @@