Rate Limits

Rate Limits for Amazon Web Service (AWS)

How Spinnaker Monitors a Deployment

By default Spinnaker queries (e.g. polls) the entire state of the AWS resources managed by Spinnaker every 30 seconds through the Clouddriver sub-service. This can cause AWS to throttle the requests on your account. If you have a large number of Auto-Scaling Groups and Elastic Load Balancers in your account or other services commonly querying the same APIs then you can expect to see throttling exceptions in your Spinnaker logs.

How to alleviate AWS Throttling Exceptions

There are several things you can do to help reduce the effects of throttling:

  • Set fine tune rate limits within Spinnaker.
  • Adjust Spinnaker’s retry limit per request.
  • Decrease the polling interval.

Fine Grained Rate Limits

Spinnaker queries your cloud provider (AWS, GCP, Azure, Kubernetes, etc) frequently to understand the state of your existing infrastructure and current deployments. However, by doing so you might run into rate limits imposed by the cloud provider. To help avoid this Spinnaker provides controls to limit the number of requests it generates. The unit used for these controls is “requests per second”.

Below is an example configuration for global rate limits for all services that you would place in clouddriver-local.yml:

serviceLimits:
  defaults:
    rateLimit: 20

If you have multiple cloud providers, you can limit each one differently:

serviceLimits:
  cloudProviderOverrides:
    aws:
      rateLimit: 15

You can provide account specific overrides as well in case you have significantly more resources in one account while others have less:

serviceLimits:
  accountOverrides:
    test:
      rateLimit: 5
    prod:
      rateLimit: 100

And finally, you can have more fine-grained control for particular AWS endpoints that might have a different rate limits:

 implementationLimits:

    AmazonEC2:
      defaults:
        rateLimit: 200
      accountOverrides:
        prod:
          rateLimit: 500

    AmazonElasticLoadBalancing:
      defaults:
        rateLimit: 10

Using these rate limits will help you avoid hitting the rate limits and potentially make Spinnaker more responsive as the cloud provider clients won’t have to implement back-off strategy to continue to query the infrastructure.

Default Service Limits

The Armory Spinnaker distribution comes with the following default service limits:

serviceLimits:
  cloudProviderOverrides:
    aws:
      rateLimit: 15.0

  implementationLimits:
    AmazonAutoScaling:
      defaults:
        rateLimit: 3.0
    AmazonElasticLoadBalancing:
      defaults:
        rateLimit: 5.0

If you require a higher rate limit on these APIs then you will need to overwrite them directly. Overwriting the global service default is not sufficient.

Request Retry

You can set the number of retries per request with the following setting:

aws:
  client:
    maxErrorRetry: 4

This is the number of retries before failing the request. It is on an exponential backoff maxing out at 20 seconds. By default Armory Spinnaker sets maxErrorRetry to 20.

FAQ

Q: Why doesn’t Spinnaker use AWS Config to update its state? A: AWS Config does not support all resource types. The two most rate limitted APIs are Auto Scaling and Classic Elastic Load Balancing, neither are supported by AWS Config. Additionally, there is a non-trivial delay from the time a resource is created and the time a notification is created by AWS Config.