Migrate Beats Management UI to KP #65791

joshdover · 2020-05-07T22:36:42Z

Summary

This migrates the Beats Management UI to the new Management framework in the Kibana Platform.

Intentional behavioral changes:

The URL has changed from /app/kibana#management/beats_management to /app/kibana#management/beats/beats_management.
- This is the enforced convention by the new Management framework.
- This product is labelled as "beta" so I'm hoping this breaking URL change is acceptable.
Breadcrumbs
- The breadcrumbs in the top nav now include the "Stack Management" crumb as the first item.
- I fixed a bug where the breadcrumb for the root of the app would point to #/management/beats_managementundefined to #/management/beats/beats_management

Testing

This UI has no automated tests at all ⚠️ 😢 (functional or units) so this will require a good amount of manual QA. Unfortunately, I'm not too familiar with the idiosyncrasies of this UI, however comparing to master, this appears to be working. I will recruit a member of the Ingest Management team to assist with testing this PR.

Checklist

Delete any items that are not applicable to this PR.

This was checked for cross-browser compatibility, including a check against IE11

For maintainers

This was checked for breaking API changes and was labeled appropriately

joshdover · 2020-05-10T16:45:47Z

x-pack/plugins/beats_management/public/components/navigation/breadcrumb/breadcrumb.tsx

@@ -53,7 +53,7 @@ export const Breadcrumb: React.FC<BreadcrumbProps> = ({ title, path, parentBread
    {context => (
      <BreadcrumbManager
        text={title}
-        href={`#${BASE_PATH}${path}`}
+        href={path ? `#${BASE_PATH}${path}` : `#${BASE_PATH}`}


This was broken before and would result in URLs like #/management/beats_managementundefined

joshdover · 2020-05-10T16:47:07Z

x-pack/plugins/beats_management/public/kbn_services.ts

+  services.I18nContext = core.i18n.Context;
+  services.setBreadcrumbs = params.setBreadcrumbs;
+  services.dataStart = plugins.data;
+};


Using the "stateful module" hack here to avoid wiring up all the services into the deeply nested components. Seems an appropriate time to use this since this product is not currently in active development.

joshdover · 2020-05-10T16:48:09Z

x-pack/legacy/plugins/beats_management/common/constants/index.ts

@@ -9,4 +9,4 @@ export { INDEX_NAMES } from './index_names';
 export { PLUGIN } from './plugin';
 export { LICENSES, REQUIRED_LICENSES, REQUIRED_ROLES } from './security';
 export { TABLE_CONFIG } from './table';
-export const BASE_PATH = '/management/beats_management';
+export const BASE_PATH = '/management/beats/beats_management';


The way the new Management plugin works, this is unavoidable. This PR will change the URL for this UI, however since it's marked "beta" this should be fine.

elasticmachine · 2020-05-10T17:13:44Z

Pinging @elastic/ingest-management (Team:Ingest Management)

joshdover · 2020-05-10T20:02:44Z

x-pack/plugins/beats_management/public/lib/adapters/framework/kibana_framework_adapter.ts

@@ -0,0 +1,184 @@
+/*


This file was moved, but I did delete significant amount of code here around mounting and interfacing with Angular

justinkambic · 2020-05-11T17:49:58Z

@joshdover is the goal here to migrate the client first and move the server/common/etc in a follow-up?

joshdover · 2020-05-11T19:38:32Z

@joshdover is the goal here to migrate the client first and move the server/common/etc in a follow-up?

Correct. We need to migrate the UI now in order to unblock migrating the rest of the Management UI that this plugs into. Server will be done in a different release in order to unblock removing the legacy system.

justinkambic

Code changes LGTM. Had a few questions but the app seems to load up ok and I don't see any red flags.

@ph mentioned he'd review the functionality. FWIW I loaded up the app and tried enrolling a beat, but filebeat/metricbeat seem to reject the enroll command required to register beats. I haven't used these features in quite some time so it's probably better if someone familiar with those beats reviews this functionality anyway.

Please ping me if I can be helpful with the rest of this migration.

x-pack/plugins/beats_management/server/index.ts

x-pack/plugins/beats_management/public/lib/compose/kibana.ts

mshustov · 2020-05-12T15:58:11Z

x-pack/plugins/beats_management/public/lib/adapters/framework/kibana_framework_adapter.ts

+        settings: this.config,
+      };
+    } catch (e) {
+      throw new Error(`Unexpected data structure from xpackInfoService, ${JSON.stringify(e)}`);


don't think code in try can throw

This is valid since it's inside the catch block. Also this was from the previous implementation, I didn't change anything here except how it reads the license.

mshustov · 2020-05-12T16:00:49Z

x-pack/plugins/beats_management/public/lib/adapters/framework/kibana_framework_adapter.ts

+  }
+
+  public setUISettings = (key: string, value: any) => {
+    this.adapterService.callOrBuffer(({ config }) => {


Is it a bridge to the legacy angular code?

Not sure, I didn't touch this (just moved). I'll double check though.

Honestly it looks like this code is just broken (and probably has been for some time). The adapter service buffers calls until its $get method is called, which I cannot find any place where that is called in the legacy implementation.

Not sure if worth fixing this now or not. I'm just too afraid of breaking things here without any tests.

x-pack/plugins/beats_management/public/lib/adapters/framework/kibana_framework_adapter.ts

joshdover · 2020-05-12T18:01:18Z

@ph mentioned he'd review the functionality. FWIW I loaded up the app and tried enrolling a beat, but filebeat/metricbeat seem to reject the enroll command required to register beats. I haven't used these features in quite some time so it's probably better if someone familiar with those beats reviews this functionality anyway.

I believe it only works on 7.x builds? (at least that's what I was using and it worked fine with filebeat 7.3.2).

justinkambic · 2020-05-12T18:30:46Z

I believe it only works on 7.x builds? (at least that's what I was using and it worked fine with filebeat 7.3.2).

Oh ok, that makes sense. I'll re-try this.

joshdover · 2020-05-13T15:20:22Z

@elasticmachine merge upstream

justinkambic · 2020-05-13T19:44:02Z

I performed another smoke test of this patch and was able to configure a Filebeat to watch logs on my system.

joshdover · 2020-05-14T15:50:52Z

@elasticmachine merge upstream

joshdover · 2020-05-14T18:32:58Z

Failing tests are being skipped in #66599

ph

LGTM, I have tested the enroll flow, create configuration, edit configuration, listing all works for both metricbeat and filebeat.

👍

joshdover · 2020-05-14T21:20:44Z

@elasticmachine merge upstream

kibanamachine · 2020-05-14T23:22:34Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: c7597de

History

💔 Build #48005 failed a93b3c0
💚 Build #47697 succeeded 3fbc812
💚 Build #47452 succeeded c25f6ae
💔 Build #47426 failed 67521e7
💚 Build #46798 succeeded d6f416e

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

* master: (191 commits) [Maps] Get number of categories from palette (elastic#66454) move oss features registration to KP (elastic#66524) [kbn/plugin-helpers] typescript-ify (elastic#66513) Add kibana-operations as codeowners for .ci/es-snapshots and vars/ (elastic#66746) FTR: move basic services under common folder (elastic#66563) Migrate Beats Management UI to KP (elastic#65791) [CI] Add 20 minutes to overall build timeout lint import from restricted zones for export exressions (elastic#66588) [SIEM][Detection Engine] Add validation for Rule Actions (elastic#63332) KP plugins shouldn't need package.json (elastic#66654) Replace agent metrics link with the new one (elastic#66632) [CI] Add one retry to setup step (elastic#66638) [CI] Add slack alerts to tracked branch jobs, change default channel, change formatting (elastic#66580) [docLinks] Add docLinks to CoreSetup. (elastic#66631) [DOCS] Rename monitoring collection from internal to legacy (elastic#65781) unskip newsfeed tests (elastic#66562) [NP] Migrate uiSettings owned by Kibana app (elastic#64321) [ML] Functional tests - stabilize typing in DFA mml input (elastic#66706) [Map] return bounding box for static feature collection without joins (elastic#66607) remove trailing slash in graph sample data links (elastic#66358) ...

…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

joshdover added 3 commits May 10, 2020 10:43

Initial working version

04127ae

Move files from legacy

2b0e90b

Fix routing and breadcrumbs

5f540a3

joshdover force-pushed the beats-cm/migrate-ui branch from 103ba46 to 5f540a3 Compare May 10, 2020 16:44

joshdover commented May 10, 2020

View reviewed changes

joshdover added Feature:beats-cm Feature:NP Migration Team:Fleet Team label for Observability Data Collection Fleet team v7.9.0 labels May 10, 2020

joshdover added the release_note:skip Skip the PR/issue when compiling release notes label May 10, 2020

Fix i18nrc

d6f416e

joshdover marked this pull request as ready for review May 10, 2020 19:59

joshdover commented May 10, 2020

View reviewed changes

justinkambic approved these changes May 12, 2020

View reviewed changes

x-pack/plugins/beats_management/server/index.ts Show resolved Hide resolved

x-pack/plugins/beats_management/public/lib/compose/kibana.ts Show resolved Hide resolved

mshustov approved these changes May 12, 2020

View reviewed changes

joshdover added 2 commits May 12, 2020 12:21

Remove unused parameters

3a2f86d

Merge remote-tracking branch 'upstream/master' into beats-cm/migrate-ui

67521e7

Fix type errors

c25f6ae

Merge branch 'master' into beats-cm/migrate-ui

3fbc812

joshdover requested a review from ph May 13, 2020 22:05

Merge branch 'master' into beats-cm/migrate-ui

a93b3c0

ph approved these changes May 14, 2020

View reviewed changes

Merge branch 'master' into beats-cm/migrate-ui

c7597de

joshdover merged commit 62e8214 into elastic:master May 15, 2020

joshdover deleted the beats-cm/migrate-ui branch May 15, 2020 16:22

joshdover mentioned this pull request May 15, 2020

[7.x] Migrate Beats Management UI to KP (#65791) #66774

Merged

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

Migrate Beats Management UI to KP (elastic#65791)

48718f3

cjcenizal pushed a commit that referenced this pull request May 15, 2020

[7.x] Migrate Beats Management UI to KP (#65791) (#66774)

db807df

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate Beats Management UI to KP #65791

Migrate Beats Management UI to KP #65791

joshdover commented May 7, 2020 •

edited

Loading

joshdover May 10, 2020

joshdover May 10, 2020

joshdover May 10, 2020

elasticmachine commented May 10, 2020

joshdover May 10, 2020

justinkambic commented May 11, 2020

joshdover commented May 11, 2020

justinkambic left a comment

mshustov May 12, 2020

joshdover May 12, 2020

mshustov May 12, 2020

joshdover May 12, 2020

joshdover May 12, 2020

joshdover commented May 12, 2020

justinkambic commented May 12, 2020

joshdover commented May 13, 2020

justinkambic commented May 13, 2020

joshdover commented May 14, 2020

joshdover commented May 14, 2020

ph left a comment

joshdover commented May 14, 2020

kibanamachine commented May 14, 2020

Migrate Beats Management UI to KP #65791

Migrate Beats Management UI to KP #65791

Conversation

joshdover commented May 7, 2020 • edited Loading

Summary

Testing

Checklist

For maintainers

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented May 10, 2020

Choose a reason for hiding this comment

justinkambic commented May 11, 2020

joshdover commented May 11, 2020

justinkambic left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joshdover commented May 12, 2020

justinkambic commented May 12, 2020

joshdover commented May 13, 2020

justinkambic commented May 13, 2020

joshdover commented May 14, 2020

joshdover commented May 14, 2020

ph left a comment

Choose a reason for hiding this comment

joshdover commented May 14, 2020

kibanamachine commented May 14, 2020

💚 Build Succeeded

History

joshdover commented May 7, 2020 •

edited

Loading