Index lifecycle

x-pack/index.js

@@ -21,6 +21,7 @@ import { apm } from './plugins/apm';
 import { licenseManagement } from './plugins/license_management';
 import { cloud } from './plugins/cloud';
 import { indexManagement } from './plugins/index_management';
+import { indexLifecycleManagement } from './plugins/index_lifecycle_management';
 import { consoleExtensions } from './plugins/console_extensions';
 import { spaces } from './plugins/spaces';
 import { notifications } from './plugins/notifications';
@@ -52,6 +53,7 @@ module.exports = function (kibana) {
     indexManagement(kibana),
     consoleExtensions(kibana),
     notifications(kibana),
+    indexLifecycleManagement(kibana),
     kueryAutocomplete(kibana),
     infra(kibana),
     rollup(kibana),

x-pack/plugins/index_lifecycle_management/common/constants/index.js

@@ -0,0 +1,8 @@
+/*
+ * 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 const BASE_PATH = '/management/elasticsearch/index_lifecycle_management/';
+export const PLUGIN_ID = 'index_lifecycle_management';

x-pack/plugins/index_lifecycle_management/index.js

@@ -0,0 +1,47 @@
+/*
+ * 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 { resolve } from 'path';
+import { registerTemplatesRoutes } from './server/routes/api/templates';
+import { registerNodesRoutes } from './server/routes/api/nodes';
+import { registerPoliciesRoutes } from './server/routes/api/policies';
+import { registerLifecycleRoutes } from './server/routes/api/lifecycle';
+import { registerIndexRoutes } from './server/routes/api/index';
+import { registerLicenseChecker } from './server/lib/register_license_checker';
+import { PLUGIN_ID } from './common/constants';
+import { indexLifecycleDataEnricher } from './index_lifecycle_data';
+export function indexLifecycleManagement(kibana) {
+  return new kibana.Plugin({
+    id: PLUGIN_ID,
+    publicDir: resolve(__dirname, 'public'),
+    configPrefix: 'xpack.index_lifecycle_management',
+    require: ['kibana', 'elasticsearch', 'xpack_main', 'index_management'],
+    uiExports: {
+      managementSections: ['plugins/index_lifecycle_management'],
+    },
+    isEnabled(config) {
+      return (
+        config.get('xpack.index_lifecycle_management.enabled') &&
+        config.has('index_management.enabled') &&
+        config.get('index_management.enabled')
+      );
+    },
+    init: function (server) {
+      registerLicenseChecker(server);
+      registerTemplatesRoutes(server);
+      registerNodesRoutes(server);
+      registerPoliciesRoutes(server);
+      registerLifecycleRoutes(server);
+      registerIndexRoutes(server);
+      if (
+        server.plugins.index_management &&
+        server.plugins.index_management.addIndexManagementDataEnricher
+      ) {
+        server.plugins.index_management.addIndexManagementDataEnricher(indexLifecycleDataEnricher);
+      }
+    },
+  });
+}

x-pack/plugins/index_lifecycle_management/index_lifecycle_data.js

@@ -0,0 +1,22 @@
+/*
+ * 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 const indexLifecycleDataEnricher = async (indicesList, callWithRequest) => {
+  if (!indicesList || !indicesList.length) {
+    return;
+  }
+  const params = {
+    path: '/*/_ilm/explain',
+    method: 'GET',
+  };
+  const { indices: ilmIndicesData } = await callWithRequest('transport.request', params);
+  return indicesList.map(index => {
+    return {
+      ...index,
+      ilm: { ...(ilmIndicesData[index.name] || {}) },
+    };
+  });
+};

x-pack/plugins/index_lifecycle_management/public/app.js

@@ -0,0 +1,20 @@
+/*
+ * 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 React from 'react';
+import { HashRouter, Switch, Route } from 'react-router-dom';
+import { EditPolicy } from './sections/edit_policy';
+import { PolicyTable } from './sections/policy_table';
+import { BASE_PATH } from '../common/constants';
+
+export const App = () => (
+  <HashRouter>
+    <Switch>
+      <Route exact path={`${BASE_PATH}policies`} component={PolicyTable}/>
+      <Route path={`${BASE_PATH}policies/edit/:policyName?`} component={EditPolicy}/>
+    </Switch>
+  </HashRouter>
+);

x-pack/plugins/index_lifecycle_management/public/extend_index_management/components/add_lifecycle_confirm_modal.js

@@ -0,0 +1,282 @@
+/*
+ * 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 React, { Component } from 'react';
+import { get } from 'lodash';
+import { i18n } from '@kbn/i18n';
+import {
+  EuiLink,
+  EuiSelect,
+  EuiForm,
+  EuiFormRow,
+  EuiOverlayMask,
+  EuiConfirmModal,
+  EuiModal,
+  EuiModalBody,
+  EuiModalHeader,
+  EuiCallOut,
+  EuiModalHeaderTitle,
+} from '@elastic/eui';
+import { BASE_PATH } from '../../../common/constants';
+import { FormattedMessage } from '@kbn/i18n/react';
+import { toastNotifications } from 'ui/notify';
+import { loadPolicies, addLifecyclePolicyToIndex } from '../../services/api';
+import { showApiError } from '../../services/api_errors';
+export class AddLifecyclePolicyConfirmModal extends Component {
+  constructor(props) {
+    super(props);
+    this.state = {
+      policies: [],
+      selectedPolicyName: null,
+      selectedAlias: null,
+    };
+  }
+  addPolicy = async () => {
+    const { indexName, httpClient, closeModal, reloadIndices } = this.props;
+    const { selectedPolicyName, selectedAlias } = this.state;
+    if (!selectedPolicyName) {
+      return;
+    }
+    try {
+      const body = {
+        indexName,
+        policyName: selectedPolicyName,
+        alias: selectedAlias,
+      };
+      await addLifecyclePolicyToIndex(body, httpClient);
+      closeModal();
+      toastNotifications.addSuccess(
+        i18n.translate(
+          'xpack.indexLifecycleMgmt.indexManagementTable.addLifecyclePolicyConfirmModal.addPolicyToIndexSuccess',
+          {
+            defaultMessage: 'Added policy {policyName} to index {indexName}',
+            values: {
+              policyName: selectedPolicyName,
+              indexName,
+            },
+          }
+        )
+      );
+      reloadIndices();
+    } catch (err) {
+      showApiError(
+        err,
+        i18n.translate(
+          'xpack.indexLifecycleMgmt.indexManagementTable.addLifecyclePolicyConfirmModal.addPolicyToIndexError',
+          {
+            defaultMessage: 'Error adding policy to index',
+          }
+        )
+      );
+    }
+  };
+  renderAliasFormElement = selectedPolicy => {
+    const { selectedAlias } = this.state;
+    const { index } = this.props;
+    const showAliasSelect =
+      selectedPolicy && get(selectedPolicy, 'policy.phases.hot.actions.rollover');
+    if (!showAliasSelect) {
+      return null;
+    }
+    const { aliases } = index;
+    if (aliases === 'none') {
+      return (
+        <EuiCallOut
+          style={{ maxWidth: 400 }}
+          title={
+            <FormattedMessage
+              id="xpack.indexLifecycleMgmt.indexManagementTable.addLifecyclePolicyConfirmModal.indexHasNoAliasesWarningTitle"
+              defaultMessage="Index has no aliases"
+            />
+          }
+          color="warning"
+        >
+          <FormattedMessage
+            id="xpack.indexLifecycleMgmt.indexManagementTable.addLifecyclePolicyConfirmModal.indexHasNoAliasesWarningMessage"
+            defaultMessage="Policy {policyName} is configured for rollover,
+              but index {indexName} does not have an alias, which is required for rollover."
+            values={{
+              policyName: selectedPolicy.name,
+              indexName: index.name,
+            }}
+          />
+        </EuiCallOut>
+      );
+    }
+    const aliasOptions = aliases.map(alias => {
+      return {
+        text: alias,
+        value: alias,
+      };
+    });
+    aliasOptions.unshift({
+      text: i18n.translate(
+        'xpack.indexLifecycleMgmt.indexManagementTable.addLifecyclePolicyConfirmModal.chooseAliasMessage',
+        {
+          defaultMessage: 'Choose an alias',
+        }
+      ),
+      value: '',
+    });
+    return (
+      <EuiFormRow
+        label={
+          <FormattedMessage
+            id="xpack.indexLifecycleMgmt.indexManagementTable.addLifecyclePolicyConfirmModal.chooseAliasLabel"
+            defaultMessage="Index alias"
+          />
+        }
+      >
+        <EuiSelect
+          options={aliasOptions}
+          value={selectedAlias}
+          onChange={e => {
+            this.setState({ selectedAlias: e.target.value });
+          }}
+          aria-label="Use aria labels when no actual label is in use"
+        />
+      </EuiFormRow>
+    );
+  };
+  renderForm() {
+    const { policies, selectedPolicyName } = this.state;
+    const selectedPolicy = selectedPolicyName
+      ? policies.find(policy => policy.name === selectedPolicyName)
+      : null;
+
+    const options = policies.map(({ name }) => {
+      return {
+        value: name,
+        text: name,
+      };
+    });
+    options.unshift({
+      value: '',
+      text: i18n.translate(
+        'xpack.indexLifecycleMgmt.indexManagementTable.addLifecyclePolicyConfirmModal.choosePolicyMessage',
+        {
+          defaultMessage: 'Choose a lifecycle policy',
+        }
+      ),
+    });
+    return (
+      <EuiForm>
+        <EuiFormRow
+          label={
+            <FormattedMessage
+              id="xpack.indexLifecycleMgmt.indexManagementTable.addLifecyclePolicyConfirmModal.choosePolicyLabel"
+              defaultMessage="Lifecycle policy"
+            />
+          }
+        >
+          <EuiSelect
+            options={options}
+            value={selectedPolicyName}
+            onChange={e => {
+              this.setState({ selectedPolicyName: e.target.value });
+            }}
+            aria-label="Use aria labels when no actual label is in use"
+          />
+        </EuiFormRow>
+        {this.renderAliasFormElement(selectedPolicy)}
+      </EuiForm>
+    );
+  }
+  async componentDidMount() {
+    try {
+      const policies = await loadPolicies(false, this.props.httpClient);
+      this.setState({ policies });
+    } catch (err) {
+      showApiError(
+        err,
+        i18n.translate(
+          'xpack.indexLifecycleMgmt.indexManagementTable.addLifecyclePolicyConfirmModal.loadPolicyError',
+          {
+            defaultMessage: 'Error loading policy list',
+          }
+        )
+      );
+      this.props.closeModal();
+    }
+  }
+  render() {
+    const { policies } = this.state;
+    const { indexName, closeModal } = this.props;
+    const title = (
+      <FormattedMessage
+        id="xpack.indexLifecycleMgmt.indexManagementTable.addLifecyclePolicyConfirmModal.modalTitle"
+        defaultMessage="Add lifecycle policy to {indexName}"
+        values={{
+          indexName,
+        }}
+      />
+    );
+    if (!policies.length) {
+      return (
+        <EuiOverlayMask>
+          <EuiModal
+            onClose={closeModal}
+          >
+            <EuiModalHeader>
+              <EuiModalHeaderTitle >
+                {title}
+              </EuiModalHeaderTitle >
+
+            </EuiModalHeader>
+            <EuiModalBody>
+              <EuiCallOut
+                style={{ maxWidth: 400 }}
+                title={
+                  <FormattedMessage
+                    id="xpack.indexLifecycleMgmt.indexManagementTable.addLifecyclePolicyConfirmModal.noPoliciesWarningTitle"
+                    defaultMessage="No index lifecycle policies defined"
+                  />
+                }
+                color="warning"
+              >
+                <FormattedMessage
+                  id="xpack.indexLifecycleMgmt.indexManagementTable.addLifecyclePolicyConfirmModal.noPoliciesWarningMessage"
+                  defaultMessage="No index lifecycle policies are defined."
+                />
+                <p>
+                  <EuiLink href={`#${BASE_PATH}policies/edit`}>
+                    <FormattedMessage
+                      id="xpack.indexLifecycleMgmt.indexManagementTable.addLifecyclePolicyConfirmModal.defineLifecyclePolicyLinkText"
+                      defaultMessage="Define lifecycle policy"
+                    />
+                  </EuiLink>
+                </p>
+              </EuiCallOut>
+            </EuiModalBody>
+          </EuiModal>
+        </EuiOverlayMask>
+      );
+    }
+    return (
+      <EuiOverlayMask>
+        <EuiConfirmModal
+          title={title}
+          onCancel={closeModal}
+          onConfirm={this.addPolicy}
+          cancelButtonText={
+            <FormattedMessage
+              id="xpack.indexLifecycleMgmt.indexManagementTable.addLifecyclePolicyConfirmModal.cancelButtonText"
+              defaultMessage="Cancel"
+            />
+          }
+          confirmButtonText={
+            <FormattedMessage
+              id="xpack.indexLifecycleMgmt.indexManagementTable.addLifecyclePolicyConfirmModal.addPolicyButtonText"
+              defaultMessage="Add policy"
+            />
+          }
+        >
+          {this.renderForm()}
+        </EuiConfirmModal>
+      </EuiOverlayMask>
+    );
+  }
+}