Keda: Support API Key authentication for Metrics API scaler

[tomkerkhove]

Use-Case

Support API Key authentication for Metrics API scaler

Specification

• [x] Support for API key in HTTP URL
• [ ] Support for API key in HTTP request header

Reference

https://github.com/kedacore/keda/issues/929

[aman-bansal]

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]

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

[aman-bansal]

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]

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]

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

[aman-bansal]

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

[tomkerkhove]

Thanks!