[IM] Index Templates UI details view by alisonelizabeth · Pull Request #41602 · elastic/kibana

alisonelizabeth · 2019-07-19T19:35:47Z

This PR is continuation of #39922, and adds the details view to the Index Templates UI.

Changes include:

Details flyout for an individual template
API tests for fetching an index template
Component integration tests for details view
Telemetry for details view

Release notes

This feature adds the details panel to the Index Templates UI. Users can also delete a template from this view.

Note: This is continuation of #39922.

Testing

There are several system index templates by default. To create your own index template, go to console and follow the ES API docs.

For example:

PUT _template/template_1
{
  "index_patterns": ["te*", "bar*"],
  "settings": {
    "number_of_shards": 1
  },
  "mappings": {
    "_source": {
      "enabled": false
    },
    "properties": {
      "host_name": {
        "type": "keyword"
      },
      "created_at": {
        "type": "date",
        "format": "EEE MMM dd HH:mm:ss Z yyyy"
      }
    }
  }
}

Screenshots

Summary view with multiple index patterns:

Summary view with single index pattern, ILM policy and no mappings:

Summary view with no aliases, mappings or settings:

Settings tab

Mappings tab

Aliases tab

elasticmachine · 2019-07-19T19:35:49Z

Pinging @elastic/es-ui

alisonelizabeth · 2019-07-19T19:37:48Z

FYI @yaronp68

elasticmachine · 2019-07-19T20:37:08Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

yaronp68 · 2019-07-23T10:46:22Z

LGTM

sebelga

Great work @alisonelizabeth ! I tested locally and it works well. I made a few small comments, no blockers.

Do you know what are the limitation of an index template name though? I encoded special characters in the name and created the template PUT _template/template%25%24%263

It saved correctly. But then if I try to see the details in the UI it breaks.

sebelga · 2019-07-23T10:08:36Z

...s/index_management/public/sections/home/templates_list/template_details/template_details.tsx

+
+  return (
+    <Fragment>
+      <DeleteTemplatesModal


I am not a huge fan of this pattern where the child component is the one deciding if it is visible on the screen.

I prefer to have the parent deciding when a child component is visible:

{templateToDelete.length && ( <DeleteTemplatesModal callback={data => { if (data && data.hasDeletedTemplates) { reload(); } setTemplateToDelete([]); onClose(); }} templatesToDelete={templateToDelete} /> )}

You don't need to change it, just sharing 😊

sebelga · 2019-07-23T10:10:06Z

...s/index_management/public/sections/home/templates_list/template_details/template_details.tsx

+            </EuiFlexItem>
+
+            <EuiFlexItem grow={false}>
+              {templateDetails && (


Wouldn't it make more sense to have the <EuiFlexItem grow={false}> wrapped inside?

sebelga · 2019-07-23T10:23:40Z

x-pack/legacy/plugins/index_management/server/routes/api/templates/register_get_routes.ts

+  const { name } = req.params;
+  const indexTemplateByName = await callWithRequest('indices.getTemplate', { name });
+
+  const {


Shouldn't we add a check to make sure the template exists on the response before deconstructuring?

good point, fixed!

Bamieh

i18n looks good, one nit with trackUiMetric that needs to be addressed I believe

Bamieh · 2019-07-23T14:04:47Z

...ins/index_management/public/sections/home/templates_list/templates_table/templates_table.tsx

+          <EuiLink
+            href={`#${BASE_PATH}templates/${name}`}
+            data-test-subj="templateDetailsLink"
+            onClick={trackUiMetric.bind(null, UIM_TEMPLATE_SHOW_DETAILS_CLICK)}


this is changed now, its gonna be trackUiMetric('click', UIM_TEMPLATE_SHOW_DETAILS_CLICK)

fixed, thanks for catching this!

alisonelizabeth · 2019-07-25T01:46:07Z

@sebelga thanks for your review!

I'm not aware of any limitations with the template name. I addressed the issue with creating a template name with special characters - thanks for catching that!

elasticmachine · 2019-07-25T02:40:53Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-25T12:42:26Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-25T15:02:04Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

cjcenizal · 2019-07-25T15:12:03Z

x-pack/legacy/plugins/index_management/public/sections/home/templates_list/templates_list.tsx

@@ -20,9 +21,19 @@ import { TemplatesTable } from './templates_table';
 import { loadIndexTemplates } from '../../../services/api';
 import { Template } from '../../../../common/types';
 import { trackUiMetric, METRIC_TYPE } from '../../../services/track_ui_metric';


Minor suggestion: you might find this module's interface to be simpler if it exports trackClick, trackLoad, etc.

@cjcenizal Thanks for suggestion! I will update on another PR.

alisonelizabeth added release_note:enhancement Feature:Index Management Index and index templates UI v8.0.0 Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more t// v7.4.0 labels Jul 19, 2019

alisonelizabeth changed the title ~~Feature/index templates~~ [IM] Index Templates UI details view Jul 19, 2019

alisonelizabeth requested a review from sebelga July 19, 2019 19:37

sebelga approved these changes Jul 23, 2019

View reviewed changes

alisonelizabeth requested a review from Bamieh July 23, 2019 12:31

Bamieh approved these changes Jul 23, 2019

View reviewed changes

alisonelizabeth added 3 commits July 23, 2019 16:33

index templates detail view

2e51914

add component integration tests

aaf19e2

address review feedback

aa7649d

alisonelizabeth force-pushed the feature/index_templates branch from 9bfabe2 to aa7649d Compare July 25, 2019 01:40

fix i18n string and code editor height

e84bb4e

alisonelizabeth merged commit 1ebde1e into master Jul 25, 2019

alisonelizabeth deleted the feature/index_templates branch July 25, 2019 12:54

alisonelizabeth mentioned this pull request Jul 25, 2019

[7.x] [IM] Index Templates UI details view (#41602) #41971

Merged

alisonelizabeth added a commit that referenced this pull request Jul 25, 2019

[IM] Index Templates UI details view (#41602) (#41971)

a626c13

cjcenizal reviewed Jul 25, 2019

View reviewed changes

alisonelizabeth mentioned this pull request Aug 1, 2019

[IM] Index templates form wizard #42457

Merged

Conversation

alisonelizabeth commented Jul 19, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Release notes

Testing

Screenshots

Uh oh!

elasticmachine commented Jul 19, 2019

Uh oh!

alisonelizabeth commented Jul 19, 2019

Uh oh!

elasticmachine commented Jul 19, 2019

💚 Build Succeeded

Uh oh!

yaronp68 commented Jul 23, 2019

Uh oh!

sebelga left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Bamieh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alisonelizabeth commented Jul 25, 2019

Uh oh!

elasticmachine commented Jul 25, 2019

💚 Build Succeeded

Uh oh!

elasticmachine commented Jul 25, 2019

💚 Build Succeeded

Uh oh!

elasticmachine commented Jul 25, 2019

💔 Build Failed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

alisonelizabeth commented Jul 19, 2019 •

edited

Loading