rate_limit_quota: [Doc] add the docs for rate limit quota feature (#22539)

Signed-off-by: Tianyu Xia <tyxia@google.com>

Mirrored from https://github.com/envoyproxy/envoy @ e51e81c2dd7eea89bc451cc566c0c1349c4300e8
pull/626/head
data-plane-api(Azure Pipelines) 2 years ago
parent ef149dd5a1
commit 0a73546d8d
  1. 2
      BUILD
  2. 3
      envoy/extensions/filters/http/rate_limit_quota/v3/rate_limit_quota.proto
  3. 6
      envoy/service/rate_limit_quota/v3/rlqs.proto
  4. 1
      envoy/type/v3/ratelimit_strategy.proto

@ -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",

@ -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 <config_http_filters_rate_limit_quota>`.
// [#comment:TODO(sergiitk): extension envoy.filters.http.rate_limit_quota]
// [#extension: envoy.filters.http.rate_limit_quota]
// Configures the Rate Limit Quota filter.
//

@ -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
// <envoy_v3_api_field_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction.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
// <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.reporting_interval>`
// starts from the beginning.
//
// 2. The bucket transitions to the :ref:`"no assignment"
// <envoy_v3_api_field_extensions.filters.http.rate_limit_quota.v3.RateLimitQuotaBucketSettings.no_assignment_behavior>`
// state.
//
// 3. Once the new assignment is received, it's applied per
// "Applying the first assignment to the bucket" section of the :ref:`QuotaAssignmentAction
// <envoy_v3_api_msg_service.rate_limit_quota.v3.RateLimitQuotaResponse.BucketAction.QuotaAssignmentAction>`.

@ -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 {

Loading…
Cancel
Save