-
Notifications
You must be signed in to change notification settings - Fork 72
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.
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
Discuss: deprecation path for packages #192
Comments
We need to define what happens with such a package in Kibana / Fleet in case a users installed it. How long will it still be usable? Will it be removed automatically at one stage? How to we inform the user? |
This is of course opinionated:
The safe option would be to leave as is, just not push any further updates to it and hide in the UI. It should be still possible to force-install it using API.
Never to keep the consistency with any Kibana deployment. |
I would not mandate a behaviour, and leave the team responsible to choose how to handle it.
Is viable to stop supporting deprecated packages (maybe after a grace period)? If yes I don't see downsides of keeping it deprecated but available. Is there any disadvantage to this approach?
I think there are multiple "kinds" of users and I would expect different ways:
|
Thanks for your input, Edoardo!
Currently the most important consumer is Fleet UI, so I would leave this decision to Jen and the team on how to perform in case of detecting a deprecated package (which might be already installed).
Same here, a question for Kibana team.
Actually this is a good question, I'm sure if we have any channel to reach out to paid customers. Should we do something extra than displaying a deprecation notice? |
Thanks it makes sense that we need a path for deprecating packages. @mtojek what is the timeline for deprecating it and how long until its no longer supported? Are there any others that will be deprecated soon? I just looked at our telemetry and I only see 5 clusters using |
I think @jamiehynds have more context on this |
@mostlyjason we shipped a Cyberark Beats module also, which probably explains why we're not seeing strong adoption of the package yet. There will probably be at least one security integration to deprecate per release for the foreseeable, as we're building our experimental integrations from scratch and deprecating the old ones. If there isn't a clear path for deprecation yet, maybe we could update the package name + description to indicate they are deprecated? Want to avoid confusion as to which integration to use as users onboard sources, eg: |
@jamiehynds how many integrations are you planning to deprecate? I'm worried about the user experience if we make deprecation a standard practice because its a breaking change for users. Our new corporate level theme is "make it minor" which means to minimize breaking changes and put extra effort in to make upgrades seamless for users. Is there anything we can do to upgrade integrations in place to make it easier for users? |
@mostlyjason we could be looking at roughly 20 integrations eventually. These integrations originated from open source RSA Netwitness parsers that we converted to integrations in an attempt to quickly expand our coverage of security data sources. We shipped them as experimental with a view to iterating and moving towards Beta and GA. However, we've since realised they are exceptionally difficult to maintain/update and easier to build these integrations from scratch. The new integrations will provide a much better user experience (lots of known issues with the RSA parsing). Outside of these RSA-based integrations, we have no intention of making deprecation a standard practice. We can look at improving the upgrade experience for these particular integrations, but don't believe there's a straight forward path. Worth noting that based on Fleet telemetry, adoption for most of these integrations is pretty low. |
Ok thanks for the context! 20 integrations sounds like a lot and will impact the UX if we don't handle this use case. Updating the package name seems straightforward and doesn't require extra investment on the Kibana side. It seems like the number of users is still low so I'm not sure its worth doing more than showing they are deprecated in the package name. We need a way to filter deprecated packages out from the integrations UI browse tab. ++ on having something in the package spec. I imagine we'll want to update the EPR API to filter them out too? |
We'd like to deprecate
cyberark
in favor of thecyberarkpas
package. Unfortunately it's precedence now and we should decide what is the recommended flow here.A set of loose thoughts:
cc @ruflin @jsoriano @marc-gr @endorama
cc (kibana) @jen-huang
The text was updated successfully, but these errors were encountered: