Skip to content

Commit 1524f5a

Browse files
authored
Enhance client side throttling information
Enhance client side throttling information
1 parent 2edc214 commit 1524f5a

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

docs/deploy/configurations.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Currently, you can set only 1 namespace to watch in this flag. See [this Kuberne
6767
|Flag | Type | Default | Description |
6868
|---------------------------------------|---------------------------------|-----------------|-------------|
6969
|aws-api-endpoints | AWS API Endpoints Config | | AWS API endpoints mapping, format: serviceID1=URL1,serviceID2=URL2 |
70-
|aws-api-throttle | AWS Throttle Config | [default value](#default-throttle-config ) | throttle settings for AWS APIs, format: serviceID1:operationRegex1=rate:burst,serviceID2:operationRegex2=rate:burst |
70+
|aws-api-throttle | AWS Throttle Config | [default value](#default-throttle-config ) | throttle settings for AWS APIs, format: serviceID1:operationRegex1=burst:rate,serviceID2:operationRegex2=burst:rate |
7171
|aws-max-retries | int | 10 | Maximum retries for AWS APIs |
7272
|aws-region | string | [instance metadata](#instance-metadata) | AWS Region for the kubernetes cluster |
7373
|aws-vpc-id | string | [instance metadata](#instance-metadata) | AWS VPC ID for the Kubernetes cluster |
@@ -127,10 +127,20 @@ Once disabled:
127127
* you can no longer alter the value of an `alb.ingress.kubernetes.io/group.name` annotation on an existing Ingress.
128128

129129

130-
### Default throttle config
130+
### throttle config
131+
132+
The default throttle config used is.
133+
131134
```
132135
WAF Regional:^AssociateWebACL|DisassociateWebACL=0.5:1,WAF Regional:^GetWebACLForResource|ListResourcesForWebACL=1:1,WAFV2:^AssociateWebACL|DisassociateWebACL=0.5:1,WAFV2:^GetWebACLForResource|ListResourcesForWebACL=1:1
133136
```
137+
Client side throttling enable gradual scaling of the api calls. Additional throttle config can be specified by `--aws-api-throttle` flag. The ServiceId used in `--aws-api-throttle` The serviceID can be obtained from the API definition in AWS SDK. For e.g, ELBv2 it is [Elastic Load Balancing v2](https://github.com/aws/aws-sdk-go/blob/main/models/apis/elasticloadbalancingv2/2015-12-01/api-2.json#L9).
138+
139+
Here is an example of throttle config to specify client side throttling of ELBv2 calls.
140+
141+
```
142+
--aws-api-throttle=Elastic Load Balancing v2:RegisterTargets|DeregisterTargets=4:20,Elastic Load Balancing v2:.*=10:40
143+
```
134144
135145
### Instance metadata
136146
If running on EC2, the default values are obtained from the instance metadata service.

0 commit comments

Comments
 (0)