Reorganize Management apps into Ingest, Data, Alerts and Insights, Security, Kibana, and Stack groups #65796

cjcenizal · 2020-05-07T23:52:29Z

Replaces #60847. See that issue for more background on the intention and reasoning behind this reorganization.

I'd like to get approval from all affected teams:

CC @elastic/kibana-core-ui

I'm also particularly interested in hearing people's thoughts on how this change defines all possible buckets in a single place (src/plugins/management/public/legacy/sections_register.js). I think this makes it clearer which buckets are available to put apps into and how the buckets are ordered. I don't think it's a concern that we're creating some buckets in OSS that currently only contain X-Pack apps -- these buckets disappear from the UI when they're empty and they provide a useful structure for third-party plugin developers to follow.

Note that I've also removed the ability to register new sections, which I am concerned might prove controversial (and I'm happy to revert this if it's the case). @elastic/kibana-platform Could you chime in on this?

To-do

#67044 tracks required changes to docs.

Release note

Management apps are now organized into buckets that support common workflow-oriented use-cases: data ingestion, data management, insights and alerting, security, Kibana management, and Stack management.

elasticmachine · 2020-05-07T23:52:31Z

Pinging @elastic/es-ui (Team:Elasticsearch UI)

…Security, Kibana, and Stack groups. - Define these groups in src/plugins/management/public/legacy/sections_register to act as a single source of truth in both OSS and X-Pack.

jloleysens

@cjcenizal this is looking great! I think the buckets communicate solutions really well and create a sense of intentionality that was lacking before. Overall happy with ESUI changes, I loaded Kibana and was able to access all apps (also tested linking from CCR -> remote clusters, working as expected)

I am happy for this to be merged once CI is passing 👍

Code

Left some minor comments.

UI

The bucketed list takes up a bit more vertical screen space than its predecessor which creates a scrollbar for all management apps. This is not the worst thing but it might be worth thinking about a way for the nav bar to not increase height of apps directly.
Beats seems to be cutting off (same with CCR) on my screen:

jloleysens · 2020-05-08T07:47:59Z

src/plugins/management/public/legacy/sections_register.js

@@ -20,6 +20,33 @@
 import { LegacyManagementSection } from './section';
 import { i18n } from '@kbn/i18n';

+export const sections = [
+  {
+    id: 'ingest',


I really like this.

One suggestion in case we want to refactor ids whatever reason, it could be useful to have an enum that management exports in public (I can imagine search for 'data' may bring up many results 😄 ). Maybe Sections.Ingest for instance.

Great idea! Will do.

I'm hoping we'll change how sections are referenced in the near future. I'm 👎 on looking items up by id unless necessary and this case is not necessary. We should be exporting the sections as public APIs of the plugins that create them. The current usage creates an implicit dependency and the potential for runtime errors instead of compile time errors.

jloleysens · 2020-05-08T07:49:59Z

src/plugins/management/public/legacy/sections_register.js

-      display: 'Logstash',
-      order: 30,
-      icon: 'logoLogstash',
+    sections.forEach(({ id, title, icon }, idx) => {


Does icon exist in any of these?

It doesn't, great spot. My original line of thought was that we'd need to support icons for these buckets but TBH, I think they're unnecessary in terms of UX. I'll remove this from the code and we can always reimplement if we need to.

legrego

I'm surprised to find Index Patterns grouped under the Data section. I can see the rationale for putting it here, but I wonder if it would be better suited under the Kibana section?

The term "Index Pattern" is already pretty overloaded, and having this link outside of the Kibana section is rather confusing to me. These Index Patterns truly are specific to Kibana, and only live within Kibana.

Index Patterns are also a type of Saved Object, and the management screen for Saved Objects is under the Kibana section.

legrego · 2020-05-08T18:37:48Z

x-pack/plugins/spaces/public/management/management_service.tsx

-    const kibanaSection = management.sections.getSection('kibana');
-    if (kibanaSection) {
-      this.registeredSpacesManagementApp = kibanaSection.registerApp(
+    this.registeredSpacesManagementApp = management.sections


If we're assuming that the kibana section will always exist, can we update the type definitions to reflect that, rather than forcing TypeScript into trusting us here?

…onal sections.

cjcenizal · 2020-05-09T04:45:43Z

@jloleysens Thanks for your review! I've incorporated your feedback. In terms of the change in nav height, I think we should solve this in a separate design pass as long as the way apps are grouped and named makes sense here.

@legrego Thanks for your input, I agree with you. I'd like to avoid introducing controversial changes in this PR and I think this particular change deserves more consideration at a later time.

cjcenizal · 2020-05-09T05:00:15Z

src/plugins/management/public/management_service.ts

-  private getSection(sectionId: ManagementSection['id']) {
-    return this.sections.find(section => section.id === sectionId);
+
+  private getSection(sectionId: ManagementSectionId): ManagementSection {


Does anybody have any suggestions on what I could do to convince TypeScript that this function will always return a ManagementSection, and not undefined? TS check shows this error everywhere this method is invoked:

Object is possibly 'undefined'.

We could consider throwing if find returns undefined. That would give us both transpile-time and runtime guarantees

See my previous comment. I consider this a flaw in the API. I think throwing will work in the mean time.

Thanks Matt! I updated the code to throw.

arisonl · 2020-05-11T09:44:44Z

There is one consideration worth being aware of (this is relevant to Larry's comment above and I have mentioned it in a previous iteration. Reminding here as it might have some UX implications): Some of the features are Space specific while others are not. Notably: Alerts and Actions are space aware while Watcher is not. This means that in Alerts and Actions you only see the alerts belonging to the Space you are in (the Default in this mockup) but if you navigate to Watcher, which is within the same bucket, you will see all watches. Not sure how confusing this might be with the two living in the same bucket. Machine Learning jobs are not Space aware yet but will become some time soon (btw, not sure if Insights and alerting is the right bucket for ML, the ML team should review). I believe that this use-case/user-intention perspective is great and makes a lot of sense, but we might want to think through whether we want the design to somehow indicate this difference between space-specific and space-agnostic entities.

chrisronline

LGTM for stack monitoring

rylnd

SIEM changes LGTM 👍

jonathan-buttner

No endpoint changes in here, and I believe SIEM already 👍

smith

APM changes look good to me!

…curity, Kibana, and Stack groups (elastic#65796)

…curity, Kibana, and Stack groups (#65796) (#66836)

…ine-editor * 'master' of github.com:elastic/kibana: (157 commits) [ML] fix url assertion (#66850) Skip failing lens test(s). #66779 [SOM] Preserve saved object references when saving the object (#66584) Use ES API from start contract (#66157) Reorganize Management apps into Ingest, Data, Alerts and Insights, Security, Kibana, and Stack groups (#65796) [Uptime] Fix flaky navigation to certs page in tests (#66806) [Maps] Do not check count for blended layers when layer is not visible (#66460) [SIEM] Fixes glob patterns from directory changes recently for GraphQL chore(NA): bump static-fs to 1.0.2 (#66775) [Maps] Handle cross cluster index _settings resp (#66797) [SIEM][Lists] Adds 90% of the REST API and client API for exception lists and exception items allow any type for customResponseHeaders config (#66689) [APM] Disable map layout animation (#66763) [ML] Add linking to dataframe from job management tab (#65778) [Maps] Get number of categories from palette (#66454) move oss features registration to KP (#66524) [kbn/plugin-helpers] typescript-ify (#66513) Add kibana-operations as codeowners for .ci/es-snapshots and vars/ (#66746) FTR: move basic services under common folder (#66563) Migrate Beats Management UI to KP (#65791) ... # Conflicts: # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form.tsx # x-pack/plugins/ingest_pipelines/public/application/components/pipeline_form/pipeline_form_fields.tsx

* master: [ML] fix url assertion (elastic#66850) Skip failing lens test(s). elastic#66779 [SOM] Preserve saved object references when saving the object (elastic#66584) Use ES API from start contract (elastic#66157) Reorganize Management apps into Ingest, Data, Alerts and Insights, Security, Kibana, and Stack groups (elastic#65796) [Uptime] Fix flaky navigation to certs page in tests (elastic#66806) [Maps] Do not check count for blended layers when layer is not visible (elastic#66460) [SIEM] Fixes glob patterns from directory changes recently for GraphQL chore(NA): bump static-fs to 1.0.2 (elastic#66775) [Maps] Handle cross cluster index _settings resp (elastic#66797) [SIEM][Lists] Adds 90% of the REST API and client API for exception lists and exception items allow any type for customResponseHeaders config (elastic#66689) [APM] Disable map layout animation (elastic#66763) [ML] Add linking to dataframe from job management tab (elastic#65778)

kibanamachine · 2020-05-19T18:59:35Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 69762fd

History

💚 Build #48441 succeeded 69762fd
💚 Build #48223 succeeded 79bcbb7
💔 Build #48212 failed 3554533
💔 Build #48196 failed 68c0eb4
💔 Build #48178 failed b11ebf8

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

cjcenizal added release_note:enhancement v8.0.0 Feature:Kibana Management Feature label for Data Views, Advanced Setting, Saved Object management pages Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more v7.9.0 labels May 7, 2020

cjcenizal requested review from a team as code owners May 7, 2020 23:52

cjcenizal mentioned this pull request May 7, 2020

[skip-ci] [Discuss] Management apps organization #60847

Closed

Reorganize Management apps into Ingest, Data, Insights and Alerting, …

465d813

…Security, Kibana, and Stack groups. - Define these groups in src/plugins/management/public/legacy/sections_register to act as a single source of truth in both OSS and X-Pack.

cjcenizal force-pushed the reorg/management-apps branch from 3015048 to 465d813 Compare May 8, 2020 00:22

jloleysens approved these changes May 8, 2020

View reviewed changes

cjcenizal added 2 commits May 8, 2020 09:41

Fix TS error in beats due to missing visible option.

a66a7e0

Update snapshots.

7cc3490

legrego reviewed May 8, 2020

View reviewed changes

cjcenizal added 3 commits May 8, 2020 17:12

Remove support for icon.

25cb6ac

Create ManagementSectionId enum and remove ability to register additi…

f93aba0

…onal sections.

Merge branch 'master' into reorg/management-apps

a9fdf54

cjcenizal requested a review from a team as a code owner May 9, 2020 04:36

cjcenizal added 2 commits May 8, 2020 21:39

Return Index Patterns to Kibana section.

d3f557e

Rename Beats Central Management to Beats Management in nav.

5c6d09e

cjcenizal commented May 9, 2020

View reviewed changes

Add tooltips to sections.

6ceed19

cjcenizal requested a review from a team as a code owner May 10, 2020 21:42

ruflin requested a review from mostlyjason May 11, 2020 08:56

Fix broken links and update snapshots.

68c0eb4

cjcenizal requested review from a team as code owners May 15, 2020 00:10

cjcenizal requested a review from a team May 15, 2020 00:10

cjcenizal added 3 commits May 14, 2020 19:28

Fix watcher links.

dfccfa5

Fix broken license management link.

3554533

Merge branch 'master' into reorg/management-apps

79bcbb7

chrisronline approved these changes May 15, 2020

View reviewed changes

rylnd approved these changes May 15, 2020

View reviewed changes

jonathan-buttner approved these changes May 15, 2020

View reviewed changes

smith approved these changes May 15, 2020

View reviewed changes

andrewvc approved these changes May 15, 2020

View reviewed changes

Merge branch 'master' into reorg/management-apps

69762fd

cjcenizal changed the title ~~Reorganize Management apps into Ingest, Data, Insights and Alerting, Security, Kibana, and Stack groups~~ Reorganize Management apps into Ingest, Data, Alerts and Insights, Security, Kibana, and Stack groups May 15, 2020

cjcenizal merged commit bfdeb10 into elastic:master May 15, 2020

cjcenizal deleted the reorg/management-apps branch May 15, 2020 23:11

cjcenizal mentioned this pull request May 15, 2020

[7.x] Reorganize Management apps into Ingest, Data, Alerts and Insights, Security, Kibana, and Stack groups (#65796) #66836

Merged

cjcenizal added a commit to cjcenizal/kibana that referenced this pull request May 15, 2020

Reorganize Management apps into Ingest, Data, Alerts and Insights, Se…

0a27bc4

…curity, Kibana, and Stack groups (elastic#65796)

cjcenizal added a commit that referenced this pull request May 16, 2020

Reorganize Management apps into Ingest, Data, Alerts and Insights, Se…

06fc23f

…curity, Kibana, and Stack groups (#65796) (#66836)

cjcenizal mentioned this pull request May 19, 2020

Update Management docs to reflect new organization #67044

Closed

11 tasks

alisonelizabeth mentioned this pull request May 26, 2020

[DOCS] Adds docs for Ingest Node Pipelines #66822

Merged

flash1293 mentioned this pull request May 27, 2020

Fix reporting link in toast #67440

Merged

alexwizp mentioned this pull request May 28, 2020

[New Platform Migration]: Management - Implement NP API #66781

Merged

42 tasks

dedemorton mentioned this pull request Jun 5, 2020

Update Beats docs to reflect reorg of management app elastic/beats#18987

Closed

sulemanof mentioned this pull request Jun 11, 2020

Fix reporting link path in home feature #68889

Merged

7 tasks

cjcenizal mentioned this pull request Jul 9, 2020

Management API - simpler interface, remove app context usage #71144

Merged

cjcenizal mentioned this pull request Aug 20, 2020

License link in "Your query is taking a while" popup is not working #72801

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reorganize Management apps into Ingest, Data, Alerts and Insights, Security, Kibana, and Stack groups #65796

Reorganize Management apps into Ingest, Data, Alerts and Insights, Security, Kibana, and Stack groups #65796

cjcenizal commented May 7, 2020 •

edited

elasticmachine commented May 7, 2020

jloleysens left a comment •

edited

jloleysens May 8, 2020 •

edited

cjcenizal May 8, 2020

mattkime May 12, 2020

jloleysens May 8, 2020

cjcenizal May 8, 2020

legrego left a comment •

edited

legrego May 8, 2020

cjcenizal commented May 9, 2020 •

edited

cjcenizal May 9, 2020

legrego May 11, 2020

mattkime May 12, 2020

cjcenizal May 12, 2020

arisonl commented May 11, 2020 •

edited

chrisronline left a comment

rylnd left a comment

jonathan-buttner left a comment

smith left a comment

kibanamachine commented May 19, 2020

Reorganize Management apps into Ingest, Data, Alerts and Insights, Security, Kibana, and Stack groups #65796

Reorganize Management apps into Ingest, Data, Alerts and Insights, Security, Kibana, and Stack groups #65796

Conversation

cjcenizal commented May 7, 2020 • edited

To-do

Release note

elasticmachine commented May 7, 2020

jloleysens left a comment • edited

Choose a reason for hiding this comment

Code

UI

jloleysens May 8, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

legrego left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cjcenizal commented May 9, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arisonl commented May 11, 2020 • edited

chrisronline left a comment

Choose a reason for hiding this comment

rylnd left a comment

Choose a reason for hiding this comment

jonathan-buttner left a comment

Choose a reason for hiding this comment

smith left a comment

Choose a reason for hiding this comment

kibanamachine commented May 19, 2020

💚 Build Succeeded

History

cjcenizal commented May 7, 2020 •

edited

jloleysens left a comment •

edited

jloleysens May 8, 2020 •

edited

legrego left a comment •

edited

cjcenizal commented May 9, 2020 •

edited

arisonl commented May 11, 2020 •

edited