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

alisonelizabeth · 2019-06-28T17:28:36Z

This PR is the first phase of adding support for Index Templates within the Index Management app.

Changes include:

New tabbed content under Index Management - Indices & Index Templates
List view of a user's index templates with delete action + filter by ILM policy
API integration tests for fetching, deleting and creating index templates
Component integration tests for index templates list view
Telemetry for index templates list view

Release notes

This feature adds the list of Index Templates as a tab to the Index Management app. Users can also delete templates from this view.

Note: This is the first phase, additional functionality for Index Templates will be added for 7.4 in separate PRs.

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

Before

After
Indices (functionality unchanged, but now under Indices tab)

Index Templates (new)

List view w/o system templates:

List view with system templates toggled:

Filtered list view by ILM policy:

Delete single template:

Delete multiple templates:

Delete system template:

elasticmachine · 2019-06-28T17:28:38Z

Pinging @elastic/es-ui

elasticmachine · 2019-06-28T18:37:41Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-01T20:48:03Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-02T21:09:47Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-03T14:32:13Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-08T16:52:10Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-08T18:12:36Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-08T18:43:04Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

alisonelizabeth · 2019-07-08T18:45:48Z

Retest

elasticmachine · 2019-07-08T19:43:43Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

Conky5 · 2019-07-08T20:35:24Z

retest

elasticmachine · 2019-07-08T22:00:09Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-09T19:04:28Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-09T20:53:26Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

alisonelizabeth · 2019-07-10T16:10:02Z

FYI @yaronp68 this is ready for review

alisonelizabeth · 2019-07-10T16:13:05Z

@Bamieh do you have capacity to review i18n on this PR?

alisonelizabeth · 2019-07-10T19:08:42Z

x-pack/legacy/plugins/index_management/public/services/use_request.ts

@@ -0,0 +1,131 @@
+/*


I'll delete this file and adopt the shared plugin once #40777 is merged.

elasticmachine · 2019-07-10T20:06:01Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

yaronp68 · 2019-07-12T13:47:26Z

@cjcenizal @alisonelizabeth I'm fine with a confirmation approach for deleting system templates but worth checking with support later. I'll ask

alisonelizabeth · 2019-07-12T18:57:25Z

updated PR to allow deletion of system templates with confirmation (see latest screenshots in first comment)

elasticmachine · 2019-07-12T19:49:52Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

sebelga

LGTM! Awesome work Alison! I tested locally and works great.
I made a few tiny (preference) code comments, nothing important.

There is only 1 UX that I am not 100% convinced (but it seems to be an EUI decision, not yours), is the "ILM Policy" button. For me, it should be a dropdown that indicates that it is a filter, with a label on top Filter templates for example. As a user, I am not used to click a button to filter item in a table.

sebelga · 2019-07-15T14:09:50Z

x-pack/legacy/plugins/index_management/public/components/delete_templates_modal.tsx

+    templatesToDelete.find(templateName => templateName.startsWith('.'))
+  );
+
+  const handleDeleteTemplates = async () => {


nit: the async does not seem to be needed here

sebelga · 2019-07-15T14:14:41Z

x-pack/legacy/plugins/index_management/public/components/delete_templates_modal.tsx

+  );
+
+  const handleDeleteTemplates = async () => {
+    deleteTemplates(templatesToDelete).then(({ data: { templatesDeleted, errors }, error }) => {


I haven't looked at the API yet, but it is a bit confusing to have both "errors" and "error". It does seem though that is is a pattern we have used in another app though (now I am the reader and not the writer of the code 😊 ). If error (singular) is the Http request that failed, could we rename it "apiError"?

sebelga · 2019-07-15T14:18:15Z

x-pack/legacy/plugins/index_management/public/components/delete_templates_modal.tsx

+
+  const [isDeleteConfirmed, setIsDeleteConfirmed] = useState<boolean>(false);
+
+  if (!numTemplatesToDelete) {


This would be better on L23 to exit early.

sebelga · 2019-07-15T14:35:21Z

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

+const Checkmark = ({ tableCellData }: { tableCellData: object }) => {
+  const isChecked = Object.entries(tableCellData).length > 0;
+
+  if (isChecked) {


nit: In these cases, I usually personally prefer the shorter ternary version

return isChecked ? <EuiIcon type="check" /> : null;

sebelga · 2019-07-15T14:42:35Z

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

+      } catch (e) {
+        return response.errors.push({
+          name,
+          error: wrapEsError(e),


Now I see it 😊

Bamieh

LGTM

Bamieh · 2019-07-17T08:07:28Z

x-pack/legacy/plugins/index_management/public/components/delete_templates_modal.tsx

+          'xpack.idxMgmt.deleteTemplatesModal.successNotificationMessageText',
+          {
+            defaultMessage:
+              'Deleted {numSuccesses, number} {numSuccesses, plural, one {template} other {templates}}',


this is OK, but i'd use this:

Suggested change

'Deleted {numSuccesses, number} {numSuccesses, plural, one {template} other {templates}}',

'Deleted {numSuccesses, plural, one {# template} other {# templates}}',

the # will return the variable value.

elasticmachine · 2019-07-18T01:23:23Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

alisonelizabeth · 2019-07-18T12:20:00Z

@sebelga @ahmad thanks for your reviews! I addressed the feedback, so going to go ahead and merge.

@sebelga I agree the ILM button is a little weird, but that is a EUI decision.

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 Jun 28, 2019

alisonelizabeth force-pushed the feature/index_templates branch from 8f94c99 to 5d8205f Compare July 1, 2019 19:51

alisonelizabeth force-pushed the feature/index_templates branch from eb0c9d7 to 5954ef9 Compare July 3, 2019 13:30

alisonelizabeth force-pushed the feature/index_templates branch from 6a10894 to 25f16e4 Compare July 8, 2019 16:25

alisonelizabeth force-pushed the feature/index_templates branch from b2c9e89 to 50611d7 Compare July 9, 2019 19:44

alisonelizabeth force-pushed the feature/index_templates branch from 50611d7 to 8365f80 Compare July 10, 2019 16:02

alisonelizabeth marked this pull request as ready for review July 10, 2019 16:08

alisonelizabeth changed the title ~~[IM] Index Templates UI~~ [IM] Index Templates UI list view Jul 10, 2019

alisonelizabeth requested a review from sebelga July 10, 2019 16:09

alisonelizabeth force-pushed the feature/index_templates branch from 8365f80 to 25bf57a Compare July 10, 2019 16:21

alisonelizabeth commented Jul 10, 2019

View reviewed changes

alisonelizabeth force-pushed the feature/index_templates branch from b0fc167 to 63ab1ae Compare July 12, 2019 18:51

sebelga approved these changes Jul 15, 2019

View reviewed changes

alisonelizabeth requested a review from Bamieh July 15, 2019 15:53

Bamieh approved these changes Jul 17, 2019

View reviewed changes

alisonelizabeth added 12 commits July 17, 2019 13:19

init commit: adding index templates tab and rearranging folder structure

4044046

set up endpoint for fetching index templates

3bee049

add index templates table

9c271db

add component integration tests

f3b269a

add telemetry

3899eb0

eslint fix

1929273

add delete template functionality

89cc7f2

add filter by ilm policy and sorting behavior

559b427

update tests

2c54daa

address feedback

d3f794f

update delete system template functionality based on feedback

0f0cddc

address review feedback

d48d60b

alisonelizabeth force-pushed the feature/index_templates branch from 63ab1ae to d48d60b Compare July 18, 2019 00:33

alisonelizabeth merged commit 7dc981e into master Jul 18, 2019

alisonelizabeth deleted the feature/index_templates branch July 18, 2019 12:20

alisonelizabeth mentioned this pull request Jul 18, 2019

[7.x] [IM] Index Templates UI list view (#39922) #41451

Merged

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

[IM] Index Templates UI list view (#39922) (#41451)

4dcc99f

alisonelizabeth mentioned this pull request Jul 19, 2019

[IM] Index Templates UI details view #41602

Merged

alisonelizabeth mentioned this pull request Aug 1, 2019

[IM] Index templates form wizard #42457

Merged


		const [isDeleteConfirmed, setIsDeleteConfirmed] = useState<boolean>(false);

		if (!numTemplatesToDelete) {

	'Deleted {numSuccesses, number} {numSuccesses, plural, one {template} other {templates}}',
	'Deleted {numSuccesses, plural, one {# template} other {# templates}}',

Conversation

alisonelizabeth commented Jun 28, 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 Jun 28, 2019

Uh oh!

elasticmachine commented Jun 28, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jul 1, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jul 2, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jul 3, 2019

💚 Build Succeeded

Uh oh!

elasticmachine commented Jul 8, 2019

💚 Build Succeeded

Uh oh!

elasticmachine commented Jul 8, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jul 8, 2019

💔 Build Failed

Uh oh!

alisonelizabeth commented Jul 8, 2019

Uh oh!

elasticmachine commented Jul 8, 2019

💔 Build Failed

Uh oh!

Conky5 commented Jul 8, 2019

Uh oh!

elasticmachine commented Jul 8, 2019

💚 Build Succeeded

Uh oh!

elasticmachine commented Jul 9, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jul 9, 2019

💚 Build Succeeded

Uh oh!

alisonelizabeth commented Jul 10, 2019

Uh oh!

alisonelizabeth commented Jul 10, 2019

Uh oh!

alisonelizabeth Jul 10, 2019

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Jul 10, 2019

💚 Build Succeeded

Uh oh!

yaronp68 commented Jul 12, 2019

Uh oh!

alisonelizabeth commented Jul 12, 2019

Uh oh!

elasticmachine commented Jul 12, 2019

💚 Build Succeeded

Uh oh!

sebelga left a comment

Choose a reason for hiding this comment

Uh oh!

sebelga Jul 15, 2019

Choose a reason for hiding this comment

Uh oh!

sebelga Jul 15, 2019

Choose a reason for hiding this comment

Uh oh!

sebelga Jul 15, 2019

Choose a reason for hiding this comment

Uh oh!

sebelga Jul 15, 2019

Choose a reason for hiding this comment

Uh oh!

sebelga Jul 15, 2019

Choose a reason for hiding this comment

alisonelizabeth commented Jun 28, 2019 •

edited

Loading