On this page
RatelimitClientConfig
RatelimitClientConfig API reference.
Proto: ratelimit_client_config.proto
Package: trafficcontrol.policy.gloo.solo.io
Types:
- RateLimitClientConfigReport
- RateLimitClientConfigReport.WorkspacesEntry
- RateLimitClientConfigSpec
- RateLimitClientConfigStatus
- Raw
RateLimitClientConfigReport
| Field | Description |
|---|---|
workspaces | (repeated RateLimitClientConfigReport.WorkspacesEntry)The status of the resource in each workspace that it exists in. |
RateLimitClientConfigReport.WorkspacesEntry
| Field | Description |
|---|---|
key | (string) |
value | (common.gloo.solo.io.Report) |
RateLimitClientConfigSpec
RateLimitClientConfig is used to configure the ratelimit rules on routes/destinations. All RateLimitPolicy resources in a workspace require an RateLimitClientConfig to in order to function. If no RateLimitClientConfig is provided, no ratelimit rules will be enforced.
| Field | Description |
|---|---|
raw | (Raw)Define a policy using the raw configuration format used by the client (Envoy). |
RateLimitClientConfigStatus
The current status of the RateLimitClientConfig.
| Field | Description |
|---|---|
common | (common.gloo.solo.io.Status)The state and workspace conditions of the applied resource. |
Raw
This object allows users to specify rate limit policies using the raw configuration formats used by the client (Envoy). When using this configuration type, it is up to the user to ensure that server and client configurations match to implement the desired behavior.
| Field | Description |
|---|---|
rateLimits | (repeated ratelimit.api.solo.io.RateLimitActions)Actions specify how the client (Envoy) will compose the descriptors that will be sent to the server to make a rate limiting decision. |