[Fleet] Allow to exclude packages (#168645)

elastic · Oct 11, 2023 · 4312417 · 4312417
1 parent 7708814
commit 4312417
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 2 deletions.
diff --git a/x-pack/plugins/fleet/common/types/index.ts b/x-pack/plugins/fleet/common/types/index.ts
@@ -60,6 +60,7 @@ export interface FleetConfigType {
         min?: string;
         max?: string;
       };
+      excludePackages: string[];
     };
   };
   createArtifactsBulkBatchSize?: number;

diff --git a/x-pack/plugins/fleet/server/config.ts b/x-pack/plugins/fleet/server/config.ts
@@ -193,6 +193,7 @@ export const config: PluginConfigDescriptor = {
           registry: schema.object(
             {
               kibanaVersionCheckEnabled: schema.boolean({ defaultValue: true }),
+              excludePackages: schema.arrayOf(schema.string(), { defaultValue: [] }),
               spec: schema.object(
                 {
                   min: schema.maybe(schema.string()),
@@ -221,6 +222,7 @@ export const config: PluginConfigDescriptor = {
               defaultValue: {
                 kibanaVersionCheckEnabled: true,
                 capabilities: [],
+                excludePackages: [],
                 spec: {
                   max: REGISTRY_SPEC_MAX_VERSION,
                 },

diff --git a/x-pack/plugins/fleet/server/services/epm/filtered_packages.ts b/x-pack/plugins/fleet/server/services/epm/filtered_packages.ts
@@ -15,7 +15,10 @@ export function getFilteredSearchPackages() {
   if (shouldFilterFleetServer) {
     filtered.push(FLEET_SERVER_PACKAGE);
   }
-  return filtered;
+
+  const excludePackages = appContextService.getConfig()?.internal?.registry?.excludePackages ?? [];
+
+  return filtered.concat(excludePackages);
 }
 
 export function getFilteredInstallPackages() {
@@ -25,5 +28,7 @@ export function getFilteredInstallPackages() {
   if (shouldFilterFleetServer) {
     filtered.push(FLEET_SERVER_PACKAGE);
   }
-  return filtered;
+  const excludePackages = appContextService.getConfig()?.internal?.registry?.excludePackages ?? [];
+
+  return filtered.concat(excludePackages);
 }
diff --git a/x-pack/plugins/fleet/server/services/epm/packages/_install_package.test.ts b/x-pack/plugins/fleet/server/services/epm/packages/_install_package.test.ts
@@ -139,6 +139,7 @@ describe('_installPackage', () => {
           registry: {
             kibanaVersionCheckEnabled: true,
             capabilities: [],
+            excludePackages: [],
           },
         },
       })
@@ -197,6 +198,7 @@ describe('_installPackage', () => {
           registry: {
             kibanaVersionCheckEnabled: true,
             capabilities: [],
+            excludePackages: [],
           },
         },
       })
@@ -271,6 +273,7 @@ describe('_installPackage', () => {
             registry: {
               kibanaVersionCheckEnabled: true,
               capabilities: [],
+              excludePackages: [],
             },
           },
         })

diff --git a/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts b/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts
@@ -510,6 +510,36 @@ test: invalid manifest
       });
       expect(packages.find((item) => item.id === 'fleet_server')).toBeUndefined();
     });
+
+    it('should filter packages configured in xpack.fleet.internal.registry.excludePackages', async () => {
+      const mockContract = createAppContextStartContractMock({
+        internal: {
+          registry: {
+            excludePackages: ['nginx'],
+          },
+        },
+      } as any);
+      appContextService.start(mockContract);
+
+      const soClient = savedObjectsClientMock.create();
+      soClient.find.mockResolvedValue({
+        saved_objects: [
+          {
+            id: 'nginx',
+            attributes: {
+              name: 'nginx',
+              version: '0.0.1',
+              install_source: 'upload',
+              install_version: '0.0.1',
+            },
+          },
+        ],
+      } as any);
+      const packages = await getPackages({
+        savedObjectsClient: soClient,
+      });
+      expect(packages.find((item) => item.id === 'nginx')).toBeUndefined();
+    });
   });
 
   describe('getInstalledPackages', () => {