Skip to content

Commit 2d4c992

Browse files
[hotfix][docs] Document deprecation of target.utilization.boundary in favor of utilization.max / utilization.min
1 parent bc7c562 commit 2d4c992

2 files changed

Lines changed: 26 additions & 6 deletions

File tree

docs/content.zh/docs/custom-resource/autoscaler.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,17 @@ A target of `0.6` means we are targeting 60% utilization/load for the job vertex
156156

157157
In general, it's not recommended to set target utilization close to 100% as performance usually degrades as we reach capacity limits in most real world systems.
158158

159-
In addition to the utilization target we can set a utilization boundary, that serves as extra buffer to avoid immediate scaling on load fluctuations.
160-
Setting `job.autoscaler.target.utilization.boundary: "0.2"` means that we allow 20% deviation from the target utilization before triggering a scaling action.
159+
To control when scaling actions are triggered, users can set upper and lower utilization thresholds using `job.autoscaler.utilization.max` and `job.autoscaler.utilization.min`.
160+
These define the utilization range within which the autoscaler will not take any scaling action, providing a buffer against load fluctuations.
161+
162+
For example, with a target utilization of `0.6`, setting `job.autoscaler.utilization.max: "0.8"` and `job.autoscaler.utilization.min: "0.4"` means:
163+
- Scale-up is triggered when utilization exceeds `0.8`
164+
- Scale-down is triggered when utilization drops below `0.4`
165+
- No scaling action is taken while utilization remains between `0.4` and `0.8`
166+
167+
{{<hint info >}}
168+
The default thresholds are `target + 0.3` for max and `target - 0.3` for min.
169+
{{< /hint >}}
161170

162171
### Target catch-up duration and restart time
163172

@@ -183,7 +192,8 @@ flinkConfiguration:
183192
job.autoscaler.stabilization.interval: 1m
184193
job.autoscaler.metrics.window: 5m
185194
job.autoscaler.target.utilization: "0.6"
186-
job.autoscaler.target.utilization.boundary: "0.2"
195+
job.autoscaler.utilization.max: "0.8"
196+
job.autoscaler.utilization.min: "0.4"
187197
job.autoscaler.restart.time: 2m
188198
job.autoscaler.catch-up.duration: 5m
189199
pipeline.max-parallelism: "720"

docs/content/docs/custom-resource/autoscaler.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,17 @@ A target of `0.6` means we are targeting 60% utilization/load for the job vertex
156156

157157
In general, it's not recommended to set target utilization close to 100% as performance usually degrades as we reach capacity limits in most real world systems.
158158

159-
In addition to the utilization target we can set a utilization boundary, that serves as extra buffer to avoid immediate scaling on load fluctuations.
160-
Setting `job.autoscaler.target.utilization.boundary: "0.2"` means that we allow 20% deviation from the target utilization before triggering a scaling action.
159+
To control when scaling actions are triggered, users can set upper and lower utilization thresholds using `job.autoscaler.utilization.max` and `job.autoscaler.utilization.min`.
160+
These define the utilization range within which the autoscaler will not take any scaling action, providing a buffer against load fluctuations.
161+
162+
For example, with a target utilization of `0.6`, setting `job.autoscaler.utilization.max: "0.8"` and `job.autoscaler.utilization.min: "0.4"` means:
163+
- Scale-up is triggered when utilization exceeds `0.8`
164+
- Scale-down is triggered when utilization drops below `0.4`
165+
- No scaling action is taken while utilization remains between `0.4` and `0.8`
166+
167+
{{<hint info >}}
168+
The default thresholds are `target + 0.3` for max and `target - 0.3` for min.
169+
{{< /hint >}}
161170

162171
### Target catch-up duration and restart time
163172

@@ -183,7 +192,8 @@ flinkConfiguration:
183192
job.autoscaler.stabilization.interval: 1m
184193
job.autoscaler.metrics.window: 5m
185194
job.autoscaler.target.utilization: "0.6"
186-
job.autoscaler.target.utilization.boundary: "0.2"
195+
job.autoscaler.utilization.max: "0.8"
196+
job.autoscaler.utilization.min: "0.4"
187197
job.autoscaler.restart.time: 2m
188198
job.autoscaler.catch-up.duration: 5m
189199
pipeline.max-parallelism: "720"

0 commit comments

Comments
 (0)