initial version of upgrade assistant integration

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/migrate_existing_indices_ilm_policy.ts

@@ -7,6 +7,7 @@
 
 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 {
@@ -19,10 +20,10 @@ export const migrateExistingIndicesIlmPolicy = async (
 ): Promise<DeprecationsDetails[]> => {
   const store = await reportingCore.getStore();
   const reportingIlmPolicy = store.getIlmPolicyName();
-  const reportingIndexPrefix = store.getIndexPrefix();
+  const indexPattern = store.getReportingIndexPattern();
 
   const { body: reportingIndicesSettings } = await esClient.asInternalUser.indices.getSettings({
-    index: `${store.getIndexPrefix()}-*`,
+    index: indexPattern,
   });
 
   const someIndicesNotManagedByReportingIlm = Object.values(reportingIndicesSettings).some(
@@ -34,12 +35,13 @@ export const migrateExistingIndicesIlmPolicy = async (
       {
         level: 'warning',
         message: i18n.translate('xpack.reporting.deprecations.migrateIndexIlmPolicyActionMessage', {
-          defaultMessage: `Reporting indices can be managed by a provisioned ILM policy, ${reportingIlmPolicy}. This policy should be used to manage the lifecycle of indices. Please note, this action will target all indices prefixed with "${reportingIndexPrefix}-*".`,
+          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}".`,
         }),
+        documentationUrl: 'WIP', // TODO: Fix this!
         correctiveActions: {
           api: {
             method: 'PUT',
-            path: `${reportingIndexPrefix}-*/_settings`,
+            path: API_MIGRATE_ILM_POLICY_URL,
             body: {
               index: {
                 lifecycle: {

x-pack/plugins/reporting/server/lib/store/store.ts

@@ -406,7 +406,7 @@ export class ReportingStore {
     return this.ilmPolicyName;
   }
 
-  public getIndexPrefix(): string {
-    return this.indexPrefix;
+  public getReportingIndexPattern(): string {
+    return `${this.indexPrefix}-*`;
   }
 }

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

@@ -0,0 +1,50 @@
+/*
+ * 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 { errors } from '@elastic/elasticsearch';
+import { API_MIGRATE_ILM_POLICY_URL } from '../../common/constants';
+import { ReportingCore } from '../core';
+import { LevelLogger as Logger } from '../lib';
+
+export const registerDeprecationsRoutes = (reporting: ReportingCore, logger: Logger) => {
+  const { router } = reporting.getPluginSetupDeps();
+
+  router.put({ path: API_MIGRATE_ILM_POLICY_URL, validate: false }, async (ctx, req, res) => {
+    const store = await reporting.getStore();
+    const { asInternalUser: client } = await reporting.getEsClient();
+
+    const indexPattern = store.getReportingIndexPattern();
+    const reportingIlmPolicy = store.getIlmPolicyName();
+
+    try {
+      await client.indices.putSettings({
+        index: indexPattern,
+        body: {
+          index: {
+            lifecycle: {
+              name: reportingIlmPolicy,
+            },
+          },
+        },
+      });
+      return res.ok();
+    } catch (err) {
+      logger.error(err);
+
+      if (err instanceof errors.ResponseError) {
+        return res.customError({
+          statusCode: 500,
+          body: {
+            message: err.message,
+            name: err.name,
+          },
+        });
+      }
+
+      throw err;
+    }
+  });
+};

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

@@ -6,15 +6,17 @@
  */
 
 import { LevelLogger as Logger } from '../lib';
+import { registerDeprecationsRoutes } from './deprecations';
+import { registerDiagnosticRoutes } from './diagnostic';
 import { registerJobGenerationRoutes } from './generation';
 import { registerJobInfoRoutes } from './jobs';
 import { ReportingCore } from '../core';
-import { registerDiagnosticRoutes } from './diagnostic';
 
 export function registerRoutes(reporting: ReportingCore, logger: Logger) {
+  registerDeprecationsRoutes(reporting, logger);
+  registerDiagnosticRoutes(reporting, logger);
   registerJobGenerationRoutes(reporting, logger);
   registerJobInfoRoutes(reporting);
-  registerDiagnosticRoutes(reporting, logger);
 }
 
 export interface ReportingRequestPre {