rate_limit.proto

Package : ratelimit.networking.mesh.gloo.solo.io

Top

rate_limit.proto

Table of Contents

RateLimitClient

The RateLimitClient specifies either a simplified, abstracted rate limiting model that allows configuring the ratelimit Actions directly (raw). The corresponding server config should be set in the RateLimitConfig.

Field Type Label Description
raw ratelimit.networking.mesh.gloo.solo.io.RawRateLimit Configure the actions and/or set actions that determine how Envoy composes the descriptors

RateLimitServerSettings

Configure the RateLimit Server Settings

Field Type Label Description
ratelimitServerRef core.skv2.solo.io.ObjectRef The ratelimit service to ask about ratelimit decisions. The provided ref will be used to search for a service of the given name/namespace on the cluster the traffic policy is applied on
If omitted, Gloo Mesh will search for a service with the name rate-limiter in each namespace in the cluster of the VirtualGateway or TrafficPolicy is applied on
requestTimeout google.protobuf.Duration Timeout for the ratelimit service to respond. Defaults to 100ms
denyOnFail bool Defaults to false

RawRateLimit

Use this field if you want to inline the Envoy rate limits. Note that this does not configure the rate limit server. If you are running Gloo Mesh, you need to specify the server configuration via the appropriate field in the Gloo Mesh RateLimitConfig resource. If you are running a custom rate limit server you need to configure it yourself.

Field Type Label Description
rateLimits []ratelimit.api.solo.io.RateLimitActions repeated Actions specify how the client (Envoy) will compose the descriptors that will be sent to the server to make a rate limiting decision.

RouteRateLimit

Rate limit configuration for a Route or TrafficPolicy. Configures rate limits for individual HTTP routes

Field Type Label Description
ratelimitServerConfigSelector core.skv2.solo.io.ObjectSelector Labels to the RateLimitServerConfig ref sent to the ratelimit server
raw ratelimit.networking.mesh.gloo.solo.io.RawRateLimit Configure the actions and/or set actions that determine how Envoy composes the descriptors
ratelimitClientConfigRef core.skv2.solo.io.ObjectRef Reference to the RateLimitClientConfig that configures the rate limiting model