[Reporting] Add new ILM policy notice to deprecations service

x-pack/plugins/reporting/common/constants.ts

@@ -89,6 +89,7 @@ export const API_BASE_URL = '/api/reporting'; // "Generation URL" from share men
 export const API_BASE_GENERATE = `${API_BASE_URL}/generate`;
 export const API_LIST_URL = `${API_BASE_URL}/jobs`;
 export const API_DIAGNOSE_URL = `${API_BASE_URL}/diagnose`;
+export const API_MIGRATE_ILM_POLICY_URL = `${API_BASE_URL}/deprecations/migrate_ilm_policy`;
 
 // hacky endpoint: download CSV without queueing a report
 export const API_BASE_URL_V1 = '/api/reporting/v1'; //

x-pack/plugins/reporting/server/deprecations/index.ts

@@ -0,0 +1,28 @@
+/*
+ * 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 { CoreSetup } from 'src/core/server';
+import { ReportingCore } from '../core';
+
+import { getDeprecationsInfo as getIlmPolicyDeprecationsInfo } from './migrate_existing_indices_ilm_policy';
+import { getDeprecationsInfo as getReportingRoleDeprecationsInfo } from './reporting_role';
+
+export const registerDeprecations = ({
+  core,
+  reportingCore,
+}: {
+  core: CoreSetup;
+  reportingCore: ReportingCore;
+}) => {
+  core.deprecations.registerDeprecations({
+    getDeprecations: async (ctx) => {
+      return [
+        ...(await getIlmPolicyDeprecationsInfo(ctx, { reportingCore })),
+        ...(await getReportingRoleDeprecationsInfo(ctx, { reportingCore })),
+      ];
+    },
+  });
+};

x-pack/plugins/reporting/server/deprecations/migrage_existing_indices_ilm_policy.test.ts

@@ -0,0 +1,98 @@
+/*
+ * 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 type { GetDeprecationsContext } from 'src/core/server';
+import { elasticsearchServiceMock, savedObjectsClientMock } from 'src/core/server/mocks';
+
+import { ReportingCore } from '../core';
+import { createMockConfigSchema, createMockReportingCore } from '../test_helpers';
+
+import { getDeprecationsInfo } from './migrate_existing_indices_ilm_policy';
+
+type ScopedClusterClientMock = ReturnType<
+  typeof elasticsearchServiceMock.createScopedClusterClient
+>;
+
+const { createApiResponse } = elasticsearchServiceMock;
+
+describe("Migrate existing indices' ILM policy deprecations", () => {
+  let esClient: ScopedClusterClientMock;
+  let deprecationsCtx: GetDeprecationsContext;
+  let reportingCore: ReportingCore;
+
+  beforeEach(async () => {
+    esClient = elasticsearchServiceMock.createScopedClusterClient();
+    deprecationsCtx = { esClient, savedObjectsClient: savedObjectsClientMock.create() };
+    reportingCore = await createMockReportingCore(createMockConfigSchema());
+  });
+
+  const createIndexSettings = (lifecycleName: string) => ({
+    aliases: {},
+    mappings: {},
+    settings: {
+      index: {
+        lifecycle: {
+          name: lifecycleName,
+        },
+      },
+    },
+  });
+
+  it('returns deprecation information when reporting indices are not using the reporting ILM policy', async () => {
+    esClient.asInternalUser.indices.getSettings.mockResolvedValueOnce(
+      createApiResponse({
+        body: {
+          indexA: createIndexSettings('not-reporting-lifecycle'),
+          indexB: createIndexSettings('kibana-reporting'),
+        },
+      })
+    );
+
+    expect(await getDeprecationsInfo(deprecationsCtx, { reportingCore })).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "correctiveActions": Object {
+            "api": Object {
+              "method": "PUT",
+              "path": "/api/reporting/deprecations/migrate_ilm_policy",
+            },
+            "manualSteps": Array [
+              "Send a request to Elasticsearch that configures indices matching \\".reporting-*\\" to be managed by the \\"kibana-reporting\\" Index Lifecycle Policy.",
+            ],
+          },
+          "level": "warning",
+          "message": "All new reporting indices will be managed by a provisioned ILM policy: \\"kibana-reporting\\". To manage the lifecycle of reports edit the kibana-reporting policy. Please note, this action will target all indices prefixed with \\".reporting-*\\".",
+        },
+      ]
+    `);
+  });
+
+  it('does not return deprecations when all reporting indices are managed by the provisioned ILM policy', async () => {
+    esClient.asInternalUser.indices.getSettings.mockResolvedValueOnce(
+      createApiResponse({
+        body: {
+          indexA: createIndexSettings('kibana-reporting'),
+          indexB: createIndexSettings('kibana-reporting'),
+        },
+      })
+    );
+
+    expect(await getDeprecationsInfo(deprecationsCtx, { reportingCore })).toMatchInlineSnapshot(
+      `Array []`
+    );
+
+    esClient.asInternalUser.indices.getSettings.mockResolvedValueOnce(
+      createApiResponse({
+        body: {},
+      })
+    );
+
+    expect(await getDeprecationsInfo(deprecationsCtx, { reportingCore })).toMatchInlineSnapshot(
+      `Array []`
+    );
+  });
+});

x-pack/plugins/reporting/server/deprecations/migrate_existing_indices_ilm_policy.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; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { i18n } from '@kbn/i18n';
+import { DeprecationsDetails, GetDeprecationsContext } from 'src/core/server';
+import { API_MIGRATE_ILM_POLICY_URL } from '../../common/constants';
+import { ReportingCore } from '../core';
+
+interface ExtraDependencies {
+  reportingCore: ReportingCore;
+}
+
+export const getDeprecationsInfo = async (
+  { esClient }: GetDeprecationsContext,
+  { reportingCore }: ExtraDependencies
+): Promise<DeprecationsDetails[]> => {
+  const store = await reportingCore.getStore();
+  const reportingIlmPolicy = store.getIlmPolicyName();
+  const indexPattern = store.getReportingIndexPattern();
+
+  const { body: reportingIndicesSettings } = await esClient.asInternalUser.indices.getSettings({
+    index: indexPattern,
+  });
+
+  const someIndicesNotManagedByReportingIlm = Object.values(reportingIndicesSettings).some(
+    (settings) => settings?.settings?.index?.lifecycle?.name !== reportingIlmPolicy
+  );
+
+  if (someIndicesNotManagedByReportingIlm) {
+    return [
+      {
+        level: 'warning',
+        message: i18n.translate('xpack.reporting.deprecations.migrateIndexIlmPolicyActionMessage', {
+          defaultMessage: `All new reporting indices will be managed by a provisioned ILM policy: "{reportingIlmPolicy}". To manage the lifecycle of reports edit the {reportingIlmPolicy} policy. Please note, this action will target all indices prefixed with "{indexPattern}".`,
+          values: {
+            reportingIlmPolicy,
+            indexPattern,
+          },
+        }),
+        correctiveActions: {
+          api: {
+            method: 'PUT',
+            path: API_MIGRATE_ILM_POLICY_URL,
+          },
+        },
+      },
+    ];
+  }
+
+  return [];
+};