[Onboarding] Stack - update index management breadcrumbs #209599

saarikabhasi · 2025-02-04T17:31:44Z

Summary

Requirement:
In stack and when its search solution space, we need to update search index details breadcrumbs, when navigated via Content -> Index Management :

Index management list page - Content / Index Management / Indices
Index list page - Content / Index Management / indices / <index_name>
drop Stack management from the breadcrumb

In Classic nav, index management index details page breadcrumbs will have no change

Solutions

Currently, Index management app is rendered from management_app. The management app sets breadcrumbs for all the dependant apps. The easiest way to implement is to set breadcrumbs based on active solution type - es but this would alter breadcrumbs when index management app is rendered from side nav footer ( management -> index management) and other related management apps as well.

Other options is to modify setBreadcrumbs in ManagementAppMountParams but the setBreadcrumbs is used by multiple other apps.

In this PR, index management app is mounted via search indices plugin. In this way we can customize breadcrumbs for index management when rendered from search_indices plugin. When its search solution type, index management app will work independently from management app.

Screenshots

Search solution Nav - Changed breadcrumb ( dropped stack management & added index name)

Serverless

Note: No change in functionality from this PR. Added for additional info

index details page breadcrumbs should be Data/ Index Management / Indices/<index_name>
index list page breadcrumbs should be Data/ Index Management / Indices/

Serverless Details page

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios
Flaky Test Runner was used on any tests changed

check extensionService value in index_list

fix linting

…-fix'

kibanamachine · 2025-02-04T20:17:33Z

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#7833

[❌] x-pack/test/functional_search/config.ts: 0/25 tests passed.
[✅] x-pack/test_serverless/functional/test_suites/search/common_configs/config.group1.ts: 25/25 tests passed.
[✅] x-pack/test_serverless/functional/test_suites/search/config.ts: 25/25 tests passed.

see run history

…-fix'

…b.com:saarikabhasi/kibana into onboarding/update-breadcrumbs-indexmanagement

kibanamachine · 2025-02-04T23:45:27Z

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#7834

[❌] x-pack/test/functional_search/config.ts: 0/25 tests passed.
[❌] x-pack/test_serverless/functional/test_suites/search/common_configs/config.group1.ts: 24/25 tests passed.
[✅] x-pack/test_serverless/functional/test_suites/search/config.ts: 25/25 tests passed.

see run history

...m/plugins/shared/index_management/public/application/sections/home/index_list/index_list.tsx

x-pack/platform/plugins/shared/index_management/public/application/services/breadcrumbs.ts

x-pack/test/functional_search/tests/search_index_details.ts

x-pack/test/functional/page_objects/search_navigation.ts

kibanamachine · 2025-02-27T22:03:10Z

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#7961

[❌] x-pack/test/functional_solution_sidenav/config.ts: 0/25 tests passed.
[✅] x-pack/test_serverless/functional/test_suites/search/common_configs/config.group1.ts: 25/25 tests passed.
[❌] x-pack/test_serverless/functional/test_suites/search/config.ts: 0/25 tests passed.
[✅] x-pack/test/functional_search/config.ts: 25/25 tests passed.

see run history

…b.com:saarikabhasi/kibana into onboarding/update-breadcrumbs-indexmanagement

saarikabhasi · 2025-02-28T03:03:30Z

@mattkime I have updated this PR and is ready for review. In this solution, search_indices plugin registers a new application for index management app and the breadcrumbs logic is handled via search indices plugin. Could you please take a look again, thanks!

…b.com:saarikabhasi/kibana into onboarding/update-breadcrumbs-indexmanagement

kibanamachine · 2025-03-03T21:19:52Z

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#7967

[✅] x-pack/test/functional_solution_sidenav/config.ts: 25/25 tests passed.
[✅] x-pack/test_serverless/functional/test_suites/search/config.ts: 25/25 tests passed.
[✅] x-pack/test/functional_search/config.ts: 25/25 tests passed.
[❌] x-pack/test_serverless/functional/test_suites/search/common_configs/config.group1.ts: 3/25 tests passed.

see run history

…b.com:saarikabhasi/kibana into onboarding/update-breadcrumbs-indexmanagement

kibanamachine · 2025-03-04T16:14:26Z

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#7974

[❌] x-pack/test_serverless/functional/test_suites/search/common_configs/config.group1.ts: 1/25 tests passed.
[❌] x-pack/test/functional_search/config.ts: 24/25 tests passed.
[✅] x-pack/test_serverless/functional/test_suites/search/config.ts: 25/25 tests passed.
[✅] x-pack/test/functional_solution_sidenav/config.ts: 25/25 tests passed.

see run history

kibanamachine · 2025-03-04T21:59:38Z

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#7978

[❌] x-pack/test_serverless/functional/test_suites/search/common_configs/config.group1.ts: 22/25 tests passed.
[❌] x-pack/test/functional_search/config.ts: 24/25 tests passed.
[✅] x-pack/test_serverless/functional/test_suites/search/config.ts: 25/25 tests passed.
[✅] x-pack/test/functional_solution_sidenav/config.ts: 25/25 tests passed.

see run history

saarikabhasi · 2025-03-04T22:37:17Z

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#7978

[❌] x-pack/test_serverless/functional/test_suites/search/common_configs/config.group1.ts: 22/25 tests passed.
[❌] x-pack/test/functional_search/config.ts: 24/25 tests passed.
[✅] x-pack/test_serverless/functional/test_suites/search/config.ts: 25/25 tests passed.
[✅] x-pack/test/functional_solution_sidenav/config.ts: 25/25 tests passed.

This seems to be unrelated failures, retrying build succeeds failed FTRs and I cannot reproduce the errors locally.

mattkime

I'm mostly curious about the relationship between ManagementAppMountParams and SearchIndicesAppMountParams types. I think they should be the same unless there's something I'm missing.

mattkime · 2025-03-05T03:45:22Z

x-pack/platform/plugins/shared/index_management/public/application/mount_management_section.ts

@@ -129,7 +130,7 @@ export async function mountManagementSection({
 }: {
  coreSetup: CoreSetup<StartDependencies>;
  usageCollection: UsageCollectionSetup;
-  params: ManagementAppMountParams;
+  params: ManagementAppMountParams | SearchIndicesAppMountParams;


I left another similar comment before, got a bit confused and deleted it BUT - I'm confused why there needs to be different types here. It seems like they should be the same or at least extremely similar.

SearchIndicesAppMountParams is a subset of ManagementAppMountParams. The ManagementAppMountParams has few required field which would be undefined when mounting from search_indices plugin. This would cause type_check error.
Also from the code, I understand those fields are not used by mount_management_section in index management.

I think other way to simplify, is to create a new type IndexManagementAppMountParams which is a subset of ManagementAppMountParams and replace mount_management_section to use this type instead of ManagementAppMountParams. I will try that and confirm nothing breaks and update this PR

…b.com:saarikabhasi/kibana into onboarding/update-breadcrumbs-indexmanagement

…-fix'

elasticmachine · 2025-03-05T20:52:15Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 069e381

Failed CI Steps

FTR Configs #15

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`searchIndices`	334	336	+2

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/deeplinks-search`	19	20	+1
`@kbn/index-management-shared-types`	126	129	+3
`indexManagement`	239	241	+2
`searchIndices`	18	19	+1
total			+7

Async chunks

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

id	before	after	diff
`enterpriseSearch`	1.3MB	1.3MB	-20.0B
`searchIndices`	178.4KB	180.5KB	+2.1KB
total			+2.1KB

Page load bundle

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

id	before	after	diff
`indexManagement`	29.4KB	29.7KB	+349.0B
`searchIndices`	8.6KB	9.0KB	+503.0B
`searchNavigation`	4.8KB	4.8KB	+34.0B
`serverlessSearch`	25.5KB	25.6KB	+6.0B
total			+892.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/deeplinks-search`	19	20	+1
`@kbn/index-management-shared-types`	126	129	+3
`indexManagement`	244	246	+2
`searchIndices`	18	19	+1
total			+7

async chunk count

id	before	after	diff
`searchIndices`	4	6	+2

History

💛 Build #280536 was flaky 4b12666
💚 Build #280444 succeeded bc98ff9
💔 Build #279865 failed e601ab1
💔 Build #279831 failed 3c08dc0
💔 Build #279784 failed a73ede5
💔 Build #279623 failed 0a84fed

mattkime · 2025-03-06T02:31:17Z

x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts

@@ -35,9 +36,14 @@ export type IndexManagementLocatorParams = SerializableRecord &

 export type IndexManagementLocator = LocatorPublic<IndexManagementLocatorParams>;

+export type IndexManagementAppMountParams = Pick<


Perfect! I was really confused previously about how in one situation one set of params would work and another one would need a different set of params.

mattkime

I think there's some duplicate dependency providing that can be removed

mattkime · 2025-03-06T02:53:07Z

x-pack/solutions/search/plugins/search_indices/public/index_management_application.tsx

+import ReactDOM from 'react-dom';
+import { IndexManagementApp } from './components/index_mangement/app';
+
+export const renderIndexManagementApp = async (


I suspect this file isn't needed as this functionality is already provided within the index management app.

mattkime

Getting there, a couple more requests

mattkime · 2025-03-06T03:23:44Z

x-pack/solutions/search/plugins/search_indices/public/plugin.ts

+        defaultMessage: 'Index Management',
+      }),
+      async mount({ element, history }) {
+        const { renderIndexManagementApp } = await import('./index_management_application');


I'm pretty sure this should be able to directly use the IndexManagement.indexManagementApp

mattkime · 2025-03-06T03:24:39Z

x-pack/platform/plugins/shared/index_management/public/plugin.ts

@@ -144,6 +147,20 @@ export class IndexMgmtUIPlugin
    return {
      apiService: new PublicApiService(coreSetup.http),
      extensionsService: this.extensionsService.setup(),
+      indexManagementApp: async (params: IndexManagementAppMountParams) => {


lets call this renderIndexManagementApp

saarikabhasi added 5 commits February 4, 2025 12:34

update index management breadcrumb

60b517a

check extensionService value in index_list

add index name for stack solution nav

858d4d5

fix serverless version breadcrumb

2ce55e3

clean up

e47735c

fix linting

update FTR

42e6684

saarikabhasi force-pushed the onboarding/update-breadcrumbs-indexmanagement branch from 15172fd to 42e6684 Compare February 4, 2025 17:34

saarikabhasi changed the title ~~Onboarding/update breadcrumbs indexmanagement~~ [Onboarding] Stack - update index management breadcrumbs Feb 4, 2025

saarikabhasi added release_note:skip Skip the PR/issue when compiling release notes v9.0.0 backport:prev-minor Backport to (9.0) the previous minor version (i.e. one version back from main) Team:Search labels Feb 4, 2025

saarikabhasi marked this pull request as ready for review February 4, 2025 17:39

saarikabhasi requested review from a team as code owners February 4, 2025 17:39

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

6cf92e2

…-fix'

saarikabhasi added the v9.1.0 label Feb 4, 2025

saarikabhasi and others added 7 commits February 4, 2025 16:13

fix ci & clean up

82b297c

fix conflicts

2e22912

revert unintended change

d61d6ba

Clean ups

4816549

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

950958c

…-fix'

remove indexName

fa25cc6

Merge branch 'onboarding/update-breadcrumbs-indexmanagement' of githu…

59d38f9

…b.com:saarikabhasi/kibana into onboarding/update-breadcrumbs-indexmanagement

Merge branch 'main' into onboarding/update-breadcrumbs-indexmanagement

c6b44b7

yansavitski reviewed Feb 5, 2025

View reviewed changes

...m/plugins/shared/index_management/public/application/sections/home/index_list/index_list.tsx Outdated Show resolved Hide resolved

yansavitski reviewed Feb 5, 2025

View reviewed changes

x-pack/platform/plugins/shared/index_management/public/application/services/breadcrumbs.ts Outdated Show resolved Hide resolved

yansavitski reviewed Feb 5, 2025

View reviewed changes

x-pack/test/functional_search/tests/search_index_details.ts Outdated Show resolved Hide resolved

yansavitski reviewed Feb 5, 2025

View reviewed changes

x-pack/test/functional/page_objects/search_navigation.ts Outdated Show resolved Hide resolved

[CI] Auto-commit changed files from 'node scripts/telemetry_check'

3c08dc0

saarikabhasi and others added 3 commits February 27, 2025 20:58

fix FTR search side nav

27e157e

Merge branch 'onboarding/update-breadcrumbs-indexmanagement' of githu…

5c959d8

…b.com:saarikabhasi/kibana into onboarding/update-breadcrumbs-indexmanagement

Merge branch 'main' into onboarding/update-breadcrumbs-indexmanagement

e601ab1

saarikabhasi and others added 3 commits March 3, 2025 13:03

fix unmount index management app

8c53c2e

Merge branch 'onboarding/update-breadcrumbs-indexmanagement' of githu…

37fa6a1

…b.com:saarikabhasi/kibana into onboarding/update-breadcrumbs-indexmanagement

Merge branch 'main' into onboarding/update-breadcrumbs-indexmanagement

bc98ff9

saarikabhasi added 3 commits March 3, 2025 17:35

clean up

511b5de

FTR: add breadcrumbs check for stack

b799e10

Merge branch 'onboarding/update-breadcrumbs-indexmanagement' of githu…

4b12666

…b.com:saarikabhasi/kibana into onboarding/update-breadcrumbs-indexmanagement

sphilipse added backport:version Backport to applied version labels and removed v9.0.0 backport:prev-minor Backport to (9.0) the previous minor version (i.e. one version back from main) labels Mar 4, 2025

yansavitski approved these changes Mar 4, 2025

View reviewed changes

Merge branch 'main' into onboarding/update-breadcrumbs-indexmanagement

d6871b8

mattkime requested changes Mar 5, 2025

View reviewed changes

saarikabhasi and others added 4 commits March 5, 2025 12:30

create subset type of ManagementAppMountParams

8dd3104

Merge branch 'onboarding/update-breadcrumbs-indexmanagement' of githu…

31b8741

…b.com:saarikabhasi/kibana into onboarding/update-breadcrumbs-indexmanagement

[CI] Auto-commit changed files from 'node scripts/notice'

0c79895

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

069e381

…-fix'

mattkime reviewed Mar 6, 2025

View reviewed changes

mattkime requested changes Mar 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Onboarding] Stack - update index management breadcrumbs #209599

[Onboarding] Stack - update index management breadcrumbs #209599

saarikabhasi commented Feb 4, 2025 •

edited

Loading

kibanamachine commented Feb 4, 2025

kibanamachine commented Feb 4, 2025

kibanamachine commented Feb 27, 2025

saarikabhasi commented Feb 28, 2025

kibanamachine commented Mar 3, 2025

kibanamachine commented Mar 4, 2025

kibanamachine commented Mar 4, 2025

saarikabhasi commented Mar 4, 2025

mattkime left a comment

mattkime Mar 5, 2025

saarikabhasi Mar 5, 2025

saarikabhasi Mar 5, 2025

elasticmachine commented Mar 5, 2025

API count

async chunk count

mattkime Mar 6, 2025

mattkime left a comment

mattkime Mar 6, 2025

mattkime left a comment

mattkime Mar 6, 2025

mattkime Mar 6, 2025

		@@ -35,9 +36,14 @@ export type IndexManagementLocatorParams = SerializableRecord &

		export type IndexManagementLocator = LocatorPublic<IndexManagementLocatorParams>;

		export type IndexManagementAppMountParams = Pick<

[Onboarding] Stack - update index management breadcrumbs #209599

Are you sure you want to change the base?

[Onboarding] Stack - update index management breadcrumbs #209599

Conversation

saarikabhasi commented Feb 4, 2025 • edited Loading

Summary

Solutions

Screenshots

Search solution Nav - Changed breadcrumb ( dropped stack management & added index name)

Serverless

Checklist

kibanamachine commented Feb 4, 2025

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#7833

kibanamachine commented Feb 4, 2025

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#7834

kibanamachine commented Feb 27, 2025

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#7961

saarikabhasi commented Feb 28, 2025

kibanamachine commented Mar 3, 2025

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#7967

kibanamachine commented Mar 4, 2025

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#7974

kibanamachine commented Mar 4, 2025

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#7978

saarikabhasi commented Mar 4, 2025

mattkime left a comment

Choose a reason for hiding this comment

mattkime Mar 5, 2025

Choose a reason for hiding this comment

saarikabhasi Mar 5, 2025

Choose a reason for hiding this comment

saarikabhasi Mar 5, 2025

Choose a reason for hiding this comment

elasticmachine commented Mar 5, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

async chunk count

History

mattkime Mar 6, 2025

Choose a reason for hiding this comment

mattkime left a comment

Choose a reason for hiding this comment

mattkime Mar 6, 2025

Choose a reason for hiding this comment

mattkime left a comment

Choose a reason for hiding this comment

mattkime Mar 6, 2025

Choose a reason for hiding this comment

mattkime Mar 6, 2025

Choose a reason for hiding this comment

saarikabhasi commented Feb 4, 2025 •

edited

Loading