Skip to content

Commit

Permalink
feat: update formula documentation to include new fields
Browse files Browse the repository at this point in the history
Signed-off-by: Jorge Turrado <[email protected]>
  • Loading branch information
JorTurFer committed Sep 25, 2023
1 parent 4916f06 commit 7f11dd0
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions content/docs/2.12/concepts/scaling-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,9 +206,11 @@ Starting from Kubernetes v1.18 the autoscaling API allows scaling behavior to be

```yaml
advanced:
scalingModifiers: # Optional. Section to specify scaling modifiers
target: {target-value-to-scale-on} # Mandatory. New target if metrics are anyhow composed together
formula: {formula-for-fetched-metrics} # Mandatory. Formula for calculation
scalingModifiers: # Optional. Section to specify scaling modifiers
target: {target-value-to-scale-on} # Mandatory. New target if metrics are anyhow composed together
activationTarget: {activation-target-value-to-scale-on} # Optional. New activation target if metrics are anyhow composed together
metricType: {metric-tipe-for-the-modifier} # Optional. Metric type to be used if metrics are anyhow composed together
formula: {formula-for-fetched-metrics} # Mandatory. Formula for calculation
```

**`scalingModifiers`**
Expand All @@ -217,7 +219,15 @@ The `scalingModifiers` is optional and **experimental**. If defined, both `targe

**`scalingModifiers.target`**

`target` defines new target value to scale on for the composed metric. All scaler metrics must be of the same type in order for ScaledObject to be successfully validated.
`target` defines new target value to scale on for the composed metric.

**`scalingModifiers.activationTarget`**

`activationTarget` defines new [activation target value](./scaling-deployments.md#activating-and-scaling-thresholds) to scale on for the composed metric. (Default: `0`, Optional)

**`scalingModifiers.metricType`**

`metricType` defines metric type used for this new `composite-metric`. (Values: `AverageValue`, `Value`, Default: `AverageValue`, Optional)

**`scalingModifiers.formula`**

Expand Down

0 comments on commit 7f11dd0

Please sign in to comment.