search

kedacore / keda-docs

Documentation and landing page for KEDA
https://keda.sh
Apache License 2.0
113 stars 421 forks source link

Write a Procedure for Setting Up a Scaler #1368

Open dwelsch-esi opened 2 months ago

dwelsch-esi commented 2 months ago

Write a procedure for setting up a scaler for KEDA. Include all steps that are common to any scaler. Supplemental instructions specific to particular scalers can be elsewhere.

This procedure is fundamental to using KEDA and should go at or near the beginning of the Operator's Guide.

Use-Case

Setting up a scaler seems to be largely a matter of installing the scaler and providing parameters in a configuration file. While the configurations are provided for all the various scalers, there doesn't seem to be a description of the procedure for doing the basic setup. This should go at the top of the Operator guide.

Users should be able to follow the procedure for any (or at least most) scalers. Any scaler that requires special instructions other than the configuration file should have its own procedure page, listing the extra steps required.

Specification

Write complete, step-by-step instructions. Don't assume the user knows anything. For example, name the configuration file and tell users where to put it, even if this is common knowledge. This is the generic template they'll use to set up any scaler, including their first.

shubhusion commented 1 month ago

Hi @dwelsch-esi and @tomkerkhove,

Could you please assign this issue to me? I would like to contribute to it. I have applied for the TUF documentation project through the Linux Foundation.

Thank you!

nate-double-u commented 1 month ago

Hi @shubhusion, I appreciate your enthusiasm, but the selections haven't been made yet for LFX Mentorship 2024 Term 2. Assigning someone before the announcements go out would be premature.

Edit: I'm not sure you have the right project—this is KEDA, not TUF.

Edit 2: Sorry, I got confused thinking this was a TUF issue. KEDA isn't participating this term, so please disregard what I said above. If the maintainers want to assign someone to this issue, that's their prerogative. (Though I do invite the project to participate next term!)

zroubalik commented 3 weeks ago

@shubhusion we would be happy to assign this issue to you, if you are still interested.

shubhusion commented 3 weeks ago

@shubhusion we would be happy to assign this issue to you, if you are still interested.

Yeah, @zroubalik, I am interested. Can you also provide me resources to get started.

shubhusion commented 3 weeks ago

@zroubalik Procedure needs to be updates in version 2.15 or 2.14 ?

zroubalik commented 1 week ago

@shubhusion I think that the content will be the same for both versions, so it's a low effort to update both versions, thanks :)

shubhusion commented 1 week ago

@shubhusion I think that the content will be the same for both versions, so it's a low effort to update both versions, thanks :)

Hi @zroubalik, Could you please guide me a little? I am new to this repository I have updated version 2.14 rn which other version do I need to update?