-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Add KEDAScalersInfo to display important information #6330
base: main
Are you sure you want to change the base?
Conversation
ee11028
to
0fef06b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
would it be possible to include these events in the TypedConfig
deprecated logic?
Deprecated string |
I can imagine we may want to add something like "DeprecatedEvent"
parameter to model this behaviour, because iirc the "Deprecated"
parameter present there will error the scaler parsing. Or maybe we change the current behaviour to not fail and throw event instead?
be3da81
to
a9b15b9
Compare
Signed-off-by: rickbrouwer <[email protected]>
a9b15b9
to
cfe6e30
Compare
Thank you for the good feedback. In retrospect, it is indeed much better to handle this through I believe the other 'deprecated' parameter should remain in place. It makes the flow more logical. Perhaps it would be good to set a standard, once something is truly deprecated and causes an error, we keep showing it for two releases and then remove the parameter to keep the code clean. show 2 releases: What are your thoughts? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the good feedback. In retrospect, it is indeed much better to handle this through
TypedConfig
. I’ve restructured it accordingly. I created a new parameter calleddeprecatedAnnounce
. This will issue both, an info message (to maintain the 'old' behavior), and an event. This means I’ve removed the info message directly from the scaler, and it now also runs throughTypedConfig
, so the message only needs to be specified once.I believe the other 'deprecated' parameter should remain in place. It makes the flow more logical. First, there will be an announcement, typically for two releases. After that, it can be converted to deprecated status, triggering an error. This is important because it provides the reason for the scaler's failure if the parameter is still in use.
Perhaps it would be good to set a standard, once something is truly deprecated and causes an error, we keep showing it for two releases and then remove the parameter to keep the code clean. So in summary:
show 2 releases:
deprecatedAnnounce
: parameter x is deprecated and will be removed in release x then remove thedeprecatedAnnounce
, then; show 2 releases:deprecated
: parameter x is deprecated, use parameter x instead then removedeprecated
tagWhat are your thoughts?
I like this :)
We should document this here: https://github.com/kedacore/governance/blob/main/DEPRECATIONS.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What are your thoughts?
this is very well thought through from all angles, lgtm
/run-e2e cpu|ibm |
That seems like a good plan to me. I will document this there and offer it via a PR. |
Adding a new event (KEDAScalersInfo) so that important information is shown in e.g. Argo CD.
Added the deprecation info message by the
cpu_memory_scaler
andibmmq_scaler
.Checklist
Fixes #6328