Base Rate Limiting Policy

Introduction

This blueprint provides a token bucket based rate-limiting policy and a dashboard. This policy uses the RateLimiter component.

Configuration

Blueprint name: rate-limiting/base

Parameters

policy

Parameter	policy.components
Description	List of additional circuit components.
Type	Array of Object (aperture.spec.v1.Component)
Default Value	Expand []

Parameter	policy.policy_name
Description	Name of the policy.
Type	string
Default Value	__REQUIRED_FIELD__

Parameter	policy.resources
Description	Additional resources.
Type	Object (aperture.spec.v1.Resources)
Default Value	Expand flow_control: classifiers: []

policy.rate_limiter

Parameter	policy.rate_limiter.alerter
Description	Alerter.
Type	Object (aperture.spec.v1.AlerterParameters)
Default Value	Expand alert_name: More than 90% of requests are being rate limited

Parameter	policy.rate_limiter.bucket_capacity
Description	Bucket capacity.
Type	Number (double)
Default Value	__REQUIRED_FIELD__

Parameter	policy.rate_limiter.fill_amount
Description	Fill amount.
Type	Number (double)
Default Value	__REQUIRED_FIELD__

Parameter	policy.rate_limiter.parameters
Description	Parameters.
Type	Object (aperture.spec.v1.RateLimiterParameters)
Default Value	Expand interval: __REQUIRED_FIELD__

Parameter	policy.rate_limiter.request_parameters
Description	Request Parameters.
Type	Object (aperture.spec.v1.RateLimiterRequestParameters)
Default Value	Expand {}

Parameter	policy.rate_limiter.selectors
Description	Flow selectors to match requests against
Type	Array of Object (aperture.spec.v1.Selector)
Default Value	Expand - control_point: __REQUIRED_FIELD__

---