Introduce `preboot` lifecycle stage #103636

azasypkin · 2021-06-29T10:32:18Z

Summary

Implementation of the "RFC: Kibana preboot lifecycle stage.".

How to test

$ yarn start --plugin-path examples/preboot_example/ --prebootExample.enabled=true

Note to reviewers

Real preboot plugin will be implemented in the scope of #104068 and #102538.

In this PR I tried to write and update as much tests as it was feasible, and I'm planning to introduce a set of API integration and functional tests once we have a real preboot plugin (interactive setup mode #104068).

RFC: #99318.

elasticmachine · 2021-07-12T07:37:56Z

Pinging @elastic/kibana-core (Team:Core)

azasypkin · 2021-07-15T14:24:06Z

Okay, I think I've replied to all you comments and handled everything that we already agreed on @pgayvallet @mshustov. There are three major potential improvements left that I've put proposals for (for this PR or follow-ups if it's OK for you), let me know what you think.

Splitting of PluginWrapper Introduce preboot lifecycle stage #103636 (comment) (proposed to move to follow-up)
~~Ditching of the default UISettingsClient Introduce preboot lifecycle stage #103636 (comment)~~ (resolved in c3b8ede)
~~Changing the shape of the config in the ElasticsearchService preboot contract Introduce preboot lifecycle stage #103636 (comment)~~ (resolved in ded628f)

Thanks!

…gins.

joshdover

I haven't given this a thorough review, but I will rely on Pierre and Mikhail here as I already reviewed the RFC. I do have one comment regarding the testing of PluginsService but otherwise, LGTM

src/core/server/plugins/plugins_service.test.ts

legrego

Security changes LGTM, core changes are well-aligned with RFC, and all works as expected when testing locally -- nice work!

src/core/server/plugins/plugins_service.ts

src/core/server/preboot/types.ts

legrego · 2021-07-19T12:52:35Z

src/core/server/elasticsearch/elasticsearch_service.ts

+        credentialsSpecified:
+          config.username !== undefined ||
+          config.password !== undefined ||
+          config.serviceAccountToken !== undefined,


question should we check for a client certificate here? If Kibana is configured for PKI-based auth, then checking for username, password, and serviceAccountToken would miss this

I was thinking we could just do something like this to cover PKI case since for PKI we'd need https or I'm missing something?

const noPKI = core.elasticsearch.config.hosts.length === 1 && core.elasticsearch.config.hosts[0] === 'http://localhost:9200';

http://localhost:9200 is a default, and if we have anything in hosts except for this default I believe we'll have to skip user setup (including PKI case).

Yeah something like that could work. I was thinking about this in isolation, not about the bigger picture of "interactive setup mode". Someone looking at this config option might not understand that PKI-based credentials aren't considered as part of credentialsSpecified. I'm happy to ignore this for now, as we don't have an explicit need for this.

nchaulet

Fleet changes 🚀

kibanamachine · 2021-07-19T15:35:54Z

💚 Build Succeeded

Metrics [docs]

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
`core`	1071	1079	+8

Unknown metric groups

API count

id	before	after	diff
`core`	2328	2358	+30

History

💚 Build #139318 succeeded 89ffdb8
💚 Build #139111 succeeded ac78c45
💚 Build #138986 succeeded f3ed02d
💚 Build #138709 succeeded 53662b8
💚 Build #138697 succeeded 496edc5

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

cc @azasypkin

kibanamachine · 2021-07-20T04:54:59Z

💔 Backport failed

Status	Branch	Result
❌	7.x	Commit could not be cherrypicked due to conflicts

To backport manually run:
node scripts/backport --pr 103636

# Conflicts: # .github/CODEOWNERS # src/core/server/ui_settings/ui_settings_service.ts

…y-show-migrate-to-authzd-users * 'master' of github.com:elastic/kibana: (187 commits) Space management page UX improvements (elastic#100448) [Reporting] Unskip flaky test when downloading CSV with "no data" (elastic#105252) Update dependency @elastic/charts to v33 (master) (elastic#105633) [Observability RAC] Improve alerts table columns (elastic#105446) Introduce `preboot` lifecycle stage (elastic#103636) [Security Solution] Invalid kql query timeline refresh bug (elastic#105525) skip flaky suite (elastic#106121) [Security Solution][Endpoint] Fix UI inconsistency between isolation forms and remove display of Pending isolation statuses (elastic#106118) docs: APM RUM Source map API (elastic#105332) [CTI] Adds indicator match rule improvements (elastic#97310) [Security Solution] update text for Isolation action submissions (elastic#105956) EP Meta Telemetry Perf (elastic#104396) [Metrics UI] Drop partial buckets from ALL Metrics UI queries (elastic#104784) Remove beta admonitions for Fleet docs (elastic#106010) [Observability RAC] Remove indexing of rule evaluation documents (elastic#104970) Parameterize migration test for kibana version (elastic#105417) [Alerting] Allow rule to execute if the value is 0 and that mets the condition (elastic#105626) [ML] Fix Index data visualizer sometimes shows wrong doc count for saved searches (elastic#106007) [Security Solution] UX fixes for Policy page and Case Host Isolation comment (elastic#106027) [Security Solution]Memory protection configuration card for policies integration. (elastic#101365) ... # Conflicts: # x-pack/plugins/reporting/public/management/report_listing.test.tsx # x-pack/plugins/reporting/public/management/report_listing.tsx

azasypkin self-assigned this Jul 1, 2021

azasypkin mentioned this pull request Jul 1, 2021

Interactive setup mode server-side functionality #104068

Closed

15 tasks

azasypkin force-pushed the issue-xxx-preboot-poc branch 2 times, most recently from c1ac601 to a608397 Compare July 5, 2021 13:04

azasypkin removed the release_note:breaking label Jul 5, 2021

azasypkin force-pushed the issue-xxx-preboot-poc branch 11 times, most recently from 7962391 to af0a654 Compare July 9, 2021 09:29

Implement preboot lifecycle stage.

6751a1c

azasypkin force-pushed the issue-xxx-preboot-poc branch from af0a654 to 6751a1c Compare July 12, 2021 05:21

azasypkin marked this pull request as ready for review July 12, 2021 07:37

azasypkin requested review from a team as code owners July 12, 2021 07:37

Update example plugin and code ownership.

ef6b84d

azasypkin added 4 commits July 15, 2021 09:51

Review#1: dont try to stop preboot plugins system twice.

36f6eef

Review#1: dont try to stop preboot HTTP server twice.

d90a252

Update latest ingegration tests from upstream.

496edc5

Add basic preboot HTTP server intergration tests.

53662b8

azasypkin requested review from pgayvallet and mshustov July 15, 2021 14:24

azasypkin added 4 commits July 16, 2021 08:23

Review#2: limit a number of ES config fields we expose to preboot plu…

ded628f

…gins.

Review#2: implement UiSettingsDefaultsClient.

c3b8ede

Review#2: skip plugin start if config.initialize is not set.

f3ed02d

Merge branch 'master' into issue-xxx-preboot-poc

5a04d48

joshdover approved these changes Jul 16, 2021

View reviewed changes

src/core/server/plugins/plugins_service.test.ts Outdated Show resolved Hide resolved

azasypkin added 2 commits July 16, 2021 17:38

Review#3: improve PluginsService tests.

ac78c45

Merge branch 'master' into issue-xxx-preboot-poc

89ffdb8

legrego reviewed Jul 19, 2021

View reviewed changes

Review#3: fix typos in docs and error message.

2d27ce4

nchaulet approved these changes Jul 19, 2021

View reviewed changes

legrego approved these changes Jul 19, 2021

View reviewed changes

azasypkin added auto-backport Deprecated - use backport:version if exact versions are needed v7.15.0 and removed backport:skip This commit does not require backporting labels Jul 20, 2021

azasypkin merged commit 237256a into elastic:master Jul 20, 2021

azasypkin deleted the issue-xxx-preboot-poc branch July 20, 2021 04:52

azasypkin mentioned this pull request Jul 20, 2021

[7.x] Introduce preboot lifecycle stage (#103636) #106194

Merged

azasypkin added a commit that referenced this pull request Jul 20, 2021

Introduce preboot lifecycle stage (#103636) (#106194)

9aa5c80

# Conflicts: # .github/CODEOWNERS # src/core/server/ui_settings/ui_settings_service.ts

azasypkin mentioned this pull request Jul 20, 2021

Improve integration between PluginSystem and PluginWrapper for preboot and standard plugins. #106218

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce `preboot` lifecycle stage #103636

Introduce `preboot` lifecycle stage #103636

azasypkin commented Jun 29, 2021 •

edited

Loading

elasticmachine commented Jul 12, 2021

azasypkin commented Jul 15, 2021 •

edited

Loading

joshdover left a comment

legrego left a comment

legrego Jul 19, 2021

azasypkin Jul 19, 2021 •

edited

Loading

legrego Jul 19, 2021

nchaulet left a comment

kibanamachine commented Jul 19, 2021

API count

kibanamachine commented Jul 20, 2021

Introduce preboot lifecycle stage #103636

Introduce preboot lifecycle stage #103636

Conversation

azasypkin commented Jun 29, 2021 • edited Loading

Summary

How to test

Note to reviewers

elasticmachine commented Jul 12, 2021

azasypkin commented Jul 15, 2021 • edited Loading

joshdover left a comment

Choose a reason for hiding this comment

legrego left a comment

Choose a reason for hiding this comment

legrego Jul 19, 2021

Choose a reason for hiding this comment

azasypkin Jul 19, 2021 • edited Loading

Choose a reason for hiding this comment

legrego Jul 19, 2021

Choose a reason for hiding this comment

nchaulet left a comment

Choose a reason for hiding this comment

kibanamachine commented Jul 19, 2021

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

API count

History

kibanamachine commented Jul 20, 2021

💔 Backport failed

Introduce `preboot` lifecycle stage #103636

Introduce `preboot` lifecycle stage #103636

azasypkin commented Jun 29, 2021 •

edited

Loading

azasypkin commented Jul 15, 2021 •

edited

Loading

azasypkin Jul 19, 2021 •

edited

Loading