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.

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

Merged
merged 8 commits into from
Sep 4, 2020

Conversation

turbaszek
Copy link
Contributor

@turbaszek turbaszek commented Aug 25, 2020

Related to kedacore/keda#929

Signed-off-by: Tomek Urbaszek <tomasz.urbaszek@polidea.com>
Copy link
Member

@tomkerkhove tomkerkhove left a 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.

content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
@tomkerkhove
Copy link
Member

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>
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
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>
@lonnix
Copy link

lonnix commented Sep 3, 2020

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.

Copy link
Member

@tomkerkhove tomkerkhove left a 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):

How it works with the API could be a (sub)section before Authentication Parameters to talk about that or as part of the sample.

content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
Signed-off-by: Tomek Urbaszek <tomasz.urbaszek@polidea.com>
@turbaszek
Copy link
Contributor Author

Thanks @tomkerkhove for your suggestions! I applied all of them

Copy link
Member

@tomkerkhove tomkerkhove left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Almost there!

content/docs/2.0/scalers/metrics-api.md Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Show resolved Hide resolved
content/docs/2.0/scalers/metrics-api.md Outdated Show resolved Hide resolved
Signed-off-by: Tomek Urbaszek <tomasz.urbaszek@polidea.com>
Copy link
Member

@tomkerkhove tomkerkhove left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - Thanks @turbaszek!

@tomkerkhove tomkerkhove merged commit 87a9092 into kedacore:master Sep 4, 2020

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.
Copy link
Contributor Author

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 😃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants