[Upgrade Assistant] Show on prem backup step when found-snapshots repository not found #121060

sabarasaba · 2021-12-13T10:11:15Z

Summary

As described by ECE-Snapshots docs users might not have snapshots configured by default. The cloud backup step assumes that the installation has it and that the found-snapshots repository exists, as a consequence of this the user will be seeing an error about a missing snapshots repository.

This PR changes the logic of the backup step to detect this edge case and default to the on prem step that will instead render a button that will take the user to the snapshots app.

How to test

Start elasticsearch with yarn es snapshot --license=trial and kibana with yarn start
Change this line so that it negates the first part of the if expression that checks for isCloudEnabled. This will force to load the cloud backup step while working locally.
Navigate to Stack Management -> Upgrade Assistant
Verify that the network request for cloud_backup_status failed and that the backupstep is for on prem

Note: when this PR is merged, I'll create a new one for getting this change into main and 8.x

Screenshots

Error message

elasticmachine · 2021-12-13T11:48:47Z

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

cjcenizal · 2021-12-13T19:41:37Z

...lugins/upgrade_assistant/public/application/components/overview/backup_step/cloud_backup.tsx

 }

+const isMissingFoundSnapshotsRepo = (error: ResponseError) => {
+  return error.statusCode === 404 && error.message === `[${CLOUD_SNAPSHOT_REPOSITORY}] missing`;


Nit: can we future-proof this by checking that the message includes the CLOUD_SNAPSHOT_REPOSITORY instead of comparing against the entire string? If it's a 404 then I think this would be sufficient to infer that the repository is missing, without depending upon the specific language ES is using to communicate this.

I think even safer would be to add a test for how missing repo error is returned to UA api integration tests here.

Thanks both for having a look! I've updated this function to check if the message includes the repo name instead of matching against the entire string as suggested.

yuliacech

Thanks a lot for fixing this step for ECE, @sabarasaba!
I tested locally with xpack.cloud.id: 'test' in kibana.dev.yml file. The missing repo error was shown in the network tab and the correct on prem backup was displayed in the UI, great job 👍

…d of the full message

sabarasaba · 2021-12-15T13:29:18Z

@elasticmachine merge upstream

…ng_foundsnapshots

kibana-ci · 2021-12-15T14:56:52Z

💚 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`	127.9KB	128.1KB	+187.0B

Page load bundle

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

id	before	after	diff
`upgradeAssistant`	18.2KB	18.3KB	+54.0B

History

💚 Build #13323 succeeded 8155336
💚 Build #12767 succeeded ea367ae

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

cc @sabarasaba

…ository not found (elastic#121060) * Show on prem stem when in cloud and missing found snapshots * Remove test code * Lets match against the error containing the missing repository instead of the full message Co-authored-by: Kibana Machine <[email protected]>

…shots repository not found (#121375) * [Upgrade Assistant] Show on prem backup step when found-snapshots repository not found (#121060) * Show on prem stem when in cloud and missing found snapshots * Remove test code * Lets match against the error containing the missing repository instead of the full message Co-authored-by: Kibana Machine <[email protected]> * commit using @elastic.co Co-authored-by: Kibana Machine <[email protected]>

…shots repository not found (elastic#121375) * [Upgrade Assistant] Show on prem backup step when found-snapshots repository not found (elastic#121060) * Show on prem stem when in cloud and missing found snapshots * Remove test code * Lets match against the error containing the missing repository instead of the full message Co-authored-by: Kibana Machine <[email protected]> * commit using @elastic.co Co-authored-by: Kibana Machine <[email protected]>

…shots repository not found (#121375) (#121450) * [Upgrade Assistant] Show on prem backup step when found-snapshots repository not found (#121060) * Show on prem stem when in cloud and missing found snapshots * Remove test code * Lets match against the error containing the missing repository instead of the full message Co-authored-by: Kibana Machine <[email protected]> * commit using @elastic.co Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Ignacio Rivas <[email protected]>

Show on prem stem when in cloud and missing found snapshots

2ea3ff4

sabarasaba added Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more release_note:skip Skip the PR/issue when compiling release notes Feature:Upgrade Assistant backport:skip This commit does not require backporting v7.16.2 labels Dec 13, 2021

sabarasaba self-assigned this Dec 13, 2021

Remove test code

ea367ae

sabarasaba changed the title ~~[Upgrade Assistant] Show on prem backupstep if snapshots are disabled~~ [Upgrade Assistant] Show on prem backupstep when found-snapshots repository not found Dec 13, 2021

sabarasaba changed the title ~~[Upgrade Assistant] Show on prem backupstep when found-snapshots repository not found~~ [Upgrade Assistant] Show on prem backup step when found-snapshots repository not found Dec 13, 2021

sabarasaba requested a review from yuliacech December 13, 2021 11:48

sabarasaba marked this pull request as ready for review December 13, 2021 11:48

cjcenizal reviewed Dec 13, 2021

View reviewed changes

yuliacech approved these changes Dec 14, 2021

View reviewed changes

Lets match against the error containing the missing repository instea…

8155336

…d of the full message

Merge branch '7.16' into ua/show_on_prem_step_when_in_cloud_and_missi…

8af28f2

…ng_foundsnapshots

sabarasaba merged commit c0f2974 into elastic:7.16 Dec 16, 2021

sabarasaba mentioned this pull request Dec 16, 2021

[Upgrade Assistant] Backport show on prem backup step when found-snapshots repository not found #121375

Merged

cjcenizal added the NeededFor:Cloud label Mar 7, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Upgrade Assistant] Show on prem backup step when found-snapshots repository not found #121060

[Upgrade Assistant] Show on prem backup step when found-snapshots repository not found #121060

sabarasaba commented Dec 13, 2021 •

edited

Loading

elasticmachine commented Dec 13, 2021

cjcenizal Dec 13, 2021 •

edited

Loading

yuliacech Dec 14, 2021

sabarasaba Dec 15, 2021

yuliacech left a comment

sabarasaba commented Dec 15, 2021

kibana-ci commented Dec 15, 2021

[Upgrade Assistant] Show on prem backup step when found-snapshots repository not found #121060

[Upgrade Assistant] Show on prem backup step when found-snapshots repository not found #121060

Conversation

sabarasaba commented Dec 13, 2021 • edited Loading

Summary

elasticmachine commented Dec 13, 2021

cjcenizal Dec 13, 2021 • edited Loading

Choose a reason for hiding this comment

yuliacech Dec 14, 2021

Choose a reason for hiding this comment

sabarasaba Dec 15, 2021

Choose a reason for hiding this comment

yuliacech left a comment

Choose a reason for hiding this comment

sabarasaba commented Dec 15, 2021

kibana-ci commented Dec 15, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

History

sabarasaba commented Dec 13, 2021 •

edited

Loading

cjcenizal Dec 13, 2021 •

edited

Loading