Skip to content

replaced ordered list of rate limit ops with flow diagram#18398

Merged
trujillo-adam merged 9 commits intomainfrom
docs/add-rate-limit-ops-diagram
Aug 8, 2023
Merged

replaced ordered list of rate limit ops with flow diagram#18398
trujillo-adam merged 9 commits intomainfrom
docs/add-rate-limit-ops-diagram

Conversation

@trujillo-adam
Copy link
Copy Markdown
Contributor

Description

This PR replaces the ordered list used to describe the order of operations for determining agent rate limits with a diagram. It includes light and dark mode versions of the diagram. I commented out the list instead of deleting it in case we wanted to revert.

PR Checklist

  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

@trujillo-adam trujillo-adam added type/docs Documentation needs to be created/updated/clarified pr/no-changelog PR does not need a corresponding .changelog entry pr/no-metrics-test backport/1.16 This release series is no longer active on CE. Use backport/ent/1.16. labels Aug 7, 2023
@trujillo-adam trujillo-adam marked this pull request as ready for review August 7, 2023 23:03
@trujillo-adam trujillo-adam requested a review from a team as a code owner August 7, 2023 23:03
You can define request rate limits in the agent configuration and in the control plane request limit configuration entry. The configuration entry also supports rate limit configurations for Consul resources. Consul performs the following order of operations when determing request rate limits:

![Diagram showing the order of operations for determining request rate limits.](/img/agent-rate-limiting-ops-order.jpg#light-theme-only)
![Diagram showing the order of operations for determining request rate limits.](/img/agent-rate-limiting-ops-order-dark.jpg#dark-theme-only)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think the dark mode coloring is kinda off?

image

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, OK. I'll have another look -- this is just how the slides spit it out

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I was actually using the wrong the slides --- we don't have the ability to do portrait, so I made a copy (of the wrong slides) and followed the instructions there.

Copy link
Copy Markdown
Contributor

@boruszak boruszak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor suggestions in this review, otherwise LGTM.

Re: the color of the diagram - looking at this slide in our toolkit - you're using the kit's grey text for labels, which is correct in how it describes labels for boxes - I think it looks weird because the grey is meant to be a secondary color - and without white text there's no primary.

Even though the text is inside boxes, try changing it to white (keep boxes and line work grey). That should improve it.