Files
goma-gateway/docs/middleware/rate-limit.md

60 lines
974 B
Markdown
Raw Normal View History

2024-11-09 15:06:09 +01:00
---
title: Rate Limit
layout: default
parent: Middleware
nav_order: 6
---
### RateLimit middleware
The RateLimit middleware ensures that services will receive a fair number of requests, and allows one to define what fair is.
2024-11-25 08:38:03 +01:00
Example of rate limiting middleware
```yaml
middlewares:
- name: rate-limit
type: ratelimit #or rateLimit
paths:
- /*
rule:
unit: minute # or hour
requestsPerUnit: 60
2024-11-25 08:38:03 +01:00
```
Example of route rate limiting middleware
2024-11-09 15:06:09 +01:00
```yaml
version: 0.1.7
gateway:
routes:
- name: Example
2024-11-25 08:42:47 +01:00
rateLimit: 60 # per minute
2024-11-09 15:06:09 +01:00
```
2024-11-25 08:38:03 +01:00
Example of global rate limiting middleware
```yaml
version: 0.1.7
gateway:
2024-11-25 08:42:47 +01:00
rateLimit: 60 # per minute
2024-11-25 08:38:03 +01:00
routes:
- name: Example
```
## Advanced Kubernetes deployment
```yaml
apiVersion: gomaproj.github.io/v1beta1
kind: Middleware
metadata:
name: ratelimit-middleware-sample
spec:
type: basic
paths:
- /*
rule:
unit: minute # or hour
requestsPerUnit: 60
2024-11-25 08:38:03 +01:00
```