From 8f293985730b973281341fcb8c49489b684883c5 Mon Sep 17 00:00:00 2001 From: Robert Burton Date: Mon, 12 Feb 2024 02:44:11 -0600 Subject: [PATCH] Update the documentation for RateLimit to provide a better example --- docs/content/middlewares/http/ratelimit.md | 24 +++++++++++----------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/content/middlewares/http/ratelimit.md b/docs/content/middlewares/http/ratelimit.md index 1fd9e723f..3020edbe7 100644 --- a/docs/content/middlewares/http/ratelimit.md +++ b/docs/content/middlewares/http/ratelimit.md @@ -16,15 +16,15 @@ It is based on a [token bucket](https://en.wikipedia.org/wiki/Token_bucket) impl ```yaml tab="Docker" # Here, an average of 100 requests per second is allowed. -# In addition, a burst of 50 requests is allowed. +# In addition, a burst of 200 requests is allowed. labels: - "traefik.http.middlewares.test-ratelimit.ratelimit.average=100" - - "traefik.http.middlewares.test-ratelimit.ratelimit.burst=50" + - "traefik.http.middlewares.test-ratelimit.ratelimit.burst=200" ``` ```yaml tab="Kubernetes" # Here, an average of 100 requests per second is allowed. -# In addition, a burst of 50 requests is allowed. +# In addition, a burst of 200 requests is allowed. apiVersion: traefik.io/v1alpha1 kind: Middleware metadata: @@ -32,12 +32,12 @@ metadata: spec: rateLimit: average: 100 - burst: 50 + burst: 200 ``` ```yaml tab="Consul Catalog" # Here, an average of 100 requests per second is allowed. -# In addition, a burst of 50 requests is allowed. +# In addition, a burst of 200 requests is allowed. - "traefik.http.middlewares.test-ratelimit.ratelimit.average=100" - "traefik.http.middlewares.test-ratelimit.ratelimit.burst=50" ``` @@ -45,36 +45,36 @@ spec: ```json tab="Marathon" "labels": { "traefik.http.middlewares.test-ratelimit.ratelimit.average": "100", - "traefik.http.middlewares.test-ratelimit.ratelimit.burst": "50" + "traefik.http.middlewares.test-ratelimit.ratelimit.burst": "200" } ``` ```yaml tab="Rancher" # Here, an average of 100 requests per second is allowed. -# In addition, a burst of 50 requests is allowed. +# In addition, a burst of 200 requests is allowed. labels: - "traefik.http.middlewares.test-ratelimit.ratelimit.average=100" - - "traefik.http.middlewares.test-ratelimit.ratelimit.burst=50" + - "traefik.http.middlewares.test-ratelimit.ratelimit.burst=200" ``` ```yaml tab="File (YAML)" # Here, an average of 100 requests per second is allowed. -# In addition, a burst of 50 requests is allowed. +# In addition, a burst of 200 requests is allowed. http: middlewares: test-ratelimit: rateLimit: average: 100 - burst: 50 + burst: 200 ``` ```toml tab="File (TOML)" # Here, an average of 100 requests per second is allowed. -# In addition, a burst of 50 requests is allowed. +# In addition, a burst of 200 requests is allowed. [http.middlewares] [http.middlewares.test-ratelimit.rateLimit] average = 100 - burst = 50 + burst = 200 ``` ## Configuration Options