Skip to content

Commit

Permalink
add note about idleReplicaCount limitation (kedacore#595)
Browse files Browse the repository at this point in the history
  • Loading branch information
zroubalik authored Nov 24, 2021
1 parent e19fd59 commit 7d90405
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions content/docs/2.4/concepts/scaling-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ The `cooldownPeriod` only applies after a trigger occurs; when you first create
idleReplicaCount: 0 # Optional. Must be less than minReplicaCount
```

> 💡 **NOTE:** Due to limitations in HPA controller the only supported value for this property is 0, it will not work corrently otherwise. See this [issue](https://github.com/kedacore/keda/issues/2314) for more details.

If this property is set, KEDA will scale the resource down to this number of replicas. If there's some activity on target triggers KEDA will scale the target resource immediately to `minReplicaCount` and then will be scaling handled by HPA. When there is no activity, the target resource is again scaled down to `idleReplicaCount`. This seting must be less than `minReplicaCount`.

**Example:** If there's no activity on triggers the target resource is scaled down to `idleReplicaCount` (0), once there is an activity the target resource is immediately scaled to `minReplicaCount` (10) and then up to `maxReplicaCount` (100) as needed. If there's no activity on triggers the resource is again scaled down to `idleReplicaCount` (0).
Expand Down
2 changes: 2 additions & 0 deletions content/docs/2.5/concepts/scaling-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,8 @@ The `cooldownPeriod` only applies after a trigger occurs; when you first create
idleReplicaCount: 0 # Optional. Must be less than minReplicaCount
```

> 💡 **NOTE:** Due to limitations in HPA controller the only supported value for this property is 0, it will not work corrently otherwise. See this [issue](https://github.com/kedacore/keda/issues/2314) for more details.

If this property is set, KEDA will scale the resource down to this number of replicas. If there's some activity on target triggers KEDA will scale the target resource immediately to `minReplicaCount` and then will be scaling handled by HPA. When there is no activity, the target resource is again scaled down to `idleReplicaCount`. This seting must be less than `minReplicaCount`.

**Example:** If there's no activity on triggers the target resource is scaled down to `idleReplicaCount` (0), once there is an activity the target resource is immediately scaled to `minReplicaCount` (10) and then up to `maxReplicaCount` (100) as needed. If there's no activity on triggers the resource is again scaled down to `idleReplicaCount` (0).
Expand Down

0 comments on commit 7d90405

Please sign in to comment.