[Upgrade Assistant] Create new status endpoint #105998

alisonelizabeth · 2021-07-16T17:01:01Z

This PR creates a new status API that cloud can use to fetch the upgrade status for Kibana and ES.

Example responses:

GET /api/upgrade_assistant/status

{
  "readyForUpgrade": false,
  "details": "You have 3 Elasticsearch deprecation issues and 2 Kibana deprecation issues that must be resolved before upgrading."
}

{
  "readyForUpgrade": true,
   "details": "All deprecation issues have been resolved."
}

Note: GET /api/upgrade_assistant/status previously returned the list of ES deprecations, this route has been renamed to GET /api/upgrade_assistant/es_deprecations.

…atus_endpoint

elasticmachine · 2021-07-27T18:05:23Z

Pinging @elastic/kibana-stack-management (Team:Stack Management)

sabarasaba

Thanks for working this out @alisonelizabeth! Stack management changes lgtm. Tested locally and code looks good. Left a non-blocking suggestion of adding a few more tests for the getKibanaUpgradeStatus function.

sabarasaba · 2021-07-28T07:08:28Z

x-pack/plugins/upgrade_assistant/server/lib/kibana_status.ts

+import { DeprecationsServiceStart, IScopedClusterClient } from 'kibana/server';
+import { DomainDeprecationDetails, SavedObjectsClientContract } from 'src/core/server/types';
+
+export const getKibanaUpgradeStatus = async ({


Should we add some tests for this the same way we have for es_deprecation_status?

joshdover · 2021-07-28T12:47:31Z

src/core/server/deprecations/deprecations_service.ts

+      getAllDeprecations: (dependencies: GetDeprecationsContext) =>
+        this.deprecationsFactory.getAllDeprecations(dependencies),
+    };


Instead of requiring the calling plugin to provide these dependencies, I think we should add this to our RequestHandlerContext and automatically wire up the ES client and SO client for the current request. This would be more in line with how we expose other services.

The type for RequestHandlerContext is defined in src/core/server/index.ts and implementation for our context provider is available in src/core/server/core_route_handler_context.ts. I'd expect that we add a new deprecations key under RequestHandlerContext['core'] and use the lazy-instantiation approach we're using for the other clients in the implementation.

If we go with this approach, I don't believe we'll need to expose this 'raw' API to plugins and can keep this API internal (don't include it in plugin_context.ts).

👍 Thanks @joshdover for the feedback! Can you let me know if this is what you had in mind: 993773e? I will follow up with updating tests and docs in a separate commit if you're happy with the approach.

Yep, this looks perfect! Feel free to ping me again when the tests are in place. Thanks for this!

Bamieh · 2021-07-28T13:48:57Z

x-pack/test/api_integration/apis/upgrade_assistant/upgrade_assistant.ts

+        // We're not able to easily test different upgrade status scenarios (there are tests with mocked data to handle this)
+        // so, for now, we simply verify the response returns the expected format
+        expectedResponseKeys.forEach((key) => {
+          expect(body[key]).to.not.equal(undefined);


Nit; maybe we can test the kibana status at least? we have a core_deprecations functional plugin in test/plugin_functional/plugins/core_plugin_deprecations which we can use to test this endpoint in test/plugin_functional/test_suites/upgrade_assistant

Bamieh

LGTM with 1 nit about testing the endpoint

…atus_endpoint

alisonelizabeth · 2021-08-05T00:27:58Z

Hi @joshdover! Would you mind taking another look at this PR when you get a chance? Cleaned up a few things and updated the tests and docs.

joshdover

Needs a couple more tests and we should be good!

joshdover · 2021-08-05T16:23:30Z

src/core/server/core_route_handler_context.ts

  }
 }

+class CoreDeprecationsRouteHandlerContext {


Can we update src/core/server/core_route_handler_context.test.ts to include tests for this?

joshdover · 2021-08-05T16:23:55Z

src/core/server/deprecations/deprecations_service.ts

-  public start() {}
+  public start(): InternalDeprecationsServiceStart {
+    return {
+      asScopedToClient: this.createScopedDeprecations(),


Needs unit test

Added test via da04f4b. Let me know if you think there should be anything more tested here.

alisonelizabeth · 2021-08-09T00:02:55Z

@elasticmachine merge upstream

alisonelizabeth · 2021-08-09T00:09:57Z

@joshdover Added some additional tests via da04f4b. Let me know what you think. Thanks!

alisonelizabeth · 2021-08-11T00:35:18Z

@elasticmachine merge upstream

Bamieh · 2021-08-13T10:15:32Z

@elasticmachine merge upstream

alisonelizabeth · 2021-08-13T12:34:18Z

Waiting to merge until @tobio can take a look and verify this doesn't break anything on the cloud side.

alisonelizabeth · 2021-08-15T23:28:41Z

@elasticmachine merge upstream

kibanamachine · 2021-08-16T01:52:28Z

💚 Build Succeeded

Metrics [docs]

Async chunks

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

id	before	after	diff
`upgradeAssistant`	159.8KB	159.8KB	+9.0B

Unknown metric groups

API count

id	before	after	diff
`core`	2442	2444	+2

API count missing comments

id	before	after	diff
`core`	1165	1166	+1

History

💚 Build #145138 succeeded 41fcc21
💚 Build #144270 succeeded dcd2e44
💚 Build #143541 succeeded 7305dae
💚 Build #143423 succeeded da04f4b
💚 Build #143085 succeeded 7a3b381

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

create new status endpoint

4419278

alisonelizabeth added v8.0.0 Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more t// release_note:skip Skip the PR/issue when compiling release notes Feature:Upgrade Assistant v7.15.0 labels Jul 16, 2021

alisonelizabeth added 6 commits July 16, 2021 15:30

fix CI errors

bbc9ff1

add back es_deprecation_status tests

fea9403

update tests

0ca2145

Merge branch 'master' of https://github.com/elastic/kibana into ua/st…

9b96947

…atus_endpoint

fix merge conflicts

271f7dd

cleanup

487a3c4

alisonelizabeth marked this pull request as ready for review July 27, 2021 18:05

alisonelizabeth requested review from a team as code owners July 27, 2021 18:05

alisonelizabeth requested review from Bamieh, beiske and sabarasaba July 27, 2021 18:05

sabarasaba approved these changes Jul 28, 2021

View reviewed changes

joshdover suggested changes Jul 28, 2021

View reviewed changes

Bamieh reviewed Jul 28, 2021

View reviewed changes

Bamieh approved these changes Jul 28, 2021

View reviewed changes

alisonelizabeth added 5 commits July 29, 2021 13:36

partially address review feedback from core

993773e

Merge branch 'master' of https://github.com/elastic/kibana into ua/st…

2d48a97

…atus_endpoint

cleanup/update tests

afa6813

Merge branch 'master' of https://github.com/elastic/kibana into ua/st…

c128738

…atus_endpoint

update docs

7a3b381

joshdover suggested changes Aug 5, 2021

View reviewed changes

add additional tests

da04f4b

Merge branch 'master' into ua/status_endpoint

7305dae

Merge branch 'master' into ua/status_endpoint

dcd2e44

joshdover approved these changes Aug 12, 2021

View reviewed changes

Merge branch 'master' into ua/status_endpoint

41fcc21

alisonelizabeth requested a review from tobio August 13, 2021 12:33

Merge branch 'master' into ua/status_endpoint

5ef1db0

alisonelizabeth merged commit 650f45b into elastic:master Aug 16, 2021

alisonelizabeth deleted the ua/status_endpoint branch August 16, 2021 12:50

alisonelizabeth mentioned this pull request Aug 16, 2021

[7.x] [Upgrade Assistant] Create new status endpoint (#105998) #108687

Merged

alisonelizabeth added a commit to alisonelizabeth/kibana that referenced this pull request Aug 16, 2021

[Upgrade Assistant] Create new status endpoint (elastic#105998)

82bc0a7

alisonelizabeth added a commit that referenced this pull request Aug 16, 2021

[Upgrade Assistant] Create new status endpoint (#105998) (#108687)

58ad478

alisonelizabeth mentioned this pull request Aug 16, 2021

[Upgrade Assistant] Overview page redesign #106521

Merged

[Upgrade Assistant] Create new status endpoint #105998

[Upgrade Assistant] Create new status endpoint #105998

Uh oh!

Conversation

alisonelizabeth commented Jul 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

elasticmachine commented Jul 27, 2021

Uh oh!

sabarasaba left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Bamieh left a comment

Choose a reason for hiding this comment

Uh oh!

alisonelizabeth commented Aug 5, 2021

Uh oh!

joshdover left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alisonelizabeth commented Aug 9, 2021

Uh oh!

alisonelizabeth commented Aug 9, 2021

Uh oh!

alisonelizabeth commented Aug 11, 2021

Uh oh!

Bamieh commented Aug 13, 2021

Uh oh!

alisonelizabeth commented Aug 13, 2021

Uh oh!

alisonelizabeth commented Aug 15, 2021

Uh oh!

kibanamachine commented Aug 16, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

API count

API count missing comments

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

alisonelizabeth commented Jul 16, 2021 •

edited

Loading