[Alerting] Export rules and connectors

docs/management/action-types.asciidoc

@@ -106,6 +106,12 @@ New connectors can be created by clicking the *Create connector* button, which w
 [role="screenshot"]
 image::images/connector-select-type.png[Connector select type]
 
+[float]
+[[importing-and-exporting-connectors]]
+=== Importing and exporting connectors
+
+Use the <<managing-saved-objects, Saved Objects Management UI>> to import and export connectors.
+
 [float]
 [[create-connectors]]
 === Preconfigured connectors

docs/user/alerting/rule-management.asciidoc

@@ -57,6 +57,12 @@ These operations can also be performed in bulk by multi-selecting rules and clic
 [role="screenshot"]
 image:images/bulk-mute-disable.png[The Manage rules button lets you mute/unmute, enable/disable, and delete in bulk]
 
+[float]
+[[importing-and-exporting-rules]]
+=== Importing and exporting rules
+
+Use the <<managing-saved-objects, Saved Objects Management UI>> to import and export rules.
+
 [float]
 === Required permissions
 

x-pack/plugins/actions/server/saved_objects/index.ts

@@ -5,12 +5,17 @@
  * 2.0.
  */
 
-import { SavedObject, SavedObjectsServiceSetup } from 'kibana/server';
+import {
+  SavedObject,
+  SavedObjectsExportTransformContext,
+  SavedObjectsServiceSetup,
+} from 'kibana/server';
 import { EncryptedSavedObjectsPluginSetup } from '../../../encrypted_saved_objects/server';
 import mappings from './mappings.json';
 import { getMigrations } from './migrations';
 import { RawAction } from '../types';
 import { getImportResultMessage, GO_TO_CONNECTORS_BUTTON_LABLE } from './get_import_result_message';
+import { transformConnectorsForExport } from './transform_connectors_for_export';
 
 export const ACTION_SAVED_OBJECT_TYPE = 'action';
 export const ALERT_SAVED_OBJECT_TYPE = 'alert';
@@ -32,6 +37,12 @@ export function setupSavedObjects(
       getTitle(obj) {
         return `Connector: [${obj.attributes.name}]`;
       },
+      onExport<RawAction>(
+        context: SavedObjectsExportTransformContext,
+        objects: Array<SavedObject<RawAction>>
+      ) {
+        return transformConnectorsForExport(objects);
+      },
       onImport(connectors) {
         return {
           warnings: [

x-pack/plugins/actions/server/saved_objects/transform_connectors_for_export.test.ts

@@ -0,0 +1,227 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { transformConnectorsForExport } from './transform_connectors_for_export';
+
+describe('transform connector for export', () => {
+  const connectorsWithNoSecrets = [
+    {
+      id: '1',
+      type: 'action',
+      attributes: {
+        actionTypeId: '.email',
+        name: 'email connector without auth',
+        isMissingSecrets: false,
+        config: {
+          hasAuth: false,
+          from: 'me@me.com',
+          host: 'host',
+          port: 22,
+          service: null,
+          secure: null,
+        },
+        secrets: 'asbqw4tqbef',
+      },
+      references: [],
+    },
+    {
+      id: '2',
+      type: 'action',
+      attributes: {
+        actionTypeId: '.index',
+        name: 'index connector',
+        isMissingSecrets: false,
+        config: {
+          index: 'test-index',
+          refresh: false,
+          executionTimeField: null,
+        },
+        secrets: 'asbqw4tqbef',
+      },
+      references: [],
+    },
+    {
+      id: '3',
+      type: 'action',
+      attributes: {
+        actionTypeId: '.server-log',
+        name: 'server log connector',
+        isMissingSecrets: false,
+        config: {},
+        secrets: 'asbqw4tqbef',
+      },
+      references: [],
+    },
+    {
+      id: '4',
+      type: 'action',
+      attributes: {
+        actionTypeId: '.webhook',
+        name: 'webhook connector without auth',
+        isMissingSecrets: false,
+        config: {
+          method: 'post',
+          hasAuth: false,
+          url: 'https://webhook',
+          headers: {},
+        },
+        secrets: 'asbqw4tqbef',
+      },
+      references: [],
+    },
+  ];
+  const connectorsWithSecrets = [
+    {
+      id: '1',
+      type: 'action',
+      attributes: {
+        actionTypeId: '.email',
+        name: 'email connector with auth',
+        isMissingSecrets: false,
+        config: {
+          hasAuth: true,
+          from: 'me@me.com',
+          host: 'host',
+          port: 22,
+          service: null,
+          secure: null,
+        },
+        secrets: 'asbqw4tqbef',
+      },
+      references: [],
+    },
+    {
+      id: '2',
+      type: 'action',
+      attributes: {
+        actionTypeId: '.resilient',
+        name: 'resilient connector',
+        isMissingSecrets: false,
+        config: {
+          apiUrl: 'https://resilient',
+          orgId: 'origId',
+        },
+        secrets: 'asbqw4tqbef',
+      },
+      references: [],
+    },
+    {
+      id: '3',
+      type: 'action',
+      attributes: {
+        actionTypeId: '.servicenow',
+        name: 'servicenow itsm connector',
+        isMissingSecrets: false,
+        config: {
+          apiUrl: 'https://servicenow',
+        },
+        secrets: 'asbqw4tqbef',
+      },
+      references: [],
+    },
+    {
+      id: '4',
+      type: 'action',
+      attributes: {
+        actionTypeId: '.pagerduty',
+        name: 'pagerduty connector',
+        isMissingSecrets: false,
+        config: {
+          apiUrl: 'https://pagerduty',
+        },
+        secrets: 'asbqw4tqbef',
+      },
+      references: [],
+    },
+    {
+      id: '5',
+      type: 'action',
+      attributes: {
+        actionTypeId: '.jira',
+        name: 'jira connector',
+        isMissingSecrets: false,
+        config: {
+          apiUrl: 'https://jira',
+          projectKey: 'foo',
+        },
+        secrets: 'asbqw4tqbef',
+      },
+      references: [],
+    },
+    {
+      id: '6',
+      type: 'action',
+      attributes: {
+        actionTypeId: '.teams',
+        name: 'teams connector',
+        isMissingSecrets: false,
+        config: {},
+        secrets: 'asbqw4tqbef',
+      },
+      references: [],
+    },
+    {
+      id: '7',
+      type: 'action',
+      attributes: {
+        actionTypeId: '.slack',
+        name: 'slack connector',
+        isMissingSecrets: false,
+        config: {},
+        secrets: 'asbqw4tqbef',
+      },
+      references: [],
+    },
+    {
+      id: '8',
+      type: 'action',
+      attributes: {
+        actionTypeId: '.servicenow-sir',
+        name: 'servicenow sir connector',
+        isMissingSecrets: false,
+        config: {
+          apiUrl: 'https://servicenow-sir',
+        },
+        secrets: 'asbqw4tqbef',
+      },
+      references: [],
+    },
+    {
+      id: '8',
+      type: 'action',
+      attributes: {
+        actionTypeId: '.webhook',
+        name: 'webhook connector with auth',
+        isMissingSecrets: false,
+        config: {
+          method: 'post',
+          hasAuth: true,
+          url: 'https://webhook',
+          headers: {},
+        },
+        secrets: 'asbqw4tqbef',
+      },
+      references: [],
+    },
+  ];
+
+  it('should not change connectors without secrets', () => {
+    expect(transformConnectorsForExport(connectorsWithNoSecrets)).toEqual(connectorsWithNoSecrets);
+  });
+
+  it('should remove secrets for connectors with secrets', () => {
+    expect(transformConnectorsForExport(connectorsWithSecrets)).toEqual(
+      connectorsWithSecrets.map((connector) => ({
+        ...connector,
+        attributes: {
+          ...connector.attributes,
+          isMissingSecrets: true,
+        },
+      }))
+    );
+  });
+});

x-pack/plugins/actions/server/saved_objects/transform_connectors_for_export.ts

@@ -0,0 +1,48 @@
+/*
+ * 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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { SavedObject } from 'kibana/server';
+import { RawAction } from '../types';
+
+const CONNECTORS_WITHOUT_SECRETS = ['.index', '.server-log'];
+const CONNECTORS_CHECK_AUTH = ['.email', '.webhook'];
+
+export function transformConnectorsForExport(
+  connectors: SavedObject[]
+): Array<SavedObject<RawAction>> {
+  return connectors.map((connector) =>
+    transformConnectorForExport(connector as SavedObject<RawAction>)
+  );
+}
+
+function connectorHasNoAuth(connector: SavedObject<RawAction>) {
+  return connector?.attributes?.config?.hasAuth === false;
+}
+
+function transformConnectorForExport(connector: SavedObject<RawAction>): SavedObject<RawAction> {
+  // Skip connectors with no secrets
+  if (CONNECTORS_WITHOUT_SECRETS.includes(connector.attributes.actionTypeId)) {
+    return connector;
+  }
+
+  // Skip connectors where hasAuth = false
+  if (
+    CONNECTORS_CHECK_AUTH.includes(connector.attributes.actionTypeId) &&
+    connectorHasNoAuth(connector)
+  ) {
+    return connector;
+  }
+
+  // Skip connectors
+  return {
+    ...connector,
+    attributes: {
+      ...connector.attributes,
+      isMissingSecrets: true,
+    },
+  };
+}

x-pack/plugins/alerting/server/saved_objects/index.ts

@@ -5,11 +5,15 @@
  * 2.0.
  */
 
-import { SavedObjectsServiceSetup } from 'kibana/server';
+import {
+  SavedObject,
+  SavedObjectsExportTransformContext,
+  SavedObjectsServiceSetup,
+} from 'kibana/server';
 import mappings from './mappings.json';
 import { getMigrations } from './migrations';
 import { EncryptedSavedObjectsPluginSetup } from '../../../encrypted_saved_objects/server';
-
+import { transformRulesForExport } from './transform_rule_for_export';
 export { partiallyUpdateAlert } from './partially_update_alert';
 
 export const AlertAttributesExcludedFromAAD = [
@@ -43,6 +47,18 @@ export function setupSavedObjects(
     namespaceType: 'single',
     migrations: getMigrations(encryptedSavedObjects),
     mappings: mappings.alert,
+    management: {
+      importableAndExportable: true,
+      getTitle(obj) {
+        return `Rule: [${obj.attributes.name}]`;
+      },
+      onExport<RawAlert>(
+        context: SavedObjectsExportTransformContext,
+        objects: Array<SavedObject<RawAlert>>
+      ) {
+        return transformRulesForExport(objects);
+      },
+    },
   });
 
   savedObjects.registerType({