Skip to content

Commit ebf7451

Browse files
acatangiualxiord
authored andcommitted
Add IO rate limiters description to api yaml
Signed-off-by: Adrian Catangiu <[email protected]>
1 parent 87a5b91 commit ebf7451

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

api_server/swagger/firecracker.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -412,6 +412,9 @@ definitions:
412412

413413
RateLimiter:
414414
type: object
415+
description:
416+
Defines an IO rate limiter with independent bytes/s and ops/s limits.
417+
Limits are defined by configuring each of the _bandwidth_ and _ops_ token buckets.
415418
properties:
416419
bandwidth:
417420
$ref: "#/definitions/TokenBucket"
@@ -422,6 +425,13 @@ definitions:
422425

423426
TokenBucket:
424427
type: object
428+
description:
429+
Defines a token bucket with a fixed size/capacity and refill_time.
430+
The refill-rate is derived from size and refill_time, and it is the constant
431+
rate at which the tokens replenish.
432+
Consumption from the token bucket is unbounded in speed which allows for bursts
433+
bound in size by the amount of tokens available.
434+
Once the token bucket is empty, consumption speed is bound by the refill_rate.
425435
properties:
426436
size:
427437
type: integer

0 commit comments

Comments
 (0)