Basic rate limit policy
Control the rate of requests to a destination or route. The following example shows you how to create a basic rate limit policy that applies to a destination or route, based on a generic key.
For more in-depth examples of the Envoy and Set-style rate limiting APIs, see More rate limit policy examples.
If you import or export resources across workspaces, your policies might not apply. For more information, see Import and export policies.
Before you begin
Follow the getting started instructions to:
-
Configure an HTTP listener on your gateway and set up basic routing for the sample apps.
-
Make sure that the rate limit server is installed and running. If not, install the rate limit server in your single or multicluster environment.
kubectl get pods -A -l app=rate-limiter
Configure rate limit policies
You can apply a rate limit policy at the destination or route level. For more information, see Applying policies.
When you create the policy with a destination selector, only Kubernetes services can be specified in the applyToDestination
section. Gloo virtual destinations or Gloo external services are not supported.
Review the following sample configuration files. Continue to the Verify rate limit policies section for example steps on how to check that rate limiting is working.
apiVersion: trafficcontrol.policy.gloo.solo.io/v2
kind: RateLimitPolicy
metadata:
annotations:
cluster.solo.io/cluster: ""
name: rl-policy
namespace: bookinfo
spec:
applyToRoutes:
- route:
labels:
route: ratings
config:
phase:
postAuthz: {}
ratelimitClientConfig:
name: rl-client-config
ratelimitServerConfig:
name: rl-server-config
namespace: gloo-mesh-addons
serverSettings:
name: rl-server
Setting | Description |
---|---|
spec.applyToRoutes |
Use labels to configure which routes to apply the policy to. This example label matches the app and route from the example route table that you apply separately. If omitted and you do not have another selector such as applyToDestinations , the policy applies to all routes in the workspace. In this example, the rate limit policy applies to all routes in the workspace with the route: ratings label. |
config |
The ratelimitServerConfig is required. The serverSettings and ratelimitClientConfig are optional, and can be added manually in the policy. In this example, the rate limit policy refers to the client config, server config, and server settings that you downloaded before you began. For more information, see Rate limit server setup. |
Verify rate limit policies
- Create a rate limit server config with the rate limiting rules that the server accepts. For more information, see Rate limit server setup. Note: Change
cluster-1
as needed to your cluster's actual name (value of$CLUSTER_NAME
).kubectl apply -f - << EOF apiVersion: admin.gloo.solo.io/v2 kind: RateLimitServerConfig metadata: annotations: cluster.solo.io/cluster: "" name: rl-server-config namespace: gloo-mesh-addons spec: destinationServers: - port: number: 8083 ref: cluster: cluster-1 name: rate-limiter namespace: gloo-mesh-addons raw: descriptors: - key: generic_key rateLimit: requestsPerUnit: 1 unit: DAY value: counter EOF
- Create a rate limit server settings resource to control how clients connect to the rate limit server. For more information, see Rate limit server setup. Note: Change
cluster-1
as needed to your cluster's actual name (value of$CLUSTER_NAME
).kubectl apply -f - << EOF apiVersion: admin.gloo.solo.io/v2 kind: RateLimitServerSettings metadata: annotations: cluster.solo.io/cluster: "" name: rl-server namespace: bookinfo spec: destinationServer: port: number: 8083 ref: cluster: cluster-1 name: rate-limiter namespace: gloo-mesh-addons EOF
- Create a rate limit client config to set up the rate limiting actions to take. For more information, see Rate limit server setup.
kubectl apply -f - << EOF apiVersion: trafficcontrol.policy.gloo.solo.io/v2 kind: RateLimitClientConfig metadata: annotations: cluster.solo.io/cluster: "" name: rl-client-config namespace: bookinfo spec: raw: rateLimits: - actions: - genericKey: descriptorValue: counter EOF
- Create the rate limit policy that you reviewed in the previous section.
kubectl apply -f - << EOF apiVersion: trafficcontrol.policy.gloo.solo.io/v2 kind: RateLimitPolicy metadata: annotations: cluster.solo.io/cluster: "" name: rl-policy namespace: bookinfo spec: applyToRoutes: - route: labels: route: ratings config: phase: postAuthz: {} ratelimitClientConfig: name: rl-client-config ratelimitServerConfig: name: rl-server-config namespace: gloo-mesh-addons serverSettings: name: rl-server EOF
- Send a request to the ratings app.
- Repeat the request a few times. Because the rate limit policy limits requests to 1 per day, the request results in a
429 - Too Many Requests
error. - Optional: Clean up the resources that you created.
kubectl -n gloo-mesh-addons delete RateLimitServerConfig rl-server-config kubectl -n bookinfo delete RateLimitServerSettings rl-server kubectl -n bookinfo delete RateLimitClientConfig rl-client-config kubectl -n bookinfo delete RateLimitPolicy rl-policy