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

Creating the rate-limits doc #1186

Open
Sayanta66 opened this issue Feb 28, 2024 · 1 comment
Open

Creating the rate-limits doc #1186

Sayanta66 opened this issue Feb 28, 2024 · 1 comment
Assignees
Labels
docs documentation Improvements or additions to documentation

Comments

@Sayanta66
Copy link
Contributor

Sayanta66 commented Feb 28, 2024

Currently, the rate-limits section is in the Advanced CAPH topic doc. The proposal is to create it as a separate doc under the Topic section.

Tasks to be done by me:

  • Introduction to Rate Limits. What does it do?
  • Importance of rate limit in CAPH

Tasks to be done with the help of the core technical team:

  • How would a user know if a rate limit is exceeded? Do we send an event or patch the object status?
  • RateLimitExceeded Which object needs to be checked?

Scope of the above tasks

  • Need live demos of the process that can be recorded instantly or recorded videos of the demos.
  • Available resources like docs or videos related to the docs that can help with the writing.
@Sayanta66 Sayanta66 self-assigned this Feb 28, 2024
@Sayanta66 Sayanta66 added documentation Improvements or additions to documentation docs labels Feb 28, 2024
@janiskemper
Copy link
Contributor

@kranurag7 you can integrate a code snippet that calls the hetzner API in some way, for example in the HetznerCluster controller, and then immediately requeues again. Then the controller calls the API until you run into a rate limit. Then you can make a screenshot of the object with kubectl or k9s where it shows in the printcolumns and the status.
This we can take for this document!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants