-
Notifications
You must be signed in to change notification settings - Fork 447
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 metrics API scaler docs #239
Conversation
Signed-off-by: Tomek Urbaszek <tomasz.urbaszek@polidea.com>
c3477c1
to
535835a
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.
Looks good overall but would like to follow the structure of other scalers and added some remarks.
And don't hesitate to drop a note about this new scaler in https://github.com/kedacore/keda-docs/blob/master/content/blog/keda-2.0-beta.md.draft#L26 given it allows for higher extensibility as well. Happy to do for you if it's too much of a hassle. |
Signed-off-by: Tomek Urbaszek <tomasz.urbaszek@polidea.com>
Signed-off-by: Tomek Urbaszek <tomasz.urbaszek@polidea.com>
Signed-off-by: Tomek Urbaszek <tomasz.urbaszek@polidea.com>
Signed-off-by: Tomek Urbaszek <tomasz.urbaszek@polidea.com>
Signed-off-by: Tomek Urbaszek <tomasz.urbaszek@polidea.com>
I looked over the docs and things look good. The only part I had to re-read was the bit about scaling down to 0 but it made sense after I read it a 2nd time. |
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.
I've added a bunch of suggestions to make it more readable/less tech detailed but it would be nice if you could align with the structure of all our scalers (example):
- Trigger Specification with parameter list after sample
- Authentication Parameters (none for now, but following https://keda.sh/docs/1.5/scalers/prometheus/#authentication-parameters)
- Example
How it works with the API could be a (sub)section before Authentication Parameters to talk about that or as part of the sample.
Signed-off-by: Tomek Urbaszek <tomasz.urbaszek@polidea.com>
Thanks @tomkerkhove for your suggestions! I applied all of them |
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.
Almost there!
Signed-off-by: Tomek Urbaszek <tomasz.urbaszek@polidea.com>
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.
LGTM - Thanks @turbaszek!
|
||
This specification describes the `metrics-api` trigger that scales based on a metric value provided by an API. | ||
|
||
This scaler allows users to utilize **any existing APIs** as a metric provider. |
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.
Bold to emphasize than any API mean in fact any API, so one can scale their deployment using current day length from https://ipgeolocation.io/astronomy-api.html 😃
Related to kedacore/keda#929