[Fleet] Add custom integrations API

docs/developer/plugin-list.asciidoc

@@ -43,6 +43,8 @@ as uiSettings within the code.
 |{kib-repo}blob/{branch}/src/plugins/console/README.md[console]
 |Console provides the user with tools for storing and executing requests against Elasticsearch.
 
+|{kib-repo}blob/{branch}/src/plugins/custom_integrations/README.md[customIntegrations]
+|Register add-data cards
 
 |<<kibana-dashboard-plugin>>
 |- Registers the dashboard application.

packages/kbn-optimizer/limits.yml

@@ -115,3 +115,4 @@ pageLoadAssetSize:
   expressionTagcloud: 27505
   expressions: 239290
   securitySolution: 231753
+  customIntegrations: 28810

src/plugins/custom_integrations/README.md

@@ -0,0 +1,9 @@
+# customIntegrations
+
+Register add-data cards
+
+---
+
+## Development
+
+See the [kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) for instructions setting up your development environment.

src/plugins/custom_integrations/common/index.ts

@@ -0,0 +1,65 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+export const PLUGIN_ID = 'customIntegrations';
+export const PLUGIN_NAME = 'customIntegrations';
+
+export interface CategoryCount {
+  count: number;
+  id: Category;
+}
+
+// todo internationalize
+export const CATEGORY_DISPLAY = {
+  aws: 'AWS',
+  azure: 'Azure',
+  cloud: 'Cloud',
+  config_management: 'Config management',
+  containers: 'Containers',
+  crm: 'CRM',
+  custom: 'Custom',
+  datastore: 'Datastore',
+  elastic_stack: 'Elastic Stack',
+  google_cloud: 'Google cloud',
+  kubernetes: 'Kubernetes',
+  languages: 'Languages',
+  message_queue: 'Message queue',
+  monitoring: 'Monitoring',
+  network: 'Network',
+  notification: 'Notification',
+  os_system: 'OS & System',
+  productivity: 'Productivity',
+  security: 'Security',
+  sample_data: 'Sample data',
+  support: 'Support',
+  ticketing: 'Ticketing',
+  version_control: 'Version control',
+  web: 'Web',
+  upload_file: 'Upload a file',
+
+  updates_available: 'Updates available',
+};
+
+export type Category = keyof typeof CATEGORY_DISPLAY;
+
+export interface CustomIntegration {
+  id: string;
+  title: string;
+  name: string;
+  description: string;
+  type: 'ui_link';
+  uiInternalPath: string;
+  isBeta: boolean;
+  icons: Array<{ src: string; type: string }>;
+  categories: Category[];
+  shipper: string;
+  eprPackageOverlap?: string;
+}
+
+export const ROUTES_ADDABLECUSTOMINTEGRATIONS = `/api/${PLUGIN_ID}/addableCustomIntegrations`;
+export const ROUTES_REPLACEABLECUSTOMINMTEGRATIONS = `/api/${PLUGIN_ID}/replaceableCustomIntegrations`;

src/plugins/custom_integrations/kibana.json

@@ -0,0 +1,16 @@
+{
+  "id": "customIntegrations",
+  "version": "1.0.0",
+  "kibanaVersion": "kibana",
+  "owner": {
+    "name": "platform",
+    "githubTeam": ""
+  },
+  "description": "test",
+  "ui": true,
+  "server": true,
+  "extraPublicDirs": [
+    "common"
+  ],
+  "optionalPlugins": []
+}

src/plugins/custom_integrations/public/index.ts

@@ -0,0 +1,16 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { CustomIntegrationPlugin } from './plugin';
+
+// This exports static code and TypeScript types,
+// as well as, Kibana Platform `plugin()` initializer.
+export function plugin() {
+  return new CustomIntegrationPlugin();
+}
+export { CustomIntegrationsSetup, CustomIntegrationsStart } from './types';

src/plugins/custom_integrations/public/plugin.ts

@@ -0,0 +1,36 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { CoreSetup, CoreStart, Plugin } from 'src/core/public';
+import { CustomIntegrationsSetup, CustomIntegrationsStart } from './types';
+import {
+  CustomIntegration,
+  ROUTES_ADDABLECUSTOMINTEGRATIONS,
+  ROUTES_REPLACEABLECUSTOMINMTEGRATIONS,
+} from '../common';
+
+export class CustomIntegrationPlugin
+  implements Plugin<CustomIntegrationsSetup, CustomIntegrationsStart> {
+  public setup(core: CoreSetup): CustomIntegrationsSetup {
+    // Return methods that should be available to other plugins
+    return {
+      async getAddableCustomIntegrations(): Promise<CustomIntegration[]> {
+        return core.http.get(ROUTES_ADDABLECUSTOMINTEGRATIONS);
+      },
+      async getReplaceableCustomIntegrations(): Promise<CustomIntegration[]> {
+        return core.http.get(ROUTES_REPLACEABLECUSTOMINMTEGRATIONS);
+      },
+    } as CustomIntegrationsSetup;
+  }
+
+  public start(core: CoreStart): CustomIntegrationsStart {
+    return {};
+  }
+
+  public stop() {}
+}

src/plugins/custom_integrations/public/types.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { CustomIntegration } from '../common';
+
+export interface CustomIntegrationsSetup {
+  getReplaceableCustomIntegrations: () => Promise<CustomIntegration[]>;
+  getAddableCustomIntegrations: () => Promise<CustomIntegration[]>;
+}
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface CustomIntegrationsStart {}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface AppPluginStartDependencies {}

src/plugins/custom_integrations/server/custom_integration_registry.ts

@@ -0,0 +1,74 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { Logger } from 'kibana/server';
+import { CustomIntegration, CategoryCount, Category } from '../common';
+
+function isAddable(integration: CustomIntegration) {
+  return integration.categories.length;
+}
+
+export class CustomIntegrationRegistry {
+  private readonly _integrations: CustomIntegration[];
+  private readonly _logger: Logger;
+
+  constructor(logger: Logger) {
+    this._integrations = [];
+    this._logger = logger;
+  }
+
+  registerCustomIntegration(customIntegration: CustomIntegration) {
+    if (
+      this._integrations.some((integration: CustomIntegration) => {
+        return integration.name === customIntegration.name;
+      })
+    ) {
+      this._logger.error(`Integration with id=${customIntegration.name} already exists.`);
+      return;
+    }
+
+    this._integrations.push(customIntegration);
+  }
+
+  getAddableCustomIntegrations(): CustomIntegration[] {
+    return this._integrations.filter(isAddable);
+  }
+
+  getReplaceableCustomIntegrations(): CustomIntegration[] {
+    return this._integrations.filter(
+      (integration) => typeof integration.eprPackageOverlap !== 'undefined'
+    );
+  }
+
+  getAddableCategories(): CategoryCount[] {
+    const categories: Map<Category, number> = new Map<Category, number>();
+    for (let i = 0; i < this._integrations.length; i++) {
+      if (!isAddable(this._integrations[i])) {
+        continue;
+      }
+      for (let j = 0; j < this._integrations[i].categories.length; j++) {
+        const category = this._integrations[i].categories[j];
+        if (categories.has(category)) {
+          // @ts-ignore
+          categories.set(category, categories.get(category) + 1);
+        } else {
+          categories.set(category, 1);
+        }
+      }
+    }
+
+    const list: CategoryCount[] = [];
+    categories.forEach((value, key) => {
+      list.push({
+        count: value,
+        id: key,
+      });
+    });
+    return list;
+  }
+}

src/plugins/custom_integrations/server/index.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { PluginInitializerContext } from '../../../core/server';
+import { CustomIntegrationsPlugin } from './plugin';
+
+//  This exports static code and TypeScript types,
+//  as well as, Kibana Platform `plugin()` initializer.
+
+export function plugin(initializerContext: PluginInitializerContext) {
+  return new CustomIntegrationsPlugin(initializerContext);
+}
+
+export { CustomIntegrationsPluginSetup, CustomIntegrationsPluginStart } from './types';
+
+export type { Category, CategoryCount, CustomIntegration } from '../common';

src/plugins/custom_integrations/server/plugin.ts

@@ -0,0 +1,55 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { PluginInitializerContext, CoreSetup, CoreStart, Plugin, Logger } from 'kibana/server';
+
+import { CustomIntegrationsPluginSetup, CustomIntegrationsPluginStart } from './types';
+import { CustomIntegration, CategoryCount } from '../common';
+import { CustomIntegrationRegistry } from './custom_integration_registry';
+import { defineRoutes } from './routes/define_routes';
+
+export class CustomIntegrationsPlugin
+  implements Plugin<CustomIntegrationsPluginSetup, CustomIntegrationsPluginStart> {
+  private readonly logger: Logger;
+  private readonly customIngegrationRegistry: CustomIntegrationRegistry;
+
+  constructor(initializerContext: PluginInitializerContext) {
+    this.logger = initializerContext.logger.get();
+    this.customIngegrationRegistry = new CustomIntegrationRegistry(this.logger);
+  }
+
+  public setup(core: CoreSetup) {
+    this.logger.debug('customIntegrations: Setup');
+
+    const router = core.http.createRouter();
+    defineRoutes(router, this.customIngegrationRegistry);
+
+    return {
+      registerCustomIntegration: (integration: CustomIntegration) => {
+        this.customIngegrationRegistry.registerCustomIntegration(integration);
+      },
+      getAddableCustomIntegrations: (): CustomIntegration[] => {
+        return this.customIngegrationRegistry.getAddableCustomIntegrations();
+      },
+
+      getAddableCategories: (): CategoryCount[] => {
+        return this.customIngegrationRegistry.getAddableCategories();
+      },
+      getReplaceableCustomIntegrations: (): CustomIntegration[] => {
+        return this.customIngegrationRegistry.getReplaceableCustomIntegrations();
+      },
+    } as CustomIntegrationsPluginSetup;
+  }
+
+  public start(core: CoreStart) {
+    this.logger.debug('customIntegrations: Started');
+    return {};
+  }
+
+  public stop() {}
+}

src/plugins/custom_integrations/server/routes/define_routes.ts

@@ -0,0 +1,45 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { IRouter } from 'src/core/server';
+import { CustomIntegrationRegistry } from '../custom_integration_registry';
+import {
+  ROUTES_ADDABLECUSTOMINTEGRATIONS,
+  ROUTES_REPLACEABLECUSTOMINMTEGRATIONS,
+} from '../../common';
+
+export function defineRoutes(
+  router: IRouter,
+  customIntegrationsRegistry: CustomIntegrationRegistry
+) {
+  router.get(
+    {
+      path: ROUTES_ADDABLECUSTOMINTEGRATIONS,
+      validate: false,
+    },
+    async (context, request, response) => {
+      const integrations = customIntegrationsRegistry.getAddableCustomIntegrations();
+      return response.ok({
+        body: integrations,
+      });
+    }
+  );
+
+  router.get(
+    {
+      path: ROUTES_REPLACEABLECUSTOMINMTEGRATIONS,
+      validate: false,
+    },
+    async (context, request, response) => {
+      const integrations = customIntegrationsRegistry.getReplaceableCustomIntegrations();
+      return response.ok({
+        body: integrations,
+      });
+    }
+  );
+}

src/plugins/custom_integrations/server/types.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { CustomIntegration, CategoryCount } from '../common';
+
+export interface CustomIntegrationsPluginSetup {
+  registerCustomIntegration(customIntegration: CustomIntegration): void;
+  getAddableCustomIntegrations(): CustomIntegration[];
+  getAddableCategories(): CategoryCount[];
+  getReplaceableCustomIntegrations(): CustomIntegration[];
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface CustomIntegrationsPluginStart {}