Skip to content

Commit fff5a1b

Browse files
committed
docs: update StartupBoost.CPU.Type to be required and fix examples
docs: update StartupBoost.CPU.Type to be required and fix examples docs: update StartupBoost.CPU.Type to be required and fix examples Update vertical-pod-autoscaler/enhancements/7862-cpu-startup-boost/README.md Address comment Co-authored-by: Adrian Moisey <[email protected]> docs: update StartupBoost.CPU.Type to be required and fix examples docs: update StartupBoost.CPU.Type to be required and fix examples
1 parent 42b5f34 commit fff5a1b

File tree

1 file changed

+8
-4
lines changed
  • vertical-pod-autoscaler/enhancements/7862-cpu-startup-boost

1 file changed

+8
-4
lines changed

vertical-pod-autoscaler/enhancements/7862-cpu-startup-boost/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -138,20 +138,19 @@ type CPUStartupBoost struct {
138138
```
139139

140140
`StartupBoost` will contain the following fields:
141-
* [Optional] `StartupBoost.CPU.Type` (type: `string`): A string that specifies
141+
* [Required] `StartupBoost.CPU.Type` (type: `string`): A string that specifies
142142
the kind of boost to apply. Supported values are:
143143
* `Factor`: The `StartupBoost.CPU.Factor` field will be interpreted as a
144144
multiplier for the recommended CPU request. For example, a value of `2` will
145145
double the CPU request.
146146
* `Quantity`: The `StartupBoost.CPU.Quantity` field will be interpreted as an
147-
absolute CPU resource quantity (e.g., `"500m"`, `"1"`) to be used as the CPU
147+
additional CPU resource quantity (e.g., `"500m"`, `"1"`) to be added to the existing CPU
148148
request or limit during the boost phase.
149-
* If not specified, `StartupBoost.CPU.Type` defaults to `Factor`.
150149

151150
* [Optional] `StartupBoost.CPU.Factor`: (type: `integer`): The factor to apply to the CPU request. Defaults to 1 if not specified.
152151
* If `StartupBoost.CPU.Type`is `Factor`, this field is required.
153152
* If `StartupBoost.CPU.Type`is `Quantity`, this field is not allowed.
154-
* [Optional] `StartupBoost.CPU.Quantity`: (type: `resource.Quantity`): The absolute CPU resource quantity.
153+
* [Optional] `StartupBoost.CPU.Quantity`: (type: `resource.Quantity`): The additional CPU resource quantity.
155154
* If `StartupBoost.CPU.Type`is `Quantity`, this field is required.
156155
* If `StartupBoost.CPU.Type`is `Factor`, this field is not allowed.
157156
* [Optional] `StartupBoost.CPU.Duration` (type: `duration`): if specified, it
@@ -301,6 +300,7 @@ spec:
301300
updateMode: "Off"
302301
startupBoost:
303302
cpu:
303+
type: "Factor"
304304
factor: 3
305305
duration: 10s
306306
```
@@ -337,6 +337,7 @@ spec:
337337
updateMode: "Auto"
338338
startupBoost:
339339
cpu:
340+
type: "Factor"
340341
factor: 3
341342
duration: 10s
342343
```
@@ -392,12 +393,14 @@ spec:
392393
name: example
393394
startupBoost:
394395
cpu:
396+
type: "Factor"
395397
factor: 2
396398
resourcePolicy:
397399
containerPolicies:
398400
- containerName: "disable-cpu-boost-for-this-container"
399401
startupBoost:
400402
cpu:
403+
type: "Factor"
401404
factor: 1
402405
```
403406

@@ -436,6 +439,7 @@ spec:
436439

437440
## Implementation History
438441

442+
* 2025-10-04: Update `startupBoost.cpu.type` field to correctly indicate it is a required field, not optional. The field has no default value and must be explicitly set to either "Factor" or "Quantity".
439443
* 2025-08-05: Make some API changes and clarify behavior during and after boost period in the workflow section.
440444
* 2025-06-23: Decouple Startup CPU Boost from InPlaceOrRecreate mode, allow
441445
users to specify a `startupBoost` config in `VerticalPodAutoscalerSpec` and in

0 commit comments

Comments
 (0)