[8.x] Add Pre-8.x Enterprise Search Index Incompatibility Deprecations

x-pack/solutions/search/plugins/enterprise_search/server/deprecations/index.test.ts

@@ -21,9 +21,12 @@ import { Connector } from '@kbn/search-connectors';
 
 import { ConfigType } from '..';
 
+import indexDeprecatorFxns = require('./pre_eight_index_deprecator');
+
 import {
   getCrawlerDeprecations,
   getEnterpriseSearchNodeDeprecation,
+  getEnterpriseSearchPre8IndexDeprecations,
   getNativeConnectorDeprecations,
 } from '.';
 
@@ -218,3 +221,72 @@ describe('Native connector deprecations', () => {
     expect(deprecations[1].title).toMatch('Integration Server must be provisioned');
   });
 });
+
+describe('getEnterpriseSearchPre8IndexDeprecations', () => {
+  it('can register index and data stream deprecations that need to be set to read only', async () => {
+    const getIndicesMock = jest.fn(() =>
+      Promise.resolve([
+        {
+          name: '.ent-search-index_without_datastream',
+          isDatastream: false,
+          datastreamName: '',
+        },
+        {
+          name: '.ent-search-with_data_stream',
+          isDatastream: true,
+          datastreamName: 'datastream-testing',
+        },
+      ])
+    );
+
+    jest
+      .spyOn(indexDeprecatorFxns, 'getPreEightEnterpriseSearchIndices')
+      .mockImplementation(getIndicesMock);
+
+    const deprecations = await getEnterpriseSearchPre8IndexDeprecations(ctx, 'docsurl', 'mockhost');
+    expect(deprecations).toHaveLength(1);
+    expect(deprecations[0].correctiveActions.api?.path).toStrictEqual(
+      '/internal/enterprise_search/deprecations/set_enterprise_search_indices_read_only'
+    );
+    expect(deprecations[0].title).toMatch('Pre 8.x Enterprise Search indices compatibility');
+    expect(deprecations[0].message.content).toContain(
+      'The following indices are found to be incompatible for upgrade'
+    );
+    expect(deprecations[0].message.content).toContain('.ent-search-index_without_datastream');
+    expect(deprecations[0].message.content).toContain(
+      'The following data streams are found to be incompatible for upgrade'
+    );
+    expect(deprecations[0].message.content).toContain('.ent-search-with_data_stream');
+  });
+
+  it('can register indexex without data stream deprecations that need to be set to read only', async () => {
+    const getIndicesMock = jest.fn(() =>
+      Promise.resolve([
+        {
+          name: '.ent-search-index_without_datastream',
+          isDatastream: false,
+          datastreamName: '',
+        },
+      ])
+    );
+
+    jest
+      .spyOn(indexDeprecatorFxns, 'getPreEightEnterpriseSearchIndices')
+      .mockImplementation(getIndicesMock);
+
+    const deprecations = await getEnterpriseSearchPre8IndexDeprecations(ctx, 'docsurl', 'mockhost');
+    expect(deprecations).toHaveLength(1);
+    expect(deprecations[0].correctiveActions.api?.path).toStrictEqual(
+      '/internal/enterprise_search/deprecations/set_enterprise_search_indices_read_only'
+    );
+    expect(deprecations[0].title).toMatch('Pre 8.x Enterprise Search indices compatibility');
+    expect(deprecations[0].message.content).toContain(
+      'The following indices are found to be incompatible for upgrade'
+    );
+    expect(deprecations[0].message.content).toContain('.ent-search-index_without_datastream');
+    expect(deprecations[0].message.content).not.toContain(
+      'The following data streams are found to be incompatible for upgrade'
+    );
+    expect(deprecations[0].message.content).not.toContain('.ent-search-with_data_stream');
+  });
+});

x-pack/solutions/search/plugins/enterprise_search/server/deprecations/index.ts

@@ -16,6 +16,8 @@ import { Connector, fetchConnectors } from '@kbn/search-connectors';
 
 import { ConfigType } from '..';
 
+import { getPreEightEnterpriseSearchIndices } from './pre_eight_index_deprecator';
+
 const NATIVE_SERVICE_TYPES = [
   'azure_blob_storage',
   'box',
@@ -59,11 +61,18 @@ export const getRegisteredDeprecations = (
         true // only counts if the Fleet Server is active
       );
       const entSearchDetails = getEnterpriseSearchNodeDeprecation(config, cloud, docsUrl);
-      const [crawlerDetails, nativeConnectorsDetails] = await Promise.all([
-        await getCrawlerDeprecations(ctx, docsUrl),
-        await getNativeConnectorDeprecations(ctx, hasAgentless, hasFleetServer, cloud, docsUrl),
-      ]);
-      return [...entSearchDetails, ...crawlerDetails, ...nativeConnectorsDetails];
+      const [crawlerDetails, nativeConnectorsDetails, entSearchIndexIncompatibility] =
+        await Promise.all([
+          await getCrawlerDeprecations(ctx, docsUrl),
+          await getNativeConnectorDeprecations(ctx, hasAgentless, hasFleetServer, cloud, docsUrl),
+          await getEnterpriseSearchPre8IndexDeprecations(ctx, docsUrl, config.host),
+        ]);
+      return [
+        ...entSearchDetails,
+        ...crawlerDetails,
+        ...nativeConnectorsDetails,
+        ...entSearchIndexIncompatibility,
+      ];
     },
   };
 };
@@ -414,3 +423,108 @@ export async function getNativeConnectorDeprecations(
     return deprecations;
   }
 }
+
+/**
+ * If there are any Enterprise Search indices that were created with Elasticsearch 7.x, they must be removed
+ * or set to read-only
+ */
+export async function getEnterpriseSearchPre8IndexDeprecations(
+  ctx: GetDeprecationsContext,
+  docsUrl: string,
+  configHost?: string
+): Promise<DeprecationsDetails[]> {
+  const deprecations: DeprecationsDetails[] = [];
+
+  if (!configHost) {
+    return deprecations;
+  }
+
+  // TODO - find out : is this applicable only on cloud?
+  // const isCloud = !!cloud?.cloudId;
+
+  const entSearchIndices = await getPreEightEnterpriseSearchIndices(ctx.esClient.asInternalUser);
+  if (!entSearchIndices || entSearchIndices.length === 0) {
+    return deprecations;
+  }
+
+  let indicesList = '';
+  let datastreamsList = '';
+  for (const index of entSearchIndices) {
+    if (index.isDatastream) {
+      datastreamsList += `${index.name}\n`;
+    } else {
+      indicesList += `${index.name}\n`;
+    }
+  }
+
+  let message = `There are ${entSearchIndices.length} incompatible Enterprise Search indices.\n\n`;
+
+  if (indicesList.length > 0) {
+    message +=
+      'The following indices are found to be incompatible for upgrade:\n\n' +
+      '```\n' +
+      `${indicesList}` +
+      '\n```\n\n' +
+      'These indices must be either set to read-only or deleted before upgrading. ';
+  }
+
+  if (datastreamsList.length > 0) {
+    message +=
+      '\nThe following data streams are found to be incompatible for upgrade:\n\n' +
+      '```\n' +
+      `${datastreamsList}` +
+      '\n```\n\n' +
+      'Using the "quick resolve" button below will roll over any datastreams and set all incompatible indices to read-only.\n\n' +
+      'Alternatively, manually deleting these indices and data streams will also unblock your upgrade.';
+  } else {
+    message +=
+      'Setting these indices to read-only can be attempted with the "quick resolve" button below.\n\n' +
+      'Alternatively, manually deleting these indices will also unblock your upgrade.';
+  }
+
+  deprecations.push({
+    level: 'critical',
+    deprecationType: 'feature',
+    title: i18n.translate(
+      'xpack.enterpriseSearch.deprecations.incompatibleEnterpriseSearchIndexes.title',
+      {
+        defaultMessage: 'Pre 8.x Enterprise Search indices compatibility',
+      }
+    ),
+    message: {
+      type: 'markdown',
+      content: i18n.translate(
+        'xpack.enterpriseSearch.deprecations.incompatibleEnterpriseSearchIndexes.message',
+        {
+          defaultMessage: message,
+        }
+      ),
+    },
+    documentationUrl: docsUrl,
+    correctiveActions: {
+      manualSteps: [
+        i18n.translate(
+          'xpack.enterpriseSearch.deprecations.incompatibleEnterpriseSearchIndexes.deleteIndices',
+          {
+            defaultMessage: 'Set all incompatible indices to read only, or',
+          }
+        ),
+        i18n.translate(
+          'xpack.enterpriseSearch.deprecations.incompatibleEnterpriseSearchIndexes.deleteIndices',
+          {
+            defaultMessage: 'Delete all incompatible indices',
+          }
+        ),
+      ],
+      api: {
+        method: 'POST',
+        path: '/internal/enterprise_search/deprecations/set_enterprise_search_indices_read_only',
+        body: {
+          deprecationDetails: { domainId: 'enterpriseSearch' },
+        },
+      },
+    },
+  });
+
+  return deprecations;
+}