Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ILM] Update the ILM tab on the index details page #170726

Merged
merged 14 commits into from
Nov 15, 2023

Conversation

yuliacech
Copy link
Contributor

@yuliacech yuliacech commented Nov 7, 2023

Summary

Fixes #170516
This PR updates how the ILM tab is rendered on the index details page to make it look more fitting with other tabs.

Screenshots

ILM is waiting for a step to complete

Screenshot 2023-11-14 at 15 06 10

ILM has an error

Screenshot 2023-11-14 at 15 05 23

ILM has no errors and is not waiting for a step

Screenshot 2023-11-14 at 15 04 57

How to test

I recommend using a chrome extension to mock the backend responses, for example https://tweak-extension.com/docs/intro.
To mock the response of the index request, configure the extension to mock the url /internal/index_management/indices/ and let it return various ilm configurations:

index with ILM that is waiting for a step to complete
{
  "health": "green",
  "status": "open",
  "name": "test",
  "uuid": "cJYz9o4jTjuAZaMNS3ERyQ",
  "primary": "1",
  "replica": "0",
  "documents": 23654,
  "documents_deleted": 0,
  "size": "248b",
  "primary_size": "248b",
  "isFrozen": false,
  "aliases": "none",
  "hidden": false,
  "isRollupIndex": false,
  "ilm": {
    "index": "test-000020",
    "index_creation_date_millis": 1538475653281,
    "time_since_index_creation": "4.12m",
    "managed": true,
    "policy": "my_lifecycle3",
    "lifecycle_date_millis": 1538475653281,
    "lifecycle_date": "2018-10-15T13:45:21.981Z",
    "age": "4.12m",
    "phase": "warm",
    "phase_time_millis": 1538475653317,
    "phase_time": "2018-10-15T13:45:22.577Z",
    "action": "allocate",
    "action_time_millis": 1538475653317,
    "action_time": "2018-10-15T13:45:22.577Z",
    "step": "check-allocation",
    "step_time_millis": 1538475653317,
    "step_time": "2018-10-15T13:45:22.577Z",
    "step_info": {
      "message": "Waiting for all shard copies to be active",
      "shards_left_to_allocate": -1,
      "all_shards_active": false,
      "number_of_replicas": 2
    },
    "phase_execution": {
      "policy": "my_lifecycle3",
      "phase_definition": {
        "min_age": "0ms",
        "actions": {
          "allocate": {
            "number_of_replicas": 2,
            "include": {
              "box_type": "warm"
            },
            "exclude": {},
            "require": {}
          },
          "forcemerge": {
            "max_num_segments": 1
          }
        }
      },
      "version": 2,
      "modified_date": "2018-10-15T13:20:02.489Z",
      "modified_date_in_millis": 1539609602489
    }
  },
  "isFollowerIndex": false
}
index with ILM that has an error
{
  "health": "green",
  "status": "open",
  "name": "test",
  "uuid": "cJYz9o4jTjuAZaMNS3ERyQ",
  "primary": "1",
  "replica": "0",
  "documents": 23654,
  "documents_deleted": 0,
  "size": "248b",
  "primary_size": "248b",
  "isFrozen": false,
  "aliases": "none",
  "hidden": false,
  "isRollupIndex": false,
  "ilm": {
    "index": "test-000056",
    "index_creation_date_millis": 1538475653281,
    "time_since_index_creation": "50.1d",
    "managed": true,
    "policy": "my_lifecycle3",
    "lifecycle_date_millis": 1538475653281,
    "lifecycle_date": "2018-10-15T13:45:21.981Z",
    "age": "50.1d",
    "phase": "hot",
    "phase_time_millis": 1538475653317,
    "phase_time": "2018-10-15T13:45:22.577Z",
    "action": "rollover",
    "action_time_millis": 1538475653317,
    "action_time": "2018-10-15T13:45:22.577Z",
    "step": "ERROR",
    "step_time_millis": 1538475653317,
    "step_time": "2018-10-15T13:45:22.577Z",
    "failed_step": "check-rollover-ready",
    "is_auto_retryable_error": true,
    "failed_step_retry_count": 1,
    "step_info": {
      "type": "cluster_block_exception",
      "reason": "index [test-000057/H7lF9n36Rzqa-KfKcnGQMg] blocked by: [FORBIDDEN/5/index read-only (api)",
      "index_uuid": "H7lF9n36Rzqa-KfKcnGQMg",
      "index": "test-000057"
    },
    "phase_execution": {
      "policy": "my_lifecycle3",
      "phase_definition": {
        "min_age": "0ms",
        "actions": {
          "rollover": {
            "max_age": "30s"
          }
        }
      },
      "version": 3,
      "modified_date": "2018-10-15T13:21:41.576Z",
      "modified_date_in_millis": 1539609701576
    }
  },
  "isFollowerIndex": false
}

Checklist

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk Probability Severity Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space. Low High Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. High Low Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled. Medium High Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

Release Note

The ILM summary on the index page is now displayed in a separate tab.

@yuliacech yuliacech added release_note:enhancement Feature:Index Management Index and index templates UI Feature:ILM Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more labels Nov 7, 2023
@yuliacech yuliacech marked this pull request as ready for review November 7, 2023 13:29
@yuliacech yuliacech requested a review from a team as a code owner November 7, 2023 13:29
@elasticmachine
Copy link
Contributor

Pinging @elastic/platform-deployment-management (Team:Deployment Management)

@ryankeairns
Copy link
Contributor

Hey @yuliacech , Alison reached out about a design review. Are there any particular aspects you'd like feedback on?

@yuliacech yuliacech added the ci:cloud-deploy Create or update a Cloud deployment label Nov 8, 2023
@yuliacech
Copy link
Contributor Author

Thanks a lot for looking into this, @ryankeairns! I think I'd be interested if the new ILM summary makes sense in relation to the existing ILM UI and if it fits with the rest of the tabs on the index page. I'll add a screen recording to the PR description with those other UI elements. I'm also trying to deploy this PR to Cloud, but it seems like the deploy keeps failing on the build.

@yuliacech
Copy link
Contributor Author

Hey @ryankeairns, I was finally able to get a Cloud deployment up and running on this PR, will send you the credentials in slack. There is an index "test_index" in Index Management that has an ILM policy attached. Could you please have a look and let me know what you think?

Copy link
Member

@sabarasaba sabarasaba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this @yuliacech! Changles lgtm!

Unrelated to this PR, but while I was testing I realized that you can click the edit policy in ILM link you might be taken to a managed policy, I was wondering if it would make sense to warn the user before they click it (perhaps a warning icon with a tooltip or something 🤔 ).

@yuliacech
Copy link
Contributor Author

Thanks a lot for the review, @sabarasaba!
Regarding a managed ILM policy: we currently don't have info if the policy is managed or not but we could send an additional request if needed. I'm not sure though that it is worth the extra loading since the user can't change the policy on the index page anyways. I think about this UI as like a short summary about ILM with more details available in ILM if needed.

@ryankeairns
Copy link
Contributor

ryankeairns commented Nov 10, 2023

Hey Yulia, I'm not having much luck hacking together - via Chrome Inspect - what I'm about to describe, but I'll do my best.

To more closely align to the other tabs, let's do a flex-grow 1 and 3 split - Lifecycle policy being on the left at 1fr; the Current phase and possible error panel stacked at right in a 3fr column (with Error on top if present).

The other comment I have is regarding typography. The panel titles feel rather large, so let's try wrapping the headings in an xs EuiTitle as opposed to m EuiText. The Description is known to be a bit heavy/bold, so we'll address that typography bit later.

@julianrosado may have more to add or clarify as the Search team did the design work on the sibling tabs.

Thanks for reaching out!

@julianrosado
Copy link
Contributor

I had the same thought @ryankeairns and had it ready to go mocked up! Have we just become best friends???

@yuliacech I have a draft Figma board here: https://www.figma.com/file/xbilnV89bje6KHXZhLv1qG/Lifecycle-ponderings?type=design&node-id=0%3A1&mode=design&t=zA9WQEbEo2Opozvr-1

I was just trying to decide if the panels should match the overview tab (where the panels have outlines) or all the other tabs (where the panels have shadows). I know we are moving away from shadowed panels overall (correct me if I'm wrong Ryan) so I'd suggest outlined panels.

Don't mind any inconsistencies here (such as the wrong tab being selected and the wrong nav, etc.) as I only had a few minutes to mock these up!

CleanShot 2023-11-10 at 12 19 18

CleanShot 2023-11-10 at 12 19 29

CleanShot 2023-11-10 at 12 19 51

@kibana-ci
Copy link
Collaborator

kibana-ci commented Nov 13, 2023

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] Investigations - Security Solution Cypress Tests #3 / Ransomware Detection Alerts Ransomware in Timelines Renders ransomware entries in timelines table Renders ransomware entries in timelines table

Metrics [docs]

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
indexLifecycleManagement 26.6KB 27.2KB +553.0B

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@yuliacech
Copy link
Contributor Author

Thanks a lot for your feedback, @ryankeairns and @julianrosado! I've updated the ILM tab as you suggested: the ILM tab has the same 1-3 structure as Mappings and Settings, but with the smaller panel on the left, new screenshots are in the PR description. I'll be merging this PR today but please feel free to let me know, if you have more feedback that I can address in a follow up work.

@yuliacech yuliacech merged commit 88c313e into elastic:main Nov 15, 2023
29 checks passed
@kibanamachine kibanamachine added v8.12.0 backport:skip This commit does not require backporting labels Nov 15, 2023
jillguyonnet pushed a commit to jillguyonnet/kibana that referenced this pull request Nov 16, 2023
## Summary

Fixes elastic#170516
This PR updates how the ILM tab is rendered on the index details page to
make it look more fitting with other tabs.

### Screenshots 

#### ILM is waiting for a step to complete
<img width="1448" alt="Screenshot 2023-11-14 at 15 06 10"
src="https://github.com/elastic/kibana/assets/6585477/47642cd5-3a22-44ee-b49f-0a87713eba3b">


#### ILM has an error
<img width="1450" alt="Screenshot 2023-11-14 at 15 05 23"
src="https://github.com/elastic/kibana/assets/6585477/78a7af30-5ba1-4a74-b5fe-c359341f20f4">



#### ILM has no errors and is not waiting for a step
<img width="1460" alt="Screenshot 2023-11-14 at 15 04 57"
src="https://github.com/elastic/kibana/assets/6585477/43b215e0-d56f-4fb8-927f-35a7c2b1b313">



### How to test
I recommend using a chrome extension to mock the backend responses, for
example https://tweak-extension.com/docs/intro.
To mock the response of the index request, configure the extension to
mock the url `/internal/index_management/indices/` and let it return
various ilm configurations:

<details>

<summary>index with ILM that is waiting for a step to complete
</summary>

```json
{
  "health": "green",
  "status": "open",
  "name": "test",
  "uuid": "cJYz9o4jTjuAZaMNS3ERyQ",
  "primary": "1",
  "replica": "0",
  "documents": 23654,
  "documents_deleted": 0,
  "size": "248b",
  "primary_size": "248b",
  "isFrozen": false,
  "aliases": "none",
  "hidden": false,
  "isRollupIndex": false,
  "ilm": {
    "index": "test-000020",
    "index_creation_date_millis": 1538475653281,
    "time_since_index_creation": "4.12m",
    "managed": true,
    "policy": "my_lifecycle3",
    "lifecycle_date_millis": 1538475653281,
    "lifecycle_date": "2018-10-15T13:45:21.981Z",
    "age": "4.12m",
    "phase": "warm",
    "phase_time_millis": 1538475653317,
    "phase_time": "2018-10-15T13:45:22.577Z",
    "action": "allocate",
    "action_time_millis": 1538475653317,
    "action_time": "2018-10-15T13:45:22.577Z",
    "step": "check-allocation",
    "step_time_millis": 1538475653317,
    "step_time": "2018-10-15T13:45:22.577Z",
    "step_info": {
      "message": "Waiting for all shard copies to be active",
      "shards_left_to_allocate": -1,
      "all_shards_active": false,
      "number_of_replicas": 2
    },
    "phase_execution": {
      "policy": "my_lifecycle3",
      "phase_definition": {
        "min_age": "0ms",
        "actions": {
          "allocate": {
            "number_of_replicas": 2,
            "include": {
              "box_type": "warm"
            },
            "exclude": {},
            "require": {}
          },
          "forcemerge": {
            "max_num_segments": 1
          }
        }
      },
      "version": 2,
      "modified_date": "2018-10-15T13:20:02.489Z",
      "modified_date_in_millis": 1539609602489
    }
  },
  "isFollowerIndex": false
}

```
</details>

<details>
<summary>index with ILM that has an error</summary>

```json
{
  "health": "green",
  "status": "open",
  "name": "test",
  "uuid": "cJYz9o4jTjuAZaMNS3ERyQ",
  "primary": "1",
  "replica": "0",
  "documents": 23654,
  "documents_deleted": 0,
  "size": "248b",
  "primary_size": "248b",
  "isFrozen": false,
  "aliases": "none",
  "hidden": false,
  "isRollupIndex": false,
  "ilm": {
    "index": "test-000056",
    "index_creation_date_millis": 1538475653281,
    "time_since_index_creation": "50.1d",
    "managed": true,
    "policy": "my_lifecycle3",
    "lifecycle_date_millis": 1538475653281,
    "lifecycle_date": "2018-10-15T13:45:21.981Z",
    "age": "50.1d",
    "phase": "hot",
    "phase_time_millis": 1538475653317,
    "phase_time": "2018-10-15T13:45:22.577Z",
    "action": "rollover",
    "action_time_millis": 1538475653317,
    "action_time": "2018-10-15T13:45:22.577Z",
    "step": "ERROR",
    "step_time_millis": 1538475653317,
    "step_time": "2018-10-15T13:45:22.577Z",
    "failed_step": "check-rollover-ready",
    "is_auto_retryable_error": true,
    "failed_step_retry_count": 1,
    "step_info": {
      "type": "cluster_block_exception",
      "reason": "index [test-000057/H7lF9n36Rzqa-KfKcnGQMg] blocked by: [FORBIDDEN/5/index read-only (api)",
      "index_uuid": "H7lF9n36Rzqa-KfKcnGQMg",
      "index": "test-000057"
    },
    "phase_execution": {
      "policy": "my_lifecycle3",
      "phase_definition": {
        "min_age": "0ms",
        "actions": {
          "rollover": {
            "max_age": "30s"
          }
        }
      },
      "version": 3,
      "modified_date": "2018-10-15T13:21:41.576Z",
      "modified_date_in_millis": 1539609701576
    }
  },
  "isFollowerIndex": false
}
```

</details>


### Checklist


- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

### Release Note
The ILM summary on the index page is now displayed in a separate tab.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
@yuliacech yuliacech deleted the im/details_page/fix_ilm branch February 15, 2024 12:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting ci:cloud-deploy Create or update a Cloud deployment Feature:ILM Feature:Index Management Index and index templates UI release_note:enhancement Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more v8.12.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Index Management] Update the ILM tab on the index details page
7 participants