[Platform Onboarding] Elastic cloud migration assistant page #145523

claracruz · 2022-11-17T10:04:24Z

Summary

This PR adds a new static migration page in self-managed Kibana instances. This page provides self-managed users with a link to migration instructions for migrating their self-managed cluster over to Elastic Cloud.
A new landing page is added to the Management plugin with a page that links to the migration assistant instructions. The url for the new page is /app/management/data/migrate_data.

Release Note

Self-managed Kibana instances now have a link to migration instructions for migrating their self-managed cluster over to Elastic Cloud.

Screenshots

Homepage

Landing page

Checklist

Delete any items that are not applicable to this PR.

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
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

Risk Matrix

Risk	Probability	Severity	Mitigation/Notes
Code should gracefully handle cases when feature X or plugin Y are disabled.	Medium	High	Unit tests will verify that any feature flag or plugin combination still results in our service operational.

alisonelizabeth

Nice work @claracruz! I took a quick look through the code and left some initial comments. Did not test locally, but screenshots look great so far 👍

src/plugins/home/public/application/components/add_data/add_data.tsx

x-pack/plugins/cloud_integrations/cloud_data_migration/kibana.json

x-pack/plugins/cloud_integrations/cloud_data_migration/public/application/components/app.tsx

x-pack/plugins/cloud_integrations/cloud_data_migration/public/plugin.ts

x-pack/plugins/cloud_integrations/cloud_data_migration/public/application/components/app.tsx

x-pack/plugins/cloud_integrations/cloud_data_migration/common/index.ts

x-pack/plugins/cloud_integrations/cloud_data_migration/public/plugin.ts

alisonelizabeth · 2022-11-17T18:32:03Z

x-pack/plugins/cloud_integrations/cloud_data_migration/README.md

@@ -0,0 +1,3 @@
+# Cloud Data Migration


I don't have much context on the cloud_integrations directory in Kibana. Do you know if there are any guidelines on what should live under here?

As far as I can tell it seems to be all cloud related implementations. e.g. Gainsight, DriftChat, FullStory, Cloud links e.t.c

johnbarrierwilson · 2022-11-21T21:13:59Z

@claracruz Don't want to do this on your PR myself, but looks like we might need a merge from upstream? I'll be happy to dive in via my local once again when the errors are gone.

johnbarrierwilson · 2022-11-28T22:31:03Z

No worries on the sidebar... that can stay. Could just move the layout to a subdued <EuiPanel color="subdued" /> win the inner content being in a column? Like this:

I'll need to get the writers to do a pass on the content. And, I'll send you a new image, that SVG looks like it got corrupt when I compressed it.

johnbarrierwilson · 2022-11-28T22:35:06Z

Here's the updated image. SVG export was causing problems, so I just did so with PNG.

kellyemurphy

@claracruz hope it's ok I'm adding my changes this way. There are a couple that I'd like to get input on still.

src/plugins/home/public/application/components/add_data/add_data.tsx

x-pack/plugins/cloud_integrations/cloud_data_migration/public/application/components/app.tsx

alisonelizabeth · 2022-12-05T18:44:13Z

@elasticmachine merge upstream

alisonelizabeth

Hey @claracruz! This looks really great. I tested locally, and left a couple more comments in the code.

I also updated your branch and reviewed the CI errors. A couple things:

I think you need to add a .i18nrc.json file to your plugin for translations. It should look something like this:

{
  "prefix": "cloudDataMigration",
  "paths": {
    "cloudDataMigration": "."
  },
  "translations": []
}

Then, you will also need to update the ids of any i18n strings. You can run node scripts/i18n_check.js to verify translations when you're done.

You need to update the limits.yml file since this is a new plugin. To do so, you can run:

node scripts/build_kibana_platform_plugins.js --update-limits

You need to update some jest snapshots in thehome plugin. It looks like the failing tests are in: src/plugins/home/public/application/components/add_data/add_data.test.tsx
The plugin.test.ts tests are also failing. You can run jest tests in kibana via: npm run test:jest <path_to_test_file>
There appears to be a handful of functional tests that rely on the side nav in Stack Management to be in a particular order. Now that the "Migrate" link has been added, those are failing. There's quite a few here, so let me know if you need help going through them all. More about Kibana testing here - https://www.elastic.co/guide/en/kibana/current/development-tests.html.
There's another CI error that appears related to the cloud_integrations directory. I'm not sure about this one yet. Let's resolve all the other issues first, and if it's still an issue, I can help revisit.

ERROR Error: ENOENT: no such file or directory, stat '/dev/shm/builds/kb-n2-16-spot-721a7f5a24dec03f/elastic/kibana-pull-request/kibana/x-pack/plugins/cloud_integrations/features/tsconfig.json'

x-pack/plugins/cloud_integrations/cloud_data_migration/public/application/components/app.tsx

x-pack/plugins/cloud_integrations/cloud_data_migration/public/plugin.ts

src/plugins/home/public/application/components/add_data/add_data.tsx

x-pack/plugins/cloud_integrations/cloud_data_migration/public/application/components/app.tsx

alisonelizabeth · 2022-12-05T19:47:20Z

@claracruz let's also not forget about the telemetry requirements. We can discuss more offline, but just leaving a comment here so I don't forget 😄

gchaps · 2022-12-12T16:49:45Z

@claracruz Can you please post screenshots with the updated text? I'll do a final copy review.

Build migration info page Update home page navigation Implemment breadcrumbs Remove unneeded typings Remove unneeded code and comments Fix breadcrumb Remove unnecessary component Fix newline at the end of files Update breadcrumb label

Update tests, styles and images Update copy

…ocs'

…-fix'

elasticmachine · 2022-12-13T19:21:33Z

Pinging @elastic/platform-onboarding (Team:Journey/Onboarding)

alisonelizabeth

Awesome work @claracruz! I opened #147474 and #147462 to track some follow-up work.

We should also update the CODEOWNERS file and assign our team as owner of this new plugin. I can open up a separate PR to address that.

alisonelizabeth · 2022-12-13T19:21:18Z

x-pack/plugins/cloud_integrations/cloud_data_migration/public/application/components/app.tsx

+          <EuiSpacer size="l" />
+
+          <div>
+            <EuiButton fill={true} target="_blank" href="https://ela.st/cloud-migration">


We'll want to track telemetry here; opened #147474 to follow up.

alisonelizabeth · 2022-12-13T19:22:31Z

x-pack/plugins/cloud_integrations/cloud_data_migration/server/plugin.ts

+      management: {
+        data: [PLUGIN_ID],
+      },
+      catalogue: [PLUGIN_ID],


I don't think this is required. I'll open up a follow-up PR to fix.

alisonelizabeth · 2022-12-13T19:25:57Z

Hi @gchaps, here are the latest screenshots. Let us know if there are any further copy changes that need to be made. Thank you!

gchaps

Copy LGTM.

kc13greiner

LGTM!

alisonelizabeth · 2022-12-15T00:12:44Z

@elasticmachine merge upstream

kibana-ci · 2022-12-15T01:12:49Z

💚 Build Succeeded

Buildkite Build
Commit: eb73153

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`cloudDataMigration`	-	9	+9

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
`cloudDataMigration`	-	7	+7

Any counts in public APIs

Total count of every any typed public API. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats any for more detailed information.

id	before	after	diff
`cloudDataMigration`	-	1	+1

Async chunks

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

id	before	after	diff
`cloudDataMigration`	-	3.8KB	+3.8KB
`home`	160.0KB	161.3KB	+1.3KB
total			+5.0KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`cloudDataMigration`	-	1	+1

Page load bundle

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

id	before	after	diff
`cloudDataMigration`	-	4.1KB	+4.1KB

Unknown metric groups

API count

id	before	after	diff
`cloudDataMigration`	-	7	+7

async chunk count

id	before	after	diff
`cloudDataMigration`	-	1	+1

ESLint disabled in files

id	before	after	diff
`osquery`	1	2	+1

ESLint disabled line counts

id	before	after	diff
`cloudDataMigration`	-	1	+1
`enterpriseSearch`	19	21	+2
`fleet`	61	67	+6
`home`	9	10	+1
`osquery`	109	115	+6
`securitySolution`	445	451	+6
total			+22

Total ESLint disabled count

id	before	after	diff
`cloudDataMigration`	-	1	+1
`enterpriseSearch`	20	22	+2
`fleet`	70	76	+6
`home`	10	11	+1
`osquery`	110	117	+7
`securitySolution`	521	527	+6
total			+23

History

💚 Build #94181 succeeded 112bee0
💔 Build #94152 failed f16871f872b211155fcfcce57eaae6b531e5fa86
💔 Build #94149 failed e09849a56bbe0704d48466ca8c56eee368be6dfd
💔 Build #94129 failed 6b67efd5f51f69e696b9c7f3fcd3a0be130b8c96
💔 Build #94101 failed 3d4818a1408e2c4d063ddda7c9714b8e92b7b04d
💔 Build #93661 failed b3e7f6c

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

pgayvallet

ATM all plugins under /x-pack/plugins/cloud_integrations/ are identified as being owned by Core (which is also what triggered the review from our team):

kibana/.github/CODEOWNERS

Line 313 in 3e49992

/x-pack/plugins/cloud_integrations/ @elastic/kibana-core

I think you may need to change that, as I assume Core isn't supposed to be owning the new plugin you're introducing in this PR, right?

vadimkibana

GX code changes LGTM.

alisonelizabeth · 2022-12-15T16:45:22Z

I think you may need to change that, as I assume Core isn't supposed to be owning the new plugin you're introducing in this PR, right?

@pgayvallet Ah, I didn't realize that there was already an existing owner for that directory. Thanks for pointing that out. I made a comment in #145523 (review) that the CODEOWNERS file needs to be updated.

Would it be OK if I follow up with this change in a separate PR? The engineer who opened this is out until January and I would like to get this merged if possible.

pgayvallet

LGTM

claracruz force-pushed the elastic_cloud_migration_assistant_info_page branch from eb1453a to 8243bc5 Compare November 17, 2022 10:15

alisonelizabeth reviewed Nov 17, 2022

View reviewed changes

claracruz force-pushed the elastic_cloud_migration_assistant_info_page branch from 6147189 to 74f0a51 Compare November 28, 2022 12:02

kellyemurphy reviewed Nov 30, 2022

View reviewed changes

claracruz force-pushed the elastic_cloud_migration_assistant_info_page branch from 6085a46 to cf1602f Compare November 30, 2022 16:10

alisonelizabeth added the Team:Journey/Onboarding Platform Journey Onboarding team label Nov 30, 2022

claracruz added v8.6.0 release_note:feature Makes this part of the condensed release notes labels Dec 5, 2022

claracruz changed the title ~~[Platform Onboarding] Elastic cloud migration assistant info page~~ [Platform Onboarding] Elastic cloud migration assistant page Dec 5, 2022

claracruz added v8.7.0 and removed v8.6.0 labels Dec 5, 2022

claracruz force-pushed the elastic_cloud_migration_assistant_info_page branch from 2795c8c to 9cdf0ae Compare December 5, 2022 17:02

alisonelizabeth reviewed Dec 5, 2022

View reviewed changes

claracruz force-pushed the elastic_cloud_migration_assistant_info_page branch 3 times, most recently from b3e7f6c to 3d4818a Compare December 12, 2022 16:42

claracruz added 8 commits December 12, 2022 18:47

Implement cloud migration assistant info page

37bda8f

Build migration info page Update home page navigation Implemment breadcrumbs Remove unneeded typings Remove unneeded code and comments Fix breadcrumb Remove unnecessary component Fix newline at the end of files Update breadcrumb label

Updates per review - apply cloud enabled condition

cf0ca60

Update tests, styles and images Update copy

Update copy pt.2

744cd78

Apply migration link

546de26

Updates per review

ed848fe

Fix CI errors

f046dfe

Apply security privileges

2589118

Update tsconfig.json for server

56880df

Fix CI errors

c7ebadc

claracruz force-pushed the elastic_cloud_migration_assistant_info_page branch from 6b67efd to c7ebadc Compare December 12, 2022 18:49

Fix CI errors - Jest and ui capabilities

c63cb0f

claracruz force-pushed the elastic_cloud_migration_assistant_info_page branch from f16871f to c63cb0f Compare December 12, 2022 20:17

kibanamachine added 2 commits December 12, 2022 20:26

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

0932bad

…ocs'

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

112bee0

…-fix'

alisonelizabeth marked this pull request as ready for review December 13, 2022 19:21

alisonelizabeth requested review from a team as code owners December 13, 2022 19:21

alisonelizabeth approved these changes Dec 13, 2022

View reviewed changes

alisonelizabeth requested a review from gchaps December 13, 2022 19:26

gchaps approved these changes Dec 13, 2022

View reviewed changes

jbudz approved these changes Dec 13, 2022

View reviewed changes

kc13greiner approved these changes Dec 14, 2022

View reviewed changes

Merge branch 'main' into elastic_cloud_migration_assistant_info_page

eb73153

pgayvallet reviewed Dec 15, 2022

View reviewed changes

vadimkibana approved these changes Dec 15, 2022

View reviewed changes

pgayvallet approved these changes Dec 16, 2022

View reviewed changes

alisonelizabeth merged commit e868b3a into elastic:main Dec 16, 2022

kibanamachine added the backport:skip This commit does not require backporting label Dec 16, 2022

alisonelizabeth mentioned this pull request Dec 16, 2022

[Onboarding] ECMA MVP cleanup #147702

Merged

alisonelizabeth mentioned this pull request Apr 3, 2023

Disable "Migrate" plugin #154265

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Platform Onboarding] Elastic cloud migration assistant page #145523

[Platform Onboarding] Elastic cloud migration assistant page #145523

claracruz commented Nov 17, 2022 •

edited

Loading

alisonelizabeth left a comment

alisonelizabeth Nov 17, 2022

claracruz Nov 28, 2022

johnbarrierwilson commented Nov 21, 2022 •

edited

Loading

johnbarrierwilson commented Nov 28, 2022

johnbarrierwilson commented Nov 28, 2022

kellyemurphy left a comment

alisonelizabeth commented Dec 5, 2022

alisonelizabeth left a comment •

edited

Loading

alisonelizabeth commented Dec 5, 2022

gchaps commented Dec 12, 2022

elasticmachine commented Dec 13, 2022

alisonelizabeth left a comment

alisonelizabeth Dec 13, 2022

alisonelizabeth Dec 13, 2022

alisonelizabeth commented Dec 13, 2022

gchaps left a comment

kc13greiner left a comment

alisonelizabeth commented Dec 15, 2022

kibana-ci commented Dec 15, 2022

API count

async chunk count

ESLint disabled in files

ESLint disabled line counts

Total ESLint disabled count

pgayvallet left a comment •

edited

Loading

vadimkibana left a comment

alisonelizabeth commented Dec 15, 2022 •

edited

Loading

pgayvallet left a comment

[Platform Onboarding] Elastic cloud migration assistant page #145523

[Platform Onboarding] Elastic cloud migration assistant page #145523

Conversation

claracruz commented Nov 17, 2022 • edited Loading

Summary

Release Note

Screenshots

Homepage

Landing page

Checklist

Risk Matrix

alisonelizabeth left a comment

Choose a reason for hiding this comment

alisonelizabeth Nov 17, 2022

Choose a reason for hiding this comment

claracruz Nov 28, 2022

Choose a reason for hiding this comment

johnbarrierwilson commented Nov 21, 2022 • edited Loading

johnbarrierwilson commented Nov 28, 2022

johnbarrierwilson commented Nov 28, 2022

kellyemurphy left a comment

Choose a reason for hiding this comment

alisonelizabeth commented Dec 5, 2022

alisonelizabeth left a comment • edited Loading

Choose a reason for hiding this comment

alisonelizabeth commented Dec 5, 2022

gchaps commented Dec 12, 2022

elasticmachine commented Dec 13, 2022

alisonelizabeth left a comment

Choose a reason for hiding this comment

alisonelizabeth Dec 13, 2022

Choose a reason for hiding this comment

alisonelizabeth Dec 13, 2022

Choose a reason for hiding this comment

alisonelizabeth commented Dec 13, 2022

gchaps left a comment

Choose a reason for hiding this comment

kc13greiner left a comment

Choose a reason for hiding this comment

alisonelizabeth commented Dec 15, 2022

kibana-ci commented Dec 15, 2022

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Any counts in public APIs

Async chunks

Public APIs missing exports

Page load bundle

API count

async chunk count

ESLint disabled in files

ESLint disabled line counts

Total ESLint disabled count

History

pgayvallet left a comment • edited Loading

Choose a reason for hiding this comment

vadimkibana left a comment

Choose a reason for hiding this comment

alisonelizabeth commented Dec 15, 2022 • edited Loading

pgayvallet left a comment

Choose a reason for hiding this comment

claracruz commented Nov 17, 2022 •

edited

Loading

johnbarrierwilson commented Nov 21, 2022 •

edited

Loading

alisonelizabeth left a comment •

edited

Loading

pgayvallet left a comment •

edited

Loading

alisonelizabeth commented Dec 15, 2022 •

edited

Loading