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

Write a Procedure for Setting Up a Scaler #1368

Open
Tracked by #221 ...
dwelsch-esi opened this issue Apr 15, 2024 · 3 comments
Open
Tracked by #221 ...

Write a Procedure for Setting Up a Scaler #1368

dwelsch-esi opened this issue Apr 15, 2024 · 3 comments

Comments

@dwelsch-esi
Copy link

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
Copy link

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
Copy link

nate-double-u commented Jun 7, 2024

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
Copy link
Member

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

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

No branches or pull requests

4 participants