gloo
gloo copied to clipboard
Doc updates to make rate limiting guides more user-centric
Version
master
Describe the requested changes
Goals
- Full-blown RLCs and configuration YAML files for each example use case
- Better/more real-world example use cases
- Each use case to be copy+paste and follow-able
Changes to make
- Each example becomes ordered steps
- Refer to new setup guide for basic "before you begin" steps
- Add conceptual info about RL options and implementation options
- Steps about how to configure the rate limiting rules (usu. descriptor and actions), including explanation of options. For example, in method-based RL, you can have 4 potential values for the request header, not just method, but the doc only has method right now.
- Sample YAML files added to the Use Cases repo and referred to.
- Verification steps to test RL rule works
Status
- [x] Before you begin setup guide
- [x] Conceptual info about RL options and implementation options
Envoy API
- [x] Generic key
- [ ] Header values
- [ ] Remote address
- [ ] Limits for key-value tuples
- [ ] Nested limits
- [ ] Rule priority and weights
- [ ] Customizing routes
- [ ] Client IP
- [ ] HTTP method
- [ ] Secure with JWTs
- [ ] WAF and auth
- [ ] New from George (see Slack): Path routing
Set-style
- [ ] Explain how you can use same Envoy approach
- [ ] Set-style config YAMLs
Gloo Edge
- [ ] any other use cases?
Link to any relevant existing docs
Browser Information
N/A
Additional Context
- See Slack discussion.
- Another Slack discussion.
See feedback shared in Slack: https://solo-io-corp.slack.com/archives/CHJV572TG/p1713885545260929
another thread to add some more info about our global rate limiting implementation https://solo-io-corp.slack.com/archives/CHJV572TG/p1714414128130249