Skip to content

Commit fd5addc

Browse files
Templumalexellis
authored andcommitted
Updated auto scaling documentation
Updated the documentation of the auto-scaling feature to include the newly added feature from openfaas/faas#605. Signed-off-by: Simon Pelczer <[email protected]>
1 parent 97fae69 commit fd5addc

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/architecture/autoscaling.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,14 @@ The minimum (initial) and maximum replica count can be set at deployment time by
2222

2323
* `com.openfaas.scale.max` The current default value is `20` for 20 replicas
2424

25-
> Note: Setting `com.openfaas.scale.min` and `com.openfaas.scale.max` to the same value, allows to disable the auto-scaling functionality of openfaas.
25+
* `com.openfaas.scale.factor` By default this is set to `20%` and has to be a value between 0-100 (including borders)
2626

27+
> Note:
28+
Setting `com.openfaas.scale.min` and `com.openfaas.scale.max` to the same value, allows to disable the auto-scaling functionality of openfaas.
29+
Setting `com.openfaas.scale.factor=0` also allows to disable the auto-scaling functionality of openfaas.
2730

28-
For each alert fired the auto-scaler will add 5 replicas, but we are currently working on making the step configurable as a pre-defined step or proportional percentage. Once an alert is resolved due to a lower load than is needed for scaling the replica count will be scaled to the minimum replica count.
31+
32+
For each alert fired the auto-scaler will add a number of replicas, which is a defined percentage of the max replicas. This percentage can be set using `com.openfaas.scale.factor`. For example setting `com.openfaas.scale.factor=100` will instantly scale to max replicas. This label enables to define the overall scaling behavior of the function.
2933

3034
> Note: Active alerts can be viewed in the "Alerts" tab of Prometheus which is deployed with OpenFaaS.
3135

0 commit comments

Comments
 (0)