[8.x] [Index Management] Add index mode field in index template form (#…

…199521) (#200244) # Backport This will backport the following commits from `main` to `8.x`: - [[Index Management] Add index mode field in index template form (#199521)](#199521)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Elena Stoeva <[email protected]>
elastic · Nov 14, 2024 · 7ef99b3 · 7ef99b3
1 parent 798e18c
commit 7ef99b3
Show file tree

Hide file tree

Showing 26 changed files with 403 additions and 56 deletions.
diff --git a/...dex_management/__jest__/client_integration/index_template_wizard/template_create.test.tsx b/...dex_management/__jest__/client_integration/index_template_wizard/template_create.test.tsx
@@ -52,6 +52,15 @@ jest.mock('@elastic/eui', () => {
         }}
       />
     ),
+    EuiSuperSelect: (props: any) => (
+      <input
+        data-test-subj={props['data-test-subj'] || 'mockSuperSelect'}
+        value={props.valueOfSelected}
+        onChange={(e) => {
+          props.onChange(e.target.value);
+        }}
+      />
+    ),
   };
 });
 
@@ -301,6 +310,15 @@ describe('<TemplateCreate />', () => {
         expect(find('stepTitle').text()).toEqual('Index settings (optional)');
       });
 
+      it('should display a warning callout displaying the selected index mode', async () => {
+        const { exists, find } = testBed;
+
+        expect(exists('indexModeCallout')).toBe(true);
+        expect(find('indexModeCallout').text()).toContain(
+          'The index.mode setting has been set to Standard within template Logistics.'
+        );
+      });
+
       it('should not allow invalid json', async () => {
         const { form, actions } = testBed;
 
@@ -426,6 +444,53 @@ describe('<TemplateCreate />', () => {
     });
   });
 
+  describe('logistics (step 1)', () => {
+    beforeEach(async () => {
+      await act(async () => {
+        testBed = await setup(httpSetup);
+      });
+      testBed.component.update();
+    });
+
+    it('setting index pattern to logs-*-* should set the index mode to logsdb', async () => {
+      const { component, actions } = testBed;
+      // Logistics
+      await actions.completeStepOne({ name: 'my_logs_template', indexPatterns: ['logs-*-*'] });
+      // Component templates
+      await actions.completeStepTwo();
+      // Index settings
+      await actions.completeStepThree('{}');
+      // Mappings
+      await actions.completeStepFour();
+      // Aliases
+      await actions.completeStepFive();
+
+      await act(async () => {
+        actions.clickNextButton();
+      });
+      component.update();
+
+      expect(httpSetup.post).toHaveBeenLastCalledWith(
+        `${API_BASE_PATH}/index_templates`,
+        expect.objectContaining({
+          body: JSON.stringify({
+            name: 'my_logs_template',
+            indexPatterns: ['logs-*-*'],
+            allowAutoCreate: 'NO_OVERWRITE',
+            indexMode: 'logsdb',
+            dataStream: {},
+            _kbnMeta: {
+              type: 'default',
+              hasDatastream: false,
+              isLegacy: false,
+            },
+            template: {},
+          }),
+        })
+      );
+    });
+  });
+
   describe('review (step 6)', () => {
     beforeEach(async () => {
       await act(async () => {
@@ -529,6 +594,7 @@ describe('<TemplateCreate />', () => {
         name: TEMPLATE_NAME,
         indexPatterns: DEFAULT_INDEX_PATTERNS,
         allowAutoCreate: 'TRUE',
+        indexMode: 'time_series',
       });
       // Component templates
       await actions.completeStepTwo('test_component_template_1');
@@ -557,6 +623,7 @@ describe('<TemplateCreate />', () => {
             name: TEMPLATE_NAME,
             indexPatterns: DEFAULT_INDEX_PATTERNS,
             allowAutoCreate: 'TRUE',
+            indexMode: 'time_series',
             dataStream: {},
             _kbnMeta: {
               type: 'default',

diff --git a/...index_management/__jest__/client_integration/index_template_wizard/template_edit.test.tsx b/...index_management/__jest__/client_integration/index_template_wizard/template_edit.test.tsx
@@ -169,6 +169,7 @@ describe('<TemplateEdit />', () => {
             indexPatterns: ['myPattern*'],
             version: 1,
             allowAutoCreate: 'NO_OVERWRITE',
+            indexMode: 'standard',
             dataStream: {
               hidden: true,
               anyUnknownKey: 'should_be_kept',

diff --git a/...dex_management/__jest__/client_integration/index_template_wizard/template_form.helpers.ts b/...dex_management/__jest__/client_integration/index_template_wizard/template_form.helpers.ts
@@ -148,6 +148,7 @@ export const formSetup = async (initTestBed: SetupFunc<TestSubjects>) => {
     enableDataStream,
     lifecycle,
     allowAutoCreate,
+    indexMode,
   }: Partial<TemplateDeserialized> & { enableDataStream?: boolean } = {}) => {
     const { component, form, find } = testBed;
 
@@ -204,6 +205,10 @@ export const formSetup = async (initTestBed: SetupFunc<TestSubjects>) => {
         radioOption.simulate('change', { target: { checked: true } });
         component.update();
       }
+
+      if (indexMode) {
+        form.setSelectValue('indexModeField', indexMode);
+      }
     });
     component.update();
 
@@ -356,6 +361,7 @@ export type TestSubjects =
   | 'mappingsEditorFieldEdit'
   | 'mockCodeEditor'
   | 'mockComboBox'
+  | 'mockSuperSelect'
   | 'nameField'
   | 'nameField.input'
   | 'nameParameterInput'
@@ -364,6 +370,8 @@ export type TestSubjects =
   | 'orderField.input'
   | 'priorityField.input'
   | 'dataStreamField.input'
+  | 'indexModeField'
+  | 'indexModeCallout'
   | 'dataRetentionToggle.input'
   | 'allowAutoCreateField.input'
   | 'pageTitle'

diff --git a/x-pack/plugins/index_management/common/constants/index.ts b/x-pack/plugins/index_management/common/constants/index.ts
@@ -9,6 +9,7 @@ import { i18n } from '@kbn/i18n';
 export { BASE_PATH } from './base_path';
 export { API_BASE_PATH, INTERNAL_API_BASE_PATH } from './api_base_path';
 export { INVALID_INDEX_PATTERN_CHARS, INVALID_TEMPLATE_NAME_CHARS } from './invalid_characters';
+export * from './index_modes';
 export * from './index_statuses';
 
 // Since each index can have a max length or 255 characters and the max length of

diff --git a/x-pack/plugins/index_management/common/constants/index_modes.ts b/x-pack/plugins/index_management/common/constants/index_modes.ts
@@ -0,0 +1,10 @@
+/*
+ * 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.
+ */
+
+export const STANDARD_INDEX_MODE = 'standard';
+export const LOGSDB_INDEX_MODE = 'logsdb';
+export const TIME_SERIES_MODE = 'time_series';
diff --git a/x-pack/plugins/index_management/common/lib/template_serialization.test.ts b/x-pack/plugins/index_management/common/lib/template_serialization.test.ts
@@ -6,7 +6,8 @@
  */
 
 import { deserializeTemplate, serializeTemplate } from './template_serialization';
-import { TemplateDeserialized, TemplateSerialized } from '../types';
+import { TemplateDeserialized, TemplateSerialized, IndexMode } from '../types';
+import { STANDARD_INDEX_MODE, LOGSDB_INDEX_MODE, TIME_SERIES_MODE } from '../constants';
 
 const defaultSerializedTemplate: TemplateSerialized = {
   template: {},
@@ -17,6 +18,7 @@ const defaultSerializedTemplate: TemplateSerialized = {
 const defaultDeserializedTemplate: TemplateDeserialized = {
   name: 'my_template',
   indexPatterns: ['test'],
+  indexMode: STANDARD_INDEX_MODE,
   _kbnMeta: {
     type: 'default',
     hasDatastream: true,
@@ -26,12 +28,13 @@ const defaultDeserializedTemplate: TemplateDeserialized = {
 
 const allowAutoCreateRadioOptions = ['NO_OVERWRITE', 'TRUE', 'FALSE'];
 const allowAutoCreateSerializedValues = [undefined, true, false];
+const indexModeValues = [STANDARD_INDEX_MODE, LOGSDB_INDEX_MODE, TIME_SERIES_MODE, undefined];
 
 describe('Template serialization', () => {
   describe('serialization of allow_auto_create parameter', () => {
     describe('deserializeTemplate()', () => {
       allowAutoCreateSerializedValues.forEach((value, index) => {
-        test(`correctly deserializes ${value} value`, () => {
+        test(`correctly deserializes ${value} allow_auto_create value`, () => {
           expect(
             deserializeTemplate({
               ...defaultSerializedTemplate,
@@ -41,11 +44,29 @@ describe('Template serialization', () => {
           ).toHaveProperty('allowAutoCreate', allowAutoCreateRadioOptions[index]);
         });
       });
+
+      indexModeValues.forEach((value) => {
+        test(`correctly deserializes ${value} index mode settings value`, () => {
+          expect(
+            deserializeTemplate({
+              ...defaultSerializedTemplate,
+              name: 'my_template',
+              template: {
+                settings: {
+                  index: {
+                    mode: value,
+                  },
+                },
+              },
+            })
+          ).toHaveProperty('indexMode', value ?? STANDARD_INDEX_MODE);
+        });
+      });
     });
 
     describe('serializeTemplate()', () => {
       allowAutoCreateRadioOptions.forEach((option, index) => {
-        test(`correctly serializes ${option} radio option`, () => {
+        test(`correctly serializes ${option} allowAutoCreate radio option`, () => {
           expect(
             serializeTemplate({
               ...defaultDeserializedTemplate,
@@ -54,6 +75,18 @@ describe('Template serialization', () => {
           ).toHaveProperty('allow_auto_create', allowAutoCreateSerializedValues[index]);
         });
       });
+
+      // Only use the first three values (omit undefined)
+      indexModeValues.slice(0, 3).forEach((value) => {
+        test(`correctly serializes ${value} indexMode option`, () => {
+          expect(
+            serializeTemplate({
+              ...defaultDeserializedTemplate,
+              indexMode: value as IndexMode,
+            })
+          ).toHaveProperty('template.settings.index.mode', value);
+        });
+      });
     });
   });
 });
diff --git a/x-pack/plugins/index_management/common/lib/template_serialization.ts b/x-pack/plugins/index_management/common/lib/template_serialization.ts
@@ -11,9 +11,15 @@ import {
   TemplateSerialized,
   TemplateListItem,
   TemplateType,
+  IndexMode,
 } from '../types';
 import { deserializeESLifecycle } from './data_stream_utils';
-import { allowAutoCreateRadioValues, allowAutoCreateRadioIds } from '../constants';
+import {
+  allowAutoCreateRadioValues,
+  allowAutoCreateRadioIds,
+  STANDARD_INDEX_MODE,
+  LOGSDB_INDEX_MODE,
+} from '../constants';
 
 const hasEntries = (data: object = {}) => Object.entries(data).length > 0;
 
@@ -26,6 +32,7 @@ export function serializeTemplate(templateDeserialized: TemplateDeserialized): T
     composedOf,
     ignoreMissingComponentTemplates,
     dataStream,
+    indexMode,
     _meta,
     allowAutoCreate,
     deprecated,
@@ -34,7 +41,16 @@ export function serializeTemplate(templateDeserialized: TemplateDeserialized): T
   return {
     version,
     priority,
-    template,
+    template: {
+      ...template,
+      settings: {
+        ...template?.settings,
+        index: {
+          ...template?.settings?.index,
+          mode: indexMode,
+        },
+      },
+    },
     index_patterns: indexPatterns,
     data_stream: dataStream,
     composed_of: composedOf,
@@ -75,13 +91,19 @@ export function deserializeTemplate(
 
   const ilmPolicyName = settings?.index?.lifecycle?.name;
 
+  const indexMode = (settings?.index?.mode ??
+    (indexPatterns.some((pattern) => pattern === 'logs-*-*')
+      ? LOGSDB_INDEX_MODE
+      : STANDARD_INDEX_MODE)) as IndexMode;
+
   const deserializedTemplate: TemplateDeserialized = {
     name,
     version,
     priority,
     ...(template.lifecycle ? { lifecycle: deserializeESLifecycle(template.lifecycle) } : {}),
     indexPatterns: indexPatterns.sort(),
     template,
+    indexMode,
     ilmPolicy: ilmPolicyName ? { name: ilmPolicyName } : undefined,
     composedOf: composedOf ?? [],
     ignoreMissingComponentTemplates: ignoreMissingComponentTemplates ?? [],

diff --git a/x-pack/plugins/index_management/common/types/index.ts b/x-pack/plugins/index_management/common/types/index.ts
@@ -19,6 +19,7 @@ export type {
   DataStream,
   DataStreamIndex,
   DataRetention,
+  IndexMode,
 } from './data_streams';
 
 export * from './component_templates';

diff --git a/x-pack/plugins/index_management/common/types/templates.ts b/x-pack/plugins/index_management/common/types/templates.ts
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { DataRetention, DataStream } from './data_streams';
+import { DataRetention, DataStream, IndexMode } from './data_streams';
 import { IndexSettings } from './indices';
 import { Aliases } from './aliases';
 import { Mappings } from './mappings';
@@ -51,6 +51,7 @@ export interface TemplateDeserialized {
   priority?: number; // Composable template only
   allowAutoCreate: string;
   order?: number; // Legacy template only
+  indexMode: IndexMode;
   ilmPolicy?: {
     name: string;
   };