From 0a73546d8dd450025e77402c5457b936ca091e03 Mon Sep 17 00:00:00 2001 From: "data-plane-api(Azure Pipelines)" Date: Tue, 22 Nov 2022 16:25:33 +0000 Subject: [PATCH] rate_limit_quota: [Doc] add the docs for rate limit quota feature (#22539) Signed-off-by: Tianyu Xia Mirrored from https://github.com/envoyproxy/envoy @ e51e81c2dd7eea89bc451cc566c0c1349c4300e8 --- BUILD | 2 ++ .../filters/http/rate_limit_quota/v3/rate_limit_quota.proto | 3 +-- envoy/service/rate_limit_quota/v3/rlqs.proto | 6 +++--- envoy/type/v3/ratelimit_strategy.proto | 1 - 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/BUILD b/BUILD index 71cce936..0f776c32 100644 --- a/BUILD +++ b/BUILD @@ -188,6 +188,7 @@ proto_library( "//envoy/extensions/filters/http/oauth2/v3:pkg", "//envoy/extensions/filters/http/on_demand/v3:pkg", "//envoy/extensions/filters/http/original_src/v3:pkg", + "//envoy/extensions/filters/http/rate_limit_quota/v3:pkg", "//envoy/extensions/filters/http/ratelimit/v3:pkg", "//envoy/extensions/filters/http/rbac/v3:pkg", "//envoy/extensions/filters/http/router/v3:pkg", @@ -297,6 +298,7 @@ proto_library( "//envoy/service/listener/v3:pkg", "//envoy/service/load_stats/v3:pkg", "//envoy/service/metrics/v3:pkg", + "//envoy/service/rate_limit_quota/v3:pkg", "//envoy/service/ratelimit/v3:pkg", "//envoy/service/route/v3:pkg", "//envoy/service/runtime/v3:pkg", diff --git a/envoy/extensions/filters/http/rate_limit_quota/v3/rate_limit_quota.proto b/envoy/extensions/filters/http/rate_limit_quota/v3/rate_limit_quota.proto index a181a41b..93dded43 100644 --- a/envoy/extensions/filters/http/rate_limit_quota/v3/rate_limit_quota.proto +++ b/envoy/extensions/filters/http/rate_limit_quota/v3/rate_limit_quota.proto @@ -25,10 +25,9 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/extensions/fil option (udpa.annotations.file_status).package_version_status = ACTIVE; option (xds.annotations.v3.file_status).work_in_progress = true; -// [#not-implemented-hide:] // [#protodoc-title: Rate Limit Quota] // Rate Limit Quota :ref:`configuration overview `. -// [#comment:TODO(sergiitk): extension envoy.filters.http.rate_limit_quota] +// [#extension: envoy.filters.http.rate_limit_quota] // Configures the Rate Limit Quota filter. // diff --git a/envoy/service/rate_limit_quota/v3/rlqs.proto b/envoy/service/rate_limit_quota/v3/rlqs.proto index 418710d5..160a7140 100644 --- a/envoy/service/rate_limit_quota/v3/rlqs.proto +++ b/envoy/service/rate_limit_quota/v3/rlqs.proto @@ -19,7 +19,6 @@ option java_generic_services = true; option (udpa.annotations.file_status).package_version_status = ACTIVE; option (xds.annotations.v3.file_status).work_in_progress = true; -// [#not-implemented-hide:] // [#protodoc-title: Rate Limit Quota Service (RLQS)] // The Rate Limit Quota Service (RLQS) is a Envoy global rate limiting service that allows to @@ -126,7 +125,7 @@ message RateLimitQuotaResponse { // the current bucket assignment is ``expired``, the data plane must immediately // end the current assignment, report the bucket usage, and apply the new assignment. // The new assignment becomes bucket's ``active`` assignment. - // `` If the rate limiting strategy is the same as the bucket's ``active`` (not ``expired``) + // * If the rate limiting strategy is the same as the bucket's ``active`` (not ``expired``) // assignment, the data plane should extend the duration of the ``active`` assignment // for the duration of the new assignment provided in the :ref:`assignment_time_to_live // ` @@ -156,7 +155,6 @@ message RateLimitQuotaResponse { google.protobuf.Duration assignment_time_to_live = 2 [(validate.rules).duration = {gte {}}]; // Configures the local rate limiter for the request matched to the bucket. - // // If not set, allow all requests. type.v3.RateLimitStrategy rate_limit_strategy = 3; } @@ -183,9 +181,11 @@ message RateLimitQuotaResponse { // 1. The process of :ref:`subscription and reporting // ` // starts from the beginning. + // // 2. The bucket transitions to the :ref:`"no assignment" // ` // state. + // // 3. Once the new assignment is received, it's applied per // "Applying the first assignment to the bucket" section of the :ref:`QuotaAssignmentAction // `. diff --git a/envoy/type/v3/ratelimit_strategy.proto b/envoy/type/v3/ratelimit_strategy.proto index 47249039..a86da55b 100644 --- a/envoy/type/v3/ratelimit_strategy.proto +++ b/envoy/type/v3/ratelimit_strategy.proto @@ -17,7 +17,6 @@ option go_package = "github.com/envoyproxy/go-control-plane/envoy/type/v3;typev3 option (udpa.annotations.file_status).package_version_status = ACTIVE; option (xds.annotations.v3.file_status).work_in_progress = true; -// [#not-implemented-hide:] // [#protodoc-title: Rate Limit Strategies] message RateLimitStrategy {