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

Closed
Tracked by #1361 ...
dwelsch-esi opened this issue Apr 15, 2024 · 13 comments · Fixed by #1446
Closed
Tracked by #1361 ...

Write a Procedure for Setting Up a Scaler #1368

dwelsch-esi opened this issue Apr 15, 2024 · 13 comments · Fixed by #1446
Assignees
Labels
stale All issues that are marked as stale due to inactivity

Comments

@dwelsch-esi
Copy link
Contributor

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
Contributor

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
Contributor

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.

@shubhusion
Copy link
Contributor

shubhusion commented Jun 13, 2024

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

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

@zroubalik
Copy link
Member

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

@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?

@shubhusion
Copy link
Contributor

@zroubalik @tomkerkhove can you please assign this issue to me ? I have already made a PR

Copy link

stale bot commented Oct 17, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale All issues that are marked as stale due to inactivity label Oct 17, 2024
Copy link

stale bot commented Oct 29, 2024

This issue has been automatically closed due to inactivity.

@stale stale bot closed this as completed Oct 29, 2024
@nate-double-u
Copy link
Contributor

I'm not sure this has been completed, if it was just the bot that closed this could we reopen it?

@shubhusion
Copy link
Contributor

I'm not sure this has been completed, if it was just the bot that closed this could we reopen it?

@nate-double-u PR has been completed. It was initially reviewed by @zroubalik, and I made changes based on his feedback.

@zroubalik @nate-double-u can check and merge

@nate-double-u
Copy link
Contributor

I'm not sure this has been completed, if it was just the bot that closed this could we reopen it?

@nate-double-u PR has been completed. It was initially reviewed by @zroubalik, and I made changes based on his feedback.

@zroubalik @nate-double-u can check and merge

If it's done, great! I just didn't want the issue auto-closed by bot 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale All issues that are marked as stale due to inactivity
Projects
Status: Done
4 participants