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.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__ label_key: ''

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__ service: __REQUIRED_FIELD__

---

dashboard

Parameter	dashboard.extra_filters
Description	Additional filters to pass to each query to Grafana datasource.
Type	Object (map[string]string)
Default Value	Expand {}

Parameter	dashboard.refresh_interval
Description	Refresh interval for dashboard panels.
Type	string
Default Value	15s

Parameter	dashboard.time_from
Description	From time of dashboard.
Type	string
Default Value	now-15m

Parameter	dashboard.time_to
Description	To time of dashboard.
Type	string
Default Value	now

Parameter	dashboard.title
Description	Name of the main dashboard.
Type	string
Default Value	Aperture Rate Limiter

dashboard.datasource

Parameter	dashboard.datasource.filter_regex
Description	Datasource filter regex.
Type	string
Default Value

Parameter	dashboard.datasource.name
Description	Datasource name.
Type	string
Default Value	$datasource

---