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

Support API Key authentication for Metrics API scaler #1083

Closed
1 of 2 tasks
tomkerkhove opened this issue Sep 4, 2020 · 7 comments
Closed
1 of 2 tasks

Support API Key authentication for Metrics API scaler #1083

tomkerkhove opened this issue Sep 4, 2020 · 7 comments
Labels
feature All issues for new features that have been committed to good first issue Good for newcomers Hacktoberfest scaler-metrics-api All issues related to our Metrics API scaler security All issues related to security

Comments

@tomkerkhove
Copy link
Member

tomkerkhove commented Sep 4, 2020

Use-Case

Support API Key authentication for Metrics API scaler

Specification

  • Support for API key in HTTP URL
  • Support for API key in HTTP request header

Reference

#929

@tomkerkhove tomkerkhove added feature All issues for new features that have been committed to security All issues related to security scaler-metrics-api All issues related to our Metrics API scaler good first issue Good for newcomers Hacktoberfest labels Sep 4, 2020
@aman-bansal
Copy link
Contributor

Hi @tomkerkhove, I would like to pick this issue. Based on this thread, I believe no one is doing any development on this. Just wanted to check if I can start.

@tomkerkhove
Copy link
Member Author

Nope, that is correct. Thanks for picking this up!

@aman-bansal
Copy link
Contributor

Perfect. So what I get from the description is that we wanted to integrate API Key (which will be available in the metadata) to be appended to the http URL like this http://myapp/metric/endpoint?api_key=<metadata.APIKEY>. I believe this is the standard implementation practice or do we need customization in defining the query param name?

@tomkerkhove
Copy link
Member Author

Today, they have to provide the full URL to call - https://keda.sh/docs/2.0/scalers/metrics-api/

In theory they can add the API key in there already but I'd prefer not to. What we want to achieve here is:

  • API key support through request header
  • API key support through query parameter

For both I would provide a standard header/query parameter name, but with the option to define their own in case they deviate from the mainstream. Make sense?

@aman-bansal
Copy link
Contributor

Got it. All clear now. I am starting with this. Thanks!

@aman-bansal
Copy link
Contributor

@tomkerkhove this is done. can we close this issue :)

@tomkerkhove
Copy link
Member Author

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature All issues for new features that have been committed to good first issue Good for newcomers Hacktoberfest scaler-metrics-api All issues related to our Metrics API scaler security All issues related to security
Projects
None yet
Development

No branches or pull requests

2 participants