ratelimit

Documentation

Index

• Variables
• type RateLimit
  • func ParseAnnotations(ing *extensions.Ingress) (*RateLimit, error)
• type Zone

Variables

var (
	// ErrInvalidRateLimit is returned when the annotation caontains invalid values
	ErrInvalidRateLimit = errors.New("invalid rate limit value. Must be > 0")

	// ErrMissingAnnotations is returned when the ingress rule
	// does not contains annotations related with rate limit
	ErrMissingAnnotations = errors.New("no annotations present")
)

Types

type RateLimit

type RateLimit struct {
	// Connections indicates a limit with the number of connections per IP address
	Connections Zone
	// RPS indicates a limit with the number of connections per second
	RPS Zone
}

RateLimit returns rate limit configuration for an Ingress rule Is possible to limit the number of connections per IP address or connections per second. Note: Is possible to specify both limits

func ParseAnnotations

func ParseAnnotations(ing *extensions.Ingress) (*RateLimit, error)

ParseAnnotations parses the annotations contained in the ingress rule used to rewrite the defined paths

type Zone

type Zone struct {
	Name  string
	Limit int
	Burst int
	// SharedSize amount of shared memory for the zone
	SharedSize int
}

Zone returns information about the NGINX rate limit (limit_req_zone) http://nginx.org/en/docs/http/ngx_http_limit_req_module.html#limit_req_zone