[7.x] [Upgrade Assistant] Better handling of closed indices (#58890)

x-pack/plugins/upgrade_assistant/common/get_index_state_from_cluster_state.test.ts

@@ -0,0 +1,53 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+import { getIndexStateFromClusterState } from './get_index_state_from_cluster_state';
+import { ClusterStateAPIResponse } from './types';
+
+describe('getIndexStateFromClusterState', () => {
+  const indexName = 'indexName';
+  const clusterState: ClusterStateAPIResponse = {
+    metadata: {
+      indices: {},
+      cluster_coordination: {} as any,
+      cluster_uuid: 'test',
+      templates: {} as any,
+    },
+    cluster_name: 'test',
+    cluster_uuid: 'test',
+  };
+
+  afterEach(() => {
+    clusterState.metadata.indices = {};
+  });
+
+  it('correctly extracts state from cluster state', () => {
+    clusterState.metadata.indices[indexName] = { state: 'open' } as any;
+    clusterState.metadata.indices.aTotallyDifferentIndex = { state: 'close' } as any;
+    expect(getIndexStateFromClusterState(indexName, clusterState)).toBe('open');
+  });
+
+  it('correctly extracts state from aliased index in cluster state', () => {
+    clusterState.metadata.indices.aTotallyDifferentName = {
+      state: 'close',
+      aliases: [indexName, 'test'],
+    } as any;
+    clusterState.metadata.indices.aTotallyDifferentName1 = {
+      state: 'open',
+      aliases: ['another', 'test'],
+    } as any;
+
+    expect(getIndexStateFromClusterState(indexName, clusterState)).toBe('close');
+  });
+
+  it('throws if the index name cannot be found in the cluster state', () => {
+    expect(() => getIndexStateFromClusterState(indexName, clusterState)).toThrow('not found');
+    clusterState.metadata.indices.aTotallyDifferentName1 = {
+      state: 'open',
+      aliases: ['another', 'test'],
+    } as any;
+    expect(() => getIndexStateFromClusterState(indexName, clusterState)).toThrow('not found');
+  });
+});

x-pack/plugins/upgrade_assistant/common/get_index_state_from_cluster_state.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;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { ClusterStateAPIResponse } from './types';
+
+const checkAllAliases = (
+  indexName: string,
+  clusterState: ClusterStateAPIResponse
+): 'open' | 'close' => {
+  for (const index of Object.values(clusterState.metadata.indices)) {
+    if (index.aliases?.some(alias => alias === indexName)) {
+      return index.state;
+    }
+  }
+
+  throw new Error(`${indexName} not found in cluster state!`);
+};
+
+export const getIndexStateFromClusterState = (
+  indexName: string,
+  clusterState: ClusterStateAPIResponse
+): 'open' | 'close' =>
+  clusterState.metadata.indices[indexName]
+    ? clusterState.metadata.indices[indexName].state
+    : checkAllAliases(indexName, clusterState);

x-pack/plugins/upgrade_assistant/common/types.ts

@@ -34,6 +34,13 @@ export interface QueueSettings extends SavedObjectAttributes {
 }
 
 export interface ReindexOptions extends SavedObjectAttributes {
+  /**
+   * Whether to treat the index as if it were closed. This instructs the
+   * reindex strategy to first open the index, perform reindexing and
+   * then close the index again.
+   */
+  openAndClose?: boolean;
+
   /**
    * Set this key to configure a reindex operation as part of a
    * batch to be run in series.
@@ -50,7 +57,6 @@ export interface ReindexOperation extends SavedObjectAttributes {
   reindexTaskId: string | null;
   reindexTaskPercComplete: number | null;
   errorMessage: string | null;
-
   // This field is only used for the singleton IndexConsumerType documents.
   runningReindexCount: number | null;
 
@@ -142,10 +148,57 @@ export interface EnrichedDeprecationInfo extends DeprecationInfo {
   node?: string;
   reindex?: boolean;
   needsDefaultFields?: boolean;
+  /**
+   * Indicate what blockers have been detected for calling reindex
+   * against this index.
+   *
+   * @remark
+   * In future this could be an array of blockers.
+   */
+  blockerForReindexing?: 'index-closed'; // 'index-closed' can be handled automatically, but requires more resources, user should be warned
 }
 
 export interface UpgradeAssistantStatus {
   readyForUpgrade: boolean;
   cluster: EnrichedDeprecationInfo[];
   indices: EnrichedDeprecationInfo[];
 }
+
+export interface ClusterStateIndexAPIResponse {
+  state: 'open' | 'close';
+  settings: {
+    index: {
+      verified_before_close: string;
+      search: {
+        throttled: string;
+      };
+      number_of_shards: string;
+      provided_name: string;
+      frozen: string;
+      creation_date: string;
+      number_of_replicas: string;
+      uuid: string;
+      version: {
+        created: string;
+      };
+    };
+  };
+  mappings: any;
+  aliases: string[];
+}
+
+export interface ClusterStateAPIResponse {
+  cluster_name: string;
+  cluster_uuid: string;
+  metadata: {
+    cluster_uuid: string;
+    cluster_coordination: {
+      term: number;
+      last_committed_config: string[];
+      last_accepted_config: string[];
+      voting_config_exclusions: [];
+    };
+    templates: any;
+    indices: { [indexName: string]: ClusterStateIndexAPIResponse };
+  };
+}

x-pack/plugins/upgrade_assistant/public/application/app_context.tsx

@@ -3,12 +3,13 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
-import { HttpSetup } from 'src/core/public';
+import { DocLinksStart, HttpSetup } from 'src/core/public';
 import React, { createContext, useContext } from 'react';
 
 export interface ContextValue {
   http: HttpSetup;
   isCloudEnabled: boolean;
+  docLinks: DocLinksStart;
 }
 
 export const AppContext = createContext<ContextValue>({} as any);

x-pack/plugins/upgrade_assistant/public/application/components/tabs.tsx

@@ -14,7 +14,8 @@ import {
   EuiTabbedContent,
   EuiTabbedContentTab,
 } from '@elastic/eui';
-import { FormattedMessage, injectI18n } from '@kbn/i18n/react';
+import { i18n } from '@kbn/i18n';
+import { FormattedMessage } from '@kbn/i18n/react';
 import { HttpSetup } from 'src/core/public';
 
 import { UpgradeAssistantStatus } from '../../../common/types';
@@ -38,9 +39,11 @@ interface TabsState {
   clusterUpgradeState: ClusterUpgradeState;
 }
 
-type Props = ReactIntl.InjectedIntlProps & { http: HttpSetup };
+interface Props {
+  http: HttpSetup;
+}
 
-export class UpgradeAssistantTabsUI extends React.Component<Props, TabsState> {
+export class UpgradeAssistantTabs extends React.Component<Props, TabsState> {
   constructor(props: Props) {
     super(props);
     this.state = {
@@ -172,7 +175,6 @@ export class UpgradeAssistantTabsUI extends React.Component<Props, TabsState> {
   };
 
   private get tabs() {
-    const { intl } = this.props;
     const { loadingError, loadingState, checkupData } = this.state;
     const commonProps: UpgradeAssistantTabProps = {
       loadingError,
@@ -186,24 +188,21 @@ export class UpgradeAssistantTabsUI extends React.Component<Props, TabsState> {
     return [
       {
         id: 'overview',
-        name: intl.formatMessage({
-          id: 'xpack.upgradeAssistant.overviewTab.overviewTabTitle',
+        name: i18n.translate('xpack.upgradeAssistant.overviewTab.overviewTabTitle', {
           defaultMessage: 'Overview',
         }),
         content: <OverviewTab checkupData={checkupData} {...commonProps} />,
       },
       {
         id: 'cluster',
-        name: intl.formatMessage({
-          id: 'xpack.upgradeAssistant.checkupTab.clusterTabLabel',
+        name: i18n.translate('xpack.upgradeAssistant.checkupTab.clusterTabLabel', {
           defaultMessage: 'Cluster',
         }),
         content: (
           <CheckupTab
             key="cluster"
             deprecations={checkupData ? checkupData.cluster : undefined}
-            checkupLabel={intl.formatMessage({
-              id: 'xpack.upgradeAssistant.tabs.checkupTab.clusterLabel',
+            checkupLabel={i18n.translate('xpack.upgradeAssistant.tabs.checkupTab.clusterLabel', {
               defaultMessage: 'cluster',
             })}
             {...commonProps}
@@ -212,16 +211,14 @@ export class UpgradeAssistantTabsUI extends React.Component<Props, TabsState> {
       },
       {
         id: 'indices',
-        name: intl.formatMessage({
-          id: 'xpack.upgradeAssistant.checkupTab.indicesTabLabel',
+        name: i18n.translate('xpack.upgradeAssistant.checkupTab.indicesTabLabel', {
           defaultMessage: 'Indices',
         }),
         content: (
           <CheckupTab
             key="indices"
             deprecations={checkupData ? checkupData.indices : undefined}
-            checkupLabel={intl.formatMessage({
-              id: 'xpack.upgradeAssistant.checkupTab.indexLabel',
+            checkupLabel={i18n.translate('xpack.upgradeAssistant.checkupTab.indexLabel', {
               defaultMessage: 'index',
             })}
             showBackupWarning
@@ -249,5 +246,3 @@ export class UpgradeAssistantTabsUI extends React.Component<Props, TabsState> {
     this.setState({ telemetryState: TelemetryState.Complete });
   }
 }
-
-export const UpgradeAssistantTabs = injectI18n(UpgradeAssistantTabsUI);

x-pack/plugins/upgrade_assistant/public/application/components/tabs/checkup/deprecations/cell.tsx

@@ -19,6 +19,7 @@ import { FormattedMessage } from '@kbn/i18n/react';
 import { FixDefaultFieldsButton } from './default_fields/button';
 import { ReindexButton } from './reindex';
 import { AppContext } from '../../../../app_context';
+import { EnrichedDeprecationInfo } from '../../../../../../common/types';
 
 interface DeprecationCellProps {
   items?: Array<{ title?: string; body: string }>;
@@ -29,6 +30,7 @@ interface DeprecationCellProps {
   headline?: string;
   healthColor?: string;
   children?: ReactNode;
+  reindexBlocker?: EnrichedDeprecationInfo['blockerForReindexing'];
 }
 
 /**
@@ -43,6 +45,7 @@ export const DeprecationCell: FunctionComponent<DeprecationCellProps> = ({
   docUrl,
   items = [],
   children,
+  reindexBlocker,
 }) => (
   <div className="upgDeprecationCell">
     <EuiFlexGroup responsive={false} wrap alignItems="baseline">
@@ -84,7 +87,14 @@ export const DeprecationCell: FunctionComponent<DeprecationCellProps> = ({
       {reindex && (
         <EuiFlexItem grow={false}>
           <AppContext.Consumer>
-            {({ http }) => <ReindexButton indexName={indexName!} http={http} />}
+            {({ http, docLinks }) => (
+              <ReindexButton
+                docLinks={docLinks}
+                reindexBlocker={reindexBlocker}
+                indexName={indexName!}
+                http={http}
+              />
+            )}
           </AppContext.Consumer>
         </EuiFlexItem>
       )}

x-pack/plugins/upgrade_assistant/public/application/components/tabs/checkup/deprecations/index_table.tsx

@@ -12,13 +12,15 @@ import { injectI18n } from '@kbn/i18n/react';
 import { FixDefaultFieldsButton } from './default_fields/button';
 import { ReindexButton } from './reindex';
 import { AppContext } from '../../../../app_context';
+import { EnrichedDeprecationInfo } from '../../../../../../common/types';
 
 const PAGE_SIZES = [10, 25, 50, 100, 250, 500, 1000];
 
 export interface IndexDeprecationDetails {
   index: string;
   reindex: boolean;
   needsDefaultFields: boolean;
+  blockerForReindexing?: EnrichedDeprecationInfo['blockerForReindexing'];
   details?: string;
 }
 
@@ -70,9 +72,10 @@ export class IndexDeprecationTableUI extends React.Component<
       },
     ];
 
-    if (this.actionsColumn) {
-      // @ts-ignore
-      columns.push(this.actionsColumn);
+    const actionsColumn = this.generateActionsColumn();
+
+    if (actionsColumn) {
+      columns.push(actionsColumn as any);
     }
 
     const sorting = {
@@ -136,7 +139,7 @@ export class IndexDeprecationTableUI extends React.Component<
     return { totalItemCount, pageSizeOptions, hidePerPageOptions: false };
   }
 
-  private get actionsColumn() {
+  private generateActionsColumn() {
     // NOTE: this naive implementation assumes all indices in the table are
     // should show the reindex button. This should work for known usecases.
     const { indices } = this.props;
@@ -153,7 +156,16 @@ export class IndexDeprecationTableUI extends React.Component<
             if (showReindexButton) {
               return (
                 <AppContext.Consumer>
-                  {({ http }) => <ReindexButton indexName={indexDep.index!} http={http} />}
+                  {({ http, docLinks }) => {
+                    return (
+                      <ReindexButton
+                        docLinks={docLinks}
+                        reindexBlocker={indexDep.blockerForReindexing}
+                        indexName={indexDep.index!}
+                        http={http}
+                      />
+                    );
+                  }}
                 </AppContext.Consumer>
               );
             } else {