Creating the `rate-limits` doc

[Sayanta66]

trafficstars

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.

[janiskemper]

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

[guettli]

@janiskemper is still relevant?

[janiskemper]

sounds like a good idea to explain hetzner rate limits and how exactly we show it