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

[Onboarding] Expose settings component in index_management to reuse in search_indices #193492

Conversation

saarikabhasi
Copy link
Member

@saarikabhasi saarikabhasi commented Sep 19, 2024

Summary

This PR exposes index_management index details settings component during index_management plugin start. This would enable search_indices plugin to reuse.

With this change, in new search index details page user can :

  • Can View settings
  • Update settings & save
  • Reset changes
Screenshot 2024-09-19 at 5 48 28 PM

How to test:

  1. Enable searchIndices plugin in kibana.dev.yml as this plugin is behind Feature flag
xpack.searchIndices.enabled: true

  1. Create new index
  2. Navigate to /app/elasticsearch/indices/index_details/${indexName}/settings

Checklist

@saarikabhasi saarikabhasi added release_note:skip Skip the PR/issue when compiling release notes v9.0.0 Team:Search backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) v8.16.0 labels Sep 19, 2024
@saarikabhasi saarikabhasi requested review from a team as code owners September 19, 2024 21:37
@saarikabhasi saarikabhasi force-pushed the onboarding/expose-settings-from-index-management branch from 2ad6e5e to 9152451 Compare September 19, 2024 21:55
@kibanamachine
Copy link
Contributor

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#6985

[✅] x-pack/test_serverless/functional/test_suites/search/config.feature_flags.ts: 25/25 tests passed.

see run history

@saarikabhasi saarikabhasi force-pushed the onboarding/expose-settings-from-index-management branch from 9152451 to 351c515 Compare September 20, 2024 13:27
@saarikabhasi
Copy link
Member Author

@elasticmachine merge upstream

@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
indexManagement 688 690 +2
searchIndices 170 171 +1
total +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
@kbn/index-management-shared-types 109 114 +5
indexManagement 238 241 +3
total +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 682.4KB 683.4KB +1.0KB
searchIndices 84.3KB 84.7KB +396.0B
total +1.4KB

Page load bundle

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

id before after diff
indexManagement 43.6KB 44.4KB +799.0B
Unknown metric groups

API count

id before after diff
@kbn/index-management-shared-types 109 114 +5
indexManagement 243 246 +3
total +8

async chunk count

id before after diff
indexManagement 3 4 +1

History

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

@ElenaStoeva ElenaStoeva self-requested a review September 23, 2024 20:14
Copy link
Contributor

@ElenaStoeva ElenaStoeva left a comment

Choose a reason for hiding this comment

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

IM changes lgtm. Tested locally for regressions in IM.

@saarikabhasi saarikabhasi merged commit d925391 into elastic:main Sep 24, 2024
22 checks passed
@saarikabhasi saarikabhasi deleted the onboarding/expose-settings-from-index-management branch September 24, 2024 13:13
@saarikabhasi saarikabhasi restored the onboarding/expose-settings-from-index-management branch September 24, 2024 13:13
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Sep 24, 2024
…n search_indices (elastic#193492)

## Summary
This PR exposes `index_management` index details [settings component
](https://github.com/elastic/kibana/blob/main/x-pack/plugins/index_management/public/application/sections/home/index_list/details_page/details_page_settings.tsx#L16)during
`index_management` plugin start. This would enable `search_indices`
plugin to reuse.

With this change, in new search index details page user can :

- Can View settings
- Update settings & save
- Reset changes

<img width="1719" alt="Screenshot 2024-09-19 at 5 48 28 PM"
src="https://github.com/user-attachments/assets/a6179fb6-c180-434e-bdb1-3c784006069f">

**How to test:**
1. Enable searchIndices plugin in `kibana.dev.yml` as this plugin is
behind Feature flag
```
xpack.searchIndices.enabled: true

```
2. [Create new
index](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html)
3. Navigate to
`/app/elasticsearch/indices/index_details/${indexName}/settings`

### Checklist

- [x] 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)
- [x] [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
- [x] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed

---------

Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>
(cherry picked from commit d925391)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Sep 24, 2024
…euse in search_indices (#193492) (#193870)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Onboarding] Expose settings component in index_management to reuse
in search_indices
(#193492)](#193492)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Saarika
Bhasi","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-24T13:13:31Z","message":"[Onboarding]
Expose settings component in index_management to reuse in search_indices
(#193492)\n\n## Summary\r\nThis PR exposes `index_management` index
details [settings
component\r\n](https://github.com/elastic/kibana/blob/main/x-pack/plugins/index_management/public/application/sections/home/index_list/details_page/details_page_settings.tsx#L16)during\r\n`index_management`
plugin start. This would enable `search_indices`\r\nplugin to
reuse.\r\n\r\nWith this change, in new search index details page user
can :\r\n\r\n- Can View settings \r\n- Update settings & save \r\n-
Reset changes\r\n\r\n<img width=\"1719\" alt=\"Screenshot 2024-09-19 at
5 48
28 PM\"\r\nsrc=\"https://github.com/user-attachments/assets/a6179fb6-c180-434e-bdb1-3c784006069f\">\r\n\r\n**How
to test:** \r\n1. Enable searchIndices plugin in `kibana.dev.yml` as
this plugin is\r\nbehind Feature
flag\r\n```\r\nxpack.searchIndices.enabled: true\r\n\r\n```\r\n2.
[Create
new\r\nindex](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html)\r\n3.
Navigate
to\r\n`/app/elasticsearch/indices/index_details/${indexName}/settings`\r\n\r\n
\r\n\r\n### Checklist\r\n\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [x] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\r\nused on any tests changed\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>\r\nCo-authored-by:
Elastic Machine
<[email protected]>","sha":"d925391b90d2ed06c3e940d4112baaa634a9182a","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:Search","backport:prev-minor","v8.16.0"],"title":"[Onboarding]
Expose settings component in index_management to reuse in search_indices
","number":193492,"url":"https://github.com/elastic/kibana/pull/193492","mergeCommit":{"message":"[Onboarding]
Expose settings component in index_management to reuse in search_indices
(#193492)\n\n## Summary\r\nThis PR exposes `index_management` index
details [settings
component\r\n](https://github.com/elastic/kibana/blob/main/x-pack/plugins/index_management/public/application/sections/home/index_list/details_page/details_page_settings.tsx#L16)during\r\n`index_management`
plugin start. This would enable `search_indices`\r\nplugin to
reuse.\r\n\r\nWith this change, in new search index details page user
can :\r\n\r\n- Can View settings \r\n- Update settings & save \r\n-
Reset changes\r\n\r\n<img width=\"1719\" alt=\"Screenshot 2024-09-19 at
5 48
28 PM\"\r\nsrc=\"https://github.com/user-attachments/assets/a6179fb6-c180-434e-bdb1-3c784006069f\">\r\n\r\n**How
to test:** \r\n1. Enable searchIndices plugin in `kibana.dev.yml` as
this plugin is\r\nbehind Feature
flag\r\n```\r\nxpack.searchIndices.enabled: true\r\n\r\n```\r\n2.
[Create
new\r\nindex](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html)\r\n3.
Navigate
to\r\n`/app/elasticsearch/indices/index_details/${indexName}/settings`\r\n\r\n
\r\n\r\n### Checklist\r\n\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [x] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\r\nused on any tests changed\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>\r\nCo-authored-by:
Elastic Machine
<[email protected]>","sha":"d925391b90d2ed06c3e940d4112baaa634a9182a"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/193492","number":193492,"mergeCommit":{"message":"[Onboarding]
Expose settings component in index_management to reuse in search_indices
(#193492)\n\n## Summary\r\nThis PR exposes `index_management` index
details [settings
component\r\n](https://github.com/elastic/kibana/blob/main/x-pack/plugins/index_management/public/application/sections/home/index_list/details_page/details_page_settings.tsx#L16)during\r\n`index_management`
plugin start. This would enable `search_indices`\r\nplugin to
reuse.\r\n\r\nWith this change, in new search index details page user
can :\r\n\r\n- Can View settings \r\n- Update settings & save \r\n-
Reset changes\r\n\r\n<img width=\"1719\" alt=\"Screenshot 2024-09-19 at
5 48
28 PM\"\r\nsrc=\"https://github.com/user-attachments/assets/a6179fb6-c180-434e-bdb1-3c784006069f\">\r\n\r\n**How
to test:** \r\n1. Enable searchIndices plugin in `kibana.dev.yml` as
this plugin is\r\nbehind Feature
flag\r\n```\r\nxpack.searchIndices.enabled: true\r\n\r\n```\r\n2.
[Create
new\r\nindex](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html)\r\n3.
Navigate
to\r\n`/app/elasticsearch/indices/index_details/${indexName}/settings`\r\n\r\n
\r\n\r\n### Checklist\r\n\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [x] [Flaky
Test\r\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1)
was\r\nused on any tests changed\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>\r\nCo-authored-by:
Elastic Machine
<[email protected]>","sha":"d925391b90d2ed06c3e940d4112baaa634a9182a"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Saarika Bhasi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) release_note:skip Skip the PR/issue when compiling release notes Team:Search v8.16.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants