[ILM] Data tiers for 7.10

x-pack/plugins/index_lifecycle_management/__jest__/components/helpers/edit_policy.ts

@@ -0,0 +1,30 @@
+/*
+ * 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 { init as initHttpRequests } from './http_requests';
+
+export type EditPolicySetup = ReturnType<typeof setup>;
+
+export const setup = () => {
+  const { httpRequestsMockHelpers, server } = initHttpRequests();
+
+  const setupNodeListResponse = (
+    response: Record<string, any> = {
+      nodesByAttributes: { 'attribute:true': ['node1'] },
+      nodesByRoles: { data: ['node1'] },
+    }
+  ) => {
+    httpRequestsMockHelpers.setNodesListResponse(response);
+  };
+
+  return {
+    http: {
+      setupNodeListResponse,
+      httpRequestsMockHelpers,
+      server,
+    },
+  };
+};

x-pack/plugins/index_lifecycle_management/__jest__/components/helpers/http_requests.ts

@@ -40,6 +40,8 @@ const registerHttpRequestMockHelpers = (server: SinonFakeServer) => {
   };
 };
 
+export type HttpRequestMockHelpers = ReturnType<typeof registerHttpRequestMockHelpers>;
+
 export const init = () => {
   const server = sinon.fakeServer.create();
 

x-pack/plugins/index_lifecycle_management/__jest__/components/helpers/index.ts

@@ -0,0 +1,11 @@
+/*
+ * 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 * as editPolicyHelpers from './edit_policy';
+
+export { HttpRequestMockHelpers, init } from './http_requests';
+
+export { editPolicyHelpers };

x-pack/plugins/index_lifecycle_management/common/types/api.ts

@@ -0,0 +1,12 @@
+/*
+ * 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.
+ */
+
+export type NodeDataRole = 'data' | 'data_hot' | 'data_warm' | 'data_cold' | 'data_frozen';
+
+export interface ListNodesRouteResponse {
+  nodesByAttributes: { [attributePair: string]: string[] };
+  nodesByRoles: { [role in NodeDataRole]?: string[] };
+}

x-pack/plugins/index_lifecycle_management/common/types/index.ts

@@ -4,4 +4,6 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+export * from './api';
+
 export * from './policies';

x-pack/plugins/index_lifecycle_management/common/types/policies.ts

@@ -6,6 +6,8 @@
 
 import { Index as IndexInterface } from '../../../index_management/common/types';
 
+export type PhaseWithAllocation = 'warm' | 'cold' | 'frozen';
+
 export interface SerializedPolicy {
   name: string;
   phases: Phases;
@@ -62,6 +64,7 @@ export interface SerializedWarmPhase extends SerializedPhase {
     set_priority?: {
       priority: number | null;
     };
+    migrate?: { enabled: boolean };
   };
 }
 
@@ -72,6 +75,7 @@ export interface SerializedColdPhase extends SerializedPhase {
     set_priority?: {
       priority: number | null;
     };
+    migrate?: { enabled: boolean };
   };
 }
 
@@ -82,6 +86,7 @@ export interface SerializedFrozenPhase extends SerializedPhase {
     set_priority?: {
       priority: number | null;
     };
+    migrate?: { enabled: boolean };
   };
 }
 
@@ -103,6 +108,13 @@ export interface AllocateAction {
   require?: {
     [attribute: string]: string;
   };
+  migrate?: {
+    /**
+     * If enabled is ever set it will only be set to `false` because the default value
+     * for this is `true`. Rather leave unspecified for true.
+     */
+    enabled: false;
+  };
 }
 
 export interface Policy {
@@ -125,9 +137,23 @@ export interface PhaseWithMinAge {
   selectedMinimumAgeUnits: string;
 }
 
+/**
+ * Different types of allocation markers we use in deserialized policies.
+ *
+ * default - use data tier based data allocation based on node roles -- this is ES best practice mode.
+ * custom - use node_attrs to allocate data to specific nodes
+ * none - do not move data anywhere when entering a phase
+ */
+export type DataTierAllocationType = 'default' | 'custom' | 'none';
+
 export interface PhaseWithAllocationAction {
   selectedNodeAttrs: string;
   selectedReplicaCount: string;
+  /**
+   * A string value indicating allocation type. If unspecified we assume the user
+   * wants to use default allocation.
+   */
+  dataTierAllocationType: DataTierAllocationType;
 }
 
 export interface PhaseWithIndexPriority {

x-pack/plugins/index_lifecycle_management/public/application/constants/policy.ts

@@ -38,6 +38,7 @@ export const defaultNewWarmPhase: WarmPhase = {
   selectedReplicaCount: '',
   warmPhaseOnRollover: true,
   phaseIndexPriority: '50',
+  dataTierAllocationType: 'default',
 };
 
 export const defaultNewColdPhase: ColdPhase = {
@@ -48,6 +49,7 @@ export const defaultNewColdPhase: ColdPhase = {
   selectedReplicaCount: '',
   freezeEnabled: false,
   phaseIndexPriority: '0',
+  dataTierAllocationType: 'default',
 };
 
 export const defaultNewFrozenPhase: FrozenPhase = {
@@ -58,6 +60,7 @@ export const defaultNewFrozenPhase: FrozenPhase = {
   selectedReplicaCount: '',
   freezeEnabled: false,
   phaseIndexPriority: '0',
+  dataTierAllocationType: 'default',
 };
 
 export const defaultNewDeletePhase: DeletePhase = {

x-pack/plugins/index_lifecycle_management/public/application/lib/data_tiers/check_phase_compatibility.ts

@@ -0,0 +1,36 @@
+/*
+ * 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 {
+  NodeDataRole,
+  ListNodesRouteResponse,
+  PhaseWithAllocation,
+} from '../../../../common/types';
+
+/**
+ * Given a phase and current node roles, determine whether the phase
+ * can use default data tier allocation.
+ *
+ * This can only be checked for phases that have an allocate action.
+ */
+export const isPhaseDefaultDataAllocationCompatible = (
+  phase: PhaseWithAllocation,
+  nodesByRoles: ListNodesRouteResponse['nodesByRoles']
+): boolean => {
+  // The 'data' role covers all node roles, so if we have at least one node with the data role
+  // we can use default allocation.
+  if (nodesByRoles.data?.length) {
+    return true;
+  }
+
+  // Otherwise we need to check whether a node role for the specific phase exists
+  if (nodesByRoles[`data_${phase}` as NodeDataRole]?.length) {
+    return true;
+  }
+
+  // Otherwise default allocation has nowhere to allocate new shards to in this phase.
+  return false;
+};

x-pack/plugins/index_lifecycle_management/public/application/lib/data_tiers/determine_allocation_type.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 { DataTierAllocationType, AllocateAction } from '../../../../common/types';
+
+/**
+ * Determine what deserialized state the policy config represents.
+ *
+ * See {@DataTierAllocationType} for more information.
+ */
+export const determineDataTierAllocationType = (
+  allocateAction?: AllocateAction
+): DataTierAllocationType => {
+  if (!allocateAction) {
+    return 'default';
+  }
+
+  if (allocateAction.migrate?.enabled === false) {
+    return 'none';
+  }
+
+  if (
+    (allocateAction.require && Object.keys(allocateAction.require).length) ||
+    (allocateAction.include && Object.keys(allocateAction.include).length) ||
+    (allocateAction.exclude && Object.keys(allocateAction.exclude).length)
+  ) {
+    return 'custom';
+  }
+
+  return 'default';
+};

x-pack/plugins/index_lifecycle_management/public/application/lib/data_tiers/index.ts

@@ -0,0 +1,9 @@
+/*
+ * 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.
+ */
+
+export * from './determine_allocation_type';
+
+export * from './check_phase_compatibility';

x-pack/plugins/index_lifecycle_management/public/application/lib/index.ts

@@ -0,0 +1,7 @@
+/*
+ * 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.
+ */
+
+export * from './data_tiers';

x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/data_tier_allocation/data_tier_allocation.scss

@@ -0,0 +1,9 @@
+.indexLifecycleManagement__phase__dataTierAllocation {
+  &__controlSection {
+    background-color: $euiColorLightestShade;
+    padding-top: $euiSizeM;
+    padding-left: $euiSizeM;
+    padding-right: $euiSizeM;
+    padding-bottom: $euiSizeM;
+  }
+}