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

[Index Management] Add deprecation warning to index template and component template UIs #174450

Merged

Conversation

sabarasaba
Copy link
Member

@sabarasaba sabarasaba commented Jan 8, 2024

Partially addresses #170805

Summary

With elastic/elasticsearch#101148 we now can alert the users when a component template or index template will soon be deprecated and shouldnt be relied upon. This PR adds a badge and a callout to the component template and index template UIs to alert the users about this.

How to test
  • Start up kibana and es
  • Navigate to Stack management -> index management (component_templates|index_templates)
  • Verify that:
    • Deprecated resources are hidden by default
    • Upon enabling filtering to see them they should pop up on the table with a badge
    • Verify that deprecated resources are highlighted and when editing, we also show a warning callout.
Create deprecated component template
PUT _component_template/template_1
{
  "template": {
    "settings" : {
        "number_of_shards" : 1
    }    
  },
  "deprecated": true
}
Screenshots

// index templates

Screenshot 2024-01-10 at 15 25 26
Screenshot 2024-01-10 at 15 25 31

Screenshot 2024-01-08 at 13 52 35
Screenshot 2024-01-08 at 14 00 46

// component templates

Screenshot 2024-01-10 at 14 45 10
Screenshot 2024-01-10 at 14 45 15
Screenshot 2024-01-08 at 14 51 03
Screenshot 2024-01-08 at 15 07 17

@sabarasaba sabarasaba added Feature:Index Management Index and index templates UI Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting v8.13.0 labels Jan 8, 2024
@sabarasaba sabarasaba self-assigned this Jan 8, 2024
@sabarasaba
Copy link
Member Author

/ci

@sabarasaba
Copy link
Member Author

@elasticmachine merge upstream

@sabarasaba
Copy link
Member Author

/ci

@sabarasaba
Copy link
Member Author

/ci

@sabarasaba
Copy link
Member Author

/ci

@sabarasaba
Copy link
Member Author

@elasticmachine merge upstream

@sabarasaba
Copy link
Member Author

/ci

@sabarasaba sabarasaba marked this pull request as ready for review January 11, 2024 16:22
@sabarasaba sabarasaba requested a review from a team as a code owner January 11, 2024 16:22
@elasticmachine
Copy link
Contributor

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

@sabarasaba
Copy link
Member Author

@elasticmachine merge upstream

@yuliacech yuliacech self-requested a review January 16, 2024 11:26
Copy link
Contributor

@yuliacech yuliacech left a comment

Choose a reason for hiding this comment

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

Thanks a lot for working on this, @sabarasaba!
Code changes LGTM and locally the badges work as expected. As already discussed, we should decide together with the team on how to handle the filters and hiding/showing the items in the table consistently. The component templates filters have the same issue as ingest pipelines.
Other than that I noticed that both index templates and component templates tables have issues with column widths. I opened an issue for that, maybe it's a regression we haven't noticed after an update or similar. But I think the badges in component templates should stack when there are several of them, wdyt? (see screenshot below)
Screenshot 2024-01-16 at 17 54 29

@sabarasaba
Copy link
Member Author

@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

merge conflict between base and head

@sabarasaba
Copy link
Member Author

@elasticmachine merge upstream

@yuliacech yuliacech assigned yuliacech and unassigned sabarasaba Feb 5, 2024
Copy link
Contributor

@yuliacech yuliacech left a comment

Choose a reason for hiding this comment

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

Thanks a lot for addressing the feedback, @sabarasaba!
I re-tested locally and pushed some changes for component templates: similar to ingest pipelines, I don't think we need to add "fuzzy matching" because the table handles the search automatically.

@yuliacech yuliacech enabled auto-merge (squash) February 5, 2024 16:59
@yuliacech yuliacech merged commit 173151b into elastic:main Feb 5, 2024
18 checks passed
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
indexManagement 604 607 +3

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
indexManagement 210 218 +8

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
indexManagement 588.9KB 593.2KB +4.3KB
Unknown metric groups

API count

id before after diff
indexManagement 215 223 +8

History

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

cc @yuliacech

fkanout pushed a commit to fkanout/kibana that referenced this pull request Feb 7, 2024
…onent template UIs (elastic#174450)

Partially addresses elastic#170805

## Summary

With elastic/elasticsearch#101148 we now can
alert the users when a component template or index template will soon be
deprecated and shouldnt be relied upon. This PR adds a badge and a
callout to the component template and index template UIs to alert the
users about this.

##### How to test

* Start up kibana and es
* Navigate to Stack management -> index management
(component_templates|index_templates)
* Verify that:
  * Deprecated resources are hidden by default
* Upon enabling filtering to see them they should pop up on the table
with a badge
* Verify that deprecated resources are highlighted and when editing, we
also show a warning callout.


<details>
<summary>Create deprecated component template</summary>

```
PUT _component_template/template_1
{
  "template": {
    "settings" : {
        "number_of_shards" : 1
    }    
  },
  "deprecated": true
}
```
</details>

<details>
<summary>Screenshots</summary>

// index templates

![Screenshot 2024-01-10 at 15 25
26](https://github.com/elastic/kibana/assets/1191206/ff632464-c4ac-43a2-b89d-be423489a82a)
![Screenshot 2024-01-10 at 15 25
31](https://github.com/elastic/kibana/assets/1191206/bb231c7c-5ae3-466d-9411-3cca842124dc)

![Screenshot 2024-01-08 at 13 52
35](https://github.com/elastic/kibana/assets/1191206/c6724867-3a0e-4998-871b-35fd577689bc)
![Screenshot 2024-01-08 at 14 00
46](https://github.com/elastic/kibana/assets/1191206/0b1001d4-c0bb-49a8-862a-746754e34fe0)

// component templates


![Screenshot 2024-01-10 at 14 45
10](https://github.com/elastic/kibana/assets/1191206/675519b8-80d7-466a-a4ad-185bb7f52651)
![Screenshot 2024-01-10 at 14 45
15](https://github.com/elastic/kibana/assets/1191206/0cbe5704-8549-4812-9202-e44b8f02ac95)
![Screenshot 2024-01-08 at 14 51
03](https://github.com/elastic/kibana/assets/1191206/0288ca12-c8f5-4ed5-ba4c-f77834702e68)
![Screenshot 2024-01-08 at 15 07
17](https://github.com/elastic/kibana/assets/1191206/97f72f52-6816-4bc9-910c-fbe88df50ad2)



</details>

---------

Co-authored-by: Kibana Machine <[email protected]>
Co-authored-by: Yulia Čech <[email protected]>
Co-authored-by: Yulia Cech <[email protected]>
CoenWarmer pushed a commit to CoenWarmer/kibana that referenced this pull request Feb 15, 2024
…onent template UIs (elastic#174450)

Partially addresses elastic#170805

## Summary

With elastic/elasticsearch#101148 we now can
alert the users when a component template or index template will soon be
deprecated and shouldnt be relied upon. This PR adds a badge and a
callout to the component template and index template UIs to alert the
users about this.

##### How to test

* Start up kibana and es
* Navigate to Stack management -> index management
(component_templates|index_templates)
* Verify that:
  * Deprecated resources are hidden by default
* Upon enabling filtering to see them they should pop up on the table
with a badge
* Verify that deprecated resources are highlighted and when editing, we
also show a warning callout.


<details>
<summary>Create deprecated component template</summary>

```
PUT _component_template/template_1
{
  "template": {
    "settings" : {
        "number_of_shards" : 1
    }    
  },
  "deprecated": true
}
```
</details>

<details>
<summary>Screenshots</summary>

// index templates

![Screenshot 2024-01-10 at 15 25
26](https://github.com/elastic/kibana/assets/1191206/ff632464-c4ac-43a2-b89d-be423489a82a)
![Screenshot 2024-01-10 at 15 25
31](https://github.com/elastic/kibana/assets/1191206/bb231c7c-5ae3-466d-9411-3cca842124dc)

![Screenshot 2024-01-08 at 13 52
35](https://github.com/elastic/kibana/assets/1191206/c6724867-3a0e-4998-871b-35fd577689bc)
![Screenshot 2024-01-08 at 14 00
46](https://github.com/elastic/kibana/assets/1191206/0b1001d4-c0bb-49a8-862a-746754e34fe0)

// component templates


![Screenshot 2024-01-10 at 14 45
10](https://github.com/elastic/kibana/assets/1191206/675519b8-80d7-466a-a4ad-185bb7f52651)
![Screenshot 2024-01-10 at 14 45
15](https://github.com/elastic/kibana/assets/1191206/0cbe5704-8549-4812-9202-e44b8f02ac95)
![Screenshot 2024-01-08 at 14 51
03](https://github.com/elastic/kibana/assets/1191206/0288ca12-c8f5-4ed5-ba4c-f77834702e68)
![Screenshot 2024-01-08 at 15 07
17](https://github.com/elastic/kibana/assets/1191206/97f72f52-6816-4bc9-910c-fbe88df50ad2)



</details>

---------

Co-authored-by: Kibana Machine <[email protected]>
Co-authored-by: Yulia Čech <[email protected]>
Co-authored-by: Yulia Cech <[email protected]>
fkanout pushed a commit to fkanout/kibana that referenced this pull request Mar 4, 2024
…onent template UIs (elastic#174450)

Partially addresses elastic#170805

## Summary

With elastic/elasticsearch#101148 we now can
alert the users when a component template or index template will soon be
deprecated and shouldnt be relied upon. This PR adds a badge and a
callout to the component template and index template UIs to alert the
users about this.

##### How to test

* Start up kibana and es
* Navigate to Stack management -> index management
(component_templates|index_templates)
* Verify that:
  * Deprecated resources are hidden by default
* Upon enabling filtering to see them they should pop up on the table
with a badge
* Verify that deprecated resources are highlighted and when editing, we
also show a warning callout.


<details>
<summary>Create deprecated component template</summary>

```
PUT _component_template/template_1
{
  "template": {
    "settings" : {
        "number_of_shards" : 1
    }    
  },
  "deprecated": true
}
```
</details>

<details>
<summary>Screenshots</summary>

// index templates

![Screenshot 2024-01-10 at 15 25
26](https://github.com/elastic/kibana/assets/1191206/ff632464-c4ac-43a2-b89d-be423489a82a)
![Screenshot 2024-01-10 at 15 25
31](https://github.com/elastic/kibana/assets/1191206/bb231c7c-5ae3-466d-9411-3cca842124dc)

![Screenshot 2024-01-08 at 13 52
35](https://github.com/elastic/kibana/assets/1191206/c6724867-3a0e-4998-871b-35fd577689bc)
![Screenshot 2024-01-08 at 14 00
46](https://github.com/elastic/kibana/assets/1191206/0b1001d4-c0bb-49a8-862a-746754e34fe0)

// component templates


![Screenshot 2024-01-10 at 14 45
10](https://github.com/elastic/kibana/assets/1191206/675519b8-80d7-466a-a4ad-185bb7f52651)
![Screenshot 2024-01-10 at 14 45
15](https://github.com/elastic/kibana/assets/1191206/0cbe5704-8549-4812-9202-e44b8f02ac95)
![Screenshot 2024-01-08 at 14 51
03](https://github.com/elastic/kibana/assets/1191206/0288ca12-c8f5-4ed5-ba4c-f77834702e68)
![Screenshot 2024-01-08 at 15 07
17](https://github.com/elastic/kibana/assets/1191206/97f72f52-6816-4bc9-910c-fbe88df50ad2)



</details>

---------

Co-authored-by: Kibana Machine <[email protected]>
Co-authored-by: Yulia Čech <[email protected]>
Co-authored-by: Yulia Cech <[email protected]>
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 Feature:Index Management Index and index templates UI release_note:skip Skip the PR/issue when compiling release notes Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more v8.13.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants