Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Fleet] Refactor package installation / upgrade / downgrade and error recovery / rollback #82007

Closed
skh opened this issue Oct 29, 2020 · 2 comments · Fixed by #150444
Closed

[Fleet] Refactor package installation / upgrade / downgrade and error recovery / rollback #82007

skh opened this issue Oct 29, 2020 · 2 comments · Fixed by #150444
Assignees
@juliaElastic
Labels
Feature:EPM Fleet team's Elastic Package Manager (aka Integrations) project Feature:Fleet Fleet team's agent central management project Team:Fleet Team label for Observability Data Collection Fleet team technical debt Improvement of the software architecture and operational architecture

Comments

@skh
Copy link
Contributor

skh commented Oct 29, 2020 •
edited
Loading

Currently, direct package upload only allows the fresh installation of packages. It should support the same functionality of reinstalling, upgrading and downgrading packages as installation from the registry does. This logic is currently implemented in both installPackageFromRegistry() (full functionality) and installPackageByUpload() (install only) and should be factored out to a separate function.
Related files:

  • server/services/epm/packages/install.ts

Error recovery and rollback is currently implemented in handleInstallPackageFailure(), which is called from installPackageFromRegistry() (and also directly from the installPackageFromRegistryHandler() and possibly other places (security/endpoint?)), and in turn directly calls and is therefore tightly coupled with installPackageFromRegistry(). This needs to be factored out so that all installation methods can use the same function for error recovery and rollback.
Related files:

  • server/services/epm/packages/install.ts
  • server/routes/epm/handlers.ts

Possible scenarios

Installed package: registry package

New package

  • registry, newer version: supported, triggers update

  • registry, same version: supported, triggers reinstall

  • registry, older version: requires --force, triggers downgrade

  • upload, newer version: ?

  • upload, same version: ?

  • upload, older version: ?

Installed package: uploaded package

New package

  • registry, newer version: ?

  • registry, same version: ?

  • registry, older version: ?

  • upload, newer version: supported, triggers update

  • upload, same version: supported, triggers reinstall

  • upload, older version: supported, triggers downgrade (package upload has implicit --force)
@skh skh added Feature:EPM Fleet team's Elastic Package Manager (aka Integrations) project Feature:Fleet Fleet team's agent central management project Team:Fleet Team label for Observability Data Collection Fleet team labels Oct 29, 2020
@skh skh self-assigned this Oct 29, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/ingest-management (Feature:EPM)

@elasticmachine
Copy link
Contributor

Pinging @elastic/ingest-management (Feature:Fleet)

@ph ph added the v7.11 label Oct 29, 2020
@timroes timroes added v7.11.0 and removed v7.11 labels Oct 30, 2020
@skh skh mentioned this issue Nov 2, 2020
Closed
8 tasks
@ph ph removed the v7.11.0 label Feb 15, 2021
@jen-huang jen-huang added the technical debt Improvement of the software architecture and operational architecture label Apr 27, 2021
This was referenced Sep 13, 2021
Merged
Closed
@juliaElastic juliaElastic mentioned this issue Feb 6, 2023
Closed
7 tasks
@juliaElastic juliaElastic self-assigned this Feb 7, 2023
@juliaElastic juliaElastic mentioned this issue Feb 7, 2023
Merged
1 task
juliaElastic added a commit that referenced this issue Feb 8, 2023
@juliaElastic
[Fleet] refactor install registry and upload to extract common logic (#…
67d1a46 
…150444)

## Summary

Related to #148599

Closes #82007

Factored out common logic in `installPackageFromRegistry` and
`installPackageByUpload` to a new function. This improves the upload
flow as well to handle install failure.

We might want to introduce a `force` flag for the upload API to
reinstall a package, now the logic does not do anything if the installed
version package is uploaded again.
EDIT: found [here](#82007) that
upload should work with an implicit `force` flag, so will update that.

More manual and automated tests needed.


### Checklist

- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@juliaElastic juliaElastic

Labels
Feature:EPM Fleet team's Elastic Package Manager (aka Integrations) project Feature:Fleet Fleet team's agent central management project Team:Fleet Team label for Observability Data Collection Fleet team technical debt Improvement of the software architecture and operational architecture
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Fleet] refactor install registry and upload to extract common logic juliaElastic/kibana
6 participants
@ph @skh @timroes @jen-huang @elasticmachine @juliaElastic